include/libxfs.h

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (c) 2000-2005 Silicon Graphics, Inc.
   4  * All Rights Reserved.
   5  */
   6
   7 #ifndef __LIBXFS_H__
   8 #define __LIBXFS_H__
   9
  10 #include "libxfs_api_defs.h"
  11 #include "platform_defs.h"
  12 #include "xfs.h"
  13
  14 #include "list.h"
  15 #include "hlist.h"
  16 #include "cache.h"
  17 #include "bitops.h"
  18 #include "kmem.h"
  19 #include "libfrog/radix-tree.h"
  20 #include "libfrog/bitmask.h"
  21 #include "libfrog/div64.h"
  22 #include "atomic.h"
  23 #include "spinlock.h"
  24
  25 #include "xfs_types.h"
  26 #include "xfs_fs.h"
  27 #include "xfs_arch.h"
  28
  29 #include "xfs_shared.h"
  30 #include "xfs_format.h"
  31 #include "xfs_log_format.h"
  32 #include "xfs_quota_defs.h"
  33 #include "xfs_trans_resv.h"
  34
  35
  36 /* CRC stuff, buffer API dependent on it */
  37 extern uint32_t crc32c_le(uint32_t crc, unsigned char const *p, size_t len);
  38 #define crc32c(c,p,l)   crc32c_le((c),(unsigned char const *)(p),(l))
  39
  40 /* fake up kernel's iomap, (not) used in xfs_bmap.[ch] */
  41 struct iomap;
  42 #include "xfs_cksum.h"
  43
  44 #define __round_mask(x, y) ((__typeof__(x))((y)-1))
  45 #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
  46 #define unlikely(x) (x)
  47
  48 /*
  49  * This mirrors the kernel include for xfs_buf.h - it's implicitly included in
  50  * every files via a similar include in the kernel xfs_linux.h.
  51  */
  52 #include "libxfs_io.h"
  53
  54 #include "xfs_bit.h"
  55 #include "xfs_sb.h"
  56 #include "xfs_mount.h"
  57 #include "xfs_defer.h"
  58 #include "xfs_errortag.h"
  59 #include "xfs_da_format.h"
  60 #include "xfs_da_btree.h"
  61 #include "xfs_inode.h"
  62 #include "xfs_dir2.h"
  63 #include "xfs_dir2_priv.h"
  64 #include "xfs_bmap_btree.h"
  65 #include "xfs_alloc_btree.h"
  66 #include "xfs_ialloc_btree.h"
  67 #include "xfs_attr.h"
  68 #include "xfs_attr_sf.h"
  69 #include "xfs_inode_fork.h"
  70 #include "xfs_inode_buf.h"
  71 #include "xfs_alloc.h"
  72 #include "xfs_btree.h"
  73 #include "xfs_bmap.h"
  74 #include "xfs_trace.h"
  75 #include "xfs_trans.h"
  76 #include "xfs_ag.h"
  77 #include "xfs_rmap_btree.h"
  78 #include "xfs_rmap.h"
  79 #include "xfs_refcount_btree.h"
  80 #include "xfs_refcount.h"
  81 #include "xfs_btree_staging.h"
  82
  83 #ifndef ARRAY_SIZE
  84 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
  85 #endif
  86
  87 #ifndef XFS_SUPER_MAGIC
  88 #define XFS_SUPER_MAGIC 0x58465342
  89 #endif
  90
  91 #define xfs_isset(a,i)  ((a)[(i)/(sizeof(*(a))*NBBY)] & (1ULL<<((i)%(sizeof(*(a))*NBBY))))
  92
  93 struct libxfs_dev {
  94         /* input parameters */
  95         char            *name;  /* pathname of the device */
  96         bool            isfile; /* is the device a file? */
  97         bool            create; /* create file if it doesn't exist */
  98
  99         /* output parameters */
 100         dev_t           dev;    /* device name for the device */
 101         long long       size;   /* size of subvolume (BBs) */
 102         int             bsize;  /* device blksize */
 103         int             fd;     /* file descriptor */
 104 };
 105
 106 /*
 107  * Argument structure for libxfs_init().
 108  */
 109 struct libxfs_init {
 110         struct libxfs_dev       data;
 111         struct libxfs_dev       log;
 112         struct libxfs_dev       rt;
 113
 114         /* input parameters */
 115         unsigned        flags;          /* LIBXFS_* flags below */
 116         int             bcache_flags;   /* cache init flags */
 117         int             setblksize;     /* value to set device blksizes to */
 118 };
 119
 120 /* disallow all mounted filesystems: */
 121 #define LIBXFS_ISREADONLY       (1U << 0)
 122
 123 /* allow mounted only if mounted ro: */
 124 #define LIBXFS_ISINACTIVE       (1U << 1)
 125
 126 /* repairing a device mounted ro: */
 127 #define LIBXFS_DANGEROUSLY      (1U << 2)
 128
 129 /* disallow other accesses (O_EXCL): */
 130 #define LIBXFS_EXCLUSIVELY      (1U << 3)
 131
 132 /* can use direct I/O, not buffered: */
 133 #define LIBXFS_DIRECT           (1U << 4)
 134
 135 /* lock xfs_buf's - for MT usage */
 136 #define LIBXFS_USEBUFLOCK       (1U << 5)
 137
 138 extern char     *progname;
 139 extern xfs_lsn_t libxfs_max_lsn;
 140
 141 int             libxfs_init(struct libxfs_init *);
 142 void            libxfs_destroy(struct libxfs_init *li);
 143
 144 extern int      libxfs_device_alignment (void);
 145 extern void     libxfs_report(FILE *);
 146
 147 /* check or write log footer: specify device, log size in blocks & uuid */
 148 typedef char    *(libxfs_get_block_t)(char *, int, void *);
 149
 150 /*
 151  * Helpers to clear the log to a particular log cycle.
 152  */
 153 #define XLOG_INIT_CYCLE 1
 154 extern int      libxfs_log_clear(struct xfs_buftarg *, char *, xfs_daddr_t,
 155                                  uint, uuid_t *, int, int, int, int, bool);
 156 extern int      libxfs_log_header(char *, uuid_t *, int, int, int, xfs_lsn_t,
 157                                   xfs_lsn_t, libxfs_get_block_t *, void *);
 158
 159
 160 /* Shared utility routines */
 161
 162 extern int      libxfs_alloc_file_space (struct xfs_inode *, xfs_off_t,
 163                                 xfs_off_t, int, int);
 164
 165 /* XXX: this is messy and needs fixing */
 166 #ifndef __LIBXFS_INTERNAL_XFS_H__
 167 extern void cmn_err(int, char *, ...);
 168 enum ce { CE_DEBUG, CE_CONT, CE_NOTE, CE_WARN, CE_ALERT, CE_PANIC };
 169 #endif
 170
 171 #include "xfs_ialloc.h"
 172
 173 #include "xfs_attr_leaf.h"
 174 #include "xfs_attr_remote.h"
 175 #include "xfs_trans_space.h"
 176
 177 #define XFS_INOBT_IS_FREE_DISK(rp,i)            \
 178                         ((be64_to_cpu((rp)->ir_free) & XFS_INOBT_MASK(i)) != 0)
 179
 180 static inline bool
 181 xfs_inobt_is_sparse_disk(
 182         struct xfs_inobt_rec    *rp,
 183         int                     offset)
 184 {
 185         int                     spshift;
 186         uint16_t                holemask;
 187
 188         holemask = be16_to_cpu(rp->ir_u.sp.ir_holemask);
 189         spshift = offset / XFS_INODES_PER_HOLEMASK_BIT;
 190         if ((1 << spshift) & holemask)
 191                 return true;
 192
 193         return false;
 194 }
 195
 196 static inline void
 197 libxfs_bmbt_disk_get_all(
 198         struct xfs_bmbt_rec     *rec,
 199         struct xfs_bmbt_irec    *irec)
 200 {
 201         uint64_t                l0 = get_unaligned_be64(&rec->l0);
 202         uint64_t                l1 = get_unaligned_be64(&rec->l1);
 203
 204         irec->br_startoff = (l0 & xfs_mask64lo(64 - BMBT_EXNTFLAG_BITLEN)) >> 9;
 205         irec->br_startblock = ((l0 & xfs_mask64lo(9)) << 43) | (l1 >> 21);
 206         irec->br_blockcount = l1 & xfs_mask64lo(21);
 207         if (l0 >> (64 - BMBT_EXNTFLAG_BITLEN))
 208                 irec->br_state = XFS_EXT_UNWRITTEN;
 209         else
 210                 irec->br_state = XFS_EXT_NORM;
 211 }
 212
 213 /* XXX: this is clearly a bug - a shared header needs to export this */
 214 /* xfs_rtalloc.c */
 215 int libxfs_rtfree_extent(struct xfs_trans *, xfs_rtblock_t, xfs_extlen_t);
 216 bool libxfs_verify_rtbno(struct xfs_mount *mp, xfs_rtblock_t rtbno);
 217
 218 #include "xfs_attr.h"
 219 #include "topology.h"
 220
 221 /*
 222  * Superblock helpers for programs that act on independent superblock
 223  * structures.  These used to be part of xfs_format.h.
 224  */
 225 static inline bool xfs_sb_version_haslazysbcount(struct xfs_sb *sbp)
 226 {
 227         return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5) ||
 228                (xfs_sb_version_hasmorebits(sbp) &&
 229                 (sbp->sb_features2 & XFS_SB_VERSION2_LAZYSBCOUNTBIT));
 230 }
 231
 232 static inline bool xfs_sb_version_hascrc(struct xfs_sb *sbp)
 233 {
 234         return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5;
 235 }
 236
 237 static inline bool xfs_sb_version_hasmetauuid(struct xfs_sb *sbp)
 238 {
 239         return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5) &&
 240                 (sbp->sb_features_incompat & XFS_SB_FEAT_INCOMPAT_META_UUID);
 241 }
 242
 243 static inline bool xfs_sb_version_hasalign(struct xfs_sb *sbp)
 244 {
 245         return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 ||
 246                 (sbp->sb_versionnum & XFS_SB_VERSION_ALIGNBIT));
 247 }
 248
 249 static inline bool xfs_sb_version_hasdalign(struct xfs_sb *sbp)
 250 {
 251         return (sbp->sb_versionnum & XFS_SB_VERSION_DALIGNBIT);
 252 }
 253
 254 static inline bool xfs_sb_version_haslogv2(struct xfs_sb *sbp)
 255 {
 256         return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 ||
 257                (sbp->sb_versionnum & XFS_SB_VERSION_LOGV2BIT);
 258 }
 259
 260 static inline bool xfs_sb_version_hassector(struct xfs_sb *sbp)
 261 {
 262         return (sbp->sb_versionnum & XFS_SB_VERSION_SECTORBIT);
 263 }
 264
 265 static inline bool xfs_sb_version_needsrepair(struct xfs_sb *sbp)
 266 {
 267         return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 &&
 268                 (sbp->sb_features_incompat & XFS_SB_FEAT_INCOMPAT_NEEDSREPAIR);
 269 }
 270
 271 static inline bool xfs_sb_version_hassparseinodes(struct xfs_sb *sbp)
 272 {
 273         return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 &&
 274                 xfs_sb_has_incompat_feature(sbp, XFS_SB_FEAT_INCOMPAT_SPINODES);
 275 }
 276
 277 #endif  /* __LIBXFS_H__ */