1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2002 Juli Mallett. All rights reserved. 5 * 6 * This software was written by Juli Mallett <jmallett@FreeBSD.org> for the 7 * FreeBSD project. Redistribution and use in source and binary forms, with 8 * or without modification, are permitted provided that the following 9 * conditions are met: 10 * 11 * 1. Redistribution of source code must retain the above copyright notice, 12 * this list of conditions and the following disclaimer. 13 * 2. Redistribution in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 20 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, 21 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 23 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 25 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 26 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 27 * POSSIBILITY OF SUCH DAMAGE. 28 * 29 * $FreeBSD$ 30 */ 31 32 #ifndef __LIBUFS_H__ 33 #define __LIBUFS_H__ 34 35 /* 36 * libufs structures. 37 */ 38 union dinodep { 39 struct ufs1_dinode *dp1; 40 struct ufs2_dinode *dp2; 41 }; 42 43 /* 44 * userland ufs disk. 45 */ 46 struct uufsd { 47 const char *d_name; /* disk name */ 48 int d_ufs; /* decimal UFS version */ 49 int d_fd; /* raw device file descriptor */ 50 long d_bsize; /* device bsize */ 51 ufs2_daddr_t d_sblock; /* superblock location */ 52 struct fs_summary_info *d_si; /* Superblock summary info */ 53 caddr_t d_inoblock; /* inode block */ 54 uint32_t d_inomin; /* low ino, not ino_t for ABI compat */ 55 uint32_t d_inomax; /* high ino, not ino_t for ABI compat */ 56 union dinodep d_dp; /* pointer to currently active inode */ 57 union { 58 struct fs d_fs; /* filesystem information */ 59 char d_sb[MAXBSIZE]; /* superblock as buffer */ 60 } d_sbunion; 61 union { 62 struct cg d_cg; /* cylinder group */ 63 char d_buf[MAXBSIZE]; /* cylinder group storage */ 64 } d_cgunion; 65 int d_ccg; /* current cylinder group */ 66 int d_lcg; /* last cylinder group (in d_cg) */ 67 const char *d_error; /* human readable disk error */ 68 off_t d_sblockloc; /* where to look for the superblock */ 69 int d_lookupflags; /* flags to superblock lookup */ 70 int d_mine; /* internal flags */ 71 #define d_fs d_sbunion.d_fs 72 #define d_sb d_sbunion.d_sb 73 #define d_cg d_cgunion.d_cg 74 }; 75 76 /* 77 * libufs macros (internal, non-exported). 78 */ 79 #ifdef _LIBUFS 80 /* 81 * Trace steps through libufs, to be used at entry and erroneous return. 82 */ 83 static inline void 84 ERROR(struct uufsd *u, const char *str) 85 { 86 87 #ifdef _LIBUFS_DEBUGGING 88 if (str != NULL) { 89 fprintf(stderr, "libufs: %s", str); 90 if (errno != 0) 91 fprintf(stderr, ": %s", strerror(errno)); 92 fprintf(stderr, "\n"); 93 } 94 #endif 95 if (u != NULL) 96 u->d_error = str; 97 } 98 #endif /* _LIBUFS */ 99 100 __BEGIN_DECLS 101 102 /* 103 * libufs prototypes. 104 */ 105 106 /* 107 * ffs_subr.c 108 */ 109 void ffs_clrblock(struct fs *, u_char *, ufs1_daddr_t); 110 void ffs_clusteracct(struct fs *, struct cg *, ufs1_daddr_t, int); 111 void ffs_fragacct(struct fs *, int, int32_t [], int); 112 int ffs_isblock(struct fs *, u_char *, ufs1_daddr_t); 113 int ffs_isfreeblock(struct fs *, u_char *, ufs1_daddr_t); 114 int ffs_sbsearch(void *, struct fs **, int, char *, 115 int (*)(void *, off_t, void **, int)); 116 void ffs_setblock(struct fs *, u_char *, ufs1_daddr_t); 117 int ffs_sbget(void *, struct fs **, off_t, int, char *, 118 int (*)(void *, off_t, void **, int)); 119 int ffs_sbput(void *, struct fs *, off_t, 120 int (*)(void *, off_t, void *, int)); 121 void ffs_update_dinode_ckhash(struct fs *, struct ufs2_dinode *); 122 int ffs_verify_dinode_ckhash(struct fs *, struct ufs2_dinode *); 123 124 /* 125 * block.c 126 */ 127 ssize_t bread(struct uufsd *, ufs2_daddr_t, void *, size_t); 128 ssize_t bwrite(struct uufsd *, ufs2_daddr_t, const void *, size_t); 129 int berase(struct uufsd *, ufs2_daddr_t, ufs2_daddr_t); 130 131 /* 132 * cgroup.c 133 */ 134 ufs2_daddr_t cgballoc(struct uufsd *); 135 int cgbfree(struct uufsd *, ufs2_daddr_t, long); 136 ino_t cgialloc(struct uufsd *); 137 int cgget(int, struct fs *, int, struct cg *); 138 int cgput(int, struct fs *, struct cg *); 139 int cgread(struct uufsd *); 140 int cgread1(struct uufsd *, int); 141 int cgwrite(struct uufsd *); 142 int cgwrite1(struct uufsd *, int); 143 144 /* 145 * inode.c 146 */ 147 int getinode(struct uufsd *, union dinodep *, ino_t); 148 int putinode(struct uufsd *); 149 150 /* 151 * sblock.c 152 */ 153 int sbread(struct uufsd *); 154 int sbfind(struct uufsd *, int); 155 int sbwrite(struct uufsd *, int); 156 /* low level superblock read/write functions */ 157 int sbget(int, struct fs **, off_t, int); 158 int sbsearch(int, struct fs **, int); 159 int sbput(int, struct fs *, int); 160 161 /* 162 * type.c 163 */ 164 int ufs_disk_close(struct uufsd *); 165 int ufs_disk_fillout(struct uufsd *, const char *); 166 int ufs_disk_fillout_blank(struct uufsd *, const char *); 167 int ufs_disk_write(struct uufsd *); 168 169 /* 170 * crc32c.c 171 */ 172 uint32_t calculate_crc32c(uint32_t, const void *, size_t); 173 174 __END_DECLS 175 176 #endif /* __LIBUFS_H__ */ 177