xfs_attr.h 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  1. /*
  2. * Copyright (c) 2000,2002-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_ATTR_H__
  19. #define __XFS_ATTR_H__
  20. /*
  21. * xfs_attr.h
  22. *
  23. * Large attribute lists are structured around Btrees where all the data
  24. * elements are in the leaf nodes. Attribute names are hashed into an int,
  25. * then that int is used as the index into the Btree. Since the hashval
  26. * of an attribute name may not be unique, we may have duplicate keys.
  27. * The internal links in the Btree are logical block offsets into the file.
  28. *
  29. * Small attribute lists use a different format and are packed as tightly
  30. * as possible so as to fit into the literal area of the inode.
  31. */
  32. /*========================================================================
  33. * External interfaces
  34. *========================================================================*/
  35. struct cred;
  36. struct bhv_vnode;
  37. struct xfs_attr_list_context;
  38. typedef int (*attrset_t)(struct bhv_vnode *, char *, void *, size_t, int);
  39. typedef int (*attrget_t)(struct bhv_vnode *, char *, void *, size_t, int);
  40. typedef int (*attrremove_t)(struct bhv_vnode *, char *, int);
  41. typedef int (*attrexists_t)(struct bhv_vnode *);
  42. typedef int (*attrcapable_t)(struct bhv_vnode *, struct cred *);
  43. typedef struct attrnames {
  44. char * attr_name;
  45. unsigned int attr_namelen;
  46. unsigned int attr_flag;
  47. attrget_t attr_get;
  48. attrset_t attr_set;
  49. attrremove_t attr_remove;
  50. attrexists_t attr_exists;
  51. attrcapable_t attr_capable;
  52. } attrnames_t;
  53. #define ATTR_NAMECOUNT 4
  54. extern struct attrnames attr_user;
  55. extern struct attrnames attr_secure;
  56. extern struct attrnames attr_system;
  57. extern struct attrnames attr_trusted;
  58. extern struct attrnames *attr_namespaces[ATTR_NAMECOUNT];
  59. extern attrnames_t *attr_lookup_namespace(char *, attrnames_t **, int);
  60. extern int attr_generic_list(struct bhv_vnode *, void *, size_t, int, ssize_t *);
  61. #define ATTR_DONTFOLLOW 0x0001 /* -- unused, from IRIX -- */
  62. #define ATTR_ROOT 0x0002 /* use attrs in root (trusted) namespace */
  63. #define ATTR_TRUST 0x0004 /* -- unused, from IRIX -- */
  64. #define ATTR_SECURE 0x0008 /* use attrs in security namespace */
  65. #define ATTR_CREATE 0x0010 /* pure create: fail if attr already exists */
  66. #define ATTR_REPLACE 0x0020 /* pure set: fail if attr does not exist */
  67. #define ATTR_SYSTEM 0x0100 /* use attrs in system (pseudo) namespace */
  68. #define ATTR_KERNACCESS 0x0400 /* [kernel] iaccess, inode held io-locked */
  69. #define ATTR_KERNOTIME 0x1000 /* [kernel] don't update inode timestamps */
  70. #define ATTR_KERNOVAL 0x2000 /* [kernel] get attr size only, not value */
  71. #define ATTR_KERNAMELS 0x4000 /* [kernel] list attr names (simple list) */
  72. #define ATTR_KERNORMALS 0x0800 /* [kernel] normal attr list: user+secure */
  73. #define ATTR_KERNROOTLS 0x8000 /* [kernel] include root in the attr list */
  74. #define ATTR_KERNFULLS (ATTR_KERNORMALS|ATTR_KERNROOTLS)
  75. /*
  76. * The maximum size (into the kernel or returned from the kernel) of an
  77. * attribute value or the buffer used for an attr_list() call. Larger
  78. * sizes will result in an ERANGE return code.
  79. */
  80. #define ATTR_MAX_VALUELEN (64*1024) /* max length of a value */
  81. /*
  82. * Define how lists of attribute names are returned to the user from
  83. * the attr_list() call. A large, 32bit aligned, buffer is passed in
  84. * along with its size. We put an array of offsets at the top that each
  85. * reference an attrlist_ent_t and pack the attrlist_ent_t's at the bottom.
  86. */
  87. typedef struct attrlist {
  88. __s32 al_count; /* number of entries in attrlist */
  89. __s32 al_more; /* T/F: more attrs (do call again) */
  90. __s32 al_offset[1]; /* byte offsets of attrs [var-sized] */
  91. } attrlist_t;
  92. /*
  93. * Show the interesting info about one attribute. This is what the
  94. * al_offset[i] entry points to.
  95. */
  96. typedef struct attrlist_ent { /* data from attr_list() */
  97. __u32 a_valuelen; /* number bytes in value of attr */
  98. char a_name[1]; /* attr name (NULL terminated) */
  99. } attrlist_ent_t;
  100. /*
  101. * Given a pointer to the (char*) buffer containing the attr_list() result,
  102. * and an index, return a pointer to the indicated attribute in the buffer.
  103. */
  104. #define ATTR_ENTRY(buffer, index) \
  105. ((attrlist_ent_t *) \
  106. &((char *)buffer)[ ((attrlist_t *)(buffer))->al_offset[index] ])
  107. /*
  108. * Multi-attribute operation vector.
  109. */
  110. typedef struct attr_multiop {
  111. int am_opcode; /* operation to perform (ATTR_OP_GET, etc.) */
  112. int am_error; /* [out arg] result of this sub-op (an errno) */
  113. char *am_attrname; /* attribute name to work with */
  114. char *am_attrvalue; /* [in/out arg] attribute value (raw bytes) */
  115. int am_length; /* [in/out arg] length of value */
  116. int am_flags; /* bitwise OR of attr API flags defined above */
  117. } attr_multiop_t;
  118. #define ATTR_OP_GET 1 /* return the indicated attr's value */
  119. #define ATTR_OP_SET 2 /* set/create the indicated attr/value pair */
  120. #define ATTR_OP_REMOVE 3 /* remove the indicated attr */
  121. /*
  122. * Kernel-internal version of the attrlist cursor.
  123. */
  124. typedef struct attrlist_cursor_kern {
  125. __u32 hashval; /* hash value of next entry to add */
  126. __u32 blkno; /* block containing entry (suggestion) */
  127. __u32 offset; /* offset in list of equal-hashvals */
  128. __u16 pad1; /* padding to match user-level */
  129. __u8 pad2; /* padding to match user-level */
  130. __u8 initted; /* T/F: cursor has been initialized */
  131. } attrlist_cursor_kern_t;
  132. /*========================================================================
  133. * Function prototypes for the kernel.
  134. *========================================================================*/
  135. struct xfs_inode;
  136. struct attrlist_cursor_kern;
  137. struct xfs_da_args;
  138. /*
  139. * Overall external interface routines.
  140. */
  141. int xfs_attr_get(bhv_desc_t *, const char *, char *, int *, int, struct cred *);
  142. int xfs_attr_set(bhv_desc_t *, const char *, char *, int, int, struct cred *);
  143. int xfs_attr_set_int(struct xfs_inode *, const char *, int, char *, int, int);
  144. int xfs_attr_remove(bhv_desc_t *, const char *, int, struct cred *);
  145. int xfs_attr_remove_int(struct xfs_inode *, const char *, int, int);
  146. int xfs_attr_list(bhv_desc_t *, char *, int, int, struct attrlist_cursor_kern *, struct cred *);
  147. int xfs_attr_list_int(struct xfs_attr_list_context *);
  148. int xfs_attr_inactive(struct xfs_inode *dp);
  149. int xfs_attr_shortform_getvalue(struct xfs_da_args *);
  150. int xfs_attr_fetch(struct xfs_inode *, const char *, int,
  151. char *, int *, int, struct cred *);
  152. int xfs_attr_rmtval_get(struct xfs_da_args *args);
  153. #endif /* __XFS_ATTR_H__ */