1/*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 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 */ 38union dinodep { 39 struct ufs1_dinode *dp1; 40 struct ufs2_dinode *dp2; 41}; 42 43/* 44 * userland ufs disk. 45 */ 46struct 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 int d_mine; /* internal flags */ 69#define d_fs d_sbunion.d_fs 70#define d_sb d_sbunion.d_sb 71#define d_cg d_cgunion.d_cg 72}; 73 74/* 75 * libufs macros (internal, non-exported). 76 */ 77#ifdef _LIBUFS 78/* 79 * Trace steps through libufs, to be used at entry and erroneous return. 80 */ 81static inline void 82ERROR(struct uufsd *u, const char *str) 83{ 84 85#ifdef _LIBUFS_DEBUGGING 86 if (str != NULL) { 87 fprintf(stderr, "libufs: %s", str); 88 if (errno != 0) 89 fprintf(stderr, ": %s", strerror(errno)); 90 fprintf(stderr, "\n"); 91 } 92#endif 93 if (u != NULL) 94 u->d_error = str; 95} 96#endif /* _LIBUFS */ 97 98__BEGIN_DECLS 99 100/* 101 * libufs prototypes. 102 */ 103 104/* 105 * ffs_subr.c 106 */ 107void ffs_clrblock(struct fs *, u_char *, ufs1_daddr_t); 108void ffs_clusteracct(struct fs *, struct cg *, ufs1_daddr_t, int); 109void ffs_fragacct(struct fs *, int, int32_t [], int); 110int ffs_isblock(struct fs *, u_char *, ufs1_daddr_t); 111int ffs_isfreeblock(struct fs *, u_char *, ufs1_daddr_t); 112void ffs_setblock(struct fs *, u_char *, ufs1_daddr_t); 113int ffs_sbget(void *, struct fs **, off_t, char *, 114 int (*)(void *, off_t, void **, int)); 115int ffs_sbput(void *, struct fs *, off_t, 116 int (*)(void *, off_t, void *, int)); 117void ffs_update_dinode_ckhash(struct fs *, struct ufs2_dinode *); 118int ffs_verify_dinode_ckhash(struct fs *, struct ufs2_dinode *); 119 120/* 121 * Request standard superblock location in ffs_sbget 122 */ 123#define STDSB -1 /* Fail if check-hash is bad */ 124#define STDSB_NOHASHFAIL -2 /* Ignore check-hash failure */ 125 126/* 127 * block.c 128 */ 129ssize_t bread(struct uufsd *, ufs2_daddr_t, void *, size_t); 130ssize_t bwrite(struct uufsd *, ufs2_daddr_t, const void *, size_t); 131int berase(struct uufsd *, ufs2_daddr_t, ufs2_daddr_t); 132 133/* 134 * cgroup.c 135 */ 136ufs2_daddr_t cgballoc(struct uufsd *); 137int cgbfree(struct uufsd *, ufs2_daddr_t, long); 138ino_t cgialloc(struct uufsd *); 139int cgget(int, struct fs *, int, struct cg *); 140int cgput(int, struct fs *, struct cg *); 141int cgread(struct uufsd *); 142int cgread1(struct uufsd *, int); 143int cgwrite(struct uufsd *); 144int cgwrite1(struct uufsd *, int); 145 146/* 147 * inode.c 148 */ 149int getinode(struct uufsd *, union dinodep *, ino_t); 150int putinode(struct uufsd *); 151 152/* 153 * sblock.c 154 */ 155int sbread(struct uufsd *); 156int sbwrite(struct uufsd *, int); 157/* low level superblock read/write functions */ 158int sbget(int, struct fs **, off_t); 159int sbput(int, struct fs *, int); 160 161/* 162 * type.c 163 */ 164int ufs_disk_close(struct uufsd *); 165int ufs_disk_fillout(struct uufsd *, const char *); 166int ufs_disk_fillout_blank(struct uufsd *, const char *); 167int ufs_disk_write(struct uufsd *); 168 169/* 170 * crc32c.c 171 */ 172uint32_t calculate_crc32c(uint32_t, const void *, size_t); 173 174__END_DECLS 175 176#endif /* __LIBUFS_H__ */ 177