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