1 /* 2 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc. 3 * All Rights Reserved. 4 * 5 * This program is free software; you can redistribute it and/or 6 * modify it under the terms of the GNU General Public License as 7 * published by the Free Software Foundation. 8 * 9 * This program is distributed in the hope that it would be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 * GNU General Public License for more details. 13 * 14 * You should have received a copy of the GNU General Public License 15 * along with this program; if not, write the Free Software Foundation, 16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 17 */ 18 #ifndef __XFS_INODE_H__ 19 #define __XFS_INODE_H__ 20 21 #include "xfs_inode_buf.h" 22 #include "xfs_inode_fork.h" 23 24 /* 25 * Kernel only inode definitions 26 */ 27 struct xfs_dinode; 28 struct xfs_inode; 29 struct xfs_buf; 30 struct xfs_bmap_free; 31 struct xfs_bmbt_irec; 32 struct xfs_inode_log_item; 33 struct xfs_mount; 34 struct xfs_trans; 35 struct xfs_dquot; 36 37 typedef struct xfs_inode { 38 /* Inode linking and identification information. */ 39 struct xfs_mount *i_mount; /* fs mount struct ptr */ 40 struct xfs_dquot *i_udquot; /* user dquot */ 41 struct xfs_dquot *i_gdquot; /* group dquot */ 42 struct xfs_dquot *i_pdquot; /* project dquot */ 43 44 /* Inode location stuff */ 45 xfs_ino_t i_ino; /* inode number (agno/agino)*/ 46 struct xfs_imap i_imap; /* location for xfs_imap() */ 47 48 /* Extent information. */ 49 xfs_ifork_t *i_afp; /* attribute fork pointer */ 50 xfs_ifork_t i_df; /* data fork */ 51 52 /* operations vectors */ 53 const struct xfs_dir_ops *d_ops; /* directory ops vector */ 54 55 /* Transaction and locking information. */ 56 struct xfs_inode_log_item *i_itemp; /* logging information */ 57 mrlock_t i_lock; /* inode lock */ 58 mrlock_t i_iolock; /* inode IO lock */ 59 atomic_t i_pincount; /* inode pin count */ 60 spinlock_t i_flags_lock; /* inode i_flags lock */ 61 /* Miscellaneous state. */ 62 unsigned long i_flags; /* see defined flags below */ 63 unsigned int i_delayed_blks; /* count of delay alloc blks */ 64 65 xfs_icdinode_t i_d; /* most of ondisk inode */ 66 67 /* VFS inode */ 68 struct inode i_vnode; /* embedded VFS inode */ 69 } xfs_inode_t; 70 71 /* Convert from vfs inode to xfs inode */ 72 static inline struct xfs_inode *XFS_I(struct inode *inode) 73 { 74 return container_of(inode, struct xfs_inode, i_vnode); 75 } 76 77 /* convert from xfs inode to vfs inode */ 78 static inline struct inode *VFS_I(struct xfs_inode *ip) 79 { 80 return &ip->i_vnode; 81 } 82 83 /* 84 * For regular files we only update the on-disk filesize when actually 85 * writing data back to disk. Until then only the copy in the VFS inode 86 * is uptodate. 87 */ 88 static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip) 89 { 90 if (S_ISREG(ip->i_d.di_mode)) 91 return i_size_read(VFS_I(ip)); 92 return ip->i_d.di_size; 93 } 94 95 /* 96 * If this I/O goes past the on-disk inode size update it unless it would 97 * be past the current in-core inode size. 98 */ 99 static inline xfs_fsize_t 100 xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size) 101 { 102 xfs_fsize_t i_size = i_size_read(VFS_I(ip)); 103 104 if (new_size > i_size || new_size < 0) 105 new_size = i_size; 106 return new_size > ip->i_d.di_size ? new_size : 0; 107 } 108 109 /* 110 * i_flags helper functions 111 */ 112 static inline void 113 __xfs_iflags_set(xfs_inode_t *ip, unsigned short flags) 114 { 115 ip->i_flags |= flags; 116 } 117 118 static inline void 119 xfs_iflags_set(xfs_inode_t *ip, unsigned short flags) 120 { 121 spin_lock(&ip->i_flags_lock); 122 __xfs_iflags_set(ip, flags); 123 spin_unlock(&ip->i_flags_lock); 124 } 125 126 static inline void 127 xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags) 128 { 129 spin_lock(&ip->i_flags_lock); 130 ip->i_flags &= ~flags; 131 spin_unlock(&ip->i_flags_lock); 132 } 133 134 static inline int 135 __xfs_iflags_test(xfs_inode_t *ip, unsigned short flags) 136 { 137 return (ip->i_flags & flags); 138 } 139 140 static inline int 141 xfs_iflags_test(xfs_inode_t *ip, unsigned short flags) 142 { 143 int ret; 144 spin_lock(&ip->i_flags_lock); 145 ret = __xfs_iflags_test(ip, flags); 146 spin_unlock(&ip->i_flags_lock); 147 return ret; 148 } 149 150 static inline int 151 xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags) 152 { 153 int ret; 154 155 spin_lock(&ip->i_flags_lock); 156 ret = ip->i_flags & flags; 157 if (ret) 158 ip->i_flags &= ~flags; 159 spin_unlock(&ip->i_flags_lock); 160 return ret; 161 } 162 163 static inline int 164 xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags) 165 { 166 int ret; 167 168 spin_lock(&ip->i_flags_lock); 169 ret = ip->i_flags & flags; 170 if (!ret) 171 ip->i_flags |= flags; 172 spin_unlock(&ip->i_flags_lock); 173 return ret; 174 } 175 176 /* 177 * Project quota id helpers (previously projid was 16bit only 178 * and using two 16bit values to hold new 32bit projid was chosen 179 * to retain compatibility with "old" filesystems). 180 */ 181 static inline prid_t 182 xfs_get_projid(struct xfs_inode *ip) 183 { 184 return (prid_t)ip->i_d.di_projid_hi << 16 | ip->i_d.di_projid_lo; 185 } 186 187 static inline void 188 xfs_set_projid(struct xfs_inode *ip, 189 prid_t projid) 190 { 191 ip->i_d.di_projid_hi = (__uint16_t) (projid >> 16); 192 ip->i_d.di_projid_lo = (__uint16_t) (projid & 0xffff); 193 } 194 195 static inline prid_t 196 xfs_get_initial_prid(struct xfs_inode *dp) 197 { 198 if (dp->i_d.di_flags & XFS_DIFLAG_PROJINHERIT) 199 return xfs_get_projid(dp); 200 201 return XFS_PROJID_DEFAULT; 202 } 203 204 /* 205 * In-core inode flags. 206 */ 207 #define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */ 208 #define XFS_ISTALE (1 << 1) /* inode has been staled */ 209 #define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */ 210 #define XFS_INEW (1 << 3) /* inode has just been allocated */ 211 #define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */ 212 #define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */ 213 #define __XFS_IFLOCK_BIT 7 /* inode is being flushed right now */ 214 #define XFS_IFLOCK (1 << __XFS_IFLOCK_BIT) 215 #define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */ 216 #define XFS_IPINNED (1 << __XFS_IPINNED_BIT) 217 #define XFS_IDONTCACHE (1 << 9) /* don't cache the inode long term */ 218 219 /* 220 * Per-lifetime flags need to be reset when re-using a reclaimable inode during 221 * inode lookup. This prevents unintended behaviour on the new inode from 222 * ocurring. 223 */ 224 #define XFS_IRECLAIM_RESET_FLAGS \ 225 (XFS_IRECLAIMABLE | XFS_IRECLAIM | \ 226 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED) 227 228 /* 229 * Synchronize processes attempting to flush the in-core inode back to disk. 230 */ 231 232 extern void __xfs_iflock(struct xfs_inode *ip); 233 234 static inline int xfs_iflock_nowait(struct xfs_inode *ip) 235 { 236 return !xfs_iflags_test_and_set(ip, XFS_IFLOCK); 237 } 238 239 static inline void xfs_iflock(struct xfs_inode *ip) 240 { 241 if (!xfs_iflock_nowait(ip)) 242 __xfs_iflock(ip); 243 } 244 245 static inline void xfs_ifunlock(struct xfs_inode *ip) 246 { 247 xfs_iflags_clear(ip, XFS_IFLOCK); 248 smp_mb(); 249 wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT); 250 } 251 252 static inline int xfs_isiflocked(struct xfs_inode *ip) 253 { 254 return xfs_iflags_test(ip, XFS_IFLOCK); 255 } 256 257 /* 258 * Flags for inode locking. 259 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield) 260 * 1<<16 - 1<<32-1 -- lockdep annotation (integers) 261 */ 262 #define XFS_IOLOCK_EXCL (1<<0) 263 #define XFS_IOLOCK_SHARED (1<<1) 264 #define XFS_ILOCK_EXCL (1<<2) 265 #define XFS_ILOCK_SHARED (1<<3) 266 267 #define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \ 268 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED) 269 270 #define XFS_LOCK_FLAGS \ 271 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \ 272 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \ 273 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \ 274 { XFS_ILOCK_SHARED, "ILOCK_SHARED" } 275 276 277 /* 278 * Flags for lockdep annotations. 279 * 280 * XFS_LOCK_PARENT - for directory operations that require locking a 281 * parent directory inode and a child entry inode. The parent gets locked 282 * with this flag so it gets a lockdep subclass of 1 and the child entry 283 * lock will have a lockdep subclass of 0. 284 * 285 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary 286 * inodes do not participate in the normal lock order, and thus have their 287 * own subclasses. 288 * 289 * XFS_LOCK_INUMORDER - for locking several inodes at the some time 290 * with xfs_lock_inodes(). This flag is used as the starting subclass 291 * and each subsequent lock acquired will increment the subclass by one. 292 * So the first lock acquired will have a lockdep subclass of 4, the 293 * second lock will have a lockdep subclass of 5, and so on. It is 294 * the responsibility of the class builder to shift this to the correct 295 * portion of the lock_mode lockdep mask. 296 */ 297 #define XFS_LOCK_PARENT 1 298 #define XFS_LOCK_RTBITMAP 2 299 #define XFS_LOCK_RTSUM 3 300 #define XFS_LOCK_INUMORDER 4 301 302 #define XFS_IOLOCK_SHIFT 16 303 #define XFS_IOLOCK_PARENT (XFS_LOCK_PARENT << XFS_IOLOCK_SHIFT) 304 305 #define XFS_ILOCK_SHIFT 24 306 #define XFS_ILOCK_PARENT (XFS_LOCK_PARENT << XFS_ILOCK_SHIFT) 307 #define XFS_ILOCK_RTBITMAP (XFS_LOCK_RTBITMAP << XFS_ILOCK_SHIFT) 308 #define XFS_ILOCK_RTSUM (XFS_LOCK_RTSUM << XFS_ILOCK_SHIFT) 309 310 #define XFS_IOLOCK_DEP_MASK 0x00ff0000 311 #define XFS_ILOCK_DEP_MASK 0xff000000 312 #define XFS_LOCK_DEP_MASK (XFS_IOLOCK_DEP_MASK | XFS_ILOCK_DEP_MASK) 313 314 #define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) >> XFS_IOLOCK_SHIFT) 315 #define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) >> XFS_ILOCK_SHIFT) 316 317 /* 318 * For multiple groups support: if S_ISGID bit is set in the parent 319 * directory, group of new file is set to that of the parent, and 320 * new subdirectory gets S_ISGID bit from parent. 321 */ 322 #define XFS_INHERIT_GID(pip) \ 323 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \ 324 ((pip)->i_d.di_mode & S_ISGID)) 325 326 int xfs_release(struct xfs_inode *ip); 327 void xfs_inactive(struct xfs_inode *ip); 328 int xfs_lookup(struct xfs_inode *dp, struct xfs_name *name, 329 struct xfs_inode **ipp, struct xfs_name *ci_name); 330 int xfs_create(struct xfs_inode *dp, struct xfs_name *name, 331 umode_t mode, xfs_dev_t rdev, struct xfs_inode **ipp); 332 int xfs_create_tmpfile(struct xfs_inode *dp, struct dentry *dentry, 333 umode_t mode, struct xfs_inode **ipp); 334 int xfs_remove(struct xfs_inode *dp, struct xfs_name *name, 335 struct xfs_inode *ip); 336 int xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip, 337 struct xfs_name *target_name); 338 int xfs_rename(struct xfs_inode *src_dp, struct xfs_name *src_name, 339 struct xfs_inode *src_ip, struct xfs_inode *target_dp, 340 struct xfs_name *target_name, 341 struct xfs_inode *target_ip, unsigned int flags); 342 343 void xfs_ilock(xfs_inode_t *, uint); 344 int xfs_ilock_nowait(xfs_inode_t *, uint); 345 void xfs_iunlock(xfs_inode_t *, uint); 346 void xfs_ilock_demote(xfs_inode_t *, uint); 347 int xfs_isilocked(xfs_inode_t *, uint); 348 uint xfs_ilock_data_map_shared(struct xfs_inode *); 349 uint xfs_ilock_attr_map_shared(struct xfs_inode *); 350 int xfs_ialloc(struct xfs_trans *, xfs_inode_t *, umode_t, 351 xfs_nlink_t, xfs_dev_t, prid_t, int, 352 struct xfs_buf **, xfs_inode_t **); 353 354 uint xfs_ip2xflags(struct xfs_inode *); 355 uint xfs_dic2xflags(struct xfs_dinode *); 356 int xfs_ifree(struct xfs_trans *, xfs_inode_t *, 357 struct xfs_bmap_free *); 358 int xfs_itruncate_extents(struct xfs_trans **, struct xfs_inode *, 359 int, xfs_fsize_t); 360 int xfs_iunlink(struct xfs_trans *, xfs_inode_t *); 361 362 void xfs_iext_realloc(xfs_inode_t *, int, int); 363 364 void xfs_iunpin_wait(xfs_inode_t *); 365 #define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount)) 366 367 int xfs_iflush(struct xfs_inode *, struct xfs_buf **); 368 void xfs_lock_inodes(xfs_inode_t **, int, uint); 369 void xfs_lock_two_inodes(xfs_inode_t *, xfs_inode_t *, uint); 370 371 xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip); 372 373 int xfs_dir_ialloc(struct xfs_trans **, struct xfs_inode *, umode_t, 374 xfs_nlink_t, xfs_dev_t, prid_t, int, 375 struct xfs_inode **, int *); 376 int xfs_droplink(struct xfs_trans *, struct xfs_inode *); 377 int xfs_bumplink(struct xfs_trans *, struct xfs_inode *); 378 379 /* from xfs_file.c */ 380 enum xfs_prealloc_flags { 381 XFS_PREALLOC_SET = (1 << 1), 382 XFS_PREALLOC_CLEAR = (1 << 2), 383 XFS_PREALLOC_SYNC = (1 << 3), 384 XFS_PREALLOC_INVISIBLE = (1 << 4), 385 }; 386 387 int xfs_update_prealloc_flags(struct xfs_inode *, 388 enum xfs_prealloc_flags); 389 int xfs_zero_eof(struct xfs_inode *, xfs_off_t, xfs_fsize_t); 390 int xfs_iozero(struct xfs_inode *, loff_t, size_t); 391 392 393 #define IHOLD(ip) \ 394 do { \ 395 ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \ 396 ihold(VFS_I(ip)); \ 397 trace_xfs_ihold(ip, _THIS_IP_); \ 398 } while (0) 399 400 #define IRELE(ip) \ 401 do { \ 402 trace_xfs_irele(ip, _THIS_IP_); \ 403 iput(VFS_I(ip)); \ 404 } while (0) 405 406 extern struct kmem_zone *xfs_inode_zone; 407 408 /* 409 * Flags for read/write calls 410 */ 411 #define XFS_IO_ISDIRECT 0x00001 /* bypass page cache */ 412 #define XFS_IO_INVIS 0x00002 /* don't update inode timestamps */ 413 414 #define XFS_IO_FLAGS \ 415 { XFS_IO_ISDIRECT, "DIRECT" }, \ 416 { XFS_IO_INVIS, "INVIS"} 417 418 #endif /* __XFS_INODE_H__ */ 419