1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * This file is part of Lustre, http://www.lustre.org
6 * Lustre wire protocol definitions.
9 * We assume all nodes are either little-endian or big-endian, and we
10 * always send messages in the sender's native format. The receiver
11 * detects the message format by checking the 'magic' field of the message
12 * (see lustre_msg_swabbed() below).
13 * ALL structs passing over the wire should be declared here. Structs
14 * that are used in interfaces with userspace should go in lustre_user.h.
16 * All structs being declared here should be built from simple fixed-size
17 * types (__u8, __u16, __u32, __u64) or be built from other types or
18 * structs also declared in this file. Similarly, all flags and magic
19 * values in those structs should also be declared here. This ensures
20 * that the Lustre wire protocol is not influenced by external dependencies.
22 * The only other acceptable items in this file are VERY SIMPLE accessor
23 * functions to avoid callers grubbing inside the structures, and the
24 * prototypes of the swabber functions for each struct. Nothing that
25 * depends on external functions or definitions should be in here.
27 * Structs must be properly aligned to put 64-bit values on an 8-byte
28 * boundary. Any structs being added here must also be added to
29 * utils/wirecheck.c and "make newwiretest" run to regenerate the
30 * utils/wiretest.c sources. This allows us to verify that wire structs
31 * have the proper alignment/size on all architectures.
33 * DO NOT CHANGE any of the structs, flags, values declared here and used
34 * in released Lustre versions. Some structs may have padding fields that
35 * can be used. Some structs might allow addition at the end (verify this
36 * in the code to ensure that new/old clients that see this larger struct
37 * do not fail, otherwise you need to implement protocol compatibility).
39 * Each wire type has corresponding 'lustre_swab_xxxtypexxx()' routines,
40 * implemented either here, inline (trivial implementations) or in
41 * ptlrpc/pack_generic.c. These 'swabbers' convert the type from "other"
42 * endian, in-place in the message buffer.
44 * A swabber takes a single pointer argument. The caller must already have
45 * verified that the length of the message buffer >= sizeof (type).
47 * For variable length types, a second 'lustre_swab_v_xxxtypexxx()' routine
48 * may be defined that swabs just the variable part, after the caller has
49 * verified that the message buffer is large enough.
52 #ifndef _LUSTRE_IDL_H_
53 #define _LUSTRE_IDL_H_
55 #include <libcfs/kp30.h>
57 #include <lustre/types.h>
59 /* Defn's shared with user-space. */
60 #include <lustre/lustre_user.h>
65 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
66 * FOO_REPLY_PORTAL is for incoming replies on the FOO
67 * FOO_BULK_PORTAL is for incoming bulk on the FOO
70 #define CONNMGR_REQUEST_PORTAL 1
71 #define CONNMGR_REPLY_PORTAL 2
72 //#define OSC_REQUEST_PORTAL 3
73 #define OSC_REPLY_PORTAL 4
74 //#define OSC_BULK_PORTAL 5
75 #define OST_IO_PORTAL 6
76 #define OST_CREATE_PORTAL 7
77 #define OST_BULK_PORTAL 8
78 //#define MDC_REQUEST_PORTAL 9
79 #define MDC_REPLY_PORTAL 10
80 //#define MDC_BULK_PORTAL 11
81 #define MDS_REQUEST_PORTAL 12
82 //#define MDS_REPLY_PORTAL 13
83 #define MDS_BULK_PORTAL 14
84 #define LDLM_CB_REQUEST_PORTAL 15
85 #define LDLM_CB_REPLY_PORTAL 16
86 #define LDLM_CANCEL_REQUEST_PORTAL 17
87 #define LDLM_CANCEL_REPLY_PORTAL 18
88 //#define PTLBD_REQUEST_PORTAL 19
89 //#define PTLBD_REPLY_PORTAL 20
90 //#define PTLBD_BULK_PORTAL 21
91 #define MDS_SETATTR_PORTAL 22
92 #define MDS_READPAGE_PORTAL 23
93 #define MDS_MDS_PORTAL 24
95 #define MGC_REPLY_PORTAL 25
96 #define MGS_REQUEST_PORTAL 26
97 #define MGS_REPLY_PORTAL 27
98 #define OST_REQUEST_PORTAL 28
99 #define FLD_REQUEST_PORTAL 29
100 #define SEQ_METADATA_PORTAL 30
101 #define SEQ_DATA_PORTAL 31
102 #define SEQ_CONTROLLER_PORTAL 32
107 #define SVC_RUNNING 8
108 #define SVC_STOPPING 16
109 #define SVC_STOPPED 32
112 #define PTL_RPC_MSG_REQUEST 4711
113 #define PTL_RPC_MSG_ERR 4712
114 #define PTL_RPC_MSG_REPLY 4713
116 /* DON'T use swabbed values of MAGIC as magic! */
117 #define LUSTRE_MSG_MAGIC_V1 0x0BD00BD0
118 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
120 #define LUSTRE_MSG_MAGIC_V1_SWABBED 0xD00BD00B
121 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
123 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
125 #define PTLRPC_MSG_VERSION 0x00000003
126 #define LUSTRE_VERSION_MASK 0xffff0000
127 #define LUSTRE_OBD_VERSION 0x00010000
128 #define LUSTRE_MDS_VERSION 0x00020000
129 #define LUSTRE_OST_VERSION 0x00030000
130 #define LUSTRE_DLM_VERSION 0x00040000
131 #define LUSTRE_LOG_VERSION 0x00050000
132 #define LUSTRE_MGS_VERSION 0x00060000
134 typedef __u64 mdsno_t;
135 typedef __u64 seqno_t;
142 static inline __u64 range_space(struct lu_range *r)
144 return r->lr_end - r->lr_start;
147 static inline void range_zero(struct lu_range *r)
149 r->lr_start = r->lr_end = 0;
152 static inline int range_within(struct lu_range *r,
155 return s >= r->lr_start && s < r->lr_end;
158 static inline void range_alloc(struct lu_range *r,
162 r->lr_start = s->lr_start;
163 r->lr_end = s->lr_start + w;
167 static inline int range_is_sane(struct lu_range *r)
169 return (r->lr_end >= r->lr_start);
172 static inline int range_is_zero(struct lu_range *r)
174 return (r->lr_start == 0 && r->lr_end == 0);
177 static inline int range_is_exhausted(struct lu_range *r)
179 return range_space(r) == 0;
182 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x]"
184 #define PRANGE(range) \
189 __u64 f_seq; /* holds fid sequence. Lustre should support 2 ^ 64
190 * objects, thus even if one sequence has one object we
191 * reach this value. */
192 __u32 f_oid; /* fid number within its sequence. */
193 __u32 f_ver; /* holds fid version. */
200 LUSTRE_ROOT_FID_SEQ = 1ULL, /* XXX: should go into mkfs. */
202 /* initial fid id value */
203 LUSTRE_FID_INIT_OID = 1UL
206 /* get object sequence */
207 static inline __u64 fid_seq(const struct lu_fid *fid)
213 static inline __u32 fid_oid(const struct lu_fid *fid)
218 /* get object version */
219 static inline __u32 fid_ver(const struct lu_fid *fid)
224 static inline int fid_seq_is_sane(__u64 seq)
229 static inline void fid_zero(struct lu_fid *fid)
231 memset(fid, 0, sizeof(*fid));
234 static inline int fid_is_igif(const struct lu_fid *fid)
236 return fid_seq(fid) == LUSTRE_ROOT_FID_SEQ;
239 #define DFID "[0x%16.16"LPF64"x/0x%8.8x:0x%8.8x]"
246 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
248 /* check that all fields are converted */
249 CLASSERT(sizeof *src ==
250 sizeof fid_seq(src) +
251 sizeof fid_oid(src) + sizeof fid_ver(src));
252 LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
253 dst->f_seq = cpu_to_le64(fid_seq(src));
254 dst->f_oid = cpu_to_le32(fid_oid(src));
255 dst->f_ver = cpu_to_le32(fid_ver(src));
258 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
260 /* check that all fields are converted */
261 CLASSERT(sizeof *src ==
262 sizeof fid_seq(src) +
263 sizeof fid_oid(src) + sizeof fid_ver(src));
264 dst->f_seq = le64_to_cpu(fid_seq(src));
265 dst->f_oid = le32_to_cpu(fid_oid(src));
266 dst->f_ver = le32_to_cpu(fid_ver(src));
267 LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
270 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
272 /* check that all fields are converted */
273 CLASSERT(sizeof *src ==
274 sizeof fid_seq(src) +
275 sizeof fid_oid(src) + sizeof fid_ver(src));
276 LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
277 dst->f_seq = cpu_to_be64(fid_seq(src));
278 dst->f_oid = cpu_to_be32(fid_oid(src));
279 dst->f_ver = cpu_to_be32(fid_ver(src));
282 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
284 /* check that all fields are converted */
285 CLASSERT(sizeof *src ==
286 sizeof fid_seq(src) +
287 sizeof fid_oid(src) + sizeof fid_ver(src));
288 dst->f_seq = be64_to_cpu(fid_seq(src));
289 dst->f_oid = be32_to_cpu(fid_oid(src));
290 dst->f_ver = be32_to_cpu(fid_ver(src));
291 LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
296 * Storage representation for fids.
298 * Variable size, first byte contains the length of the whole record.
303 char fp_area[sizeof(struct lu_fid)];
306 void fid_pack(struct lu_fid_pack *pack, const struct lu_fid *fid,
307 struct lu_fid *befider);
308 int fid_unpack(const struct lu_fid_pack *pack, struct lu_fid *fid);
313 static inline int fid_is_sane(const struct lu_fid *fid)
317 ((fid_seq_is_sane(fid_seq(fid)) && fid_oid(fid) != 0
318 && fid_ver(fid) == 0) ||
322 static inline int fid_is_zero(const struct lu_fid *fid)
324 return fid_seq(fid) == 0 && fid_oid(fid) == 0;
327 extern void lustre_swab_lu_fid(struct lu_fid *fid);
328 extern void lustre_swab_lu_range(struct lu_range *range);
330 static inline int lu_fid_eq(const struct lu_fid *f0,
331 const struct lu_fid *f1)
333 /* Check that there is no alignment padding. */
334 CLASSERT(sizeof *f0 ==
335 sizeof f0->f_seq + sizeof f0->f_oid + sizeof f0->f_ver);
336 LASSERTF(fid_is_igif(f0) || fid_ver(f0) == 0, DFID, PFID(f0));
337 LASSERTF(fid_is_igif(f1) || fid_ver(f1) == 0, DFID, PFID(f1));
338 return memcmp(f0, f1, sizeof *f0) == 0;
342 * Layout of readdir pages, as transmitted on wire.
345 struct lu_fid lde_fid;
354 __u64 ldp_hash_start;
359 struct lu_dirent ldp_entries[0];
362 enum lu_dirpage_flags {
366 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
368 if (le16_to_cpu(dp->ldp_flags) & LDF_EMPTY)
371 return dp->ldp_entries;
374 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
376 struct lu_dirent *next;
378 if (le16_to_cpu(ent->lde_reclen) != 0)
379 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
386 static inline int lu_dirent_size(struct lu_dirent *ent)
388 if (le16_to_cpu(ent->lde_reclen) == 0) {
389 return (sizeof(*ent) +
390 le16_to_cpu(ent->lde_namelen) + 3) & ~3;
392 return le16_to_cpu(ent->lde_reclen);
395 #define DIR_END_OFF 0xfffffffffffffffeULL
397 struct lustre_handle {
400 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
402 static inline int lustre_handle_is_used(struct lustre_handle *lh)
404 return lh->cookie != 0ull;
407 static inline int lustre_handle_equal(struct lustre_handle *lh1,
408 struct lustre_handle *lh2)
410 return lh1->cookie == lh2->cookie;
413 static inline void lustre_handle_copy(struct lustre_handle *tgt,
414 struct lustre_handle *src)
416 tgt->cookie = src->cookie;
419 /* we depend on this structure to be 8-byte aligned */
420 /* this type is only endian-adjusted in lustre_unpack_msg() */
421 struct lustre_msg_v1 {
422 struct lustre_handle lm_handle;
428 __u64 lm_last_committed;
437 #define lustre_msg lustre_msg_v2
438 /* we depend on this structure to be 8-byte aligned */
439 /* this type is only endian-adjusted in lustre_unpack_msg() */
440 struct lustre_msg_v2 {
452 /* without gss, ptlrpc_body is put at the first buffer. */
454 struct lustre_handle pb_handle;
461 __u64 pb_last_committed;
472 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
474 /* message body offset for lustre_msg_v2 */
475 /* ptlrpc body offset in all request/reply messages */
476 #define MSG_PTLRPC_BODY_OFF 0
478 /* normal request/reply message record offset */
479 #define REQ_REC_OFF 1
480 #define REPLY_REC_OFF 1
482 /* ldlm request message body offset */
483 #define DLM_LOCKREQ_OFF 1 /* lockreq offset */
484 #define DLM_REQ_REC_OFF 2 /* normal dlm request record offset */
486 /* ldlm intent lock message body offset */
487 #define DLM_INTENT_IT_OFF 2 /* intent lock it offset */
488 #define DLM_INTENT_REC_OFF 3 /* intent lock record offset */
490 /* ldlm reply message body offset */
491 #define DLM_LOCKREPLY_OFF 1 /* lockrep offset */
492 #define DLM_REPLY_REC_OFF 2 /* reply record offset */
494 /* Flags that are operation-specific go in the top 16 bits. */
495 #define MSG_OP_FLAG_MASK 0xffff0000
496 #define MSG_OP_FLAG_SHIFT 16
498 /* Flags that apply to all requests are in the bottom 16 bits */
499 #define MSG_GEN_FLAG_MASK 0x0000ffff
500 #define MSG_LAST_REPLAY 1
503 #define MSG_REQ_REPLAY_DONE 8
504 #define MSG_LOCK_REPLAY_DONE 16
507 * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
510 #define MSG_CONNECT_RECOVERING 0x1
511 #define MSG_CONNECT_RECONNECT 0x2
512 #define MSG_CONNECT_REPLAYABLE 0x4
513 //#define MSG_CONNECT_PEER 0x8
514 #define MSG_CONNECT_LIBCLIENT 0x10
515 #define MSG_CONNECT_INITIAL 0x20
516 #define MSG_CONNECT_ASYNC 0x40
517 #define MSG_CONNECT_NEXT_VER 0x80 /* use next version of lustre_msg */
518 #define MSG_CONNECT_TRANSNO 0x100 /* report transno */
521 #define OBD_CONNECT_RDONLY 0x00000001ULL /* client allowed read-only access */
522 #define OBD_CONNECT_INDEX 0x00000002ULL /* connect to specific LOV idx */
523 #define OBD_CONNECT_GRANT 0x00000008ULL /* OSC acquires grant at connect */
524 #define OBD_CONNECT_SRVLOCK 0x00000010ULL /* server takes locks for client */
525 #define OBD_CONNECT_VERSION 0x00000020ULL /* Server supports versions in ocd */
526 #define OBD_CONNECT_REQPORTAL 0x00000040ULL /* Separate portal for non-IO reqs */
527 #define OBD_CONNECT_ACL 0x00000080ULL /* client uses access control lists */
528 #define OBD_CONNECT_XATTR 0x00000100ULL /* client using extended attributes*/
529 #define OBD_CONNECT_TRUNCLOCK 0x00000400ULL /* locks on server for punch b=9528 */
530 #define OBD_CONNECT_IBITS 0x00001000ULL /* support for inodebits locks */
531 #define OBD_CONNECT_JOIN 0x00002000ULL /* files can be concatenated */
532 #define OBD_CONNECT_ATTRFID 0x00004000ULL /* Server supports GetAttr By Fid */
533 #define OBD_CONNECT_NODEVOH 0x00008000ULL /* No open handle for special nodes */
534 #define OBD_CONNECT_LCL_CLIENT 0x00010000ULL /* local 1.8 client */
535 #define OBD_CONNECT_RMT_CLIENT 0x00020000ULL /* Remote 1.8 client */
536 #define OBD_CONNECT_BRW_SIZE 0x00040000ULL /* Max bytes per rpc */
537 #define OBD_CONNECT_QUOTA64 0x00080000ULL /* 64bit qunit_data.qd_count b=10707*/
538 #define OBD_CONNECT_MDS_CAPA 0x00100000ULL /* MDS capability */
539 #define OBD_CONNECT_OSS_CAPA 0x00200000ULL /* OSS capability */
540 #define OBD_CONNECT_CANCELSET 0x00400000ULL /* Early batched cancels. */
541 #define OBD_CONNECT_SOM 0x00800000ULL /* SOM feature */
542 #define OBD_CONNECT_AT 0x01000000ULL /* client uses adaptive timeouts */
543 #define OBD_CONNECT_LRU_RESIZE 0x02000000ULL /* Lru resize feature. */
544 #define OBD_CONNECT_MDS_MDS 0x04000000ULL /* MDS-MDS connection*/
545 #define OBD_CONNECT_REAL 0x08000000ULL /* real connection */
546 #define OBD_CONNECT_CHANGE_QS 0x10000000ULL /*shrink/enlarge qunit size
548 #define OBD_CONNECT_CKSUM 0x20000000ULL /* support several cksum algos */
549 #define OBD_CONNECT_FID 0x40000000ULL /* FID is supported by server */
551 /* also update obd_connect_names[] for lprocfs_rd_connect_flags()
552 * and lustre/utils/wirecheck.c */
554 #ifdef HAVE_LRU_RESIZE_SUPPORT
555 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
557 #define LRU_RESIZE_CONNECT_FLAG 0
560 #define MDT_CONNECT_SUPPORTED (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
561 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
562 OBD_CONNECT_IBITS | OBD_CONNECT_JOIN | \
563 OBD_CONNECT_NODEVOH |/* OBD_CONNECT_ATTRFID |*/\
564 OBD_CONNECT_LCL_CLIENT | \
565 OBD_CONNECT_RMT_CLIENT | \
566 OBD_CONNECT_MDS_CAPA | OBD_CONNECT_OSS_CAPA | \
567 OBD_CONNECT_MDS_MDS | OBD_CONNECT_CANCELSET | \
569 LRU_RESIZE_CONNECT_FLAG)
570 #define OST_CONNECT_SUPPORTED (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
571 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
572 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
573 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_QUOTA64 | \
574 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_CANCELSET | \
575 OBD_CONNECT_FID | OBD_CONNECT_CKSUM | \
576 LRU_RESIZE_CONNECT_FLAG)
577 #define ECHO_CONNECT_SUPPORTED (0)
578 #define MGS_CONNECT_SUPPORTED (OBD_CONNECT_VERSION | OBD_CONNECT_FID)
580 #define MAX_QUOTA_COUNT32 (0xffffffffULL)
582 #define OBD_OCD_VERSION(major,minor,patch,fix) (((major)<<24) + ((minor)<<16) +\
583 ((patch)<<8) + (fix))
584 #define OBD_OCD_VERSION_MAJOR(version) ((int)((version)>>24)&255)
585 #define OBD_OCD_VERSION_MINOR(version) ((int)((version)>>16)&255)
586 #define OBD_OCD_VERSION_PATCH(version) ((int)((version)>>8)&255)
587 #define OBD_OCD_VERSION_FIX(version) ((int)(version)&255)
589 /* This structure is used for both request and reply.
591 * If we eventually have separate connect data for different types, which we
592 * almost certainly will, then perhaps we stick a union in here. */
593 struct obd_connect_data {
594 __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
595 __u32 ocd_version; /* lustre release version number */
596 __u32 ocd_grant; /* initial cache grant amount (bytes) */
597 __u32 ocd_index; /* LOV index to connect to */
598 __u32 ocd_brw_size; /* Maximum BRW size in bytes */
599 __u64 ocd_ibits_known; /* inode bits this client understands */
600 __u32 ocd_nllu; /* non-local-lustre-user */
601 __u32 ocd_nllg; /* non-local-lustre-group */
602 __u64 ocd_transno; /* first transno from client to be replayed */
603 __u32 ocd_group; /* MDS group on OST */
604 __u32 ocd_cksum_types; /* supported checksum algorithms */
605 __u64 padding1; /* also fix lustre_swab_connect */
606 __u64 padding2; /* also fix lustre_swab_connect */
609 extern void lustre_swab_connect(struct obd_connect_data *ocd);
612 * Supported checksum algorithms. Up to 32 checksum types are supported.
613 * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
614 * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
615 * algorithm and also the OBD_FL_CKSUM* flags.
618 OBD_CKSUM_CRC32 = 0x00000001,
619 OBD_CKSUM_ADLER = 0x00000002,
623 * OST requests: OBDO & OBD request records
628 OST_REPLY = 0, /* reply ? */
648 #define OST_FIRST_OPC OST_REPLY
650 typedef uint64_t obd_id;
651 typedef uint64_t obd_gr;
652 typedef uint64_t obd_time;
653 typedef uint64_t obd_size;
654 typedef uint64_t obd_off;
655 typedef uint64_t obd_blocks;
656 typedef uint32_t obd_blksize;
657 typedef uint32_t obd_mode;
658 typedef uint32_t obd_uid;
659 typedef uint32_t obd_gid;
660 typedef uint32_t obd_flag;
661 typedef uint64_t obd_valid;
662 typedef uint32_t obd_count;
664 #define OBD_FL_INLINEDATA (0x00000001)
665 #define OBD_FL_OBDMDEXISTS (0x00000002)
666 #define OBD_FL_DELORPHAN (0x00000004) /* if set in o_flags delete orphans */
667 #define OBD_FL_NORPC (0x00000008) /* set in o_flags do in OSC not OST */
668 #define OBD_FL_IDONLY (0x00000010) /* set in o_flags only adjust obj id*/
669 #define OBD_FL_RECREATE_OBJS (0x00000020) /* recreate missing obj */
670 #define OBD_FL_DEBUG_CHECK (0x00000040) /* echo client/server debug check */
671 #define OBD_FL_NO_USRQUOTA (0x00000100) /* the object's owner is over quota */
672 #define OBD_FL_NO_GRPQUOTA (0x00000200) /* the object's group is over quota */
675 * Set this to delegate DLM locking during obd_punch() to the OSTs. Only OSTs
676 * that declared OBD_CONNECT_TRUNCLOCK in their connect flags support this
679 #define OBD_FL_TRUNCLOCK (0x00000800)
684 #define OBD_FL_CKSUM_CRC32 (0x00001000)
685 #define OBD_FL_CKSUM_ADLER (0x00002000)
686 #define OBD_FL_CKSUM_ALL (OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER)
689 * This should not be smaller than sizeof(struct lustre_handle) + sizeof(struct
690 * llog_cookie) + sizeof(struct ll_fid). Nevertheless struct ll_fid is not
691 * longer stored in o_inline, we keep this just for case.
693 #define OBD_INLINESZ 80
695 /* Note: 64-bit types are 64-bit aligned in structure */
697 obd_valid o_valid; /* hot fields in this obdo */
701 obd_size o_size; /* o_size-o_blocks == ost_lvb */
705 obd_blocks o_blocks; /* brw: cli sent cached bytes */
708 /* 32-bit fields start here: keep an even number of them via padding */
709 obd_blksize o_blksize; /* optimal IO blocksize */
710 obd_mode o_mode; /* brw: cli sent cache remain */
714 obd_count o_nlink; /* brw: checksum */
715 obd_count o_generation;
716 obd_count o_misc; /* brw: o_dropped */
717 __u32 o_easize; /* epoch in ost writes */
719 __u32 o_stripe_idx; /* holds stripe idx */
721 char o_inline[OBD_INLINESZ];
722 /* lustre_handle + llog_cookie */
725 #define o_dirty o_blocks
726 #define o_undirty o_mode
727 #define o_dropped o_misc
728 #define o_cksum o_nlink
730 extern void lustre_swab_obdo (struct obdo *o);
733 #define LOV_MAGIC_V1 0x0BD10BD0
734 #define LOV_MAGIC LOV_MAGIC_V1
735 #define LOV_MAGIC_JOIN 0x0BD20BD0
737 #define LOV_PATTERN_RAID0 0x001 /* stripes are used round-robin */
738 #define LOV_PATTERN_RAID1 0x002 /* stripes are mirrors of each other */
739 #define LOV_PATTERN_FIRST 0x100 /* first stripe is not in round-robin */
740 #define LOV_PATTERN_CMOBD 0x200
742 #define LOV_OBJECT_GROUP_DEFAULT ~0ULL
743 #define LOV_OBJECT_GROUP_CLEAR 0ULL
745 #define lov_ost_data lov_ost_data_v1
746 struct lov_ost_data_v1 { /* per-stripe data structure (little-endian)*/
747 __u64 l_object_id; /* OST object ID */
748 __u64 l_object_gr; /* OST object group (creating MDS number) */
749 __u32 l_ost_gen; /* generation of this l_ost_idx */
750 __u32 l_ost_idx; /* OST index in LOV (lov_tgt_desc->tgts) */
753 #define lov_mds_md lov_mds_md_v1
754 struct lov_mds_md_v1 { /* LOV EA mds/wire data (little-endian) */
755 __u32 lmm_magic; /* magic number = LOV_MAGIC_V1 */
756 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
757 __u64 lmm_object_id; /* LOV object ID */
758 __u64 lmm_object_gr; /* LOV object group */
759 __u32 lmm_stripe_size; /* size of stripe in bytes */
760 __u32 lmm_stripe_count; /* num stripes in use for this object */
761 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
764 extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm);
766 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
767 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
769 #define XATTR_NAME_ACL_ACCESS "system.posix_acl_access"
770 #define XATTR_NAME_ACL_DEFAULT "system.posix_acl_default"
771 #define XATTR_NAME_LOV "trusted.lov"
773 #define OBD_MD_FLID (0x00000001ULL) /* object ID */
774 #define OBD_MD_FLATIME (0x00000002ULL) /* access time */
775 #define OBD_MD_FLMTIME (0x00000004ULL) /* data modification time */
776 #define OBD_MD_FLCTIME (0x00000008ULL) /* change time */
777 #define OBD_MD_FLSIZE (0x00000010ULL) /* size */
778 #define OBD_MD_FLBLOCKS (0x00000020ULL) /* allocated blocks count */
779 #define OBD_MD_FLBLKSZ (0x00000040ULL) /* block size */
780 #define OBD_MD_FLMODE (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
781 #define OBD_MD_FLTYPE (0x00000100ULL) /* object type (mode & S_IFMT) */
782 #define OBD_MD_FLUID (0x00000200ULL) /* user ID */
783 #define OBD_MD_FLGID (0x00000400ULL) /* group ID */
784 #define OBD_MD_FLFLAGS (0x00000800ULL) /* flags word */
785 #define OBD_MD_FLNLINK (0x00002000ULL) /* link count */
786 #define OBD_MD_FLGENER (0x00004000ULL) /* generation number */
787 #define OBD_MD_FLINLINE (0x00008000ULL) /* inline data */
788 #define OBD_MD_FLRDEV (0x00010000ULL) /* device number */
789 #define OBD_MD_FLEASIZE (0x00020000ULL) /* extended attribute data */
790 #define OBD_MD_LINKNAME (0x00040000ULL) /* symbolic link target */
791 #define OBD_MD_FLHANDLE (0x00080000ULL) /* file handle */
792 #define OBD_MD_FLCKSUM (0x00100000ULL) /* bulk data checksum */
793 #define OBD_MD_FLQOS (0x00200000ULL) /* quality of service stats */
794 #define OBD_MD_FLOSCOPQ (0x00400000ULL) /* osc opaque data */
795 #define OBD_MD_FLCOOKIE (0x00800000ULL) /* log cancellation cookie */
796 #define OBD_MD_FLGROUP (0x01000000ULL) /* group */
797 #define OBD_MD_FLFID (0x02000000ULL) /* ->ost write inline fid */
798 #define OBD_MD_FLEPOCH (0x04000000ULL) /* ->ost write easize is epoch */
799 /* ->mds if epoch opens or closes */
800 #define OBD_MD_FLGRANT (0x08000000ULL) /* ost preallocation space grant */
801 #define OBD_MD_FLDIREA (0x10000000ULL) /* dir's extended attribute data */
802 #define OBD_MD_FLUSRQUOTA (0x20000000ULL) /* over quota flags sent from ost */
803 #define OBD_MD_FLGRPQUOTA (0x40000000ULL) /* over quota flags sent from ost */
804 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
806 #define OBD_MD_MDS (0x0000000100000000ULL) /* where an inode lives on */
807 #define OBD_MD_REINT (0x0000000200000000ULL) /* reintegrate oa */
808 #define OBD_MD_MEA (0x0000000400000000ULL) /* CMD split EA */
810 #define OBD_MD_FLXATTR (0x0000001000000000ULL) /* xattr */
811 #define OBD_MD_FLXATTRLS (0x0000002000000000ULL) /* xattr list */
812 #define OBD_MD_FLXATTRRM (0x0000004000000000ULL) /* xattr remove */
813 #define OBD_MD_FLACL (0x0000008000000000ULL) /* ACL */
814 #define OBD_MD_FLRMTPERM (0x0000010000000000ULL) /* remote permission */
815 #define OBD_MD_FLMDSCAPA (0x0000020000000000ULL) /* MDS capability */
816 #define OBD_MD_FLOSSCAPA (0x0000040000000000ULL) /* OSS capability */
817 #define OBD_MD_FLCKSPLIT (0x0000080000000000ULL) /* Check split on server */
818 #define OBD_MD_FLCROSSREF (0x0000100000000000ULL) /* Cross-ref case */
820 #define OBD_MD_FLRMTLSETFACL (0x0001000000000000ULL) /* lfs lsetfacl case */
821 #define OBD_MD_FLRMTLGETFACL (0x0002000000000000ULL) /* lfs lgetfacl case */
822 #define OBD_MD_FLRMTRSETFACL (0x0004000000000000ULL) /* lfs rsetfacl case */
823 #define OBD_MD_FLRMTRGETFACL (0x0008000000000000ULL) /* lfs rgetfacl case */
825 #define OBD_MD_FLGETATTR (OBD_MD_FLID | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
826 OBD_MD_FLCTIME | OBD_MD_FLSIZE | OBD_MD_FLBLKSZ | \
827 OBD_MD_FLMODE | OBD_MD_FLTYPE | OBD_MD_FLUID | \
828 OBD_MD_FLGID | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
829 OBD_MD_FLGENER | OBD_MD_FLRDEV | OBD_MD_FLGROUP)
831 static inline struct lustre_handle *obdo_handle(struct obdo *oa)
833 return (struct lustre_handle *)oa->o_inline;
836 static inline struct llog_cookie *obdo_logcookie(struct obdo *oa)
838 return (struct llog_cookie *)(oa->o_inline +
839 sizeof(struct lustre_handle));
841 /* don't forget obdo_fid which is way down at the bottom so it can
842 * come after the definition of llog_cookie */
855 __u32 os_state; /* positive error code on server */
867 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
868 #define OBD_STATFS_NODELAY 0x0001 /* requests should be send without delay
869 * and resends for avoid deadlocks */
871 /* ost_body.data values for OST_BRW */
873 #define OBD_BRW_READ 0x01
874 #define OBD_BRW_WRITE 0x02
875 #define OBD_BRW_RWMASK (OBD_BRW_READ | OBD_BRW_WRITE)
876 #define OBD_BRW_SYNC 0x08
877 #define OBD_BRW_CHECK 0x10
878 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
879 #define OBD_BRW_GRANTED 0x40 /* the ost manages this */
880 #define OBD_BRW_DROP 0x80 /* drop the page after IO */
881 #define OBD_BRW_NOQUOTA 0x100
882 #define OBD_BRW_SRVLOCK 0x200 /* Client holds no lock over this page */
884 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
886 #define OST_MIN_PRECREATE 32
887 #define OST_MAX_PRECREATE 20000
896 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
898 /* multiple of 8 bytes => can array */
899 struct niobuf_remote {
905 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
907 /* request structure for OST's */
913 extern void lustre_swab_ost_body (struct ost_body *b);
914 extern void lustre_swab_ost_last_id(obd_id *id);
916 /* lock value block communicated between the filter and llite */
918 /* OST_LVB_ERR_INIT is needed because the return code in rc is
919 * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
920 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
921 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
922 #define OST_LVB_IS_ERR(blocks) \
923 ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
924 #define OST_LVB_SET_ERR(blocks, rc) \
925 do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
926 #define OST_LVB_GET_ERR(blocks) (int)(blocks - OST_LVB_ERR_INIT)
936 extern void lustre_swab_ost_lvb(struct ost_lvb *);
945 MDS_GETATTR_NAME = 34,
956 MDS_DONE_WRITING = 45,
961 MDS_SETXATTR = 50, /* obsolete, now it's MDS_REINT op */
967 #define MDS_FIRST_OPC MDS_GETATTR
984 } mds_reint_t, mdt_reint_t;
986 extern void lustre_swab_generic_32s (__u32 *val);
988 /* the disposition of the intent outlines what was executed */
989 #define DISP_IT_EXECD 0x00000001
990 #define DISP_LOOKUP_EXECD 0x00000002
991 #define DISP_LOOKUP_NEG 0x00000004
992 #define DISP_LOOKUP_POS 0x00000008
993 #define DISP_OPEN_CREATE 0x00000010
994 #define DISP_OPEN_OPEN 0x00000020
995 #define DISP_ENQ_COMPLETE 0x00400000
996 #define DISP_ENQ_OPEN_REF 0x00800000
997 #define DISP_ENQ_CREATE_REF 0x01000000
998 #define DISP_OPEN_LOCK 0x02000000
1000 /* INODE LOCK PARTS */
1001 #define MDS_INODELOCK_LOOKUP 0x000001 /* dentry, mode, owner, group */
1002 #define MDS_INODELOCK_UPDATE 0x000002 /* size, links, timestamps */
1003 #define MDS_INODELOCK_OPEN 0x000004 /* For opened files */
1005 /* Do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits */
1006 #define MDS_INODELOCK_MAXSHIFT 2
1007 /* This FULL lock is useful to take on unlink sort of operations */
1008 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
1011 __u64 id; /* holds object id */
1012 __u32 generation; /* holds object generation */
1014 __u32 f_type; /* holds object type or stripe idx when passing it to
1015 * OST for saving into EA. */
1018 extern void lustre_swab_ll_fid (struct ll_fid *fid);
1020 #define MDS_STATUS_CONN 1
1021 #define MDS_STATUS_LOV 2
1023 struct mds_status_req {
1028 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
1030 /* mdt_thread_info.mti_flags. */
1032 /* The flag indicates Size-on-MDS attributes are changed. */
1033 MF_SOM_CHANGE = (1 << 0),
1034 /* Flags indicates an epoch opens or closes. */
1035 MF_EPOCH_OPEN = (1 << 1),
1036 MF_EPOCH_CLOSE = (1 << 2),
1037 MF_MDC_CANCEL_FID1 = (1 << 3),
1038 MF_MDC_CANCEL_FID2 = (1 << 4),
1039 MF_MDC_CANCEL_FID3 = (1 << 5),
1040 MF_MDC_CANCEL_FID4 = (1 << 6),
1043 #define MF_SOM_LOCAL_FLAGS (MF_MDC_CANCEL_FID1 | MF_MDC_CANCEL_FID2 | \
1044 MF_MDC_CANCEL_FID3 | MF_MDC_CANCEL_FID4)
1046 #define MDS_BFLAG_UNCOMMITTED_WRITES 0x1
1047 #define MDS_BFLAG_EXT_FLAGS 0x80000000 /* == EXT3_RESERVED_FL */
1049 /* these should be identical to their EXT3_*_FL counterparts, and are
1050 * redefined here only to avoid dragging in ext3_fs.h */
1051 #define MDS_SYNC_FL 0x00000008 /* Synchronous updates */
1052 #define MDS_IMMUTABLE_FL 0x00000010 /* Immutable file */
1053 #define MDS_APPEND_FL 0x00000020 /* writes to file may only append */
1054 #define MDS_NOATIME_FL 0x00000080 /* do not update atime */
1055 #define MDS_DIRSYNC_FL 0x00010000 /* dirsync behaviour (dir only) */
1058 /* If MDS_BFLAG_IOC_FLAGS is set it means we requested EXT3_*_FL inode flags
1059 * and we need to decode these into local S_* flags in the inode. Otherwise
1060 * we pass flags straight through (see bug 9486). */
1061 static inline int ll_ext_to_inode_flags(int flags)
1063 return (flags & MDS_BFLAG_EXT_FLAGS) ?
1064 (((flags & MDS_SYNC_FL) ? S_SYNC : 0) |
1065 ((flags & MDS_NOATIME_FL) ? S_NOATIME : 0) |
1066 ((flags & MDS_APPEND_FL) ? S_APPEND : 0) |
1067 #if defined(S_DIRSYNC)
1068 ((flags & MDS_DIRSYNC_FL) ? S_DIRSYNC : 0) |
1070 ((flags & MDS_IMMUTABLE_FL) ? S_IMMUTABLE : 0)) :
1071 (flags & ~MDS_BFLAG_EXT_FLAGS);
1074 /* If MDS_BFLAG_EXT_FLAGS is set it means we requested EXT3_*_FL inode flags
1075 * and we pass these straight through. Otherwise we need to convert from
1076 * S_* flags to their EXT3_*_FL equivalents (see bug 9486). */
1077 static inline int ll_inode_to_ext_flags(int oflags, int iflags)
1079 return (oflags & MDS_BFLAG_EXT_FLAGS) ? (oflags & ~MDS_BFLAG_EXT_FLAGS):
1080 (((iflags & S_SYNC) ? MDS_SYNC_FL : 0) |
1081 ((iflags & S_NOATIME) ? MDS_NOATIME_FL : 0) |
1082 ((iflags & S_APPEND) ? MDS_APPEND_FL : 0) |
1083 #if defined(S_DIRSYNC)
1084 ((iflags & S_DIRSYNC) ? MDS_DIRSYNC_FL : 0) |
1086 ((iflags & S_IMMUTABLE) ? MDS_IMMUTABLE_FL : 0));
1093 struct lustre_handle handle;
1095 __u64 size; /* Offset, in the case of MDS_READPAGE */
1099 __u64 blocks; /* XID, in the case of MDS_READPAGE */
1101 __u64 ino; /* for 1.6 compatibility */
1108 __u32 flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1110 __u32 nlink; /* #bytes to read in the case of MDS_READPAGE */
1111 __u32 generation; /* for 1.6 compatibility */
1116 __u32 max_cookiesize;
1117 __u32 padding_4; /* also fix lustre_swab_mdt_body */
1123 struct lustre_handle handle;
1125 __u64 size; /* Offset, in the case of MDS_READPAGE */
1129 __u64 blocks; /* XID, in the case of MDS_READPAGE */
1138 __u32 flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1140 __u32 nlink; /* #bytes to read in the case of MDS_READPAGE */
1146 __u32 max_cookiesize; /* also fix lustre_swab_mds_body */
1147 __u32 padding_4; /* also fix lustre_swab_mds_body */
1150 extern void lustre_swab_mds_body (struct mds_body *b);
1151 extern void lustre_swab_mdt_body (struct mdt_body *b);
1154 struct lustre_handle handle;
1160 extern void lustre_swab_mdt_epoch (struct mdt_epoch *b);
1162 #define Q_QUOTACHECK 0x800100
1163 #define Q_INITQUOTA 0x800101 /* init slave limits */
1164 #define Q_GETOINFO 0x800102 /* get obd quota info */
1165 #define Q_GETOQUOTA 0x800103 /* get obd quotas */
1167 #define Q_TYPESET(oqc, type) \
1168 ((oqc)->qc_type == type || (oqc)->qc_type == UGQUOTA)
1170 #define Q_GETOCMD(oqc) \
1171 ((oqc)->qc_cmd == Q_GETOINFO || (oqc)->qc_cmd == Q_GETOQUOTA)
1173 struct obd_quotactl {
1178 struct obd_dqinfo qc_dqinfo;
1179 struct obd_dqblk qc_dqblk;
1182 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1184 /* inode access permission for remote user, the inode info are omitted,
1185 * for client knows them. */
1186 struct mds_remote_perm {
1191 __u32 rp_access_perm; /* MAY_READ/WRITE/EXEC */
1194 /* permissions for md_perm.mp_perm */
1196 CFS_SETUID_PERM = 0x01,
1197 CFS_SETGID_PERM = 0x02,
1198 CFS_SETGRP_PERM = 0x04,
1199 CFS_RMTACL_PERM = 0x08
1202 extern void lustre_swab_mds_remote_perm(struct mds_remote_perm *p);
1204 struct mdt_remote_perm {
1209 __u32 rp_access_perm; /* MAY_READ/WRITE/EXEC */
1212 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
1214 struct mds_rec_setattr {
1221 struct ll_fid sa_fid;
1222 __u64 sa_valid; /* MDS_ATTR_* attributes */
1229 __u32 sa_attr_flags;
1230 __u32 sa_padding; /* also fix lustre_swab_mds_rec_setattr */
1233 extern void lustre_swab_mds_rec_setattr (struct mds_rec_setattr *sa);
1235 struct mdt_rec_setattr {
1242 struct lu_fid sa_fid;
1251 __u32 sa_attr_flags;
1259 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
1262 * Attribute flags used in mds_rec_setattr::sa_valid.
1263 * The kernel's #defines for ATTR_* should not be used over the network
1264 * since the client and MDS may run different kernels (see bug 13828)
1265 * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1267 #define MDS_ATTR_MODE 0x1ULL /* = 1 */
1268 #define MDS_ATTR_UID 0x2ULL /* = 2 */
1269 #define MDS_ATTR_GID 0x4ULL /* = 4 */
1270 #define MDS_ATTR_SIZE 0x8ULL /* = 8 */
1271 #define MDS_ATTR_ATIME 0x10ULL /* = 16 */
1272 #define MDS_ATTR_MTIME 0x20ULL /* = 32 */
1273 #define MDS_ATTR_CTIME 0x40ULL /* = 64 */
1274 #define MDS_ATTR_ATIME_SET 0x80ULL /* = 128 */
1275 #define MDS_ATTR_MTIME_SET 0x100ULL /* = 256 */
1276 #define MDS_ATTR_FORCE 0x200ULL /* = 512, Not a change, but a change it */
1277 #define MDS_ATTR_ATTR_FLAG 0x400ULL /* = 1024 */
1278 #define MDS_ATTR_KILL_SUID 0x800ULL /* = 2048 */
1279 #define MDS_ATTR_KILL_SGID 0x1000ULL /* = 4096 */
1280 #define MDS_ATTR_CTIME_SET 0x2000ULL /* = 8192 */
1281 #define MDS_ATTR_FROM_OPEN 0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
1282 #define MDS_ATTR_BLOCKS 0x8000ULL /* = 32768 */
1285 #define FMODE_READ 00000001
1286 #define FMODE_WRITE 00000002
1289 #define FMODE_EPOCH 01000000
1290 #define FMODE_EPOCHLCK 02000000
1291 #define FMODE_SOM 04000000
1292 #define FMODE_CLOSED 0
1294 #define MDS_OPEN_CREATED 00000010
1295 #define MDS_OPEN_CROSS 00000020
1297 #define MDS_FMODE_EXEC 00000004
1298 #define MDS_OPEN_CREAT 00000100
1299 #define MDS_OPEN_EXCL 00000200
1300 #define MDS_OPEN_TRUNC 00001000
1301 #define MDS_OPEN_APPEND 00002000
1302 #define MDS_OPEN_SYNC 00010000
1303 #define MDS_OPEN_DIRECTORY 00200000
1305 #define MDS_OPEN_DELAY_CREATE 0100000000 /* delay initial object create */
1306 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1307 #define MDS_OPEN_JOIN_FILE 0400000000 /* open for join file*/
1308 #define MDS_CREATE_RMT_ACL 01000000000 /* indicate create on remote server
1309 * with default ACL */
1310 #define MDS_CREATE_SLAVE_OBJ 02000000000 /* indicate create slave object
1311 * actually, this is for create, not
1312 * conflict with other open flags */
1313 #define MDS_OPEN_LOCK 04000000000 /* This open requires open lock */
1314 #define MDS_OPEN_HAS_EA 010000000000 /* specify object create pattern */
1315 #define MDS_OPEN_HAS_OBJS 020000000000 /* Just set the EA the obj exist */
1317 /* permission for create non-directory file */
1318 #define MAY_CREATE (1 << 7)
1319 /* permission for create directory file */
1320 #define MAY_LINK (1 << 8)
1321 /* permission for delete from the directory */
1322 #define MAY_UNLINK (1 << 9)
1323 /* source's permission for rename */
1324 #define MAY_RENAME_SRC (1 << 10)
1325 /* target's permission for rename */
1326 #define MAY_RENAME_TAR (1 << 11)
1327 /* part (parent's) VTX permission check */
1328 #define MAY_VTX_PART (1 << 12)
1329 /* full VTX permission check */
1330 #define MAY_VTX_FULL (1 << 13)
1331 /* lfs rgetfacl permission check */
1332 #define MAY_RGETFACL (1 << 14)
1335 MDS_CHECK_SPLIT = 1 << 0,
1336 MDS_CROSS_REF = 1 << 1,
1337 MDS_VTX_BYPASS = 1 << 2,
1338 MDS_PERM_BYPASS = 1 << 3
1341 struct mds_rec_join {
1342 struct ll_fid jr_fid;
1346 extern void lustre_swab_mds_rec_join (struct mds_rec_join *jr);
1348 struct mdt_rec_join {
1349 struct lu_fid jr_fid;
1353 extern void lustre_swab_mdt_rec_join (struct mdt_rec_join *jr);
1355 struct mds_rec_create {
1360 __u32 cr_flags; /* for use with open */
1362 struct ll_fid cr_fid;
1363 struct ll_fid cr_replayfid;
1367 __u32 cr_padding_1; /* also fix lustre_swab_mds_rec_create */
1368 __u32 cr_padding_2; /* also fix lustre_swab_mds_rec_create */
1369 __u32 cr_padding_3; /* also fix lustre_swab_mds_rec_create */
1370 __u32 cr_padding_4; /* also fix lustre_swab_mds_rec_create */
1371 __u32 cr_padding_5; /* also fix lustre_swab_mds_rec_create */
1374 extern void lustre_swab_mds_rec_create (struct mds_rec_create *cr);
1376 struct mdt_rec_create {
1383 struct lu_fid cr_fid1;
1384 struct lu_fid cr_fid2;
1385 struct lustre_handle cr_old_handle; /* u64 handle in case of open replay */
1389 __u64 cr_padding_1; /* pad for 64 bits*/
1392 __u32 cr_flags; /* for use with open */
1398 extern void lustre_swab_mdt_rec_create (struct mdt_rec_create *cr);
1400 struct mds_rec_link {
1407 struct ll_fid lk_fid1;
1408 struct ll_fid lk_fid2;
1410 __u32 lk_padding_1; /* also fix lustre_swab_mds_rec_link */
1411 __u32 lk_padding_2; /* also fix lustre_swab_mds_rec_link */
1412 __u32 lk_padding_3; /* also fix lustre_swab_mds_rec_link */
1413 __u32 lk_padding_4; /* also fix lustre_swab_mds_rec_link */
1416 extern void lustre_swab_mds_rec_link (struct mds_rec_link *lk);
1418 struct mdt_rec_link {
1425 struct lu_fid lk_fid1;
1426 struct lu_fid lk_fid2;
1440 struct mds_rec_unlink {
1447 struct ll_fid ul_fid1;
1448 struct ll_fid ul_fid2;
1450 __u32 ul_padding_1; /* also fix lustre_swab_mds_rec_unlink */
1451 __u32 ul_padding_2; /* also fix lustre_swab_mds_rec_unlink */
1452 __u32 ul_padding_3; /* also fix lustre_swab_mds_rec_unlink */
1453 __u32 ul_padding_4; /* also fix lustre_swab_mds_rec_unlink */
1456 extern void lustre_swab_mds_rec_unlink (struct mds_rec_unlink *ul);
1458 struct mdt_rec_unlink {
1465 struct lu_fid ul_fid1;
1466 struct lu_fid ul_fid2;
1480 struct mds_rec_rename {
1487 struct ll_fid rn_fid1;
1488 struct ll_fid rn_fid2;
1490 __u32 rn_padding_1; /* also fix lustre_swab_mds_rec_rename */
1491 __u32 rn_padding_2; /* also fix lustre_swab_mds_rec_rename */
1492 __u32 rn_padding_3; /* also fix lustre_swab_mds_rec_rename */
1493 __u32 rn_padding_4; /* also fix lustre_swab_mds_rec_rename */
1496 extern void lustre_swab_mds_rec_rename (struct mds_rec_rename *rn);
1498 struct mdt_rec_rename {
1505 struct lu_fid rn_fid1;
1506 struct lu_fid rn_fid2;
1512 __u32 rn_bias; /* some operation flags */
1513 __u32 rn_mode; /* cross-ref rename has mode */
1520 struct mdt_rec_setxattr {
1527 struct lu_fid sx_fid;
1528 __u64 sx_padding_1; /* These three members are lu_fid size */
1540 __u32 sx_padding_10;
1541 __u32 sx_padding_11;
1544 struct mdt_rec_reint {
1551 struct lu_fid rr_fid1;
1552 struct lu_fid rr_fid2;
1560 __u32 rr_padding_1; /* also fix lustre_swab_mdt_rec_reint */
1561 __u32 rr_padding_2; /* also fix lustre_swab_mdt_rec_reint */
1562 __u32 rr_padding_3; /* also fix lustre_swab_mdt_rec_reint */
1563 __u32 rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
1566 extern void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
1569 __u32 ld_tgt_count; /* how many MDS's */
1570 __u32 ld_active_tgt_count; /* how many active */
1571 struct obd_uuid ld_uuid;
1574 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
1581 extern void lustre_swab_md_fld (struct md_fld *mf);
1586 FLD_FIRST_OPC = FLD_QUERY
1592 SEQ_FIRST_OPC = SEQ_QUERY
1596 SEQ_ALLOC_SUPER = 0,
1601 * LOV data structures
1604 #define LOV_MIN_STRIPE_SIZE 65536 /* maximum PAGE_SIZE (ia64), power of 2 */
1605 #define LOV_MAX_STRIPE_COUNT 160 /* until bug 4424 is fixed */
1606 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
1608 #define LOV_MAX_UUID_BUFFER_SIZE 8192
1609 /* The size of the buffer the lov/mdc reserves for the
1610 * array of UUIDs returned by the MDS. With the current
1611 * protocol, this will limit the max number of OSTs per LOV */
1613 #define LOV_DESC_MAGIC 0xB0CCDE5C
1615 /* LOV settings descriptor (should only contain static info) */
1617 __u32 ld_tgt_count; /* how many OBD's */
1618 __u32 ld_active_tgt_count; /* how many active */
1619 __u32 ld_default_stripe_count; /* how many objects are used */
1620 __u32 ld_pattern; /* default PATTERN_RAID0 */
1621 __u64 ld_default_stripe_size; /* in bytes */
1622 __u64 ld_default_stripe_offset; /* in bytes */
1623 __u32 ld_padding_0; /* unused */
1624 __u32 ld_qos_maxage; /* in second */
1625 __u32 ld_padding_1; /* also fix lustre_swab_lov_desc */
1626 __u32 ld_padding_2; /* also fix lustre_swab_lov_desc */
1627 struct obd_uuid ld_uuid;
1630 #define ld_magic ld_active_tgt_count /* for swabbing from llogs */
1632 extern void lustre_swab_lov_desc (struct lov_desc *ld);
1637 /* opcodes -- MUST be distinct from OST/MDS opcodes */
1642 LDLM_BL_CALLBACK = 104,
1643 LDLM_CP_CALLBACK = 105,
1644 LDLM_GL_CALLBACK = 106,
1647 #define LDLM_FIRST_OPC LDLM_ENQUEUE
1649 #define RES_NAME_SIZE 4
1650 struct ldlm_res_id {
1651 __u64 name[RES_NAME_SIZE];
1654 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
1669 #define LCK_MODE_NUM 7
1679 #define LDLM_MIN_TYPE LDLM_PLAIN
1681 struct ldlm_extent {
1687 static inline int ldlm_extent_overlap(struct ldlm_extent *ex1,
1688 struct ldlm_extent *ex2)
1690 return (ex1->start <= ex2->end) && (ex2->start <= ex1->end);
1693 struct ldlm_inodebits {
1700 __u64 blocking_export; /* not actually used over the wire */
1701 __u32 blocking_pid; /* not actually used over the wire */
1705 /* it's important that the fields of the ldlm_extent structure match
1706 * the first fields of the ldlm_flock structure because there is only
1707 * one ldlm_swab routine to process the ldlm_policy_data_t union. if
1708 * this ever changes we will need to swab the union differently based
1709 * on the resource type. */
1712 struct ldlm_extent l_extent;
1713 struct ldlm_flock l_flock;
1714 struct ldlm_inodebits l_inodebits;
1715 } ldlm_policy_data_t;
1717 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
1719 struct ldlm_intent {
1723 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
1725 struct ldlm_resource_desc {
1726 ldlm_type_t lr_type;
1727 __u32 lr_padding; /* also fix lustre_swab_ldlm_resource_desc */
1728 struct ldlm_res_id lr_name;
1731 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
1733 struct ldlm_lock_desc {
1734 struct ldlm_resource_desc l_resource;
1735 ldlm_mode_t l_req_mode;
1736 ldlm_mode_t l_granted_mode;
1737 ldlm_policy_data_t l_policy_data;
1740 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
1742 #define LDLM_LOCKREQ_HANDLES 2
1743 #define LDLM_ENQUEUE_CANCEL_OFF 1
1745 struct ldlm_request {
1748 struct ldlm_lock_desc lock_desc;
1749 struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
1752 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
1754 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
1755 * Otherwise, 2 are available. */
1756 #define ldlm_request_bufsize(count,type) \
1758 int _avail = LDLM_LOCKREQ_HANDLES; \
1759 _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
1760 sizeof(struct ldlm_request) + \
1761 (count > _avail ? count - _avail : 0) * \
1762 sizeof(struct lustre_handle); \
1767 __u32 lock_padding; /* also fix lustre_swab_ldlm_reply */
1768 struct ldlm_lock_desc lock_desc;
1769 struct lustre_handle lock_handle;
1770 __u64 lock_policy_res1;
1771 __u64 lock_policy_res2;
1774 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
1777 * Opcodes for mountconf (mgs and mgc)
1782 MGS_EXCEPTION, /* node died, etc. */
1783 MGS_TARGET_REG, /* whenever target starts up */
1788 #define MGS_FIRST_OPC MGS_CONNECT
1790 #define MGS_PARAM_MAXLEN 1024
1791 #define KEY_SET_INFO "set_info"
1793 struct mgs_send_param {
1794 char mgs_param[MGS_PARAM_MAXLEN];
1797 /* We pass this info to the MGS so it can write config logs */
1798 #define MTI_NAME_MAXLEN 64
1799 #define MTI_PARAM_MAXLEN 4096
1800 #define MTI_NIDS_MAX 32
1801 struct mgs_target_info {
1802 __u32 mti_lustre_ver;
1803 __u32 mti_stripe_index;
1804 __u32 mti_config_ver;
1806 __u32 mti_nid_count;
1807 __u32 padding; /* 64 bit align */
1808 char mti_fsname[MTI_NAME_MAXLEN];
1809 char mti_svname[MTI_NAME_MAXLEN];
1810 char mti_uuid[sizeof(struct obd_uuid)];
1811 __u64 mti_nids[MTI_NIDS_MAX]; /* host nids (lnet_nid_t)*/
1812 char mti_params[MTI_PARAM_MAXLEN];
1815 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
1817 /* Config marker flags (in config log) */
1818 #define CM_START 0x01
1820 #define CM_SKIP 0x04
1821 #define CM_UPGRADE146 0x08
1822 #define CM_EXCLUDE 0x10
1823 #define CM_START_SKIP (CM_START | CM_SKIP)
1826 __u32 cm_step; /* aka config version */
1828 __u32 cm_vers; /* lustre release version number */
1829 __u32 padding; /* 64 bit align */
1830 time_t cm_createtime; /*when this record was first created */
1831 time_t cm_canceltime; /*when this record is no longer valid*/
1832 char cm_tgtname[MTI_NAME_MAXLEN];
1833 char cm_comment[MTI_NAME_MAXLEN];
1837 * Opcodes for multiple servers.
1846 #define OBD_FIRST_OPC OBD_PING
1848 /* catalog of log objects */
1850 /* Identifier for a single log object */
1855 } __attribute__((packed));
1857 /* Records written to the CATALOGS list */
1858 #define CATLIST "CATALOGS"
1860 struct llog_logid lci_logid;
1864 } __attribute__((packed));
1866 /*join file lov mds md*/
1867 struct lov_mds_md_join {
1868 struct lov_mds_md lmmj_md;
1869 /*join private info*/
1870 struct llog_logid lmmj_array_id; /*array object id*/
1871 __u32 lmmj_extent_count; /*array extent count*/
1874 /* Log data record types - there is no specific reason that these need to
1875 * be related to the RPC opcodes, but no reason not to (may be handy later?)
1877 #define LLOG_OP_MAGIC 0x10600000
1878 #define LLOG_OP_MASK 0xfff00000
1881 LLOG_PAD_MAGIC = LLOG_OP_MAGIC | 0x00000,
1882 OST_SZ_REC = LLOG_OP_MAGIC | 0x00f00,
1883 OST_RAID1_REC = LLOG_OP_MAGIC | 0x01000,
1884 MDS_UNLINK_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_UNLINK,
1885 MDS_SETATTR_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_SETATTR,
1886 OBD_CFG_REC = LLOG_OP_MAGIC | 0x20000,
1887 PTL_CFG_REC = LLOG_OP_MAGIC | 0x30000, /* obsolete */
1888 LLOG_GEN_REC = LLOG_OP_MAGIC | 0x40000,
1889 LLOG_JOIN_REC = LLOG_OP_MAGIC | 0x50000,
1890 LLOG_HDR_MAGIC = LLOG_OP_MAGIC | 0x45539,
1891 LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
1895 * for now, continue to support old pad records which have 0 for their
1896 * type but still need to be swabbed for their length
1898 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
1899 (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == \
1900 __swab32(LLOG_OP_MAGIC) || \
1901 (((r)->lrh_type == 0) && ((r)->lrh_len > LLOG_CHUNK_SIZE)))
1903 /* Log record header - stored in little endian order.
1904 * Each record must start with this struct, end with a llog_rec_tail,
1905 * and be a multiple of 256 bits in size.
1907 struct llog_rec_hdr {
1914 struct llog_rec_tail {
1919 struct llog_logid_rec {
1920 struct llog_rec_hdr lid_hdr;
1921 struct llog_logid lid_id;
1927 struct llog_rec_tail lid_tail;
1928 } __attribute__((packed));
1930 /* MDS extent description
1931 * It is for joined file extent info, each extent info for joined file
1932 * just like (start, end, lmm).
1934 struct mds_extent_desc {
1935 __u64 med_start; /* extent start */
1936 __u64 med_len; /* extent length */
1937 struct lov_mds_md med_lmm; /* extent's lmm */
1939 /*Joined file array extent log record*/
1940 struct llog_array_rec {
1941 struct llog_rec_hdr lmr_hdr;
1942 struct mds_extent_desc lmr_med;
1943 struct llog_rec_tail lmr_tail;
1946 struct llog_create_rec {
1947 struct llog_rec_hdr lcr_hdr;
1948 struct ll_fid lcr_fid;
1952 struct llog_rec_tail lcr_tail;
1953 } __attribute__((packed));
1955 struct llog_orphan_rec {
1956 struct llog_rec_hdr lor_hdr;
1960 struct llog_rec_tail lor_tail;
1961 } __attribute__((packed));
1963 struct llog_unlink_rec {
1964 struct llog_rec_hdr lur_hdr;
1968 struct llog_rec_tail lur_tail;
1969 } __attribute__((packed));
1971 struct llog_setattr_rec {
1972 struct llog_rec_hdr lsr_hdr;
1978 struct llog_rec_tail lsr_tail;
1979 } __attribute__((packed));
1981 struct llog_size_change_rec {
1982 struct llog_rec_hdr lsc_hdr;
1983 struct ll_fid lsc_fid;
1986 struct llog_rec_tail lsc_tail;
1987 } __attribute__((packed));
1992 } __attribute__((packed));
1994 struct llog_gen_rec {
1995 struct llog_rec_hdr lgr_hdr;
1996 struct llog_gen lgr_gen;
1997 struct llog_rec_tail lgr_tail;
1999 /* On-disk header structure of each log object, stored in little endian order */
2000 #define LLOG_CHUNK_SIZE 8192
2001 #define LLOG_HEADER_SIZE (96)
2002 #define LLOG_BITMAP_BYTES (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
2004 #define LLOG_MIN_REC_SIZE (24) /* round(llog_rec_hdr + llog_rec_tail) */
2006 /* flags for the logs */
2007 #define LLOG_F_ZAP_WHEN_EMPTY 0x1
2008 #define LLOG_F_IS_CAT 0x2
2009 #define LLOG_F_IS_PLAIN 0x4
2011 struct llog_log_hdr {
2012 struct llog_rec_hdr llh_hdr;
2013 __u64 llh_timestamp;
2015 __u32 llh_bitmap_offset;
2019 /* for a catalog the first plain slot is next to it */
2020 struct obd_uuid llh_tgtuuid;
2021 __u32 llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
2022 __u32 llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
2023 struct llog_rec_tail llh_tail;
2024 } __attribute__((packed));
2026 #define LLOG_BITMAP_SIZE(llh) ((llh->llh_hdr.lrh_len - \
2027 llh->llh_bitmap_offset - \
2028 sizeof(llh->llh_tail)) * 8)
2030 /* log cookies are used to reference a specific log file and a record therein */
2031 struct llog_cookie {
2032 struct llog_logid lgc_lgl;
2036 } __attribute__((packed));
2039 enum llogd_rpc_ops {
2040 LLOG_ORIGIN_HANDLE_CREATE = 501,
2041 LLOG_ORIGIN_HANDLE_NEXT_BLOCK = 502,
2042 LLOG_ORIGIN_HANDLE_READ_HEADER = 503,
2043 LLOG_ORIGIN_HANDLE_WRITE_REC = 504,
2044 LLOG_ORIGIN_HANDLE_CLOSE = 505,
2045 LLOG_ORIGIN_CONNECT = 506,
2046 LLOG_CATINFO = 507, /* for lfs catinfo */
2047 LLOG_ORIGIN_HANDLE_PREV_BLOCK = 508,
2048 LLOG_ORIGIN_HANDLE_DESTROY = 509, /* for destroy llog object*/
2050 LLOG_FIRST_OPC = LLOG_ORIGIN_HANDLE_CREATE
2054 struct llog_logid lgd_logid;
2056 __u32 lgd_llh_flags;
2058 __u32 lgd_saved_index;
2060 __u64 lgd_cur_offset;
2061 } __attribute__((packed));
2063 struct llogd_conn_body {
2064 struct llog_gen lgdc_gen;
2065 struct llog_logid lgdc_logid;
2066 __u32 lgdc_ctxt_idx;
2067 } __attribute__((packed));
2069 struct lov_user_ost_data_join { /* per-stripe data structure */
2070 __u64 l_extent_start; /* extent start*/
2071 __u64 l_extent_end; /* extent end*/
2072 __u64 l_object_id; /* OST object ID */
2073 __u64 l_object_gr; /* OST object group (creating MDS number) */
2074 __u32 l_ost_gen; /* generation of this OST index */
2075 __u32 l_ost_idx; /* OST index in LOV */
2076 } __attribute__((packed));
2078 struct lov_user_md_join { /* LOV EA user data (host-endian) */
2079 __u32 lmm_magic; /* magic number = LOV_MAGIC_JOIN */
2080 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
2081 __u64 lmm_object_id; /* LOV object ID */
2082 __u64 lmm_object_gr; /* LOV object group */
2083 __u32 lmm_stripe_size; /* size of stripe in bytes */
2084 __u32 lmm_stripe_count; /* num stripes in use for this object */
2085 __u32 lmm_extent_count; /* extent count of lmm*/
2086 __u64 lmm_tree_id; /* mds tree object id */
2087 __u64 lmm_tree_gen; /* mds tree object gen */
2088 struct llog_logid lmm_array_id; /* mds extent desc llog object id */
2089 struct lov_user_ost_data_join lmm_objects[0]; /* per-stripe data */
2090 } __attribute__((packed));
2092 extern void lustre_swab_lov_user_md(struct lov_user_md *lum);
2093 extern void lustre_swab_lov_user_md_objects(struct lov_user_md *lum);
2094 extern void lustre_swab_lov_user_md_join(struct lov_user_md_join *lumj);
2097 extern void lustre_swab_llogd_body (struct llogd_body *d);
2098 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
2099 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
2100 extern void lustre_swab_llog_rec(struct llog_rec_hdr *rec,
2101 struct llog_rec_tail *tail);
2104 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
2106 /* quota. fixed by tianzy for bug10707 */
2107 #define QUOTA_IS_GRP 0X1UL /* 0 is user, 1 is group. Used by qd_flags*/
2108 #define QUOTA_IS_BLOCK 0x2UL /* 0 is inode, 1 is block. Used by qd_flags*/
2111 __u32 qd_id; /* ID appiles to (uid, gid) */
2112 __u32 qd_flags; /* Quota type (USRQUOTA, GRPQUOTA) occupy one bit;
2113 * Block quota or file quota occupy one bit */
2114 __u64 qd_count; /* acquire/release count (bytes for block quota) */
2117 struct qunit_data_old {
2118 __u32 qd_id; /* ID appiles to (uid, gid) */
2119 __u32 qd_type; /* Quota type (USRQUOTA, GRPQUOTA) */
2120 __u32 qd_count; /* acquire/release count (bytes for block quota) */
2121 __u32 qd_isblk; /* Block quota or file quota */
2124 extern void lustre_swab_qdata(struct qunit_data *d);
2125 extern void lustre_swab_qdata_old(struct qunit_data_old *d);
2126 extern struct qunit_data *lustre_quota_old_to_new(struct qunit_data_old *d);
2127 extern struct qunit_data_old *lustre_quota_new_to_old(struct qunit_data *d);
2134 #define JOIN_FILE_ALIGN 4096
2136 /* security opcodes */
2139 SEC_CTX_INIT_CONT = 802,
2142 SEC_FIRST_OPC = SEC_CTX_INIT
2146 * capa related definitions
2148 #define CAPA_HMAC_MAX_LEN 64
2149 #define CAPA_HMAC_KEY_MAX_LEN 56
2151 /* NB take care when changing the sequence of elements this struct,
2152 * because the offset info is used in find_capa() */
2153 struct lustre_capa {
2154 struct lu_fid lc_fid; /* fid */
2155 __u64 lc_opc; /* operations allowed */
2156 __u32 lc_uid; /* uid, it is obsolete, but maybe used in
2157 * future, reserve it for 64-bits aligned.*/
2158 __u32 lc_flags; /* HMAC algorithm & flags */
2159 __u32 lc_keyid; /* key used for the capability */
2160 __u32 lc_timeout; /* capa timeout value (sec) */
2161 __u64 lc_expiry; /* expiry time (sec) */
2162 __u8 lc_hmac[CAPA_HMAC_MAX_LEN]; /* HMAC */
2163 } __attribute__((packed));
2165 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
2167 /* lustre_capa.lc_opc */
2169 CAPA_OPC_BODY_WRITE = 1<<0, /* write object data */
2170 CAPA_OPC_BODY_READ = 1<<1, /* read object data */
2171 CAPA_OPC_INDEX_LOOKUP = 1<<2, /* lookup object fid */
2172 CAPA_OPC_INDEX_INSERT = 1<<3, /* insert object fid */
2173 CAPA_OPC_INDEX_DELETE = 1<<4, /* delete object fid */
2174 CAPA_OPC_OSS_WRITE = 1<<5, /* write oss object data */
2175 CAPA_OPC_OSS_READ = 1<<6, /* read oss object data */
2176 CAPA_OPC_OSS_TRUNC = 1<<7, /* truncate oss object */
2177 CAPA_OPC_META_WRITE = 1<<8, /* write object meta data */
2178 CAPA_OPC_META_READ = 1<<9, /* read object meta data */
2182 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
2183 #define CAPA_OPC_MDS_ONLY \
2184 (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
2185 CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
2186 #define CAPA_OPC_OSS_ONLY \
2187 (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC)
2188 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
2189 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
2191 /* MDS capability covers object capability for operations of body r/w
2192 * (dir readpage/sendpage), index lookup/insert/delete and meta data r/w,
2193 * while OSS capability only covers object capability for operations of
2194 * oss data(file content) r/w/truncate.
2196 static inline int capa_for_mds(struct lustre_capa *c)
2198 return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) != 0;
2201 static inline int capa_for_oss(struct lustre_capa *c)
2203 return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) == 0;
2206 /* lustre_capa.lc_hmac_alg */
2208 CAPA_HMAC_ALG_SHA1 = 1, /* sha1 algorithm */
2212 #define CAPA_FL_MASK 0x00ffffff
2213 #define CAPA_HMAC_ALG_MASK 0xff000000
2215 struct lustre_capa_key {
2216 __u64 lk_mdsid; /* mds# */
2217 __u32 lk_keyid; /* key# */
2219 __u8 lk_key[CAPA_HMAC_KEY_MAX_LEN]; /* key */
2220 } __attribute__((packed));
2222 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
2224 /* quota check function */
2225 #define QUOTA_RET_OK 0 /* return successfully */
2226 #define QUOTA_RET_NOQUOTA 1 /* not support quota */
2227 #define QUOTA_RET_NOLIMIT 2 /* quota limit isn't set */
2228 #define QUOTA_RET_ACQUOTA 3 /* need to acquire extra quota */