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