fs/ext4/xattr.h

   1 /*
   2   File: fs/ext4/xattr.h
   3
   4   On-disk format of extended attributes for the ext4 filesystem.
   5
   6   (C) 2001 Andreas Gruenbacher, <a.gruenbacher@computer.org>
   7 */
   8
   9 #include <linux/xattr.h>
  10
  11 /* Magic value in attribute blocks */
  12 #define EXT4_XATTR_MAGIC                0xEA020000
  13
  14 /* Maximum number of references to one attribute block */
  15 #define EXT4_XATTR_REFCOUNT_MAX         1024
  16
  17 /* Name indexes */
  18 #define EXT4_XATTR_INDEX_USER                   1
  19 #define EXT4_XATTR_INDEX_POSIX_ACL_ACCESS       2
  20 #define EXT4_XATTR_INDEX_POSIX_ACL_DEFAULT      3
  21 #define EXT4_XATTR_INDEX_TRUSTED                4
  22 #define EXT4_XATTR_INDEX_LUSTRE                 5
  23 #define EXT4_XATTR_INDEX_SECURITY               6
  24 #define EXT4_XATTR_INDEX_SYSTEM                 7
  25
  26 struct ext4_xattr_header {
  27         __le32  h_magic;        /* magic number for identification */
  28         __le32  h_refcount;     /* reference count */
  29         __le32  h_blocks;       /* number of disk blocks used */
  30         __le32  h_hash;         /* hash value of all attributes */
  31         __le32  h_checksum;     /* crc32c(uuid+id+xattrblock) */
  32                                 /* id = inum if refcount=1, blknum otherwise */
  33         __u32   h_reserved[3];  /* zero right now */
  34 };
  35
  36 struct ext4_xattr_ibody_header {
  37         __le32  h_magic;        /* magic number for identification */
  38 };
  39
  40 struct ext4_xattr_entry {
  41         __u8    e_name_len;     /* length of name */
  42         __u8    e_name_index;   /* attribute name index */
  43         __le16  e_value_offs;   /* offset in disk block of value */
  44         __le32  e_value_block;  /* disk block attribute is stored on (n/i) */
  45         __le32  e_value_size;   /* size of attribute value */
  46         __le32  e_hash;         /* hash value of name and value */
  47         char    e_name[0];      /* attribute name */
  48 };
  49
  50 #define EXT4_XATTR_PAD_BITS             2
  51 #define EXT4_XATTR_PAD          (1<<EXT4_XATTR_PAD_BITS)
  52 #define EXT4_XATTR_ROUND                (EXT4_XATTR_PAD-1)
  53 #define EXT4_XATTR_LEN(name_len) \
  54         (((name_len) + EXT4_XATTR_ROUND + \
  55         sizeof(struct ext4_xattr_entry)) & ~EXT4_XATTR_ROUND)
  56 #define EXT4_XATTR_NEXT(entry) \
  57         ((struct ext4_xattr_entry *)( \
  58          (char *)(entry) + EXT4_XATTR_LEN((entry)->e_name_len)))
  59 #define EXT4_XATTR_SIZE(size) \
  60         (((size) + EXT4_XATTR_ROUND) & ~EXT4_XATTR_ROUND)
  61
  62 #define IHDR(inode, raw_inode) \
  63         ((struct ext4_xattr_ibody_header *) \
  64                 ((void *)raw_inode + \
  65                 EXT4_GOOD_OLD_INODE_SIZE + \
  66                 EXT4_I(inode)->i_extra_isize))
  67 #define IFIRST(hdr) ((struct ext4_xattr_entry *)((hdr)+1))
  68
  69 #define BHDR(bh) ((struct ext4_xattr_header *)((bh)->b_data))
  70 #define ENTRY(ptr) ((struct ext4_xattr_entry *)(ptr))
  71 #define BFIRST(bh) ENTRY(BHDR(bh)+1)
  72 #define IS_LAST_ENTRY(entry) (*(__u32 *)(entry) == 0)
  73
  74
  75 struct ext4_xattr_info {
  76         int name_index;
  77         const char *name;
  78         const void *value;
  79         size_t value_len;
  80 };
  81
  82 struct ext4_xattr_search {
  83         struct ext4_xattr_entry *first;
  84         void *base;
  85         void *end;
  86         struct ext4_xattr_entry *here;
  87         int not_found;
  88 };
  89
  90 struct ext4_xattr_ibody_find {
  91         struct ext4_xattr_search s;
  92         struct ext4_iloc iloc;
  93 };
  94
  95 # ifdef CONFIG_EXT4_FS_XATTR
  96
  97 extern const struct xattr_handler ext4_xattr_user_handler;
  98 extern const struct xattr_handler ext4_xattr_trusted_handler;
  99 extern const struct xattr_handler ext4_xattr_acl_access_handler;
 100 extern const struct xattr_handler ext4_xattr_acl_default_handler;
 101 extern const struct xattr_handler ext4_xattr_security_handler;
 102
 103 extern ssize_t ext4_listxattr(struct dentry *, char *, size_t);
 104
 105 extern int ext4_xattr_get(struct inode *, int, const char *, void *, size_t);
 106 extern int ext4_xattr_set(struct inode *, int, const char *, const void *, size_t, int);
 107 extern int ext4_xattr_set_handle(handle_t *, struct inode *, int, const char *, const void *, size_t, int);
 108
 109 extern void ext4_xattr_delete_inode(handle_t *, struct inode *);
 110 extern void ext4_xattr_put_super(struct super_block *);
 111
 112 extern int ext4_expand_extra_isize_ea(struct inode *inode, int new_extra_isize,
 113                             struct ext4_inode *raw_inode, handle_t *handle);
 114
 115 extern int __init ext4_init_xattr(void);
 116 extern void ext4_exit_xattr(void);
 117
 118 extern const struct xattr_handler *ext4_xattr_handlers[];
 119
 120 extern int ext4_xattr_ibody_find(struct inode *inode, struct ext4_xattr_info *i,
 121                                  struct ext4_xattr_ibody_find *is);
 122 extern int ext4_xattr_ibody_get(struct inode *inode, int name_index,
 123                                 const char *name,
 124                                 void *buffer, size_t buffer_size);
 125 extern int ext4_xattr_ibody_inline_set(handle_t *handle, struct inode *inode,
 126                                        struct ext4_xattr_info *i,
 127                                        struct ext4_xattr_ibody_find *is);
 128
 129 extern int ext4_has_inline_data(struct inode *inode);
 130 extern int ext4_get_inline_size(struct inode *inode);
 131 extern int ext4_get_max_inline_size(struct inode *inode);
 132 extern int ext4_find_inline_data_nolock(struct inode *inode);
 133 extern void ext4_write_inline_data(struct inode *inode,
 134                                    struct ext4_iloc *iloc,
 135                                    void *buffer, loff_t pos,
 136                                    unsigned int len);
 137 extern int ext4_prepare_inline_data(handle_t *handle, struct inode *inode,
 138                                     unsigned int len);
 139 extern int ext4_init_inline_data(handle_t *handle, struct inode *inode,
 140                                  unsigned int len);
 141 extern int ext4_destroy_inline_data(handle_t *handle, struct inode *inode);
 142
 143 extern int ext4_readpage_inline(struct inode *inode, struct page *page);
 144 extern int ext4_try_to_write_inline_data(struct address_space *mapping,
 145                                          struct inode *inode,
 146                                          loff_t pos, unsigned len,
 147                                          unsigned flags,
 148                                          struct page **pagep);
 149 extern int ext4_write_inline_data_end(struct inode *inode,
 150                                       loff_t pos, unsigned len,
 151                                       unsigned copied,
 152                                       struct page *page);
 153 extern struct buffer_head *
 154 ext4_journalled_write_inline_data(struct inode *inode,
 155                                   unsigned len,
 156                                   struct page *page);
 157 extern int ext4_da_write_inline_data_begin(struct address_space *mapping,
 158                                            struct inode *inode,
 159                                            loff_t pos, unsigned len,
 160                                            unsigned flags,
 161                                            struct page **pagep,
 162                                            void **fsdata);
 163 extern int ext4_da_write_inline_data_end(struct inode *inode, loff_t pos,
 164                                          unsigned len, unsigned copied,
 165                                          struct page *page);
 166 extern int ext4_try_add_inline_entry(handle_t *handle, struct dentry *dentry,
 167                                      struct inode *inode);
 168 extern int ext4_try_create_inline_dir(handle_t *handle,
 169                                       struct inode *parent,
 170                                       struct inode *inode);
 171 extern int ext4_read_inline_dir(struct file *filp,
 172                                 void *dirent, filldir_t filldir,
 173                                 int *has_inline_data);
 174 extern struct buffer_head *ext4_find_inline_entry(struct inode *dir,
 175                                         const struct qstr *d_name,
 176                                         struct ext4_dir_entry_2 **res_dir,
 177                                         int *has_inline_data);
 178 extern int ext4_delete_inline_entry(handle_t *handle,
 179                                     struct inode *dir,
 180                                     struct ext4_dir_entry_2 *de_del,
 181                                     struct buffer_head *bh,
 182                                     int *has_inline_data);
 183 extern int empty_inline_dir(struct inode *dir, int *has_inline_data);
 184 extern struct buffer_head *ext4_get_first_inline_block(struct inode *inode,
 185                                         struct ext4_dir_entry_2 **parent_de,
 186                                         int *retval);
 187 extern int ext4_inline_data_fiemap(struct inode *inode,
 188                                    struct fiemap_extent_info *fieinfo,
 189                                    int *has_inline);
 190 extern int ext4_try_to_evict_inline_data(handle_t *handle,
 191                                          struct inode *inode,
 192                                          int needed);
 193 extern void ext4_inline_data_truncate(struct inode *inode, int *has_inline);
 194
 195 # else  /* CONFIG_EXT4_FS_XATTR */
 196
 197 static inline int
 198 ext4_xattr_get(struct inode *inode, int name_index, const char *name,
 199                void *buffer, size_t size, int flags)
 200 {
 201         return -EOPNOTSUPP;
 202 }
 203
 204 static inline int
 205 ext4_xattr_set(struct inode *inode, int name_index, const char *name,
 206                const void *value, size_t size, int flags)
 207 {
 208         return -EOPNOTSUPP;
 209 }
 210
 211 static inline int
 212 ext4_xattr_set_handle(handle_t *handle, struct inode *inode, int name_index,
 213                const char *name, const void *value, size_t size, int flags)
 214 {
 215         return -EOPNOTSUPP;
 216 }
 217
 218 static inline void
 219 ext4_xattr_delete_inode(handle_t *handle, struct inode *inode)
 220 {
 221 }
 222
 223 static inline void
 224 ext4_xattr_put_super(struct super_block *sb)
 225 {
 226 }
 227
 228 static __init inline int
 229 ext4_init_xattr(void)
 230 {
 231         return 0;
 232 }
 233
 234 static inline void
 235 ext4_exit_xattr(void)
 236 {
 237 }
 238
 239 static inline int
 240 ext4_expand_extra_isize_ea(struct inode *inode, int new_extra_isize,
 241                             struct ext4_inode *raw_inode, handle_t *handle)
 242 {
 243         return -EOPNOTSUPP;
 244 }
 245
 246 #define ext4_xattr_handlers     NULL
 247
 248 static inline int
 249 ext4_xattr_ibody_find(struct inode *inode, struct ext4_xattr_info *i,
 250                       struct ext4_xattr_ibody_find *is)
 251 {
 252         return -EOPNOTSUPP;
 253 }
 254
 255 static inline int
 256 ext4_xattr_ibody_set(handle_t *handle, struct inode *inode,
 257                      struct ext4_xattr_info *i,
 258                      struct ext4_xattr_ibody_find *is)
 259 {
 260         return -EOPNOTSUPP;
 261 }
 262
 263 static inline int
 264 ext4_xattr_ibody_get(struct inode *inode, int name_index,
 265                      const char *name,
 266                      void *buffer, size_t buffer_size)
 267 {
 268         return -EOPNOTSUPP;
 269 }
 270
 271 static inline int ext4_find_inline_data_nolock(struct inode *inode)
 272 {
 273         return 0;
 274 }
 275
 276 static inline int ext4_has_inline_data(struct inode *inode)
 277 {
 278         return 0;
 279 }
 280
 281 static inline int ext4_get_inline_size(struct inode *inode)
 282 {
 283         return 0;
 284 }
 285
 286 static inline int ext4_get_max_inline_size(struct inode *inode)
 287 {
 288         return 0;
 289 }
 290
 291 static inline void ext4_write_inline_data(struct inode *inode,
 292                                           struct ext4_iloc *iloc,
 293                                           void *buffer, loff_t pos,
 294                                           unsigned int len)
 295 {
 296         return;
 297 }
 298
 299 static inline int ext4_init_inline_data(handle_t *handle,
 300                                         struct inode *inode,
 301                                         unsigned int len)
 302 {
 303         return 0;
 304 }
 305
 306 static inline int ext4_destroy_inline_data(handle_t *handle,
 307                                            struct inode *inode)
 308 {
 309         return 0;
 310 }
 311
 312 static inline int ext4_readpage_inline(struct inode *inode, struct page *page)
 313 {
 314         return 0;
 315 }
 316
 317 static inline int ext4_try_to_write_inline_data(struct address_space *mapping,
 318                                                 struct inode *inode,
 319                                                 loff_t pos, unsigned len,
 320                                                 unsigned flags,
 321                                                 struct page **pagep)
 322 {
 323         return 0;
 324 }
 325
 326 static inline int ext4_write_inline_data_end(struct inode *inode,
 327                                              loff_t pos, unsigned len,
 328                                              unsigned copied,
 329                                              struct page *page)
 330 {
 331         return 0;
 332 }
 333
 334 static inline struct buffer_head *
 335 ext4_journalled_write_inline_data(struct inode *inode,
 336                                   unsigned len,
 337                                   struct page *page)
 338 {
 339         return NULL;
 340 }
 341
 342 static inline int
 343 ext4_da_write_inline_data_begin(struct address_space *mapping,
 344                                 struct inode *inode,
 345                                 loff_t pos, unsigned len,
 346                                 unsigned flags,
 347                                 struct page **pagep,
 348                                 void **fsdata)
 349 {
 350         return 0;
 351 }
 352
 353 static inline int ext4_da_write_inline_data_end(struct inode *inode, loff_t pos,
 354                                                 unsigned len, unsigned copied,
 355                                                 struct page *page)
 356 {
 357         return 0;
 358 }
 359
 360 static inline int ext4_try_add_inline_entry(handle_t *handle,
 361                                             struct dentry *dentry,
 362                                             struct inode *inode)
 363 {
 364         return 0;
 365 }
 366
 367 static inline int ext4_try_create_inline_dir(handle_t *handle,
 368                                              struct inode *parent,
 369                                              struct inode *inode)
 370 {
 371         return 0;
 372 }
 373 static inline int ext4_read_inline_dir(struct file *filp,
 374                                        void *dirent, filldir_t filldir,
 375                                        int *has_inline_data)
 376 {
 377         return 0;
 378 }
 379
 380 static inline struct buffer_head *
 381 ext4_find_inline_entry(struct inode *dir,
 382                        const struct qstr *d_name,
 383                        struct ext4_dir_entry_2 **res_dir,
 384                        int *has_inline_data)
 385 {
 386         return NULL;
 387 }
 388 static inline int ext4_delete_inline_entry(handle_t *handle,
 389                                            struct inode *dir,
 390                                            struct ext4_dir_entry_2 *de_del,
 391                                            struct buffer_head *bh,
 392                                            int *has_inline_data)
 393 {
 394         return 0;
 395 }
 396
 397 static inline int empty_inline_dir(struct inode *dir, int *has_inline_data)
 398 {
 399         return 0;
 400 }
 401
 402 static inline struct buffer_head *
 403 ext4_get_first_inline_block(struct inode *inode,
 404                             struct ext4_dir_entry_2 **parent_de,
 405                             int *retval)
 406 {
 407         return NULL;
 408 }
 409
 410 static inline int ext4_inline_data_fiemap(struct inode *inode,
 411                                           struct fiemap_extent_info *fieinfo,
 412                                           int *has_inline)
 413 {
 414         return 0;
 415 }
 416
 417 static inline void ext4_inline_data_truncate(struct inode *inode,
 418                                              int *has_inline)
 419 {
 420         return;
 421 }
 422
 423 # endif  /* CONFIG_EXT4_FS_XATTR */
 424
 425 #ifdef CONFIG_EXT4_FS_SECURITY
 426 extern int ext4_init_security(handle_t *handle, struct inode *inode,
 427                               struct inode *dir, const struct qstr *qstr);
 428 #else
 429 static inline int ext4_init_security(handle_t *handle, struct inode *inode,
 430                                      struct inode *dir, const struct qstr *qstr)
 431 {
 432         return 0;
 433 }
 434 #endif