Whamcloud - gitweb
b=14433
[fs/lustre-release.git] / lustre / include / lustre / lustre_idl.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  *   This file is part of Lustre, http://www.lustre.org
5  *
6  * Lustre wire protocol definitions.
7  *
8  *
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.
15  *
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.
21  *
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.
26  *
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.
32  *
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).
38  *
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.
43  *
44  * A swabber takes a single pointer argument.  The caller must already have
45  * verified that the length of the message buffer >= sizeof (type).
46  *
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.
50  */
51
52 #ifndef _LUSTRE_IDL_H_
53 #define _LUSTRE_IDL_H_
54
55 #include <libcfs/kp30.h>
56
57 #if defined(__linux__)
58 #include <linux/lustre_types.h>
59 #elif defined(__APPLE__)
60 #include <darwin/lustre_types.h>
61 #elif defined(__WINNT__)
62 #include <winnt/lustre_types.h>
63 #else
64 #error Unsupported operating system.
65 #endif
66
67 /* Defn's shared with user-space. */
68 #include <lustre/lustre_user.h>
69
70 /*
71  *  GENERAL STUFF
72  */
73 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
74  * FOO_REPLY_PORTAL   is for incoming replies on the FOO
75  * FOO_BULK_PORTAL    is for incoming bulk on the FOO
76  */
77
78 #define CONNMGR_REQUEST_PORTAL          1
79 #define CONNMGR_REPLY_PORTAL            2
80 //#define OSC_REQUEST_PORTAL            3
81 #define OSC_REPLY_PORTAL                4
82 //#define OSC_BULK_PORTAL               5
83 #define OST_IO_PORTAL                   6
84 #define OST_CREATE_PORTAL               7
85 #define OST_BULK_PORTAL                 8
86 //#define MDC_REQUEST_PORTAL            9
87 #define MDC_REPLY_PORTAL               10
88 //#define MDC_BULK_PORTAL              11
89 #define MDS_REQUEST_PORTAL             12
90 //#define MDS_REPLY_PORTAL             13
91 #define MDS_BULK_PORTAL                14
92 #define LDLM_CB_REQUEST_PORTAL         15
93 #define LDLM_CB_REPLY_PORTAL           16
94 #define LDLM_CANCEL_REQUEST_PORTAL     17
95 #define LDLM_CANCEL_REPLY_PORTAL       18
96 //#define PTLBD_REQUEST_PORTAL           19
97 //#define PTLBD_REPLY_PORTAL             20
98 //#define PTLBD_BULK_PORTAL              21
99 #define MDS_SETATTR_PORTAL             22
100 #define MDS_READPAGE_PORTAL            23
101 #define MDS_MDS_PORTAL                 24
102
103 #define MGC_REPLY_PORTAL               25
104 #define MGS_REQUEST_PORTAL             26
105 #define MGS_REPLY_PORTAL               27
106 #define OST_REQUEST_PORTAL             28
107 #define FLD_REQUEST_PORTAL             29
108 #define SEQ_METADATA_PORTAL            30
109 #define SEQ_DATA_PORTAL                31
110 #define SEQ_CONTROLLER_PORTAL          32
111
112 #define SVC_KILLED               1
113 #define SVC_EVENT                2
114 #define SVC_SIGNAL               4
115 #define SVC_RUNNING              8
116 #define SVC_STOPPING            16
117 #define SVC_STOPPED             32
118
119 /* packet types */
120 #define PTL_RPC_MSG_REQUEST 4711
121 #define PTL_RPC_MSG_ERR     4712
122 #define PTL_RPC_MSG_REPLY   4713
123
124 /* DON'T use swabbed values of MAGIC as magic! */
125 #define LUSTRE_MSG_MAGIC_V1 0x0BD00BD0
126 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
127
128 #define LUSTRE_MSG_MAGIC_V1_SWABBED 0xD00BD00B
129 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
130
131 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
132
133 #define PTLRPC_MSG_VERSION  0x00000003
134 #define LUSTRE_VERSION_MASK 0xffff0000
135 #define LUSTRE_OBD_VERSION  0x00010000
136 #define LUSTRE_MDS_VERSION  0x00020000
137 #define LUSTRE_OST_VERSION  0x00030000
138 #define LUSTRE_DLM_VERSION  0x00040000
139 #define LUSTRE_LOG_VERSION  0x00050000
140 #define LUSTRE_MGS_VERSION  0x00060000
141
142 typedef __u64 mdsno_t;
143 typedef __u64 seqno_t;
144
145 struct lu_range {
146         __u64 lr_start;
147         __u64 lr_end;
148 };
149
150 static inline __u64 range_space(struct lu_range *r)
151 {
152         return r->lr_end - r->lr_start;
153 }
154
155 static inline void range_zero(struct lu_range *r)
156 {
157         r->lr_start = r->lr_end = 0;
158 }
159
160 static inline int range_within(struct lu_range *r,
161                                __u64 s)
162 {
163         return s >= r->lr_start && s < r->lr_end;
164 }
165
166 static inline void range_alloc(struct lu_range *r,
167                                struct lu_range *s,
168                                __u64 w)
169 {
170         r->lr_start = s->lr_start;
171         r->lr_end = s->lr_start + w;
172         s->lr_start += w;
173 }
174
175 static inline int range_is_sane(struct lu_range *r)
176 {
177         return (r->lr_end >= r->lr_start);
178 }
179
180 static inline int range_is_zero(struct lu_range *r)
181 {
182         return (r->lr_start == 0 && r->lr_end == 0);
183 }
184
185 static inline int range_is_exhausted(struct lu_range *r)
186 {
187         return range_space(r) == 0;
188 }
189
190 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x]"
191
192 #define PRANGE(range)      \
193         (range)->lr_start, \
194         (range)->lr_end
195
196 struct lu_fid {
197         __u64 f_seq;  /* holds fid sequence. Lustre should support 2 ^ 64
198                        * objects, thus even if one sequence has one object we
199                        * reach this value. */
200         __u32 f_oid;  /* fid number within its sequence. */
201         __u32 f_ver;  /* holds fid version. */
202 };
203
204 /*
205  * fid constants
206  */
207 enum {
208         LUSTRE_ROOT_FID_SEQ  = 1ULL, /* XXX: should go into mkfs. */
209
210         /* initial fid id value */
211         LUSTRE_FID_INIT_OID  = 1UL
212 };
213
214 /* get object sequence */
215 static inline __u64 fid_seq(const struct lu_fid *fid)
216 {
217         return fid->f_seq;
218 }
219
220 /* get object id */
221 static inline __u32 fid_oid(const struct lu_fid *fid)
222 {
223         return fid->f_oid;
224 }
225
226 /* get object version */
227 static inline __u32 fid_ver(const struct lu_fid *fid)
228 {
229         return fid->f_ver;
230 }
231
232 static inline int fid_seq_is_sane(__u64 seq)
233 {
234         return seq != 0;
235 }
236
237 static inline void fid_zero(struct lu_fid *fid)
238 {
239         memset(fid, 0, sizeof(*fid));
240 }
241
242 static inline int fid_is_igif(const struct lu_fid *fid)
243 {
244         return fid_seq(fid) == LUSTRE_ROOT_FID_SEQ;
245 }
246
247 #define DFID "[0x%16.16"LPF64"x/0x%8.8x:0x%8.8x]"
248
249 #define PFID(fid)     \
250         fid_seq(fid), \
251         fid_oid(fid), \
252         fid_ver(fid)
253
254 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
255 {
256         /* check that all fields are converted */
257         CLASSERT(sizeof *src ==
258                  sizeof fid_seq(src) +
259                  sizeof fid_oid(src) + sizeof fid_ver(src));
260         LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
261         dst->f_seq = cpu_to_le64(fid_seq(src));
262         dst->f_oid = cpu_to_le32(fid_oid(src));
263         dst->f_ver = cpu_to_le32(fid_ver(src));
264 }
265
266 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
267 {
268         /* check that all fields are converted */
269         CLASSERT(sizeof *src ==
270                  sizeof fid_seq(src) +
271                  sizeof fid_oid(src) + sizeof fid_ver(src));
272         dst->f_seq = le64_to_cpu(fid_seq(src));
273         dst->f_oid = le32_to_cpu(fid_oid(src));
274         dst->f_ver = le32_to_cpu(fid_ver(src));
275         LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
276 }
277
278 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
279 {
280         /* check that all fields are converted */
281         CLASSERT(sizeof *src ==
282                  sizeof fid_seq(src) +
283                  sizeof fid_oid(src) + sizeof fid_ver(src));
284         LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
285         dst->f_seq = cpu_to_be64(fid_seq(src));
286         dst->f_oid = cpu_to_be32(fid_oid(src));
287         dst->f_ver = cpu_to_be32(fid_ver(src));
288 }
289
290 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
291 {
292         /* check that all fields are converted */
293         CLASSERT(sizeof *src ==
294                  sizeof fid_seq(src) +
295                  sizeof fid_oid(src) + sizeof fid_ver(src));
296         dst->f_seq = be64_to_cpu(fid_seq(src));
297         dst->f_oid = be32_to_cpu(fid_oid(src));
298         dst->f_ver = be32_to_cpu(fid_ver(src));
299         LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
300 }
301
302 #ifdef __KERNEL__
303 /*
304  * Storage representation for fids.
305  *
306  * Variable size, first byte contains the length of the whole record.
307  */
308
309 struct lu_fid_pack {
310         char fp_len;
311         char fp_area[sizeof(struct lu_fid)];
312 };
313
314 void fid_pack(struct lu_fid_pack *pack, const struct lu_fid *fid,
315               struct lu_fid *befider);
316 int  fid_unpack(const struct lu_fid_pack *pack, struct lu_fid *fid);
317
318 /* __KERNEL__ */
319 #endif
320
321 static inline int fid_is_sane(const struct lu_fid *fid)
322 {
323         return
324                 fid != NULL &&
325                 ((fid_seq_is_sane(fid_seq(fid)) && fid_oid(fid) != 0
326                                                 && fid_ver(fid) == 0) ||
327                 fid_is_igif(fid));
328 }
329
330 static inline int fid_is_zero(const struct lu_fid *fid)
331 {
332         return fid_seq(fid) == 0 && fid_oid(fid) == 0;
333 }
334
335 extern void lustre_swab_lu_fid(struct lu_fid *fid);
336 extern void lustre_swab_lu_range(struct lu_range *range);
337
338 static inline int lu_fid_eq(const struct lu_fid *f0,
339                             const struct lu_fid *f1)
340 {
341         /* Check that there is no alignment padding. */
342         CLASSERT(sizeof *f0 ==
343                  sizeof f0->f_seq + sizeof f0->f_oid + sizeof f0->f_ver);
344         LASSERTF(fid_is_igif(f0) || fid_ver(f0) == 0, DFID, PFID(f0));
345         LASSERTF(fid_is_igif(f1) || fid_ver(f1) == 0, DFID, PFID(f1));
346         return memcmp(f0, f1, sizeof *f0) == 0;
347 }
348
349 /*
350  * Layout of readdir pages, as transmitted on wire.
351  */
352 struct lu_dirent {
353         struct lu_fid lde_fid;
354         __u32         lde_hash;
355         __u16         lde_reclen;
356         __u16         lde_namelen;
357         char          lde_name[0];
358 };
359
360 struct lu_dirpage {
361         __u32            ldp_hash_start;
362         __u32            ldp_hash_end;
363         __u16            ldp_flags;
364         __u32            ldp_pad0;
365         struct lu_dirent ldp_entries[0];
366 };
367
368 enum lu_dirpage_flags {
369         LDF_EMPTY = 1 << 0
370 };
371
372 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
373 {
374         if (le16_to_cpu(dp->ldp_flags) & LDF_EMPTY)
375                 return NULL;
376         else
377                 return dp->ldp_entries;
378 }
379
380 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
381 {
382         struct lu_dirent *next;
383
384         if (le16_to_cpu(ent->lde_reclen) != 0)
385                 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
386         else
387                 next = NULL;
388
389         return next;
390 }
391
392 static inline int lu_dirent_size(struct lu_dirent *ent)
393 {
394         if (le16_to_cpu(ent->lde_reclen) == 0) {
395                 return (sizeof(*ent) +
396                         le16_to_cpu(ent->lde_namelen) + 3) & ~3;
397         }
398         return le16_to_cpu(ent->lde_reclen);
399 }
400
401 #define DIR_END_OFF              0xfffffffeUL
402
403 struct lustre_handle {
404         __u64 cookie;
405 };
406 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
407
408 static inline int lustre_handle_is_used(struct lustre_handle *lh)
409 {
410         return lh->cookie != 0ull;
411 }
412
413 static inline int lustre_handle_equal(struct lustre_handle *lh1,
414                                       struct lustre_handle *lh2)
415 {
416         return lh1->cookie == lh2->cookie;
417 }
418
419 static inline void lustre_handle_copy(struct lustre_handle *tgt,
420                                       struct lustre_handle *src)
421 {
422         tgt->cookie = src->cookie;
423 }
424
425 /* we depend on this structure to be 8-byte aligned */
426 /* this type is only endian-adjusted in lustre_unpack_msg() */
427 struct lustre_msg_v1 {
428         struct lustre_handle lm_handle;
429         __u32 lm_magic;
430         __u32 lm_type;
431         __u32 lm_version;
432         __u32 lm_opc;
433         __u64 lm_last_xid;
434         __u64 lm_last_committed;
435         __u64 lm_transno;
436         __u32 lm_status;
437         __u32 lm_flags;
438         __u32 lm_conn_cnt;
439         __u32 lm_bufcount;
440         __u32 lm_buflens[0];
441 };
442
443 #define lustre_msg lustre_msg_v2
444 /* we depend on this structure to be 8-byte aligned */
445 /* this type is only endian-adjusted in lustre_unpack_msg() */
446 struct lustre_msg_v2 {
447         __u32 lm_bufcount;
448         __u32 lm_secflvr;
449         __u32 lm_magic;
450         __u32 lm_repsize;
451         __u32 lm_timeout;
452         __u32 lm_padding_1;
453         __u32 lm_padding_2;
454         __u32 lm_padding_3;
455         __u32 lm_buflens[0];
456 };
457
458 /* without gss, ptlrpc_body is put at the first buffer. */
459 struct ptlrpc_body {
460         struct lustre_handle pb_handle;
461         __u32 pb_type;
462         __u32 pb_version;
463         __u32 pb_opc;
464         __u32 pb_status;
465         __u64 pb_last_xid;
466         __u64 pb_last_seen;
467         __u64 pb_last_committed;
468         __u64 pb_transno;
469         __u32 pb_flags;
470         __u32 pb_op_flags;
471         __u32 pb_conn_cnt;
472         __u32 pb_padding_1;
473         __u32 pb_padding_2;
474         __u32 pb_limit;
475         __u64 pb_slv;
476 };
477
478 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
479
480 /* message body offset for lustre_msg_v2 */
481 /* ptlrpc body offset in all request/reply messages */
482 #define MSG_PTLRPC_BODY_OFF             0
483
484 /* normal request/reply message record offset */
485 #define REQ_REC_OFF                     1
486 #define REPLY_REC_OFF                   1
487
488 /* ldlm request message body offset */
489 #define DLM_LOCKREQ_OFF                 1 /* lockreq offset */
490 #define DLM_REQ_REC_OFF                 2 /* normal dlm request record offset */
491
492 /* ldlm intent lock message body offset */
493 #define DLM_INTENT_IT_OFF               2 /* intent lock it offset */
494 #define DLM_INTENT_REC_OFF              3 /* intent lock record offset */
495
496 /* ldlm reply message body offset */
497 #define DLM_LOCKREPLY_OFF               1 /* lockrep offset */
498 #define DLM_REPLY_REC_OFF               2 /* reply record offset */
499
500 /* Flags that are operation-specific go in the top 16 bits. */
501 #define MSG_OP_FLAG_MASK   0xffff0000
502 #define MSG_OP_FLAG_SHIFT  16
503
504 /* Flags that apply to all requests are in the bottom 16 bits */
505 #define MSG_GEN_FLAG_MASK      0x0000ffff
506 #define MSG_LAST_REPLAY        1
507 #define MSG_RESENT             2
508 #define MSG_REPLAY             4
509 #define MSG_REQ_REPLAY_DONE    8
510 #define MSG_LOCK_REPLAY_DONE  16
511
512 /*
513  * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
514  */
515
516 #define MSG_CONNECT_RECOVERING  0x1
517 #define MSG_CONNECT_RECONNECT   0x2
518 #define MSG_CONNECT_REPLAYABLE  0x4
519 //#define MSG_CONNECT_PEER        0x8
520 #define MSG_CONNECT_LIBCLIENT   0x10
521 #define MSG_CONNECT_INITIAL     0x20
522 #define MSG_CONNECT_ASYNC       0x40
523 #define MSG_CONNECT_NEXT_VER    0x80  /* use next version of lustre_msg */
524 #define MSG_CONNECT_TRANSNO     0x100 /* report transno */
525
526 /* Connect flags */
527 #define OBD_CONNECT_RDONLY     0x00000001ULL /* client allowed read-only access */
528 #define OBD_CONNECT_INDEX      0x00000002ULL /* connect to specific LOV idx */
529 #define OBD_CONNECT_GRANT      0x00000008ULL /* OSC acquires grant at connect */
530 #define OBD_CONNECT_SRVLOCK    0x00000010ULL /* server takes locks for client */
531 #define OBD_CONNECT_VERSION    0x00000020ULL /* Server supports versions in ocd */
532 #define OBD_CONNECT_REQPORTAL  0x00000040ULL /* Separate portal for non-IO reqs */
533 #define OBD_CONNECT_ACL        0x00000080ULL /* client uses access control lists */
534 #define OBD_CONNECT_XATTR      0x00000100ULL /* client using extended attributes*/
535 #define OBD_CONNECT_TRUNCLOCK  0x00000400ULL /* locks on server for punch b=9528 */
536 #define OBD_CONNECT_IBITS      0x00001000ULL /* support for inodebits locks */
537 #define OBD_CONNECT_JOIN       0x00002000ULL /* files can be concatenated */
538 #define OBD_CONNECT_ATTRFID    0x00004000ULL /* Server supports GetAttr By Fid */
539 #define OBD_CONNECT_NODEVOH    0x00008000ULL /* No open handle for special nodes */
540 #define OBD_CONNECT_LCL_CLIENT 0x00010000ULL /* local 1.8 client */
541 #define OBD_CONNECT_RMT_CLIENT 0x00020000ULL /* Remote 1.8 client */
542 #define OBD_CONNECT_BRW_SIZE   0x00040000ULL /* Max bytes per rpc */
543 #define OBD_CONNECT_QUOTA64    0x00080000ULL /* 64bit qunit_data.qd_count b=10707*/
544 #define OBD_CONNECT_MDS_CAPA   0x00100000ULL /* MDS capability */
545 #define OBD_CONNECT_OSS_CAPA   0x00200000ULL /* OSS capability */
546 #define OBD_CONNECT_CANCELSET  0x00400000ULL /* Early batched cancels. */
547 #define OBD_CONNECT_SOM        0x00800000ULL /* SOM feature */
548 #define OBD_CONNECT_AT         0x01000000ULL /* client uses adaptive timeouts */
549 #define OBD_CONNECT_LRU_RESIZE 0x02000000ULL /* Lru resize feature. */
550 #define OBD_CONNECT_MDS_MDS    0x04000000ULL /* MDS-MDS connection*/
551 #define OBD_CONNECT_REAL       0x08000000ULL /* real connection */
552
553 /* also update obd_connect_names[] for lprocfs_rd_connect_flags()
554  * and lustre/utils/wirecheck.c */
555
556 #ifdef HAVE_LRU_RESIZE_SUPPORT
557 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
558 #else
559 #define LRU_RESIZE_CONNECT_FLAG 0
560 #endif
561
562 #define MDT_CONNECT_SUPPORTED  (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
563                                 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
564                                 OBD_CONNECT_IBITS | OBD_CONNECT_JOIN | \
565                                 OBD_CONNECT_NODEVOH |/* OBD_CONNECT_ATTRFID |*/\
566                                 OBD_CONNECT_LCL_CLIENT | \
567                                 OBD_CONNECT_RMT_CLIENT | \
568                                 OBD_CONNECT_MDS_CAPA | OBD_CONNECT_OSS_CAPA | \
569                                 OBD_CONNECT_MDS_MDS | OBD_CONNECT_CANCELSET | \
570                                 LRU_RESIZE_CONNECT_FLAG)
571 #define OST_CONNECT_SUPPORTED  (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
572                                 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
573                                 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
574                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_QUOTA64 | \
575                                 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_CANCELSET | \
576                                 LRU_RESIZE_CONNECT_FLAG)
577 #define ECHO_CONNECT_SUPPORTED (0)
578 #define MGS_CONNECT_SUPPORTED  (OBD_CONNECT_VERSION)
579
580 #define MAX_QUOTA_COUNT32 (0xffffffffULL)
581
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)
588
589 /* This structure is used for both request and reply.
590  *
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 padding1;          /* also fix lustre_swab_connect */
605         __u64 padding2;          /* also fix lustre_swab_connect */
606         __u64 padding3;          /* also fix lustre_swab_connect */
607 };
608
609 extern void lustre_swab_connect(struct obd_connect_data *ocd);
610
611 /*
612  *   OST requests: OBDO & OBD request records
613  */
614
615 /* opcodes */
616 typedef enum {
617         OST_REPLY      =  0,       /* reply ? */
618         OST_GETATTR    =  1,
619         OST_SETATTR    =  2,
620         OST_READ       =  3,
621         OST_WRITE      =  4,
622         OST_CREATE     =  5,
623         OST_DESTROY    =  6,
624         OST_GET_INFO   =  7,
625         OST_CONNECT    =  8,
626         OST_DISCONNECT =  9,
627         OST_PUNCH      = 10,
628         OST_OPEN       = 11,
629         OST_CLOSE      = 12,
630         OST_STATFS     = 13,
631         OST_SYNC       = 16,
632         OST_SET_INFO   = 17,
633         OST_QUOTACHECK = 18,
634         OST_QUOTACTL   = 19,
635         OST_LAST_OPC
636 } ost_cmd_t;
637 #define OST_FIRST_OPC  OST_REPLY
638
639 typedef uint64_t        obd_id;
640 typedef uint64_t        obd_gr;
641 typedef uint64_t        obd_time;
642 typedef uint64_t        obd_size;
643 typedef uint64_t        obd_off;
644 typedef uint64_t        obd_blocks;
645 typedef uint32_t        obd_blksize;
646 typedef uint32_t        obd_mode;
647 typedef uint32_t        obd_uid;
648 typedef uint32_t        obd_gid;
649 typedef uint32_t        obd_flag;
650 typedef uint64_t        obd_valid;
651 typedef uint32_t        obd_count;
652
653 #define OBD_FL_INLINEDATA    (0x00000001)
654 #define OBD_FL_OBDMDEXISTS   (0x00000002)
655 #define OBD_FL_DELORPHAN     (0x00000004) /* if set in o_flags delete orphans */
656 #define OBD_FL_NORPC         (0x00000008) /* set in o_flags do in OSC not OST */
657 #define OBD_FL_IDONLY        (0x00000010) /* set in o_flags only adjust obj id*/
658 #define OBD_FL_RECREATE_OBJS (0x00000020) /* recreate missing obj */
659 #define OBD_FL_DEBUG_CHECK   (0x00000040) /* echo client/server debug check */
660 #define OBD_FL_NO_USRQUOTA   (0x00000100) /* the object's owner is over quota */
661 #define OBD_FL_NO_GRPQUOTA   (0x00000200) /* the object's group is over quota */
662
663 /*
664  * Set this to delegate DLM locking during obd_punch() to the OSTs. Only OSTs
665  * that declared OBD_CONNECT_TRUNCLOCK in their connect flags support this
666  * functionality.
667  */
668 #define OBD_FL_TRUNCLOCK     (0x00000800)
669
670 /*
671  * This should not be smaller than sizeof(struct lustre_handle) + sizeof(struct
672  * llog_cookie) + sizeof(struct ll_fid). Nevertheless struct ll_fid is not
673  * longer stored in o_inline, we keep this just for case.
674  */
675 #define OBD_INLINESZ    80
676
677 /* Note: 64-bit types are 64-bit aligned in structure */
678 struct obdo {
679         obd_valid               o_valid;        /* hot fields in this obdo */
680         obd_id                  o_id;
681         obd_gr                  o_gr;
682         obd_id                  o_fid;
683         obd_size                o_size;         /* o_size-o_blocks == ost_lvb */
684         obd_time                o_mtime;
685         obd_time                o_atime;
686         obd_time                o_ctime;
687         obd_blocks              o_blocks;       /* brw: cli sent cached bytes */
688         obd_size                o_grant;
689
690         /* 32-bit fields start here: keep an even number of them via padding */
691         obd_blksize             o_blksize;      /* optimal IO blocksize */
692         obd_mode                o_mode;         /* brw: cli sent cache remain */
693         obd_uid                 o_uid;
694         obd_gid                 o_gid;
695         obd_flag                o_flags;
696         obd_count               o_nlink;        /* brw: checksum */
697         obd_count               o_generation;
698         obd_count               o_misc;         /* brw: o_dropped */
699         __u32                   o_easize;       /* epoch in ost writes */
700         __u32                   o_mds;
701         __u32                   o_stripe_idx;   /* holds stripe idx */
702         __u32                   o_padding_1;
703         char                    o_inline[OBD_INLINESZ];
704                                 /* lustre_handle + llog_cookie */
705 };
706
707 #define o_dirty   o_blocks
708 #define o_undirty o_mode
709 #define o_dropped o_misc
710 #define o_cksum   o_nlink
711
712 extern void lustre_swab_obdo (struct obdo *o);
713
714
715 #define LOV_MAGIC_V1      0x0BD10BD0
716 #define LOV_MAGIC         LOV_MAGIC_V1
717 #define LOV_MAGIC_JOIN    0x0BD20BD0
718
719 #define LOV_PATTERN_RAID0 0x001   /* stripes are used round-robin */
720 #define LOV_PATTERN_RAID1 0x002   /* stripes are mirrors of each other */
721 #define LOV_PATTERN_FIRST 0x100   /* first stripe is not in round-robin */
722 #define LOV_PATTERN_CMOBD 0x200
723
724 #define lov_ost_data lov_ost_data_v1
725 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
726         __u64 l_object_id;        /* OST object ID */
727         __u64 l_object_gr;        /* OST object group (creating MDS number) */
728         __u32 l_ost_gen;          /* generation of this l_ost_idx */
729         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
730 };
731
732 #define lov_mds_md lov_mds_md_v1
733 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
734         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
735         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
736         __u64 lmm_object_id;      /* LOV object ID */
737         __u64 lmm_object_gr;      /* LOV object group */
738         __u32 lmm_stripe_size;    /* size of stripe in bytes */
739         __u32 lmm_stripe_count;   /* num stripes in use for this object */
740         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
741 };
742
743 extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm);
744
745 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
746 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
747
748 #define XATTR_NAME_ACL_ACCESS   "system.posix_acl_access"
749 #define XATTR_NAME_ACL_DEFAULT  "system.posix_acl_default"
750 #define XATTR_NAME_LOV          "trusted.lov"
751
752 /* remote ACL */
753 #define XATTR_NAME_LUSTRE_ACL   "system.lustre_acl"
754
755 #define OBD_MD_FLID        (0x00000001ULL) /* object ID */
756 #define OBD_MD_FLATIME     (0x00000002ULL) /* access time */
757 #define OBD_MD_FLMTIME     (0x00000004ULL) /* data modification time */
758 #define OBD_MD_FLCTIME     (0x00000008ULL) /* change time */
759 #define OBD_MD_FLSIZE      (0x00000010ULL) /* size */
760 #define OBD_MD_FLBLOCKS    (0x00000020ULL) /* allocated blocks count */
761 #define OBD_MD_FLBLKSZ     (0x00000040ULL) /* block size */
762 #define OBD_MD_FLMODE      (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
763 #define OBD_MD_FLTYPE      (0x00000100ULL) /* object type (mode & S_IFMT) */
764 #define OBD_MD_FLUID       (0x00000200ULL) /* user ID */
765 #define OBD_MD_FLGID       (0x00000400ULL) /* group ID */
766 #define OBD_MD_FLFLAGS     (0x00000800ULL) /* flags word */
767 #define OBD_MD_FLNLINK     (0x00002000ULL) /* link count */
768 #define OBD_MD_FLGENER     (0x00004000ULL) /* generation number */
769 #define OBD_MD_FLINLINE    (0x00008000ULL) /* inline data */
770 #define OBD_MD_FLRDEV      (0x00010000ULL) /* device number */
771 #define OBD_MD_FLEASIZE    (0x00020000ULL) /* extended attribute data */
772 #define OBD_MD_LINKNAME    (0x00040000ULL) /* symbolic link target */
773 #define OBD_MD_FLHANDLE    (0x00080000ULL) /* file handle */
774 #define OBD_MD_FLCKSUM     (0x00100000ULL) /* bulk data checksum */
775 #define OBD_MD_FLQOS       (0x00200000ULL) /* quality of service stats */
776 #define OBD_MD_FLOSCOPQ    (0x00400000ULL) /* osc opaque data */
777 #define OBD_MD_FLCOOKIE    (0x00800000ULL) /* log cancellation cookie */
778 #define OBD_MD_FLGROUP     (0x01000000ULL) /* group */
779 #define OBD_MD_FLFID       (0x02000000ULL) /* ->ost write inline fid */
780 #define OBD_MD_FLEPOCH     (0x04000000ULL) /* ->ost write easize is epoch */
781                                            /* ->mds if epoch opens or closes */
782 #define OBD_MD_FLGRANT     (0x08000000ULL) /* ost preallocation space grant */
783 #define OBD_MD_FLDIREA     (0x10000000ULL) /* dir's extended attribute data */
784 #define OBD_MD_FLUSRQUOTA  (0x20000000ULL) /* over quota flags sent from ost */
785 #define OBD_MD_FLGRPQUOTA  (0x40000000ULL) /* over quota flags sent from ost */
786 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
787
788 #define OBD_MD_MDS         (0x0000000100000000ULL) /* where an inode lives on */
789 #define OBD_MD_REINT       (0x0000000200000000ULL) /* reintegrate oa */
790 #define OBD_MD_MEA         (0x0000000400000000ULL) /* CMD split EA  */
791
792 #define OBD_MD_FLXATTR     (0x0000001000000000ULL) /* xattr */
793 #define OBD_MD_FLXATTRLS   (0x0000002000000000ULL) /* xattr list */
794 #define OBD_MD_FLXATTRRM   (0x0000004000000000ULL) /* xattr remove */
795 #define OBD_MD_FLACL       (0x0000008000000000ULL) /* ACL */
796 #define OBD_MD_FLRMTPERM   (0x0000010000000000ULL) /* remote permission */
797 #define OBD_MD_FLMDSCAPA   (0x0000020000000000ULL) /* MDS capability */
798 #define OBD_MD_FLOSSCAPA   (0x0000040000000000ULL) /* OSS capability */
799 #define OBD_MD_FLCKSPLIT   (0x0000080000000000ULL) /* Check split on server */
800 #define OBD_MD_FLCROSSREF  (0x0000100000000000ULL) /* Cross-ref case */
801
802 #define OBD_MD_FLGETATTR (OBD_MD_FLID    | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
803                           OBD_MD_FLCTIME | OBD_MD_FLSIZE  | OBD_MD_FLBLKSZ | \
804                           OBD_MD_FLMODE  | OBD_MD_FLTYPE  | OBD_MD_FLUID   | \
805                           OBD_MD_FLGID   | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
806                           OBD_MD_FLGENER | OBD_MD_FLRDEV  | OBD_MD_FLGROUP)
807
808 static inline struct lustre_handle *obdo_handle(struct obdo *oa)
809 {
810         return (struct lustre_handle *)oa->o_inline;
811 }
812
813 static inline struct llog_cookie *obdo_logcookie(struct obdo *oa)
814 {
815         return (struct llog_cookie *)(oa->o_inline +
816                                       sizeof(struct lustre_handle));
817 }
818 /* don't forget obdo_fid which is way down at the bottom so it can
819  * come after the definition of llog_cookie */
820
821 struct obd_statfs {
822         __u64           os_type;
823         __u64           os_blocks;
824         __u64           os_bfree;
825         __u64           os_bavail;
826         __u64           os_files;
827         __u64           os_ffree;
828         __u8            os_fsid[40];
829         __u32           os_bsize;
830         __u32           os_namelen;
831         __u64           os_maxbytes;
832         __u32           os_state;       /* positive error code on server */
833         __u32           os_spare1;
834         __u32           os_spare2;
835         __u32           os_spare3;
836         __u32           os_spare4;
837         __u32           os_spare5;
838         __u32           os_spare6;
839         __u32           os_spare7;
840         __u32           os_spare8;
841         __u32           os_spare9;
842 };
843
844 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
845
846 /* ost_body.data values for OST_BRW */
847
848 #define OBD_BRW_READ            0x01
849 #define OBD_BRW_WRITE           0x02
850 #define OBD_BRW_RWMASK          (OBD_BRW_READ | OBD_BRW_WRITE)
851 #define OBD_BRW_SYNC            0x08
852 #define OBD_BRW_CHECK           0x10
853 #define OBD_BRW_FROM_GRANT      0x20 /* the osc manages this under llite */
854 #define OBD_BRW_GRANTED         0x40 /* the ost manages this */
855 #define OBD_BRW_DROP            0x80 /* drop the page after IO */
856 #define OBD_BRW_NOQUOTA        0x100
857 #define OBD_BRW_SRVLOCK        0x200 /* Client holds no lock over this page */
858
859 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
860
861 #define OST_MIN_PRECREATE 32
862 #define OST_MAX_PRECREATE 20000
863
864 struct obd_ioobj {
865         obd_id               ioo_id;
866         obd_gr               ioo_gr;
867         __u32                ioo_type;
868         __u32                ioo_bufcnt;
869 };
870
871 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
872
873 /* multiple of 8 bytes => can array */
874 struct niobuf_remote {
875         __u64 offset;
876         __u32 len;
877         __u32 flags;
878 };
879
880 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
881
882 /* request structure for OST's */
883
884 struct ost_body {
885         struct  obdo oa;
886 };
887
888 extern void lustre_swab_ost_body (struct ost_body *b);
889 extern void lustre_swab_ost_last_id(obd_id *id);
890
891 /* lock value block communicated between the filter and llite */
892
893 struct ost_lvb {
894         __u64 lvb_size;
895         __u64 lvb_mtime;
896         __u64 lvb_atime;
897         __u64 lvb_ctime;
898         __u64 lvb_blocks;
899 };
900
901 extern void lustre_swab_ost_lvb(struct ost_lvb *);
902
903 /*
904  *   MDS REQ RECORDS
905  */
906
907 /* opcodes */
908 typedef enum {
909         MDS_GETATTR      = 33,
910         MDS_GETATTR_NAME = 34,
911         MDS_CLOSE        = 35,
912         MDS_REINT        = 36,
913         MDS_READPAGE     = 37,
914         MDS_CONNECT      = 38,
915         MDS_DISCONNECT   = 39,
916         MDS_GETSTATUS    = 40,
917         MDS_STATFS       = 41,
918         MDS_PIN          = 42,
919         MDS_UNPIN        = 43,
920         MDS_SYNC         = 44,
921         MDS_DONE_WRITING = 45,
922         MDS_SET_INFO     = 46,
923         MDS_QUOTACHECK   = 47,
924         MDS_QUOTACTL     = 48,
925         MDS_GETXATTR     = 49,
926         MDS_SETXATTR     = 50,
927         MDS_WRITEPAGE    = 51,
928         MDS_IS_SUBDIR    = 52,
929         MDS_LAST_OPC
930 } mds_cmd_t;
931
932 #define MDS_FIRST_OPC    MDS_GETATTR
933
934 /*
935  * Do not exceed 63
936  */
937
938 typedef enum {
939         REINT_SETATTR  = 1,
940         REINT_CREATE   = 2,
941         REINT_LINK     = 3,
942         REINT_UNLINK   = 4,
943         REINT_RENAME   = 5,
944         REINT_OPEN     = 6,
945         REINT_MAX
946 } mds_reint_t, mdt_reint_t;
947
948 extern void lustre_swab_generic_32s (__u32 *val);
949
950 /* the disposition of the intent outlines what was executed */
951 #define DISP_IT_EXECD        0x00000001
952 #define DISP_LOOKUP_EXECD    0x00000002
953 #define DISP_LOOKUP_NEG      0x00000004
954 #define DISP_LOOKUP_POS      0x00000008
955 #define DISP_OPEN_CREATE     0x00000010
956 #define DISP_OPEN_OPEN       0x00000020
957 #define DISP_ENQ_COMPLETE    0x00400000
958 #define DISP_ENQ_OPEN_REF    0x00800000
959 #define DISP_ENQ_CREATE_REF  0x01000000
960 #define DISP_OPEN_LOCK       0x02000000
961
962 /* INODE LOCK PARTS */
963 #define MDS_INODELOCK_LOOKUP 0x000001       /* dentry, mode, owner, group */
964 #define MDS_INODELOCK_UPDATE 0x000002       /* size, links, timestamps */
965 #define MDS_INODELOCK_OPEN   0x000004       /* For opened files */
966
967 /* Do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits */
968 #define MDS_INODELOCK_MAXSHIFT 2
969 /* This FULL lock is useful to take on unlink sort of operations */
970 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
971
972 struct ll_fid {
973         __u64 id;         /* holds object id */
974         __u32 generation; /* holds object generation */
975
976         __u32 f_type;     /* holds object type or stripe idx when passing it to
977                            * OST for saving into EA. */
978 };
979
980 extern void lustre_swab_ll_fid (struct ll_fid *fid);
981
982 #define MDS_STATUS_CONN 1
983 #define MDS_STATUS_LOV 2
984
985 struct mds_status_req {
986         __u32  flags;
987         __u32  repbuf;
988 };
989
990 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
991
992 /* mdt_thread_info.mti_flags. */
993 enum md_op_flags {
994         /* The flag indicates Size-on-MDS attributes are changed. */
995         MF_SOM_CHANGE           = (1 << 0),
996         /* Flags indicates an epoch opens or closes. */
997         MF_EPOCH_OPEN           = (1 << 1),
998         MF_EPOCH_CLOSE          = (1 << 2),
999         MF_MDC_CANCEL_FID1      = (1 << 3),
1000         MF_MDC_CANCEL_FID2      = (1 << 4),
1001         MF_MDC_CANCEL_FID3      = (1 << 5),
1002         MF_MDC_CANCEL_FID4      = (1 << 6),
1003 };
1004
1005 #define MF_SOM_LOCAL_FLAGS (MF_MDC_CANCEL_FID1 | MF_MDC_CANCEL_FID2 | \
1006                             MF_MDC_CANCEL_FID3 | MF_MDC_CANCEL_FID4)
1007
1008 #define MDS_BFLAG_UNCOMMITTED_WRITES   0x1
1009 #define MDS_BFLAG_EXT_FLAGS     0x80000000 /* == EXT3_RESERVED_FL */
1010
1011 /* these should be identical to their EXT3_*_FL counterparts, and are
1012  * redefined here only to avoid dragging in ext3_fs.h */
1013 #define MDS_SYNC_FL             0x00000008 /* Synchronous updates */
1014 #define MDS_IMMUTABLE_FL        0x00000010 /* Immutable file */
1015 #define MDS_APPEND_FL           0x00000020 /* writes to file may only append */
1016 #define MDS_NOATIME_FL          0x00000080 /* do not update atime */
1017 #define MDS_DIRSYNC_FL          0x00010000 /* dirsync behaviour (dir only) */
1018
1019 #ifdef __KERNEL__
1020 /* If MDS_BFLAG_IOC_FLAGS is set it means we requested EXT3_*_FL inode flags
1021  * and we need to decode these into local S_* flags in the inode.  Otherwise
1022  * we pass flags straight through (see bug 9486). */
1023 static inline int ll_ext_to_inode_flags(int flags)
1024 {
1025         return (flags & MDS_BFLAG_EXT_FLAGS) ?
1026                (((flags & MDS_SYNC_FL)      ? S_SYNC      : 0) |
1027                 ((flags & MDS_NOATIME_FL)   ? S_NOATIME   : 0) |
1028                 ((flags & MDS_APPEND_FL)    ? S_APPEND    : 0) |
1029 #if defined(S_DIRSYNC)
1030                 ((flags & MDS_DIRSYNC_FL)   ? S_DIRSYNC   : 0) |
1031 #endif
1032                 ((flags & MDS_IMMUTABLE_FL) ? S_IMMUTABLE : 0)) :
1033                (flags & ~MDS_BFLAG_EXT_FLAGS);
1034 }
1035
1036 /* If MDS_BFLAG_EXT_FLAGS is set it means we requested EXT3_*_FL inode flags
1037  * and we pass these straight through.  Otherwise we need to convert from
1038  * S_* flags to their EXT3_*_FL equivalents (see bug 9486). */
1039 static inline int ll_inode_to_ext_flags(int oflags, int iflags)
1040 {
1041         return (oflags & MDS_BFLAG_EXT_FLAGS) ? (oflags & ~MDS_BFLAG_EXT_FLAGS):
1042                (((iflags & S_SYNC)      ? MDS_SYNC_FL      : 0) |
1043                 ((iflags & S_NOATIME)   ? MDS_NOATIME_FL   : 0) |
1044                 ((iflags & S_APPEND)    ? MDS_APPEND_FL    : 0) |
1045 #if defined(S_DIRSYNC)
1046                 ((iflags & S_DIRSYNC)   ? MDS_DIRSYNC_FL   : 0) |
1047 #endif
1048                 ((iflags & S_IMMUTABLE) ? MDS_IMMUTABLE_FL : 0));
1049 }
1050 #endif
1051
1052 struct mdt_body {
1053         struct lu_fid  fid1;
1054         struct lu_fid  fid2;
1055         struct lustre_handle handle;
1056         __u64          valid;
1057         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1058         __u64          mtime;
1059         __u64          atime;
1060         __u64          ctime;
1061         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1062         __u64          ioepoch;
1063         __u32          fsuid;
1064         __u32          fsgid;
1065         __u32          capability;
1066         __u32          mode;
1067         __u32          uid;
1068         __u32          gid;
1069         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1070         __u32          rdev;
1071         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1072         __u32          suppgid;
1073         __u32          eadatasize;
1074         __u32          aclsize;
1075         __u32          max_mdsize;
1076         __u32          max_cookiesize; /* also fix lustre_swab_mdt_body */
1077 };
1078
1079 struct mds_body {
1080         struct ll_fid  fid1;
1081         struct ll_fid  fid2;
1082         struct lustre_handle handle;
1083         __u64          valid;
1084         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1085         __u64          mtime;
1086         __u64          atime;
1087         __u64          ctime;
1088         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1089         __u64          io_epoch;
1090         __u64          ino;
1091         __u32          fsuid;
1092         __u32          fsgid;
1093         __u32          capability;
1094         __u32          mode;
1095         __u32          uid;
1096         __u32          gid;
1097         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1098         __u32          rdev;
1099         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1100         __u32          generation;
1101         __u32          suppgid;
1102         __u32          eadatasize;
1103         __u32          aclsize;
1104         __u32          max_mdsize;
1105         __u32          max_cookiesize; /* also fix lustre_swab_mds_body */
1106         __u32          padding_4; /* also fix lustre_swab_mds_body */
1107 };
1108
1109 extern void lustre_swab_mds_body (struct mds_body *b);
1110 extern void lustre_swab_mdt_body (struct mdt_body *b);
1111
1112 struct mdt_epoch {
1113         struct lustre_handle handle;
1114         __u64  ioepoch;
1115         __u32  flags;
1116         __u32  padding;
1117 };
1118
1119 extern void lustre_swab_mdt_epoch (struct mdt_epoch *b);
1120
1121 #define Q_QUOTACHECK    0x800100
1122 #define Q_INITQUOTA     0x800101        /* init slave limits */
1123 #define Q_GETOINFO      0x800102        /* get obd quota info */
1124 #define Q_GETOQUOTA     0x800103        /* get obd quotas */
1125
1126 #define Q_TYPESET(oqc, type) \
1127         ((oqc)->qc_type == type || (oqc)->qc_type == UGQUOTA)
1128
1129 #define Q_GETOCMD(oqc) \
1130         ((oqc)->qc_cmd == Q_GETOINFO || (oqc)->qc_cmd == Q_GETOQUOTA)
1131
1132 struct obd_quotactl {
1133         __u32                   qc_cmd;
1134         __u32                   qc_type;
1135         __u32                   qc_id;
1136         __u32                   qc_stat;
1137         struct obd_dqinfo       qc_dqinfo;
1138         struct obd_dqblk        qc_dqblk;
1139 };
1140
1141 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1142
1143 /* inode access permission for remote user, the inode info are omitted,
1144  * for client knows them. */
1145 struct mds_remote_perm {
1146         __u32           rp_uid;
1147         __u32           rp_gid;
1148         __u32           rp_fsuid;
1149         __u32           rp_fsgid;
1150         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
1151 };
1152
1153 /* setxid permissions for mds_setxid_perm.mp_perm */
1154 #define LUSTRE_SETUID_PERM 0x01
1155 #define LUSTRE_SETGID_PERM 0x02
1156 #define LUSTRE_SETGRP_PERM 0x04
1157
1158 extern void lustre_swab_mds_remote_perm(struct mds_remote_perm *p);
1159
1160 struct mdt_remote_perm {
1161         __u32           rp_uid;
1162         __u32           rp_gid;
1163         __u32           rp_fsuid;
1164         __u32           rp_fsgid;
1165         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
1166 };
1167
1168 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
1169
1170 struct mds_rec_setattr {
1171         __u32           sa_opcode;
1172         __u32           sa_fsuid;
1173         __u32           sa_fsgid;
1174         __u32           sa_cap;
1175         __u32           sa_suppgid;
1176         __u32           sa_mode;
1177         struct ll_fid   sa_fid;
1178         __u64           sa_valid; /* MDS_ATTR_* attributes */
1179         __u64           sa_size;
1180         __u64           sa_mtime;
1181         __u64           sa_atime;
1182         __u64           sa_ctime;
1183         __u32           sa_uid;
1184         __u32           sa_gid;
1185         __u32           sa_attr_flags;
1186         __u32           sa_padding; /* also fix lustre_swab_mds_rec_setattr */
1187 };
1188
1189 extern void lustre_swab_mds_rec_setattr (struct mds_rec_setattr *sa);
1190
1191 struct mdt_rec_setattr {
1192         __u32           sa_opcode;
1193         __u32           sa_fsuid;
1194         __u32           sa_fsgid;
1195         __u32           sa_cap;
1196         __u32           sa_suppgid;
1197         __u32           sa_mode;
1198         struct lu_fid   sa_fid;
1199         __u64           sa_valid;
1200         __u64           sa_size;
1201         __u64           sa_blocks;
1202         __u64           sa_mtime;
1203         __u64           sa_atime;
1204         __u64           sa_ctime;
1205         __u32           sa_uid;
1206         __u32           sa_gid;
1207         __u32           sa_attr_flags;
1208         __u32           sa_padding; /* also fix lustre_swab_mds_rec_setattr */
1209 };
1210
1211 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
1212
1213 /*
1214  * Attribute flags used in mds_rec_setattr::sa_valid.
1215  * The kernel's #defines for ATTR_* should not be used over the network
1216  * since the client and MDS may run different kernels (see bug 13828)
1217  * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1218  */
1219 #define MDS_ATTR_MODE          0x1ULL /* = 1 */
1220 #define MDS_ATTR_UID           0x2ULL /* = 2 */
1221 #define MDS_ATTR_GID           0x4ULL /* = 4 */
1222 #define MDS_ATTR_SIZE          0x8ULL /* = 8 */
1223 #define MDS_ATTR_ATIME        0x10ULL /* = 16 */
1224 #define MDS_ATTR_MTIME        0x20ULL /* = 32 */
1225 #define MDS_ATTR_CTIME        0x40ULL /* = 64 */
1226 #define MDS_ATTR_ATIME_SET    0x80ULL /* = 128 */
1227 #define MDS_ATTR_MTIME_SET   0x100ULL /* = 256 */
1228 #define MDS_ATTR_FORCE       0x200ULL /* = 512, Not a change, but a change it */
1229 #define MDS_ATTR_ATTR_FLAG   0x400ULL /* = 1024 */
1230 #define MDS_ATTR_KILL_SUID   0x800ULL /* = 2048 */
1231 #define MDS_ATTR_KILL_SGID  0x1000ULL /* = 4096 */
1232 #define MDS_ATTR_CTIME_SET  0x2000ULL /* = 8192 */
1233 #define MDS_ATTR_FROM_OPEN  0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
1234 #define MDS_ATTR_BLOCKS     0x8000ULL /* = 32768 */
1235
1236 #ifndef FMODE_READ
1237 #define FMODE_READ               00000001
1238 #define FMODE_WRITE              00000002
1239 #endif
1240
1241 #define FMODE_EPOCH              01000000
1242 #define FMODE_EPOCHLCK           02000000
1243 #define FMODE_SOM                04000000
1244 #define FMODE_CLOSED             0
1245
1246 #define MDS_OPEN_CREATED         00000010
1247 #define MDS_OPEN_CROSS           00000020
1248
1249 #define MDS_FMODE_EXEC           00000004
1250 #define MDS_OPEN_CREAT           00000100
1251 #define MDS_OPEN_EXCL            00000200
1252 #define MDS_OPEN_TRUNC           00001000
1253 #define MDS_OPEN_APPEND          00002000
1254 #define MDS_OPEN_SYNC            00010000
1255 #define MDS_OPEN_DIRECTORY       00200000
1256
1257 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
1258 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1259 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file*/
1260 #define MDS_CREATE_RMT_ACL    01000000000 /* indicate create on remote server
1261                                            * with default ACL */
1262 #define MDS_CREATE_SLAVE_OBJ  02000000000 /* indicate create slave object
1263                                            * actually, this is for create, not
1264                                            * conflict with other open flags */
1265 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
1266 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
1267 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
1268
1269 /* permission for create non-directory file */
1270 #define MAY_CREATE      (1 << 7)
1271 /* permission for create directory file */
1272 #define MAY_LINK        (1 << 8)
1273 /* permission for delete from the directory */
1274 #define MAY_UNLINK      (1 << 9)
1275 /* source's permission for rename */
1276 #define MAY_RENAME_SRC  (1 << 10)
1277 /* target's permission for rename */
1278 #define MAY_RENAME_TAR  (1 << 11)
1279 /* part (parent's) VTX permission check */
1280 #define MAY_VTX_PART    (1 << 12)
1281 /* full VTX permission check */
1282 #define MAY_VTX_FULL    (1 << 13)
1283
1284 enum {
1285         MDS_CHECK_SPLIT  = 1 << 0,
1286         MDS_CROSS_REF    = 1 << 1,
1287         MDS_VTX_BYPASS   = 1 << 2,
1288         MDS_PERM_BYPASS  = 1 << 3
1289 };
1290
1291 struct mds_rec_join {
1292         struct ll_fid  jr_fid;
1293         __u64          jr_headsize;
1294 };
1295
1296 extern void lustre_swab_mds_rec_join (struct mds_rec_join *jr);
1297
1298 struct mdt_rec_join {
1299         struct lu_fid  jr_fid;
1300         __u64          jr_headsize;
1301 };
1302
1303 extern void lustre_swab_mdt_rec_join (struct mdt_rec_join *jr);
1304
1305 struct mds_rec_create {
1306         __u32           cr_opcode;
1307         __u32           cr_fsuid;
1308         __u32           cr_fsgid;
1309         __u32           cr_cap;
1310         __u32           cr_flags; /* for use with open */
1311         __u32           cr_mode;
1312         struct ll_fid   cr_fid;
1313         struct ll_fid   cr_replayfid;
1314         __u64           cr_time;
1315         __u64           cr_rdev;
1316         __u32           cr_suppgid;
1317         __u32           cr_padding_1; /* also fix lustre_swab_mds_rec_create */
1318         __u32           cr_padding_2; /* also fix lustre_swab_mds_rec_create */
1319         __u32           cr_padding_3; /* also fix lustre_swab_mds_rec_create */
1320         __u32           cr_padding_4; /* also fix lustre_swab_mds_rec_create */
1321         __u32           cr_padding_5; /* also fix lustre_swab_mds_rec_create */
1322 };
1323
1324 extern void lustre_swab_mds_rec_create (struct mds_rec_create *cr);
1325
1326 struct mdt_rec_create {
1327         __u32           cr_opcode;
1328         __u32           cr_fsuid;
1329         __u32           cr_fsgid;
1330         __u32           cr_cap;
1331         __u32           cr_flags; /* for use with open */
1332         __u32           cr_mode;
1333         struct lustre_handle cr_old_handle; /* u64 handle in case of open replay */
1334         struct lu_fid   cr_fid1;
1335         struct lu_fid   cr_fid2;
1336         __u64           cr_time;
1337         __u64           cr_rdev;
1338         __u64           cr_ioepoch;
1339         __u32           cr_suppgid1;
1340         __u32           cr_suppgid2;
1341         __u32           cr_bias;
1342         __u32           cr_padding_1; /* pad for 64 bits*/
1343 };
1344
1345 extern void lustre_swab_mdt_rec_create (struct mdt_rec_create *cr);
1346
1347 struct mds_rec_link {
1348         __u32           lk_opcode;
1349         __u32           lk_fsuid;
1350         __u32           lk_fsgid;
1351         __u32           lk_cap;
1352         __u32           lk_suppgid1;
1353         __u32           lk_suppgid2;
1354         struct ll_fid   lk_fid1;
1355         struct ll_fid   lk_fid2;
1356         __u64           lk_time;
1357         __u32           lk_padding_1;  /* also fix lustre_swab_mds_rec_link */
1358         __u32           lk_padding_2;  /* also fix lustre_swab_mds_rec_link */
1359         __u32           lk_padding_3;  /* also fix lustre_swab_mds_rec_link */
1360         __u32           lk_padding_4;  /* also fix lustre_swab_mds_rec_link */
1361 };
1362
1363 extern void lustre_swab_mds_rec_link (struct mds_rec_link *lk);
1364
1365 struct mdt_rec_link {
1366         __u32           lk_opcode;
1367         __u32           lk_fsuid;
1368         __u32           lk_fsgid;
1369         __u32           lk_cap;
1370         __u32           lk_suppgid1;
1371         __u32           lk_suppgid2;
1372         struct lu_fid   lk_fid1;
1373         struct lu_fid   lk_fid2;
1374         __u64           lk_time;
1375         __u32           lk_bias;
1376         __u32           lk_padding_2;  /* also fix lustre_swab_mds_rec_link */
1377         __u32           lk_padding_3;  /* also fix lustre_swab_mds_rec_link */
1378         __u32           lk_padding_4;  /* also fix lustre_swab_mds_rec_link */
1379 };
1380
1381 extern void lustre_swab_mdt_rec_link (struct mdt_rec_link *lk);
1382
1383 struct mds_rec_unlink {
1384         __u32           ul_opcode;
1385         __u32           ul_fsuid;
1386         __u32           ul_fsgid;
1387         __u32           ul_cap;
1388         __u32           ul_suppgid;
1389         __u32           ul_mode;
1390         struct ll_fid   ul_fid1;
1391         struct ll_fid   ul_fid2;
1392         __u64           ul_time;
1393         __u32           ul_padding_1; /* also fix lustre_swab_mds_rec_unlink */
1394         __u32           ul_padding_2; /* also fix lustre_swab_mds_rec_unlink */
1395         __u32           ul_padding_3; /* also fix lustre_swab_mds_rec_unlink */
1396         __u32           ul_padding_4; /* also fix lustre_swab_mds_rec_unlink */
1397 };
1398
1399 extern void lustre_swab_mds_rec_unlink (struct mds_rec_unlink *ul);
1400
1401 struct mdt_rec_unlink {
1402         __u32           ul_opcode;
1403         __u32           ul_fsuid;
1404         __u32           ul_fsgid;
1405         __u32           ul_cap;
1406         __u32           ul_suppgid;
1407         __u32           ul_mode;
1408         struct lu_fid   ul_fid1;
1409         struct lu_fid   ul_fid2;
1410         __u64           ul_time;
1411         __u32           ul_bias;
1412         __u32           ul_padding_2; /* also fix lustre_swab_mds_rec_unlink */
1413         __u32           ul_padding_3; /* also fix lustre_swab_mds_rec_unlink */
1414         __u32           ul_padding_4; /* also fix lustre_swab_mds_rec_unlink */
1415 };
1416
1417 extern void lustre_swab_mdt_rec_unlink (struct mdt_rec_unlink *ul);
1418
1419 struct mds_rec_rename {
1420         __u32           rn_opcode;
1421         __u32           rn_fsuid;
1422         __u32           rn_fsgid;
1423         __u32           rn_cap;
1424         __u32           rn_suppgid1;
1425         __u32           rn_suppgid2;
1426         struct ll_fid   rn_fid1;
1427         struct ll_fid   rn_fid2;
1428         __u64           rn_time;
1429         __u32           rn_padding_1; /* also fix lustre_swab_mds_rec_rename */
1430         __u32           rn_padding_2; /* also fix lustre_swab_mds_rec_rename */
1431         __u32           rn_padding_3; /* also fix lustre_swab_mds_rec_rename */
1432         __u32           rn_padding_4; /* also fix lustre_swab_mds_rec_rename */
1433 };
1434
1435 extern void lustre_swab_mds_rec_rename (struct mds_rec_rename *rn);
1436
1437 struct mdt_rec_rename {
1438         __u32           rn_opcode;
1439         __u32           rn_fsuid;
1440         __u32           rn_fsgid;
1441         __u32           rn_cap;
1442         __u32           rn_suppgid1;
1443         __u32           rn_suppgid2;
1444         struct lu_fid   rn_fid1;
1445         struct lu_fid   rn_fid2;
1446         __u64           rn_time;
1447         __u32           rn_mode;      /* cross-ref rename has mode */
1448         __u32           rn_bias;      /* some operation flags */
1449         __u32           rn_padding_3; /* also fix lustre_swab_mdt_rec_rename */
1450         __u32           rn_padding_4; /* also fix lustre_swab_mdt_rec_rename */
1451 };
1452
1453 extern void lustre_swab_mdt_rec_rename (struct mdt_rec_rename *rn);
1454
1455 /* begin adding MDT by huanghua@clusterfs.com */
1456 struct lmv_desc {
1457         __u32 ld_tgt_count;                /* how many MDS's */
1458         __u32 ld_active_tgt_count;         /* how many active */
1459         struct obd_uuid ld_uuid;
1460 };
1461
1462 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
1463 /* end adding MDT by huanghua@clusterfs.com */
1464
1465 struct md_fld {
1466         seqno_t mf_seq;
1467         mdsno_t mf_mds;
1468 };
1469
1470 extern void lustre_swab_md_fld (struct md_fld *mf);
1471
1472 enum fld_rpc_opc {
1473         FLD_QUERY                       = 600,
1474         FLD_LAST_OPC,
1475         FLD_FIRST_OPC                   = FLD_QUERY
1476 };
1477
1478 enum seq_rpc_opc {
1479         SEQ_QUERY                       = 700,
1480         SEQ_LAST_OPC,
1481         SEQ_FIRST_OPC                   = SEQ_QUERY
1482 };
1483
1484 enum seq_op {
1485         SEQ_ALLOC_SUPER = 0,
1486         SEQ_ALLOC_META = 1
1487 };
1488
1489 /*
1490  *  LOV data structures
1491  */
1492
1493 #define LOV_MIN_STRIPE_SIZE 65536   /* maximum PAGE_SIZE (ia64), power of 2 */
1494 #define LOV_MAX_STRIPE_COUNT  160   /* until bug 4424 is fixed */
1495 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
1496
1497 #define LOV_MAX_UUID_BUFFER_SIZE  8192
1498 /* The size of the buffer the lov/mdc reserves for the
1499  * array of UUIDs returned by the MDS.  With the current
1500  * protocol, this will limit the max number of OSTs per LOV */
1501
1502 #define LOV_DESC_MAGIC 0xB0CCDE5C
1503
1504 /* LOV settings descriptor (should only contain static info) */
1505 struct lov_desc {
1506         __u32 ld_tgt_count;                /* how many OBD's */
1507         __u32 ld_active_tgt_count;         /* how many active */
1508         __u32 ld_default_stripe_count;     /* how many objects are used */
1509         __u32 ld_pattern;                  /* default PATTERN_RAID0 */
1510         __u64 ld_default_stripe_size;      /* in bytes */
1511         __u64 ld_default_stripe_offset;    /* in bytes */
1512         __u32 ld_padding_0;                /* unused */
1513         __u32 ld_qos_maxage;               /* in second */
1514         __u32 ld_padding_1;                /* also fix lustre_swab_lov_desc */
1515         __u32 ld_padding_2;                /* also fix lustre_swab_lov_desc */
1516         struct obd_uuid ld_uuid;
1517 };
1518
1519 #define ld_magic ld_active_tgt_count       /* for swabbing from llogs */
1520
1521 extern void lustre_swab_lov_desc (struct lov_desc *ld);
1522
1523 /*
1524  *   LDLM requests:
1525  */
1526 /* opcodes -- MUST be distinct from OST/MDS opcodes */
1527 typedef enum {
1528         LDLM_ENQUEUE     = 101,
1529         LDLM_CONVERT     = 102,
1530         LDLM_CANCEL      = 103,
1531         LDLM_BL_CALLBACK = 104,
1532         LDLM_CP_CALLBACK = 105,
1533         LDLM_GL_CALLBACK = 106,
1534         LDLM_LAST_OPC
1535 } ldlm_cmd_t;
1536 #define LDLM_FIRST_OPC LDLM_ENQUEUE
1537
1538 #define RES_NAME_SIZE 4
1539 struct ldlm_res_id {
1540         __u64 name[RES_NAME_SIZE];
1541 };
1542
1543 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
1544
1545 /* lock types */
1546 typedef enum {
1547         LCK_MINMODE = 0,
1548         LCK_EX      = 1,
1549         LCK_PW      = 2,
1550         LCK_PR      = 4,
1551         LCK_CW      = 8,
1552         LCK_CR      = 16,
1553         LCK_NL      = 32,
1554         LCK_GROUP   = 64,
1555         LCK_MAXMODE
1556 } ldlm_mode_t;
1557
1558 typedef enum {
1559         LDLM_PLAIN     = 10,
1560         LDLM_EXTENT    = 11,
1561         LDLM_FLOCK     = 12,
1562         LDLM_IBITS     = 13,
1563         LDLM_MAX_TYPE
1564 } ldlm_type_t;
1565
1566 #define LDLM_MIN_TYPE LDLM_PLAIN
1567
1568 struct ldlm_extent {
1569         __u64 start;
1570         __u64 end;
1571         __u64 gid;
1572 };
1573
1574 struct ldlm_inodebits {
1575         __u64 bits;
1576 };
1577
1578 struct ldlm_flock {
1579         __u64 start;
1580         __u64 end;
1581         __u64 blocking_export;  /* not actually used over the wire */
1582         __u32 blocking_pid;     /* not actually used over the wire */
1583         __u32 pid;
1584 };
1585
1586 /* it's important that the fields of the ldlm_extent structure match
1587  * the first fields of the ldlm_flock structure because there is only
1588  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
1589  * this ever changes we will need to swab the union differently based
1590  * on the resource type. */
1591
1592 typedef union {
1593         struct ldlm_extent l_extent;
1594         struct ldlm_flock  l_flock;
1595         struct ldlm_inodebits l_inodebits;
1596 } ldlm_policy_data_t;
1597
1598 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
1599
1600 struct ldlm_intent {
1601         __u64 opc;
1602 };
1603
1604 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
1605
1606 struct ldlm_resource_desc {
1607         ldlm_type_t lr_type;
1608         __u32 lr_padding;       /* also fix lustre_swab_ldlm_resource_desc */
1609         struct ldlm_res_id lr_name;
1610 };
1611
1612 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
1613
1614 struct ldlm_lock_desc {
1615         struct ldlm_resource_desc l_resource;
1616         ldlm_mode_t l_req_mode;
1617         ldlm_mode_t l_granted_mode;
1618         ldlm_policy_data_t l_policy_data;
1619 };
1620
1621 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
1622
1623 #define LDLM_LOCKREQ_HANDLES 2
1624 #define LDLM_ENQUEUE_CANCEL_OFF 1
1625
1626 struct ldlm_request {
1627         __u32 lock_flags;
1628         __u32 lock_count;
1629         struct ldlm_lock_desc lock_desc;
1630         struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
1631 };
1632
1633 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
1634
1635 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
1636  * Otherwise, 2 are available. */
1637 #define ldlm_request_bufsize(count,type)                                \
1638 ({                                                                      \
1639         int _avail = LDLM_LOCKREQ_HANDLES;                              \
1640         _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
1641         sizeof(struct ldlm_request) +                                   \
1642         (count > _avail ? count - _avail : 0) *                         \
1643         sizeof(struct lustre_handle);                                   \
1644 })
1645
1646 struct ldlm_reply {
1647         __u32 lock_flags;
1648         __u32 lock_padding;     /* also fix lustre_swab_ldlm_reply */
1649         struct ldlm_lock_desc lock_desc;
1650         struct lustre_handle lock_handle;
1651         __u64  lock_policy_res1;
1652         __u64  lock_policy_res2;
1653 };
1654
1655 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
1656
1657 /*
1658  * Opcodes for mountconf (mgs and mgc)
1659  */
1660 typedef enum {
1661         MGS_CONNECT = 250,
1662         MGS_DISCONNECT,
1663         MGS_EXCEPTION,         /* node died, etc. */
1664         MGS_TARGET_REG,        /* whenever target starts up */
1665         MGS_TARGET_DEL,
1666         MGS_SET_INFO,
1667         MGS_LAST_OPC
1668 } mgs_cmd_t;
1669 #define MGS_FIRST_OPC MGS_CONNECT
1670
1671 #define MGS_PARAM_MAXLEN 1024
1672 #define KEY_SET_INFO "set_info"
1673
1674 struct mgs_send_param {
1675         char             mgs_param[MGS_PARAM_MAXLEN];
1676 };
1677
1678 /* We pass this info to the MGS so it can write config logs */
1679 #define MTI_NAME_MAXLEN 64
1680 #define MTI_PARAM_MAXLEN 4096
1681 #define MTI_NIDS_MAX 32
1682 struct mgs_target_info {
1683         __u32            mti_lustre_ver;
1684         __u32            mti_stripe_index;
1685         __u32            mti_config_ver;
1686         __u32            mti_flags;
1687         __u32            mti_nid_count;
1688         __u32            padding;                    /* 64 bit align */
1689         char             mti_fsname[MTI_NAME_MAXLEN];
1690         char             mti_svname[MTI_NAME_MAXLEN];
1691         char             mti_uuid[sizeof(struct obd_uuid)];
1692         __u64            mti_nids[MTI_NIDS_MAX];     /* host nids (lnet_nid_t)*/
1693         char             mti_params[MTI_PARAM_MAXLEN];
1694 };
1695
1696 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
1697
1698 /* Config marker flags (in config log) */
1699 #define CM_START       0x01
1700 #define CM_END         0x02
1701 #define CM_SKIP        0x04
1702 #define CM_UPGRADE146  0x08
1703 #define CM_EXCLUDE     0x10
1704 #define CM_START_SKIP (CM_START | CM_SKIP)
1705
1706 struct cfg_marker {
1707         __u32             cm_step;       /* aka config version */
1708         __u32             cm_flags;
1709         __u32             cm_vers;       /* lustre release version number */
1710         __u32             padding;       /* 64 bit align */
1711         time_t            cm_createtime; /*when this record was first created */
1712         time_t            cm_canceltime; /*when this record is no longer valid*/
1713         char              cm_tgtname[MTI_NAME_MAXLEN];
1714         char              cm_comment[MTI_NAME_MAXLEN];
1715 };
1716
1717 /*
1718  * Opcodes for multiple servers.
1719  */
1720
1721 typedef enum {
1722         OBD_PING = 400,
1723         OBD_LOG_CANCEL,
1724         OBD_QC_CALLBACK,
1725         OBD_LAST_OPC
1726 } obd_cmd_t;
1727 #define OBD_FIRST_OPC OBD_PING
1728
1729 /* catalog of log objects */
1730
1731 /* Identifier for a single log object */
1732 struct llog_logid {
1733         __u64                   lgl_oid;
1734         __u64                   lgl_ogr;
1735         __u32                   lgl_ogen;
1736 } __attribute__((packed));
1737
1738 /* Records written to the CATALOGS list */
1739 #define CATLIST "CATALOGS"
1740 struct llog_catid {
1741         struct llog_logid       lci_logid;
1742         __u32                   lci_padding1;
1743         __u32                   lci_padding2;
1744         __u32                   lci_padding3;
1745 } __attribute__((packed));
1746
1747 /*join file lov mds md*/
1748 struct lov_mds_md_join {
1749         struct lov_mds_md lmmj_md;
1750         /*join private info*/
1751         struct llog_logid lmmj_array_id; /*array object id*/
1752         __u32  lmmj_extent_count;        /*array extent count*/
1753 };
1754
1755 /* Log data record types - there is no specific reason that these need to
1756  * be related to the RPC opcodes, but no reason not to (may be handy later?)
1757  */
1758 #define LLOG_OP_MAGIC 0x10600000
1759 #define LLOG_OP_MASK  0xfff00000
1760
1761 typedef enum {
1762         LLOG_PAD_MAGIC   = LLOG_OP_MAGIC | 0x00000,
1763         OST_SZ_REC       = LLOG_OP_MAGIC | 0x00f00,
1764         OST_RAID1_REC    = LLOG_OP_MAGIC | 0x01000,
1765         MDS_UNLINK_REC   = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_UNLINK,
1766         MDS_SETATTR_REC  = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_SETATTR,
1767         OBD_CFG_REC      = LLOG_OP_MAGIC | 0x20000,
1768         PTL_CFG_REC      = LLOG_OP_MAGIC | 0x30000, /* obsolete */
1769         LLOG_GEN_REC     = LLOG_OP_MAGIC | 0x40000,
1770         LLOG_JOIN_REC    = LLOG_OP_MAGIC | 0x50000,
1771         LLOG_HDR_MAGIC   = LLOG_OP_MAGIC | 0x45539,
1772         LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
1773 } llog_op_type;
1774
1775 /*
1776  * for now, continue to support old pad records which have 0 for their
1777  * type but still need to be swabbed for their length
1778  */
1779 #define LLOG_REC_HDR_NEEDS_SWABBING(r)                                  \
1780         (((r)->lrh_type & __swab32(LLOG_OP_MASK)) ==                    \
1781          __swab32(LLOG_OP_MAGIC) ||                                     \
1782          (((r)->lrh_type == 0) && ((r)->lrh_len > LLOG_CHUNK_SIZE)))
1783
1784 /* Log record header - stored in little endian order.
1785  * Each record must start with this struct, end with a llog_rec_tail,
1786  * and be a multiple of 256 bits in size.
1787  */
1788 struct llog_rec_hdr {
1789         __u32                   lrh_len;
1790         __u32                   lrh_index;
1791         __u32                   lrh_type;
1792         __u32                   padding;
1793 };
1794
1795 struct llog_rec_tail {
1796         __u32 lrt_len;
1797         __u32 lrt_index;
1798 };
1799
1800 struct llog_logid_rec {
1801         struct llog_rec_hdr     lid_hdr;
1802         struct llog_logid       lid_id;
1803         __u32                   padding1;
1804         __u32                   padding2;
1805         __u32                   padding3;
1806         __u32                   padding4;
1807         __u32                   padding5;
1808         struct llog_rec_tail    lid_tail;
1809 } __attribute__((packed));
1810
1811 /* MDS extent description
1812  * It is for joined file extent info, each extent info for joined file
1813  * just like (start, end, lmm).
1814  */
1815 struct mds_extent_desc {
1816         __u64                   med_start; /* extent start */
1817         __u64                   med_len;   /* extent length */
1818         struct lov_mds_md       med_lmm;   /* extent's lmm  */
1819 };
1820 /*Joined file array extent log record*/
1821 struct llog_array_rec {
1822         struct llog_rec_hdr     lmr_hdr;
1823         struct mds_extent_desc  lmr_med;
1824         struct llog_rec_tail    lmr_tail;
1825 };
1826
1827 struct llog_create_rec {
1828         struct llog_rec_hdr     lcr_hdr;
1829         struct ll_fid           lcr_fid;
1830         obd_id                  lcr_oid;
1831         obd_count               lcr_ogen;
1832         __u32                   padding;
1833         struct llog_rec_tail    lcr_tail;
1834 } __attribute__((packed));
1835
1836 struct llog_orphan_rec {
1837         struct llog_rec_hdr     lor_hdr;
1838         obd_id                  lor_oid;
1839         obd_count               lor_ogen;
1840         __u32                   padding;
1841         struct llog_rec_tail    lor_tail;
1842 } __attribute__((packed));
1843
1844 struct llog_unlink_rec {
1845         struct llog_rec_hdr     lur_hdr;
1846         obd_id                  lur_oid;
1847         obd_count               lur_ogen;
1848         __u32                   padding;
1849         struct llog_rec_tail    lur_tail;
1850 } __attribute__((packed));
1851
1852 struct llog_setattr_rec {
1853         struct llog_rec_hdr     lsr_hdr;
1854         obd_id                  lsr_oid;
1855         obd_count               lsr_ogen;
1856         __u32                   lsr_uid;
1857         __u32                   lsr_gid;
1858         __u32                   padding;
1859         struct llog_rec_tail    lsr_tail;
1860 } __attribute__((packed));
1861
1862 struct llog_size_change_rec {
1863         struct llog_rec_hdr     lsc_hdr;
1864         struct ll_fid           lsc_fid;
1865         __u32                   lsc_ioepoch;
1866         __u32                   padding;
1867         struct llog_rec_tail    lsc_tail;
1868 } __attribute__((packed));
1869
1870 struct llog_gen {
1871         __u64 mnt_cnt;
1872         __u64 conn_cnt;
1873 } __attribute__((packed));
1874
1875 struct llog_gen_rec {
1876         struct llog_rec_hdr     lgr_hdr;
1877         struct llog_gen         lgr_gen;
1878         struct llog_rec_tail    lgr_tail;
1879 };
1880 /* On-disk header structure of each log object, stored in little endian order */
1881 #define LLOG_CHUNK_SIZE         8192
1882 #define LLOG_HEADER_SIZE        (96)
1883 #define LLOG_BITMAP_BYTES       (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
1884
1885 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
1886
1887 /* flags for the logs */
1888 #define LLOG_F_ZAP_WHEN_EMPTY   0x1
1889 #define LLOG_F_IS_CAT           0x2
1890 #define LLOG_F_IS_PLAIN         0x4
1891
1892 struct llog_log_hdr {
1893         struct llog_rec_hdr     llh_hdr;
1894         __u64                   llh_timestamp;
1895         __u32                   llh_count;
1896         __u32                   llh_bitmap_offset;
1897         __u32                   llh_size;
1898         __u32                   llh_flags;
1899         __u32                   llh_cat_idx;
1900         /* for a catalog the first plain slot is next to it */
1901         struct obd_uuid         llh_tgtuuid;
1902         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
1903         __u32                   llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
1904         struct llog_rec_tail    llh_tail;
1905 } __attribute__((packed));
1906
1907 #define LLOG_BITMAP_SIZE(llh)  ((llh->llh_hdr.lrh_len -         \
1908                                  llh->llh_bitmap_offset -       \
1909                                  sizeof(llh->llh_tail)) * 8)
1910
1911 /* log cookies are used to reference a specific log file and a record therein */
1912 struct llog_cookie {
1913         struct llog_logid       lgc_lgl;
1914         __u32                   lgc_subsys;
1915         __u32                   lgc_index;
1916         __u32                   lgc_padding;
1917 } __attribute__((packed));
1918
1919 /* llog protocol */
1920 enum llogd_rpc_ops {
1921         LLOG_ORIGIN_HANDLE_CREATE       = 501,
1922         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
1923         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
1924         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
1925         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
1926         LLOG_ORIGIN_CONNECT             = 506,
1927         LLOG_CATINFO                    = 507,  /* for lfs catinfo */
1928         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
1929         LLOG_ORIGIN_HANDLE_DESTROY      = 509,  /* for destroy llog object*/
1930         LLOG_LAST_OPC,
1931         LLOG_FIRST_OPC                  = LLOG_ORIGIN_HANDLE_CREATE
1932 };
1933
1934 struct llogd_body {
1935         struct llog_logid  lgd_logid;
1936         __u32 lgd_ctxt_idx;
1937         __u32 lgd_llh_flags;
1938         __u32 lgd_index;
1939         __u32 lgd_saved_index;
1940         __u32 lgd_len;
1941         __u64 lgd_cur_offset;
1942 } __attribute__((packed));
1943
1944 struct llogd_conn_body {
1945         struct llog_gen         lgdc_gen;
1946         struct llog_logid       lgdc_logid;
1947         __u32                   lgdc_ctxt_idx;
1948 } __attribute__((packed));
1949
1950 struct lov_user_ost_data_join {   /* per-stripe data structure */
1951         __u64 l_extent_start;     /* extent start*/
1952         __u64 l_extent_end;       /* extent end*/
1953         __u64 l_object_id;        /* OST object ID */
1954         __u64 l_object_gr;        /* OST object group (creating MDS number) */
1955         __u32 l_ost_gen;          /* generation of this OST index */
1956         __u32 l_ost_idx;          /* OST index in LOV */
1957 } __attribute__((packed));
1958
1959 struct lov_user_md_join {         /* LOV EA user data (host-endian) */
1960         __u32 lmm_magic;          /* magic number = LOV_MAGIC_JOIN */
1961         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1962         __u64 lmm_object_id;      /* LOV object ID */
1963         __u64 lmm_object_gr;      /* LOV object group */
1964         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1965         __u32 lmm_stripe_count;   /* num stripes in use for this object */
1966         __u32 lmm_extent_count;   /* extent count of lmm*/
1967         __u64 lmm_tree_id;        /* mds tree object id */
1968         __u64 lmm_tree_gen;       /* mds tree object gen */
1969         struct llog_logid lmm_array_id; /* mds extent desc llog object id */
1970         struct lov_user_ost_data_join lmm_objects[0]; /* per-stripe data */
1971 } __attribute__((packed));
1972
1973 extern void lustre_swab_lov_user_md(struct lov_user_md *lum);
1974 extern void lustre_swab_lov_user_md_objects(struct lov_user_md *lum);
1975 extern void lustre_swab_lov_user_md_join(struct lov_user_md_join *lumj);
1976
1977 /* llog_swab.c */
1978 extern void lustre_swab_llogd_body (struct llogd_body *d);
1979 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
1980 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
1981 extern void lustre_swab_llog_rec(struct llog_rec_hdr  *rec,
1982                                  struct llog_rec_tail *tail);
1983
1984 struct lustre_cfg;
1985 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
1986
1987 /* quota. fixed by tianzy for bug10707 */
1988 #define QUOTA_IS_GRP   0X1UL  /* 0 is user, 1 is group. Used by qd_flags*/
1989 #define QUOTA_IS_BLOCK 0x2UL  /* 0 is inode, 1 is block. Used by qd_flags*/
1990
1991 struct qunit_data {
1992         __u32 qd_id; /* ID appiles to (uid, gid) */
1993         __u32 qd_flags; /* Quota type (USRQUOTA, GRPQUOTA) occupy one bit;
1994                          * Block quota or file quota occupy one bit */
1995         __u64 qd_count; /* acquire/release count (bytes for block quota) */
1996 };
1997
1998 struct qunit_data_old {
1999         __u32 qd_id;    /* ID appiles to (uid, gid) */
2000         __u32 qd_type;  /* Quota type (USRQUOTA, GRPQUOTA) */
2001         __u32 qd_count; /* acquire/release count (bytes for block quota) */
2002         __u32 qd_isblk; /* Block quota or file quota */
2003 };
2004
2005 extern void lustre_swab_qdata(struct qunit_data *d);
2006 extern void lustre_swab_qdata_old(struct qunit_data_old *d);
2007 extern struct qunit_data *lustre_quota_old_to_new(struct qunit_data_old *d);
2008 extern struct qunit_data_old *lustre_quota_new_to_old(struct qunit_data *d);
2009
2010 typedef enum {
2011         QUOTA_DQACQ     = 601,
2012         QUOTA_DQREL     = 602,
2013 } quota_cmd_t;
2014
2015 #define JOIN_FILE_ALIGN 4096
2016
2017 /* security opcodes */
2018 typedef enum {
2019         SEC_CTX_INIT            = 801,
2020         SEC_CTX_INIT_CONT       = 802,
2021         SEC_CTX_FINI            = 803,
2022         SEC_LAST_OPC,
2023         SEC_FIRST_OPC           = SEC_CTX_INIT
2024 } sec_cmd_t;
2025
2026 /*
2027  * capa related definitions
2028  */
2029 #define CAPA_HMAC_MAX_LEN       64
2030 #define CAPA_HMAC_KEY_MAX_LEN   56
2031
2032 /* NB take care when changing the sequence of elements this struct,
2033  * because the offset info is used in find_capa() */
2034 struct lustre_capa {
2035         struct lu_fid   lc_fid;     /* fid */
2036         __u64           lc_opc;     /* operations allowed */
2037         __u32           lc_uid;     /* uid, it is obsolete, but maybe used in
2038                                      * future, reserve it for 64-bits aligned.*/
2039         __u32           lc_flags;   /* HMAC algorithm & flags */
2040         __u32           lc_keyid;   /* key used for the capability */
2041         __u32           lc_timeout; /* capa timeout value (sec) */
2042         __u64           lc_expiry;  /* expiry time (sec) */
2043         __u8            lc_hmac[CAPA_HMAC_MAX_LEN];   /* HMAC */
2044 } __attribute__((packed));
2045
2046 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
2047
2048 /* lustre_capa.lc_opc */
2049 enum {
2050         CAPA_OPC_BODY_WRITE   = 1<<0,  /* write object data */
2051         CAPA_OPC_BODY_READ    = 1<<1,  /* read object data */
2052         CAPA_OPC_INDEX_LOOKUP = 1<<2,  /* lookup object fid */
2053         CAPA_OPC_INDEX_INSERT = 1<<3,  /* insert object fid */
2054         CAPA_OPC_INDEX_DELETE = 1<<4,  /* delete object fid */
2055         CAPA_OPC_OSS_WRITE    = 1<<5,  /* write oss object data */
2056         CAPA_OPC_OSS_READ     = 1<<6,  /* read oss object data */
2057         CAPA_OPC_OSS_TRUNC    = 1<<7,  /* truncate oss object */
2058         CAPA_OPC_META_WRITE   = 1<<8,  /* write object meta data */
2059         CAPA_OPC_META_READ    = 1<<9,  /* read object meta data */
2060
2061 };
2062
2063 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
2064 #define CAPA_OPC_MDS_ONLY                                                   \
2065         (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
2066          CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
2067 #define CAPA_OPC_OSS_ONLY                                                   \
2068         (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC)
2069 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
2070 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
2071
2072 /* MDS capability covers object capability for operations of body r/w
2073  * (dir readpage/sendpage), index lookup/insert/delete and meta data r/w,
2074  * while OSS capability only covers object capability for operations of
2075  * oss data(file content) r/w/truncate.
2076  */
2077 static inline int capa_for_mds(struct lustre_capa *c)
2078 {
2079         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) != 0;
2080 }
2081
2082 static inline int capa_for_oss(struct lustre_capa *c)
2083 {
2084         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) == 0;
2085 }
2086
2087 /* lustre_capa.lc_hmac_alg */
2088 enum {
2089         CAPA_HMAC_ALG_SHA1 = 1, /* sha1 algorithm */
2090         CAPA_HMAC_ALG_MAX,
2091 };
2092
2093 #define CAPA_FL_MASK            0x00ffffff
2094 #define CAPA_HMAC_ALG_MASK      0xff000000
2095
2096 struct lustre_capa_key {
2097         __u64   lk_mdsid;     /* mds# */
2098         __u32   lk_keyid;     /* key# */
2099         __u32   lk_padding;
2100         __u8    lk_key[CAPA_HMAC_KEY_MAX_LEN];    /* key */
2101 } __attribute__((packed));
2102
2103 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
2104
2105 /* quota check function */
2106 #define QUOTA_RET_OK           0 /* return successfully */
2107 #define QUOTA_RET_NOQUOTA      1 /* not support quota */
2108 #define QUOTA_RET_NOLIMIT      2 /* quota limit isn't set */
2109 #define QUOTA_RET_ACQUOTA      3 /* need to acquire extra quota */
2110 #endif