Whamcloud - gitweb
b=14836
[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 #define OBD_CONNECT_LOV_V3    0x100000000ULL /* client supports lov v3 ea */
611
612 /* also update obd_connect_names[] for lprocfs_rd_connect_flags()
613  * and lustre/utils/wirecheck.c */
614
615 #ifdef HAVE_LRU_RESIZE_SUPPORT
616 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
617 #else
618 #define LRU_RESIZE_CONNECT_FLAG 0
619 #endif
620
621 #define MDT_CONNECT_SUPPORTED  (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
622                                 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
623                                 OBD_CONNECT_IBITS | OBD_CONNECT_JOIN | \
624                                 OBD_CONNECT_NODEVOH |/* OBD_CONNECT_ATTRFID |*/\
625                                 OBD_CONNECT_LCL_CLIENT | \
626                                 OBD_CONNECT_RMT_CLIENT | \
627                                 OBD_CONNECT_MDS_CAPA | OBD_CONNECT_OSS_CAPA | \
628                                 OBD_CONNECT_MDS_MDS | OBD_CONNECT_CANCELSET | \
629                                 OBD_CONNECT_FID | \
630                                 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_AT | \
631                                 OBD_CONNECT_LOV_V3)
632 #define OST_CONNECT_SUPPORTED  (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
633                                 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
634                                 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
635                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_QUOTA64 | \
636                                 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_CANCELSET | \
637                                 OBD_CONNECT_CKSUM | LRU_RESIZE_CONNECT_FLAG | \
638                                 OBD_CONNECT_AT)
639 #define ECHO_CONNECT_SUPPORTED (0)
640 #define MGS_CONNECT_SUPPORTED  (OBD_CONNECT_VERSION | OBD_CONNECT_AT)
641
642 #define MAX_QUOTA_COUNT32 (0xffffffffULL)
643
644 #define OBD_OCD_VERSION(major,minor,patch,fix) (((major)<<24) + ((minor)<<16) +\
645                                                 ((patch)<<8) + (fix))
646 #define OBD_OCD_VERSION_MAJOR(version) ((int)((version)>>24)&255)
647 #define OBD_OCD_VERSION_MINOR(version) ((int)((version)>>16)&255)
648 #define OBD_OCD_VERSION_PATCH(version) ((int)((version)>>8)&255)
649 #define OBD_OCD_VERSION_FIX(version)   ((int)(version)&255)
650
651 /* This structure is used for both request and reply.
652  *
653  * If we eventually have separate connect data for different types, which we
654  * almost certainly will, then perhaps we stick a union in here. */
655 struct obd_connect_data {
656         __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
657         __u32 ocd_version;       /* lustre release version number */
658         __u32 ocd_grant;         /* initial cache grant amount (bytes) */
659         __u32 ocd_index;         /* LOV index to connect to */
660         __u32 ocd_brw_size;      /* Maximum BRW size in bytes */
661         __u64 ocd_ibits_known;   /* inode bits this client understands */
662         __u32 ocd_nllu;          /* non-local-lustre-user */
663         __u32 ocd_nllg;          /* non-local-lustre-group */
664         __u64 ocd_transno;       /* first transno from client to be replayed */
665         __u32 ocd_group;         /* MDS group on OST */
666         __u32 ocd_cksum_types;   /* supported checksum algorithms */
667         __u64 padding1;          /* also fix lustre_swab_connect */
668         __u64 padding2;          /* also fix lustre_swab_connect */
669 };
670
671 extern void lustre_swab_connect(struct obd_connect_data *ocd);
672
673 /*
674  * Supported checksum algorithms. Up to 32 checksum types are supported.
675  * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
676  * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
677  * algorithm and also the OBD_FL_CKSUM* flags.
678  */
679 typedef enum {
680         OBD_CKSUM_CRC32 = 0x00000001,
681         OBD_CKSUM_ADLER = 0x00000002,
682 } cksum_type_t;
683
684 /*
685  *   OST requests: OBDO & OBD request records
686  */
687
688 /* opcodes */
689 typedef enum {
690         OST_REPLY      =  0,       /* reply ? */
691         OST_GETATTR    =  1,
692         OST_SETATTR    =  2,
693         OST_READ       =  3,
694         OST_WRITE      =  4,
695         OST_CREATE     =  5,
696         OST_DESTROY    =  6,
697         OST_GET_INFO   =  7,
698         OST_CONNECT    =  8,
699         OST_DISCONNECT =  9,
700         OST_PUNCH      = 10,
701         OST_OPEN       = 11,
702         OST_CLOSE      = 12,
703         OST_STATFS     = 13,
704         OST_SYNC       = 16,
705         OST_SET_INFO   = 17,
706         OST_QUOTACHECK = 18,
707         OST_QUOTACTL   = 19,
708         OST_LAST_OPC
709 } ost_cmd_t;
710 #define OST_FIRST_OPC  OST_REPLY
711
712 typedef __u64 obd_id;
713 typedef __u64 obd_gr;
714 typedef __u64 obd_time;
715 typedef __u64 obd_size;
716 typedef __u64 obd_off;
717 typedef __u64 obd_blocks;
718 typedef __u32 obd_blksize;
719 typedef __u32 obd_mode;
720 typedef __u32 obd_uid;
721 typedef __u32 obd_gid;
722 typedef __u32 obd_flag;
723 typedef __u64 obd_valid;
724 typedef __u32 obd_count;
725
726 #define OBD_FL_INLINEDATA    (0x00000001)
727 #define OBD_FL_OBDMDEXISTS   (0x00000002)
728 #define OBD_FL_DELORPHAN     (0x00000004) /* if set in o_flags delete orphans */
729 #define OBD_FL_NORPC         (0x00000008) /* set in o_flags do in OSC not OST */
730 #define OBD_FL_IDONLY        (0x00000010) /* set in o_flags only adjust obj id*/
731 #define OBD_FL_RECREATE_OBJS (0x00000020) /* recreate missing obj */
732 #define OBD_FL_DEBUG_CHECK   (0x00000040) /* echo client/server debug check */
733 #define OBD_FL_NO_USRQUOTA   (0x00000100) /* the object's owner is over quota */
734 #define OBD_FL_NO_GRPQUOTA   (0x00000200) /* the object's group is over quota */
735
736 /*
737  * Set this to delegate DLM locking during obd_punch() to the OSTs. Only OSTs
738  * that declared OBD_CONNECT_TRUNCLOCK in their connect flags support this
739  * functionality.
740  */
741 #define OBD_FL_TRUNCLOCK     (0x00000800)
742
743 /*
744  * Checksum types
745  */
746 #define OBD_FL_CKSUM_CRC32    (0x00001000)
747 #define OBD_FL_CKSUM_ADLER    (0x00002000)
748 #define OBD_FL_CKSUM_ALL      (OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER)
749
750 #define LOV_MAGIC_V1      0x0BD10BD0
751 #define LOV_MAGIC         LOV_MAGIC_V1
752 #define LOV_MAGIC_JOIN    0x0BD20BD0
753 #define LOV_MAGIC_V3      0x0BD30BD0
754
755 #define LOV_PATTERN_RAID0 0x001   /* stripes are used round-robin */
756 #define LOV_PATTERN_RAID1 0x002   /* stripes are mirrors of each other */
757 #define LOV_PATTERN_FIRST 0x100   /* first stripe is not in round-robin */
758 #define LOV_PATTERN_CMOBD 0x200
759
760 #define LOV_OBJECT_GROUP_DEFAULT ~0ULL
761 #define LOV_OBJECT_GROUP_CLEAR 0ULL
762
763 #define MAXPOOLNAME 16
764 #define POOLNAMEF "%.16s"
765
766 #define lov_ost_data lov_ost_data_v1
767 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
768         __u64 l_object_id;        /* OST object ID */
769         __u64 l_object_gr;        /* OST object group (creating MDS number) */
770         __u32 l_ost_gen;          /* generation of this l_ost_idx */
771         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
772 };
773
774 #define lov_mds_md lov_mds_md_v1
775 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
776         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
777         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
778         __u64 lmm_object_id;      /* LOV object ID */
779         __u64 lmm_object_gr;      /* LOV object group */
780         __u32 lmm_stripe_size;    /* size of stripe in bytes */
781         __u32 lmm_stripe_count;   /* num stripes in use for this object */
782         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
783 };
784
785 /* extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm); */
786
787 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
788 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
789
790 #define XATTR_NAME_ACL_ACCESS   "system.posix_acl_access"
791 #define XATTR_NAME_ACL_DEFAULT  "system.posix_acl_default"
792 #define XATTR_NAME_LOV          "trusted.lov"
793
794 struct lov_mds_md_v3 {            /* LOV EA mds/wire data (little-endian) */
795         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V3 */
796         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
797         __u64 lmm_object_id;      /* LOV object ID */
798         __u64 lmm_object_gr;      /* LOV object group */
799         __u32 lmm_stripe_size;    /* size of stripe in bytes */
800         __u32 lmm_stripe_count;   /* num stripes in use for this object */
801         char  lmm_pool_name[MAXPOOLNAME]; /* must be 32bit aligned */
802         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
803 };
804
805
806 #define OBD_MD_FLID        (0x00000001ULL) /* object ID */
807 #define OBD_MD_FLATIME     (0x00000002ULL) /* access time */
808 #define OBD_MD_FLMTIME     (0x00000004ULL) /* data modification time */
809 #define OBD_MD_FLCTIME     (0x00000008ULL) /* change time */
810 #define OBD_MD_FLSIZE      (0x00000010ULL) /* size */
811 #define OBD_MD_FLBLOCKS    (0x00000020ULL) /* allocated blocks count */
812 #define OBD_MD_FLBLKSZ     (0x00000040ULL) /* block size */
813 #define OBD_MD_FLMODE      (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
814 #define OBD_MD_FLTYPE      (0x00000100ULL) /* object type (mode & S_IFMT) */
815 #define OBD_MD_FLUID       (0x00000200ULL) /* user ID */
816 #define OBD_MD_FLGID       (0x00000400ULL) /* group ID */
817 #define OBD_MD_FLFLAGS     (0x00000800ULL) /* flags word */
818 #define OBD_MD_FLNLINK     (0x00002000ULL) /* link count */
819 #define OBD_MD_FLGENER     (0x00004000ULL) /* generation number */
820 /*#define OBD_MD_FLINLINE    (0x00008000ULL)  inline data. used until 1.6.5 */
821 #define OBD_MD_FLRDEV      (0x00010000ULL) /* device number */
822 #define OBD_MD_FLEASIZE    (0x00020000ULL) /* extended attribute data */
823 #define OBD_MD_LINKNAME    (0x00040000ULL) /* symbolic link target */
824 #define OBD_MD_FLHANDLE    (0x00080000ULL) /* file/lock handle */
825 #define OBD_MD_FLCKSUM     (0x00100000ULL) /* bulk data checksum */
826 #define OBD_MD_FLQOS       (0x00200000ULL) /* quality of service stats */
827 #define OBD_MD_FLOSCOPQ    (0x00400000ULL) /* osc opaque data */
828 #define OBD_MD_FLCOOKIE    (0x00800000ULL) /* log cancellation cookie */
829 #define OBD_MD_FLGROUP     (0x01000000ULL) /* group */
830 #define OBD_MD_FLFID       (0x02000000ULL) /* ->ost write inline fid */
831 #define OBD_MD_FLEPOCH     (0x04000000ULL) /* ->ost write easize is epoch */
832                                            /* ->mds if epoch opens or closes */
833 #define OBD_MD_FLGRANT     (0x08000000ULL) /* ost preallocation space grant */
834 #define OBD_MD_FLDIREA     (0x10000000ULL) /* dir's extended attribute data */
835 #define OBD_MD_FLUSRQUOTA  (0x20000000ULL) /* over quota flags sent from ost */
836 #define OBD_MD_FLGRPQUOTA  (0x40000000ULL) /* over quota flags sent from ost */
837 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
838
839 #define OBD_MD_MDS         (0x0000000100000000ULL) /* where an inode lives on */
840 #define OBD_MD_REINT       (0x0000000200000000ULL) /* reintegrate oa */
841 #define OBD_MD_MEA         (0x0000000400000000ULL) /* CMD split EA  */
842
843 #define OBD_MD_FLXATTR     (0x0000001000000000ULL) /* xattr */
844 #define OBD_MD_FLXATTRLS   (0x0000002000000000ULL) /* xattr list */
845 #define OBD_MD_FLXATTRRM   (0x0000004000000000ULL) /* xattr remove */
846 #define OBD_MD_FLACL       (0x0000008000000000ULL) /* ACL */
847 #define OBD_MD_FLRMTPERM   (0x0000010000000000ULL) /* remote permission */
848 #define OBD_MD_FLMDSCAPA   (0x0000020000000000ULL) /* MDS capability */
849 #define OBD_MD_FLOSSCAPA   (0x0000040000000000ULL) /* OSS capability */
850 #define OBD_MD_FLCKSPLIT   (0x0000080000000000ULL) /* Check split on server */
851 #define OBD_MD_FLCROSSREF  (0x0000100000000000ULL) /* Cross-ref case */
852
853 #define OBD_MD_FLRMTLSETFACL    (0x0001000000000000ULL) /* lfs lsetfacl case */
854 #define OBD_MD_FLRMTLGETFACL    (0x0002000000000000ULL) /* lfs lgetfacl case */
855 #define OBD_MD_FLRMTRSETFACL    (0x0004000000000000ULL) /* lfs rsetfacl case */
856 #define OBD_MD_FLRMTRGETFACL    (0x0008000000000000ULL) /* lfs rgetfacl case */
857
858 #define OBD_MD_FLGETATTR (OBD_MD_FLID    | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
859                           OBD_MD_FLCTIME | OBD_MD_FLSIZE  | OBD_MD_FLBLKSZ | \
860                           OBD_MD_FLMODE  | OBD_MD_FLTYPE  | OBD_MD_FLUID   | \
861                           OBD_MD_FLGID   | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
862                           OBD_MD_FLGENER | OBD_MD_FLRDEV  | OBD_MD_FLGROUP)
863
864 /* don't forget obdo_fid which is way down at the bottom so it can
865  * come after the definition of llog_cookie */
866
867 struct obd_statfs {
868         __u64           os_type;
869         __u64           os_blocks;
870         __u64           os_bfree;
871         __u64           os_bavail;
872         __u64           os_files;
873         __u64           os_ffree;
874         __u8            os_fsid[40];
875         __u32           os_bsize;
876         __u32           os_namelen;
877         __u64           os_maxbytes;
878         __u32           os_state;       /* positive error code on server */
879         __u32           os_spare1;
880         __u32           os_spare2;
881         __u32           os_spare3;
882         __u32           os_spare4;
883         __u32           os_spare5;
884         __u32           os_spare6;
885         __u32           os_spare7;
886         __u32           os_spare8;
887         __u32           os_spare9;
888 };
889
890 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
891 #define OBD_STATFS_NODELAY      0x0001  /* requests should be send without delay
892                                          * and resends for avoid deadlocks */
893
894 #define OBD_STATFS_FROM_CACHE   0x0002  /* the statfs callback should not update
895                                          * obd_osfs_age */
896
897 /* ost_body.data values for OST_BRW */
898
899 #define OBD_BRW_READ            0x01
900 #define OBD_BRW_WRITE           0x02
901 #define OBD_BRW_RWMASK          (OBD_BRW_READ | OBD_BRW_WRITE)
902 #define OBD_BRW_SYNC            0x08
903 #define OBD_BRW_CHECK           0x10
904 #define OBD_BRW_FROM_GRANT      0x20 /* the osc manages this under llite */
905 #define OBD_BRW_GRANTED         0x40 /* the ost manages this */
906 #define OBD_BRW_DROP            0x80 /* drop the page after IO */
907 #define OBD_BRW_NOQUOTA        0x100
908 #define OBD_BRW_SRVLOCK        0x200 /* Client holds no lock over this page */
909
910 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
911
912 #define OST_MIN_PRECREATE 32
913 #define OST_MAX_PRECREATE 20000
914
915 struct obd_ioobj {
916         obd_id               ioo_id;
917         obd_gr               ioo_gr;
918         __u32                ioo_type;
919         __u32                ioo_bufcnt;
920 };
921
922 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
923
924 /* multiple of 8 bytes => can array */
925 struct niobuf_remote {
926         __u64 offset;
927         __u32 len;
928         __u32 flags;
929 };
930
931 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
932
933 /* lock value block communicated between the filter and llite */
934
935 /* OST_LVB_ERR_INIT is needed because the return code in rc is 
936  * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
937 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
938 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
939 #define OST_LVB_IS_ERR(blocks)                                          \
940         ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
941 #define OST_LVB_SET_ERR(blocks, rc)                                     \
942         do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
943 #define OST_LVB_GET_ERR(blocks)    (int)(blocks - OST_LVB_ERR_INIT)
944
945 struct ost_lvb {
946         __u64 lvb_size;
947         __u64 lvb_mtime;
948         __u64 lvb_atime;
949         __u64 lvb_ctime;
950         __u64 lvb_blocks;
951 };
952
953 extern void lustre_swab_ost_lvb(struct ost_lvb *);
954
955 /*
956  *   MDS REQ RECORDS
957  */
958
959 /* opcodes */
960 typedef enum {
961         MDS_GETATTR      = 33,
962         MDS_GETATTR_NAME = 34,
963         MDS_CLOSE        = 35,
964         MDS_REINT        = 36,
965         MDS_READPAGE     = 37,
966         MDS_CONNECT      = 38,
967         MDS_DISCONNECT   = 39,
968         MDS_GETSTATUS    = 40,
969         MDS_STATFS       = 41,
970         MDS_PIN          = 42,
971         MDS_UNPIN        = 43,
972         MDS_SYNC         = 44,
973         MDS_DONE_WRITING = 45,
974         MDS_SET_INFO     = 46,
975         MDS_QUOTACHECK   = 47,
976         MDS_QUOTACTL     = 48,
977         MDS_GETXATTR     = 49,
978         MDS_SETXATTR     = 50, /* obsolete, now it's MDS_REINT op */
979         MDS_WRITEPAGE    = 51,
980         MDS_IS_SUBDIR    = 52,
981         MDS_LAST_OPC
982 } mds_cmd_t;
983
984 #define MDS_FIRST_OPC    MDS_GETATTR
985
986 /*
987  * Do not exceed 63
988  */
989
990 typedef enum {
991         REINT_SETATTR  = 1,
992         REINT_CREATE   = 2,
993         REINT_LINK     = 3,
994         REINT_UNLINK   = 4,
995         REINT_RENAME   = 5,
996         REINT_OPEN     = 6,
997         REINT_SETXATTR = 7,
998 //      REINT_CLOSE    = 8,
999 //      REINT_WRITE    = 9,
1000         REINT_MAX
1001 } mds_reint_t, mdt_reint_t;
1002
1003 extern void lustre_swab_generic_32s (__u32 *val);
1004
1005 /* the disposition of the intent outlines what was executed */
1006 #define DISP_IT_EXECD        0x00000001
1007 #define DISP_LOOKUP_EXECD    0x00000002
1008 #define DISP_LOOKUP_NEG      0x00000004
1009 #define DISP_LOOKUP_POS      0x00000008
1010 #define DISP_OPEN_CREATE     0x00000010
1011 #define DISP_OPEN_OPEN       0x00000020
1012 #define DISP_ENQ_COMPLETE    0x00400000
1013 #define DISP_ENQ_OPEN_REF    0x00800000
1014 #define DISP_ENQ_CREATE_REF  0x01000000
1015 #define DISP_OPEN_LOCK       0x02000000
1016
1017 /* INODE LOCK PARTS */
1018 #define MDS_INODELOCK_LOOKUP 0x000001       /* dentry, mode, owner, group */
1019 #define MDS_INODELOCK_UPDATE 0x000002       /* size, links, timestamps */
1020 #define MDS_INODELOCK_OPEN   0x000004       /* For opened files */
1021
1022 /* Do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits */
1023 #define MDS_INODELOCK_MAXSHIFT 2
1024 /* This FULL lock is useful to take on unlink sort of operations */
1025 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
1026
1027 struct ll_fid {
1028         __u64 id;         /* holds object id */
1029         __u32 generation; /* holds object generation */
1030
1031         __u32 f_type;     /* holds object type or stripe idx when passing it to
1032                            * OST for saving into EA. */
1033 };
1034
1035 extern void lustre_swab_ll_fid (struct ll_fid *fid);
1036
1037 #define MDS_STATUS_CONN 1
1038 #define MDS_STATUS_LOV 2
1039
1040 struct mds_status_req {
1041         __u32  flags;
1042         __u32  repbuf;
1043 };
1044
1045 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
1046
1047 /* mdt_thread_info.mti_flags. */
1048 enum md_op_flags {
1049         /* The flag indicates Size-on-MDS attributes are changed. */
1050         MF_SOM_CHANGE           = (1 << 0),
1051         /* Flags indicates an epoch opens or closes. */
1052         MF_EPOCH_OPEN           = (1 << 1),
1053         MF_EPOCH_CLOSE          = (1 << 2),
1054         MF_MDC_CANCEL_FID1      = (1 << 3),
1055         MF_MDC_CANCEL_FID2      = (1 << 4),
1056         MF_MDC_CANCEL_FID3      = (1 << 5),
1057         MF_MDC_CANCEL_FID4      = (1 << 6),
1058 };
1059
1060 #define MF_SOM_LOCAL_FLAGS (MF_MDC_CANCEL_FID1 | MF_MDC_CANCEL_FID2 | \
1061                             MF_MDC_CANCEL_FID3 | MF_MDC_CANCEL_FID4)
1062
1063 #define MDS_BFLAG_UNCOMMITTED_WRITES   0x1
1064 #define MDS_BFLAG_EXT_FLAGS     0x80000000 /* == EXT3_RESERVED_FL */
1065
1066 /* these should be identical to their EXT3_*_FL counterparts, and are
1067  * redefined here only to avoid dragging in ext3_fs.h */
1068 #define MDS_SYNC_FL             0x00000008 /* Synchronous updates */
1069 #define MDS_IMMUTABLE_FL        0x00000010 /* Immutable file */
1070 #define MDS_APPEND_FL           0x00000020 /* writes to file may only append */
1071 #define MDS_NOATIME_FL          0x00000080 /* do not update atime */
1072 #define MDS_DIRSYNC_FL          0x00010000 /* dirsync behaviour (dir only) */
1073
1074 #ifdef __KERNEL__
1075 /* If MDS_BFLAG_IOC_FLAGS is set it means we requested EXT3_*_FL inode flags
1076  * and we need to decode these into local S_* flags in the inode.  Otherwise
1077  * we pass flags straight through (see bug 9486). */
1078 static inline int ll_ext_to_inode_flags(int flags)
1079 {
1080         return (flags & MDS_BFLAG_EXT_FLAGS) ?
1081                (((flags & MDS_SYNC_FL)      ? S_SYNC      : 0) |
1082                 ((flags & MDS_NOATIME_FL)   ? S_NOATIME   : 0) |
1083                 ((flags & MDS_APPEND_FL)    ? S_APPEND    : 0) |
1084 #if defined(S_DIRSYNC)
1085                 ((flags & MDS_DIRSYNC_FL)   ? S_DIRSYNC   : 0) |
1086 #endif
1087                 ((flags & MDS_IMMUTABLE_FL) ? S_IMMUTABLE : 0)) :
1088                (flags & ~MDS_BFLAG_EXT_FLAGS);
1089 }
1090
1091 /* If MDS_BFLAG_EXT_FLAGS is set it means we requested EXT3_*_FL inode flags
1092  * and we pass these straight through.  Otherwise we need to convert from
1093  * S_* flags to their EXT3_*_FL equivalents (see bug 9486). */
1094 static inline int ll_inode_to_ext_flags(int oflags, int iflags)
1095 {
1096         return (oflags & MDS_BFLAG_EXT_FLAGS) ? (oflags & ~MDS_BFLAG_EXT_FLAGS):
1097                (((iflags & S_SYNC)      ? MDS_SYNC_FL      : 0) |
1098                 ((iflags & S_NOATIME)   ? MDS_NOATIME_FL   : 0) |
1099                 ((iflags & S_APPEND)    ? MDS_APPEND_FL    : 0) |
1100 #if defined(S_DIRSYNC)
1101                 ((iflags & S_DIRSYNC)   ? MDS_DIRSYNC_FL   : 0) |
1102 #endif
1103                 ((iflags & S_IMMUTABLE) ? MDS_IMMUTABLE_FL : 0));
1104 }
1105 #endif
1106
1107 struct mdt_body {
1108         struct lu_fid  fid1;
1109         struct lu_fid  fid2;
1110         struct lustre_handle handle;
1111         __u64          valid;
1112         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1113         __u64          mtime;
1114         __u64          atime;
1115         __u64          ctime;
1116         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1117         __u64          ioepoch;
1118         __u64          ino;    /* for 1.6 compatibility */
1119         __u32          fsuid;
1120         __u32          fsgid;
1121         __u32          capability;
1122         __u32          mode;
1123         __u32          uid;
1124         __u32          gid;
1125         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1126         __u32          rdev;
1127         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1128         __u32          generation; /* for 1.6 compatibility */
1129         __u32          suppgid;
1130         __u32          eadatasize;
1131         __u32          aclsize;
1132         __u32          max_mdsize;
1133         __u32          max_cookiesize;
1134         __u32          padding_4; /* also fix lustre_swab_mdt_body */
1135 };
1136
1137 struct mds_body {
1138         struct ll_fid  fid1;
1139         struct ll_fid  fid2;
1140         struct lustre_handle handle;
1141         __u64          valid;
1142         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1143         __u64          mtime;
1144         __u64          atime;
1145         __u64          ctime;
1146         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1147         __u64          io_epoch;
1148         __u64          ino;
1149         __u32          fsuid;
1150         __u32          fsgid;
1151         __u32          capability;
1152         __u32          mode;
1153         __u32          uid;
1154         __u32          gid;
1155         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1156         __u32          rdev;
1157         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1158         __u32          generation;
1159         __u32          suppgid;
1160         __u32          eadatasize;
1161         __u32          aclsize;
1162         __u32          max_mdsize;
1163         __u32          max_cookiesize;
1164         __u32          padding_4; /* also fix lustre_swab_mds_body */
1165 };
1166
1167 extern void lustre_swab_mds_body (struct mds_body *b);
1168 extern void lustre_swab_mdt_body (struct mdt_body *b);
1169
1170 struct mdt_epoch {
1171         struct lustre_handle handle;
1172         __u64  ioepoch;
1173         __u32  flags;
1174         __u32  padding;
1175 };
1176
1177 extern void lustre_swab_mdt_epoch (struct mdt_epoch *b);
1178
1179 #define Q_QUOTACHECK    0x800100
1180 #define Q_INITQUOTA     0x800101        /* init slave limits */
1181 #define Q_GETOINFO      0x800102        /* get obd quota info */
1182 #define Q_GETOQUOTA     0x800103        /* get obd quotas */
1183
1184 #define Q_TYPESET(oqc, type) \
1185         ((oqc)->qc_type == type || (oqc)->qc_type == UGQUOTA)
1186
1187 #define Q_GETOCMD(oqc) \
1188         ((oqc)->qc_cmd == Q_GETOINFO || (oqc)->qc_cmd == Q_GETOQUOTA)
1189
1190 struct obd_quotactl {
1191         __u32                   qc_cmd;
1192         __u32                   qc_type;
1193         __u32                   qc_id;
1194         __u32                   qc_stat;
1195         struct obd_dqinfo       qc_dqinfo;
1196         struct obd_dqblk        qc_dqblk;
1197 };
1198
1199 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1200
1201 /* inode access permission for remote user, the inode info are omitted,
1202  * for client knows them. */
1203 struct mds_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 /* permissions for md_perm.mp_perm */
1212 enum {
1213         CFS_SETUID_PERM = 0x01,
1214         CFS_SETGID_PERM = 0x02,
1215         CFS_SETGRP_PERM = 0x04,
1216         CFS_RMTACL_PERM = 0x08
1217 };
1218
1219 extern void lustre_swab_mds_remote_perm(struct mds_remote_perm *p);
1220
1221 struct mdt_remote_perm {
1222         __u32           rp_uid;
1223         __u32           rp_gid;
1224         __u32           rp_fsuid;
1225         __u32           rp_fsgid;
1226         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
1227 };
1228
1229 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
1230
1231 struct mds_rec_setattr {
1232         __u32           sa_opcode;
1233         __u32           sa_fsuid;
1234         __u32           sa_fsgid;
1235         __u32           sa_cap;
1236         __u32           sa_suppgid;
1237         __u32           sa_mode;
1238         struct ll_fid   sa_fid;
1239         __u64           sa_valid; /* MDS_ATTR_* attributes */
1240         __u64           sa_size;
1241         __u64           sa_mtime;
1242         __u64           sa_atime;
1243         __u64           sa_ctime;
1244         __u32           sa_uid;
1245         __u32           sa_gid;
1246         __u32           sa_attr_flags;
1247         __u32           sa_padding; /* also fix lustre_swab_mds_rec_setattr */
1248 };
1249
1250 extern void lustre_swab_mds_rec_setattr (struct mds_rec_setattr *sa);
1251
1252 struct mdt_rec_setattr {
1253         __u32           sa_opcode;
1254         __u32           sa_fsuid;
1255         __u32           sa_fsgid;
1256         __u32           sa_cap;
1257         __u32           sa_suppgid;
1258         __u32           sa_padding_1;
1259         struct lu_fid   sa_fid;
1260         __u64           sa_valid;
1261         __u32           sa_uid;
1262         __u32           sa_gid;
1263         __u64           sa_size;
1264         __u64           sa_blocks;
1265         __u64           sa_mtime;
1266         __u64           sa_atime;
1267         __u64           sa_ctime;
1268         __u32           sa_attr_flags;
1269         __u32           sa_mode;
1270         __u32           sa_padding_2;
1271         __u32           sa_padding_3;
1272         __u32           sa_padding_4;
1273         __u32           sa_padding_5;
1274 };
1275
1276 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
1277
1278 /*
1279  * Attribute flags used in mds_rec_setattr::sa_valid.
1280  * The kernel's #defines for ATTR_* should not be used over the network
1281  * since the client and MDS may run different kernels (see bug 13828)
1282  * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1283  */
1284 #define MDS_ATTR_MODE          0x1ULL /* = 1 */
1285 #define MDS_ATTR_UID           0x2ULL /* = 2 */
1286 #define MDS_ATTR_GID           0x4ULL /* = 4 */
1287 #define MDS_ATTR_SIZE          0x8ULL /* = 8 */
1288 #define MDS_ATTR_ATIME        0x10ULL /* = 16 */
1289 #define MDS_ATTR_MTIME        0x20ULL /* = 32 */
1290 #define MDS_ATTR_CTIME        0x40ULL /* = 64 */
1291 #define MDS_ATTR_ATIME_SET    0x80ULL /* = 128 */
1292 #define MDS_ATTR_MTIME_SET   0x100ULL /* = 256 */
1293 #define MDS_ATTR_FORCE       0x200ULL /* = 512, Not a change, but a change it */
1294 #define MDS_ATTR_ATTR_FLAG   0x400ULL /* = 1024 */
1295 #define MDS_ATTR_KILL_SUID   0x800ULL /* = 2048 */
1296 #define MDS_ATTR_KILL_SGID  0x1000ULL /* = 4096 */
1297 #define MDS_ATTR_CTIME_SET  0x2000ULL /* = 8192 */
1298 #define MDS_ATTR_FROM_OPEN  0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
1299 #define MDS_ATTR_BLOCKS     0x8000ULL /* = 32768 */
1300
1301 #ifndef FMODE_READ
1302 #define FMODE_READ               00000001
1303 #define FMODE_WRITE              00000002
1304 #endif
1305
1306 #define FMODE_EPOCH              01000000
1307 #define FMODE_EPOCHLCK           02000000
1308 #define FMODE_SOM                04000000
1309 #define FMODE_CLOSED             0
1310
1311 #define MDS_OPEN_CREATED         00000010
1312 #define MDS_OPEN_CROSS           00000020
1313
1314 #define MDS_FMODE_EXEC           00000004
1315 #define MDS_OPEN_CREAT           00000100
1316 #define MDS_OPEN_EXCL            00000200
1317 #define MDS_OPEN_TRUNC           00001000
1318 #define MDS_OPEN_APPEND          00002000
1319 #define MDS_OPEN_SYNC            00010000
1320 #define MDS_OPEN_DIRECTORY       00200000
1321
1322 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
1323 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1324 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file*/
1325 #define MDS_CREATE_RMT_ACL    01000000000 /* indicate create on remote server
1326                                            * with default ACL */
1327 #define MDS_CREATE_SLAVE_OBJ  02000000000 /* indicate create slave object
1328                                            * actually, this is for create, not
1329                                            * conflict with other open flags */
1330 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
1331 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
1332 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
1333
1334 /* permission for create non-directory file */
1335 #define MAY_CREATE      (1 << 7)
1336 /* permission for create directory file */
1337 #define MAY_LINK        (1 << 8)
1338 /* permission for delete from the directory */
1339 #define MAY_UNLINK      (1 << 9)
1340 /* source's permission for rename */
1341 #define MAY_RENAME_SRC  (1 << 10)
1342 /* target's permission for rename */
1343 #define MAY_RENAME_TAR  (1 << 11)
1344 /* part (parent's) VTX permission check */
1345 #define MAY_VTX_PART    (1 << 12)
1346 /* full VTX permission check */
1347 #define MAY_VTX_FULL    (1 << 13)
1348 /* lfs rgetfacl permission check */
1349 #define MAY_RGETFACL    (1 << 14)
1350
1351 enum {
1352         MDS_CHECK_SPLIT  = 1 << 0,
1353         MDS_CROSS_REF    = 1 << 1,
1354         MDS_VTX_BYPASS   = 1 << 2,
1355         MDS_PERM_BYPASS  = 1 << 3,
1356         MDS_SOM          = 1 << 4
1357 };
1358
1359 struct mds_rec_join {
1360         struct ll_fid  jr_fid;
1361         __u64          jr_headsize;
1362 };
1363
1364 extern void lustre_swab_mds_rec_join (struct mds_rec_join *jr);
1365
1366 struct mdt_rec_join {
1367         struct lu_fid  jr_fid;
1368         __u64          jr_headsize;
1369 };
1370
1371 extern void lustre_swab_mdt_rec_join (struct mdt_rec_join *jr);
1372
1373 struct mds_rec_create {
1374         __u32           cr_opcode;
1375         __u32           cr_fsuid;
1376         __u32           cr_fsgid;
1377         __u32           cr_cap;
1378         __u32           cr_flags; /* for use with open */
1379         __u32           cr_mode;
1380         struct ll_fid   cr_fid;
1381         struct ll_fid   cr_replayfid;
1382         __u64           cr_time;
1383         __u64           cr_rdev;
1384         __u32           cr_suppgid;
1385         __u32           cr_padding_1; /* also fix lustre_swab_mds_rec_create */
1386         __u32           cr_padding_2; /* also fix lustre_swab_mds_rec_create */
1387         __u32           cr_padding_3; /* also fix lustre_swab_mds_rec_create */
1388         __u32           cr_padding_4; /* also fix lustre_swab_mds_rec_create */
1389         __u32           cr_padding_5; /* also fix lustre_swab_mds_rec_create */
1390 };
1391
1392 extern void lustre_swab_mds_rec_create (struct mds_rec_create *cr);
1393
1394 struct mdt_rec_create {
1395         __u32           cr_opcode;
1396         __u32           cr_fsuid;
1397         __u32           cr_fsgid;
1398         __u32           cr_cap;
1399         __u32           cr_suppgid1;
1400         __u32           cr_suppgid2;
1401         struct lu_fid   cr_fid1;
1402         struct lu_fid   cr_fid2;
1403         struct lustre_handle cr_old_handle; /* u64 handle in case of open replay */
1404         __u64           cr_time;
1405         __u64           cr_rdev;
1406         __u64           cr_ioepoch;
1407         __u64           cr_padding_1; /* pad for 64 bits*/
1408         __u32           cr_mode;
1409         __u32           cr_bias;
1410         __u32           cr_flags;     /* for use with open */
1411         __u32           cr_padding_2;
1412         __u32           cr_padding_3;
1413         __u32           cr_padding_4;
1414 };
1415
1416 extern void lustre_swab_mdt_rec_create (struct mdt_rec_create *cr);
1417
1418 struct mds_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 ll_fid   lk_fid1;
1426         struct ll_fid   lk_fid2;
1427         __u64           lk_time;
1428         __u32           lk_padding_1;  /* also fix lustre_swab_mds_rec_link */
1429         __u32           lk_padding_2;  /* also fix lustre_swab_mds_rec_link */
1430         __u32           lk_padding_3;  /* also fix lustre_swab_mds_rec_link */
1431         __u32           lk_padding_4;  /* also fix lustre_swab_mds_rec_link */
1432 };
1433
1434 extern void lustre_swab_mds_rec_link (struct mds_rec_link *lk);
1435
1436 struct mdt_rec_link {
1437         __u32           lk_opcode;
1438         __u32           lk_fsuid;
1439         __u32           lk_fsgid;
1440         __u32           lk_cap;
1441         __u32           lk_suppgid1;
1442         __u32           lk_suppgid2;
1443         struct lu_fid   lk_fid1;
1444         struct lu_fid   lk_fid2;
1445         __u64           lk_time;
1446         __u64           lk_padding_1;
1447         __u64           lk_padding_2;
1448         __u64           lk_padding_3;
1449         __u64           lk_padding_4;
1450         __u32           lk_bias;
1451         __u32           lk_padding_5;
1452         __u32           lk_padding_6;
1453         __u32           lk_padding_7;
1454         __u32           lk_padding_8;
1455         __u32           lk_padding_9;
1456 };
1457
1458 struct mds_rec_unlink {
1459         __u32           ul_opcode;
1460         __u32           ul_fsuid;
1461         __u32           ul_fsgid;
1462         __u32           ul_cap;
1463         __u32           ul_suppgid;
1464         __u32           ul_mode;
1465         struct ll_fid   ul_fid1;
1466         struct ll_fid   ul_fid2;
1467         __u64           ul_time;
1468         __u32           ul_padding_1; /* also fix lustre_swab_mds_rec_unlink */
1469         __u32           ul_padding_2; /* also fix lustre_swab_mds_rec_unlink */
1470         __u32           ul_padding_3; /* also fix lustre_swab_mds_rec_unlink */
1471         __u32           ul_padding_4; /* also fix lustre_swab_mds_rec_unlink */
1472 };
1473
1474 extern void lustre_swab_mds_rec_unlink (struct mds_rec_unlink *ul);
1475
1476 struct mdt_rec_unlink {
1477         __u32           ul_opcode;
1478         __u32           ul_fsuid;
1479         __u32           ul_fsgid;
1480         __u32           ul_cap;
1481         __u32           ul_suppgid1;
1482         __u32           ul_suppgid2;
1483         struct lu_fid   ul_fid1;
1484         struct lu_fid   ul_fid2;
1485         __u64           ul_time;
1486         __u64           ul_padding_2;
1487         __u64           ul_padding_3;
1488         __u64           ul_padding_4;
1489         __u64           ul_padding_5;
1490         __u32           ul_bias;
1491         __u32           ul_mode;
1492         __u32           ul_padding_6;
1493         __u32           ul_padding_7;
1494         __u32           ul_padding_8;
1495         __u32           ul_padding_9;
1496 };
1497
1498 struct mds_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 ll_fid   rn_fid1;
1506         struct ll_fid   rn_fid2;
1507         __u64           rn_time;
1508         __u32           rn_padding_1; /* also fix lustre_swab_mds_rec_rename */
1509         __u32           rn_padding_2; /* also fix lustre_swab_mds_rec_rename */
1510         __u32           rn_padding_3; /* also fix lustre_swab_mds_rec_rename */
1511         __u32           rn_padding_4; /* also fix lustre_swab_mds_rec_rename */
1512 };
1513
1514 extern void lustre_swab_mds_rec_rename (struct mds_rec_rename *rn);
1515
1516 struct mdt_rec_rename {
1517         __u32           rn_opcode;
1518         __u32           rn_fsuid;
1519         __u32           rn_fsgid;
1520         __u32           rn_cap;
1521         __u32           rn_suppgid1;
1522         __u32           rn_suppgid2;
1523         struct lu_fid   rn_fid1;
1524         struct lu_fid   rn_fid2;
1525         __u64           rn_time;
1526         __u64           rn_padding_1;
1527         __u64           rn_padding_2;
1528         __u64           rn_padding_3;
1529         __u64           rn_padding_4;
1530         __u32           rn_bias;      /* some operation flags */
1531         __u32           rn_mode;      /* cross-ref rename has mode */
1532         __u32           rn_padding_5;
1533         __u32           rn_padding_6;
1534         __u32           rn_padding_7;
1535         __u32           rn_padding_8;
1536 };
1537
1538 struct mdt_rec_setxattr {
1539         __u32           sx_opcode;
1540         __u32           sx_fsuid;
1541         __u32           sx_fsgid;
1542         __u32           sx_cap;
1543         __u32           sx_suppgid1;
1544         __u32           sx_suppgid2;
1545         struct lu_fid   sx_fid;
1546         __u64           sx_padding_1; /* These three members are lu_fid size */
1547         __u32           sx_padding_2;
1548         __u32           sx_padding_3;
1549         __u64           sx_valid;
1550         __u64           sx_time;
1551         __u64           sx_padding_5;
1552         __u64           sx_padding_6;
1553         __u64           sx_padding_7;
1554         __u32           sx_size;
1555         __u32           sx_flags;
1556         __u32           sx_padding_8;
1557         __u32           sx_padding_9;
1558         __u32           sx_padding_10;
1559         __u32           sx_padding_11;
1560 };
1561
1562 struct mdt_rec_reint {
1563         __u32           rr_opcode;
1564         __u32           rr_fsuid;
1565         __u32           rr_fsgid;
1566         __u32           rr_cap;
1567         __u32           rr_suppgid1;
1568         __u32           rr_suppgid2;
1569         struct lu_fid   rr_fid1;
1570         struct lu_fid   rr_fid2;
1571         __u64           rr_mtime;
1572         __u64           rr_atime;
1573         __u64           rr_ctime;
1574         __u64           rr_size;
1575         __u64           rr_blocks;
1576         __u32           rr_bias;
1577         __u32           rr_mode;
1578         __u32           rr_padding_1; /* also fix lustre_swab_mdt_rec_reint */
1579         __u32           rr_padding_2; /* also fix lustre_swab_mdt_rec_reint */
1580         __u32           rr_padding_3; /* also fix lustre_swab_mdt_rec_reint */
1581         __u32           rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
1582 };
1583
1584 extern void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
1585
1586 struct lmv_desc {
1587         __u32 ld_tgt_count;                /* how many MDS's */
1588         __u32 ld_active_tgt_count;         /* how many active */
1589         struct obd_uuid ld_uuid;
1590 };
1591
1592 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
1593
1594 struct md_fld {
1595         seqno_t mf_seq;
1596         mdsno_t mf_mds;
1597 };
1598
1599 extern void lustre_swab_md_fld (struct md_fld *mf);
1600
1601 enum fld_rpc_opc {
1602         FLD_QUERY                       = 600,
1603         FLD_LAST_OPC,
1604         FLD_FIRST_OPC                   = FLD_QUERY
1605 };
1606
1607 enum seq_rpc_opc {
1608         SEQ_QUERY                       = 700,
1609         SEQ_LAST_OPC,
1610         SEQ_FIRST_OPC                   = SEQ_QUERY
1611 };
1612
1613 enum seq_op {
1614         SEQ_ALLOC_SUPER = 0,
1615         SEQ_ALLOC_META = 1
1616 };
1617
1618 /*
1619  *  LOV data structures
1620  */
1621
1622 #define LOV_MIN_STRIPE_SIZE 65536   /* maximum PAGE_SIZE (ia64), power of 2 */
1623 #define LOV_MAX_STRIPE_COUNT  160   /* until bug 4424 is fixed */
1624 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
1625
1626 #define LOV_MAX_UUID_BUFFER_SIZE  8192
1627 /* The size of the buffer the lov/mdc reserves for the
1628  * array of UUIDs returned by the MDS.  With the current
1629  * protocol, this will limit the max number of OSTs per LOV */
1630
1631 #define LOV_DESC_MAGIC 0xB0CCDE5C
1632
1633 /* LOV settings descriptor (should only contain static info) */
1634 struct lov_desc {
1635         __u32 ld_tgt_count;                /* how many OBD's */
1636         __u32 ld_active_tgt_count;         /* how many active */
1637         __u32 ld_default_stripe_count;     /* how many objects are used */
1638         __u32 ld_pattern;                  /* default PATTERN_RAID0 */
1639         __u64 ld_default_stripe_size;      /* in bytes */
1640         __u64 ld_default_stripe_offset;    /* in bytes */
1641         __u32 ld_padding_0;                /* unused */
1642         __u32 ld_qos_maxage;               /* in second */
1643         __u32 ld_padding_1;                /* also fix lustre_swab_lov_desc */
1644         __u32 ld_padding_2;                /* also fix lustre_swab_lov_desc */
1645         struct obd_uuid ld_uuid;
1646 };
1647
1648 #define ld_magic ld_active_tgt_count       /* for swabbing from llogs */
1649
1650 extern void lustre_swab_lov_desc (struct lov_desc *ld);
1651
1652 /*
1653  *   LDLM requests:
1654  */
1655 /* opcodes -- MUST be distinct from OST/MDS opcodes */
1656 typedef enum {
1657         LDLM_ENQUEUE     = 101,
1658         LDLM_CONVERT     = 102,
1659         LDLM_CANCEL      = 103,
1660         LDLM_BL_CALLBACK = 104,
1661         LDLM_CP_CALLBACK = 105,
1662         LDLM_GL_CALLBACK = 106,
1663         LDLM_LAST_OPC
1664 } ldlm_cmd_t;
1665 #define LDLM_FIRST_OPC LDLM_ENQUEUE
1666
1667 #define RES_NAME_SIZE 4
1668 struct ldlm_res_id {
1669         __u64 name[RES_NAME_SIZE];
1670 };
1671
1672 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
1673
1674 /* lock types */
1675 typedef enum {
1676         LCK_MINMODE = 0,
1677         LCK_EX      = 1,
1678         LCK_PW      = 2,
1679         LCK_PR      = 4,
1680         LCK_CW      = 8,
1681         LCK_CR      = 16,
1682         LCK_NL      = 32,
1683         LCK_GROUP   = 64,
1684         LCK_MAXMODE
1685 } ldlm_mode_t;
1686
1687 #define LCK_MODE_NUM    7
1688
1689 typedef enum {
1690         LDLM_PLAIN     = 10,
1691         LDLM_EXTENT    = 11,
1692         LDLM_FLOCK     = 12,
1693         LDLM_IBITS     = 13,
1694         LDLM_MAX_TYPE
1695 } ldlm_type_t;
1696
1697 #define LDLM_MIN_TYPE LDLM_PLAIN
1698
1699 struct ldlm_extent {
1700         __u64 start;
1701         __u64 end;
1702         __u64 gid;
1703 };
1704
1705 static inline int ldlm_extent_overlap(struct ldlm_extent *ex1,
1706                                       struct ldlm_extent *ex2)
1707 {
1708         return (ex1->start <= ex2->end) && (ex2->start <= ex1->end);
1709 }
1710
1711 struct ldlm_inodebits {
1712         __u64 bits;
1713 };
1714
1715 struct ldlm_flock {
1716         __u64 start;
1717         __u64 end;
1718         __u64 blocking_export;  /* not actually used over the wire */
1719         __u32 blocking_pid;     /* not actually used over the wire */
1720         __u32 pid;
1721 };
1722
1723 /* it's important that the fields of the ldlm_extent structure match
1724  * the first fields of the ldlm_flock structure because there is only
1725  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
1726  * this ever changes we will need to swab the union differently based
1727  * on the resource type. */
1728
1729 typedef union {
1730         struct ldlm_extent l_extent;
1731         struct ldlm_flock  l_flock;
1732         struct ldlm_inodebits l_inodebits;
1733 } ldlm_policy_data_t;
1734
1735 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
1736
1737 struct ldlm_intent {
1738         __u64 opc;
1739 };
1740
1741 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
1742
1743 struct ldlm_resource_desc {
1744         ldlm_type_t lr_type;
1745         __u32 lr_padding;       /* also fix lustre_swab_ldlm_resource_desc */
1746         struct ldlm_res_id lr_name;
1747 };
1748
1749 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
1750
1751 struct ldlm_lock_desc {
1752         struct ldlm_resource_desc l_resource;
1753         ldlm_mode_t l_req_mode;
1754         ldlm_mode_t l_granted_mode;
1755         ldlm_policy_data_t l_policy_data;
1756 };
1757
1758 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
1759
1760 #define LDLM_LOCKREQ_HANDLES 2
1761 #define LDLM_ENQUEUE_CANCEL_OFF 1
1762
1763 struct ldlm_request {
1764         __u32 lock_flags;
1765         __u32 lock_count;
1766         struct ldlm_lock_desc lock_desc;
1767         struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
1768 };
1769
1770 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
1771
1772 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
1773  * Otherwise, 2 are available. */
1774 #define ldlm_request_bufsize(count,type)                                \
1775 ({                                                                      \
1776         int _avail = LDLM_LOCKREQ_HANDLES;                              \
1777         _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
1778         sizeof(struct ldlm_request) +                                   \
1779         (count > _avail ? count - _avail : 0) *                         \
1780         sizeof(struct lustre_handle);                                   \
1781 })
1782
1783 struct ldlm_reply {
1784         __u32 lock_flags;
1785         __u32 lock_padding;     /* also fix lustre_swab_ldlm_reply */
1786         struct ldlm_lock_desc lock_desc;
1787         struct lustre_handle lock_handle;
1788         __u64  lock_policy_res1;
1789         __u64  lock_policy_res2;
1790 };
1791
1792 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
1793
1794 /*
1795  * Opcodes for mountconf (mgs and mgc)
1796  */
1797 typedef enum {
1798         MGS_CONNECT = 250,
1799         MGS_DISCONNECT,
1800         MGS_EXCEPTION,         /* node died, etc. */
1801         MGS_TARGET_REG,        /* whenever target starts up */
1802         MGS_TARGET_DEL,
1803         MGS_SET_INFO,
1804         MGS_LAST_OPC
1805 } mgs_cmd_t;
1806 #define MGS_FIRST_OPC MGS_CONNECT
1807
1808 #define MGS_PARAM_MAXLEN 1024
1809 #define KEY_SET_INFO "set_info"
1810
1811 struct mgs_send_param {
1812         char             mgs_param[MGS_PARAM_MAXLEN];
1813 };
1814
1815 /* We pass this info to the MGS so it can write config logs */
1816 #define MTI_NAME_MAXLEN 64
1817 #define MTI_PARAM_MAXLEN 4096
1818 #define MTI_NIDS_MAX 32
1819 struct mgs_target_info {
1820         __u32            mti_lustre_ver;
1821         __u32            mti_stripe_index;
1822         __u32            mti_config_ver;
1823         __u32            mti_flags;
1824         __u32            mti_nid_count;
1825         __u32            padding;                    /* 64 bit align */
1826         char             mti_fsname[MTI_NAME_MAXLEN];
1827         char             mti_svname[MTI_NAME_MAXLEN];
1828         char             mti_uuid[sizeof(struct obd_uuid)];
1829         __u64            mti_nids[MTI_NIDS_MAX];     /* host nids (lnet_nid_t)*/
1830         char             mti_params[MTI_PARAM_MAXLEN];
1831 };
1832
1833 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
1834
1835 /* Config marker flags (in config log) */
1836 #define CM_START       0x01
1837 #define CM_END         0x02
1838 #define CM_SKIP        0x04
1839 #define CM_UPGRADE146  0x08
1840 #define CM_EXCLUDE     0x10
1841 #define CM_START_SKIP (CM_START | CM_SKIP)
1842
1843 struct cfg_marker {
1844         __u32             cm_step;       /* aka config version */
1845         __u32             cm_flags;
1846         __u32             cm_vers;       /* lustre release version number */
1847         __u32             padding;       /* 64 bit align */
1848         time_t            cm_createtime; /*when this record was first created */
1849         time_t            cm_canceltime; /*when this record is no longer valid*/
1850         char              cm_tgtname[MTI_NAME_MAXLEN];
1851         char              cm_comment[MTI_NAME_MAXLEN];
1852 };
1853
1854 extern void lustre_swab_cfg_marker(struct cfg_marker *marker);
1855
1856 /*
1857  * Opcodes for multiple servers.
1858  */
1859
1860 typedef enum {
1861         OBD_PING = 400,
1862         OBD_LOG_CANCEL,
1863         OBD_QC_CALLBACK,
1864         OBD_LAST_OPC
1865 } obd_cmd_t;
1866 #define OBD_FIRST_OPC OBD_PING
1867
1868 /* catalog of log objects */
1869
1870 /* Identifier for a single log object */
1871 struct llog_logid {
1872         __u64                   lgl_oid;
1873         __u64                   lgl_ogr;
1874         __u32                   lgl_ogen;
1875 } __attribute__((packed));
1876
1877 /* Records written to the CATALOGS list */
1878 #define CATLIST "CATALOGS"
1879 struct llog_catid {
1880         struct llog_logid       lci_logid;
1881         __u32                   lci_padding1;
1882         __u32                   lci_padding2;
1883         __u32                   lci_padding3;
1884 } __attribute__((packed));
1885
1886 /*join file lov mds md*/
1887 struct lov_mds_md_join {
1888         struct lov_mds_md lmmj_md;
1889         /*join private info*/
1890         struct llog_logid lmmj_array_id; /*array object id*/
1891         __u32  lmmj_extent_count;        /*array extent count*/
1892 };
1893
1894 /* Log data record types - there is no specific reason that these need to
1895  * be related to the RPC opcodes, but no reason not to (may be handy later?)
1896  */
1897 #define LLOG_OP_MAGIC 0x10600000
1898 #define LLOG_OP_MASK  0xfff00000
1899
1900 typedef enum {
1901         LLOG_PAD_MAGIC   = LLOG_OP_MAGIC | 0x00000,
1902         OST_SZ_REC       = LLOG_OP_MAGIC | 0x00f00,
1903         OST_RAID1_REC    = LLOG_OP_MAGIC | 0x01000,
1904         MDS_UNLINK_REC   = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_UNLINK,
1905         MDS_SETATTR_REC  = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_SETATTR,
1906         OBD_CFG_REC      = LLOG_OP_MAGIC | 0x20000,
1907         PTL_CFG_REC      = LLOG_OP_MAGIC | 0x30000, /* obsolete */
1908         LLOG_GEN_REC     = LLOG_OP_MAGIC | 0x40000,
1909         LLOG_JOIN_REC    = LLOG_OP_MAGIC | 0x50000,
1910         LLOG_HDR_MAGIC   = LLOG_OP_MAGIC | 0x45539,
1911         LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
1912 } llog_op_type;
1913
1914 /*
1915  * for now, continue to support old pad records which have 0 for their
1916  * type but still need to be swabbed for their length
1917  */
1918 #define LLOG_REC_HDR_NEEDS_SWABBING(r)                                  \
1919         (((r)->lrh_type & __swab32(LLOG_OP_MASK)) ==                    \
1920          __swab32(LLOG_OP_MAGIC) ||                                     \
1921          (((r)->lrh_type == 0) && ((r)->lrh_len > LLOG_CHUNK_SIZE)))
1922
1923 /* Log record header - stored in little endian order.
1924  * Each record must start with this struct, end with a llog_rec_tail,
1925  * and be a multiple of 256 bits in size.
1926  */
1927 struct llog_rec_hdr {
1928         __u32                   lrh_len;
1929         __u32                   lrh_index;
1930         __u32                   lrh_type;
1931         __u32                   padding;
1932 };
1933
1934 struct llog_rec_tail {
1935         __u32 lrt_len;
1936         __u32 lrt_index;
1937 };
1938
1939 struct llog_logid_rec {
1940         struct llog_rec_hdr     lid_hdr;
1941         struct llog_logid       lid_id;
1942         __u32                   padding1;
1943         __u32                   padding2;
1944         __u32                   padding3;
1945         __u32                   padding4;
1946         __u32                   padding5;
1947         struct llog_rec_tail    lid_tail;
1948 } __attribute__((packed));
1949
1950 /* MDS extent description
1951  * It is for joined file extent info, each extent info for joined file
1952  * just like (start, end, lmm).
1953  */
1954 struct mds_extent_desc {
1955         __u64                   med_start; /* extent start */
1956         __u64                   med_len;   /* extent length */
1957         struct lov_mds_md       med_lmm;   /* extent's lmm  */
1958 };
1959 /*Joined file array extent log record*/
1960 struct llog_array_rec {
1961         struct llog_rec_hdr     lmr_hdr;
1962         struct mds_extent_desc  lmr_med;
1963         struct llog_rec_tail    lmr_tail;
1964 };
1965
1966 struct llog_create_rec {
1967         struct llog_rec_hdr     lcr_hdr;
1968         struct ll_fid           lcr_fid;
1969         obd_id                  lcr_oid;
1970         obd_count               lcr_ogen;
1971         __u32                   padding;
1972         struct llog_rec_tail    lcr_tail;
1973 } __attribute__((packed));
1974
1975 struct llog_orphan_rec {
1976         struct llog_rec_hdr     lor_hdr;
1977         obd_id                  lor_oid;
1978         obd_count               lor_ogen;
1979         __u32                   padding;
1980         struct llog_rec_tail    lor_tail;
1981 } __attribute__((packed));
1982
1983 struct llog_unlink_rec {
1984         struct llog_rec_hdr     lur_hdr;
1985         obd_id                  lur_oid;
1986         obd_count               lur_ogen;
1987         __u32                   padding;
1988         struct llog_rec_tail    lur_tail;
1989 } __attribute__((packed));
1990
1991 struct llog_setattr_rec {
1992         struct llog_rec_hdr     lsr_hdr;
1993         obd_id                  lsr_oid;
1994         obd_count               lsr_ogen;
1995         __u32                   lsr_uid;
1996         __u32                   lsr_gid;
1997         __u32                   padding;
1998         struct llog_rec_tail    lsr_tail;
1999 } __attribute__((packed));
2000
2001 struct llog_size_change_rec {
2002         struct llog_rec_hdr     lsc_hdr;
2003         struct ll_fid           lsc_fid;
2004         __u32                   lsc_ioepoch;
2005         __u32                   padding;
2006         struct llog_rec_tail    lsc_tail;
2007 } __attribute__((packed));
2008
2009 struct llog_gen {
2010         __u64 mnt_cnt;
2011         __u64 conn_cnt;
2012 } __attribute__((packed));
2013
2014 struct llog_gen_rec {
2015         struct llog_rec_hdr     lgr_hdr;
2016         struct llog_gen         lgr_gen;
2017         struct llog_rec_tail    lgr_tail;
2018 };
2019 /* On-disk header structure of each log object, stored in little endian order */
2020 #define LLOG_CHUNK_SIZE         8192
2021 #define LLOG_HEADER_SIZE        (96)
2022 #define LLOG_BITMAP_BYTES       (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
2023
2024 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
2025
2026 /* flags for the logs */
2027 #define LLOG_F_ZAP_WHEN_EMPTY   0x1
2028 #define LLOG_F_IS_CAT           0x2
2029 #define LLOG_F_IS_PLAIN         0x4
2030
2031 struct llog_log_hdr {
2032         struct llog_rec_hdr     llh_hdr;
2033         __u64                   llh_timestamp;
2034         __u32                   llh_count;
2035         __u32                   llh_bitmap_offset;
2036         __u32                   llh_size;
2037         __u32                   llh_flags;
2038         __u32                   llh_cat_idx;
2039         /* for a catalog the first plain slot is next to it */
2040         struct obd_uuid         llh_tgtuuid;
2041         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
2042         __u32                   llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
2043         struct llog_rec_tail    llh_tail;
2044 } __attribute__((packed));
2045
2046 #define LLOG_BITMAP_SIZE(llh)  ((llh->llh_hdr.lrh_len -         \
2047                                  llh->llh_bitmap_offset -       \
2048                                  sizeof(llh->llh_tail)) * 8)
2049
2050 /* log cookies are used to reference a specific log file and a record therein */
2051 struct llog_cookie {
2052         struct llog_logid       lgc_lgl;
2053         __u32                   lgc_subsys;
2054         __u32                   lgc_index;
2055         __u32                   lgc_padding;
2056 } __attribute__((packed));
2057
2058 /* llog protocol */
2059 enum llogd_rpc_ops {
2060         LLOG_ORIGIN_HANDLE_CREATE       = 501,
2061         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
2062         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
2063         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
2064         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
2065         LLOG_ORIGIN_CONNECT             = 506,
2066         LLOG_CATINFO                    = 507,  /* for lfs catinfo */
2067         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
2068         LLOG_ORIGIN_HANDLE_DESTROY      = 509,  /* for destroy llog object*/
2069         LLOG_LAST_OPC,
2070         LLOG_FIRST_OPC                  = LLOG_ORIGIN_HANDLE_CREATE
2071 };
2072
2073 struct llogd_body {
2074         struct llog_logid  lgd_logid;
2075         __u32 lgd_ctxt_idx;
2076         __u32 lgd_llh_flags;
2077         __u32 lgd_index;
2078         __u32 lgd_saved_index;
2079         __u32 lgd_len;
2080         __u64 lgd_cur_offset;
2081 } __attribute__((packed));
2082
2083 struct llogd_conn_body {
2084         struct llog_gen         lgdc_gen;
2085         struct llog_logid       lgdc_logid;
2086         __u32                   lgdc_ctxt_idx;
2087 } __attribute__((packed));
2088
2089 struct lov_user_ost_data_join {   /* per-stripe data structure */
2090         __u64 l_extent_start;     /* extent start*/
2091         __u64 l_extent_end;       /* extent end*/
2092         __u64 l_object_id;        /* OST object ID */
2093         __u64 l_object_gr;        /* OST object group (creating MDS number) */
2094         __u32 l_ost_gen;          /* generation of this OST index */
2095         __u32 l_ost_idx;          /* OST index in LOV */
2096 } __attribute__((packed));
2097
2098 struct lov_user_md_join {         /* LOV EA user data (host-endian) */
2099         __u32 lmm_magic;          /* magic number = LOV_MAGIC_JOIN */
2100         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
2101         __u64 lmm_object_id;      /* LOV object ID */
2102         __u64 lmm_object_gr;      /* LOV object group */
2103         __u32 lmm_stripe_size;    /* size of stripe in bytes */
2104         __u32 lmm_stripe_count;   /* num stripes in use for this object */
2105         __u32 lmm_extent_count;   /* extent count of lmm*/
2106         __u64 lmm_tree_id;        /* mds tree object id */
2107         __u64 lmm_tree_gen;       /* mds tree object gen */
2108         struct llog_logid lmm_array_id; /* mds extent desc llog object id */
2109         struct lov_user_ost_data_join lmm_objects[0]; /* per-stripe data */
2110 } __attribute__((packed));
2111
2112 /* Note: 64-bit types are 64-bit aligned in structure */
2113 struct obdo {
2114         obd_valid               o_valid;        /* hot fields in this obdo */
2115         obd_id                  o_id;
2116         obd_gr                  o_gr;
2117         obd_id                  o_fid;
2118         obd_size                o_size;         /* o_size-o_blocks == ost_lvb */
2119         obd_time                o_mtime;
2120         obd_time                o_atime;
2121         obd_time                o_ctime;
2122         obd_blocks              o_blocks;       /* brw: cli sent cached bytes */
2123         obd_size                o_grant;
2124
2125         /* 32-bit fields start here: keep an even number of them via padding */
2126         obd_blksize             o_blksize;      /* optimal IO blocksize */
2127         obd_mode                o_mode;         /* brw: cli sent cache remain */
2128         obd_uid                 o_uid;
2129         obd_gid                 o_gid;
2130         obd_flag                o_flags;
2131         obd_count               o_nlink;        /* brw: checksum */
2132         obd_count               o_generation;
2133         obd_count               o_misc;         /* brw: o_dropped */
2134         __u32                   o_easize;       /* epoch in ost writes */
2135         __u32                   o_mds;
2136         __u32                   o_stripe_idx;   /* holds stripe idx */
2137         __u32                   o_padding_1;
2138         struct lustre_handle    o_handle;       /* brw: lock handle to prolong locks */
2139         struct llog_cookie      o_lcookie;      /* destroy: unlink cookie from MDS */
2140
2141         __u64                   o_padding_2;
2142         __u64                   o_padding_3;
2143         __u64                   o_padding_4;
2144         __u64                   o_padding_5;
2145         __u64                   o_padding_6;
2146 };
2147
2148 #define o_dirty   o_blocks
2149 #define o_undirty o_mode
2150 #define o_dropped o_misc
2151 #define o_cksum   o_nlink
2152
2153 extern void lustre_swab_obdo (struct obdo *o);
2154
2155 /* request structure for OST's */
2156
2157 struct ost_body {
2158         struct  obdo oa;
2159 };
2160
2161 /* Key for FIEMAP to be used in get_info calls */
2162 struct ll_fiemap_info_key {
2163         char    name[8];
2164         struct  obdo oa;
2165         struct  ll_user_fiemap fiemap;
2166 };
2167
2168 extern void lustre_swab_ost_body (struct ost_body *b);
2169 extern void lustre_swab_ost_last_id(obd_id *id);
2170 extern void lustre_swab_fiemap(struct ll_user_fiemap *fiemap);
2171
2172 extern void lustre_swab_lov_user_md_v1(struct lov_user_md_v1 *lum);
2173 extern void lustre_swab_lov_user_md_v3(struct lov_user_md_v3 *lum);
2174 extern void lustre_swab_lov_user_md_objects(struct lov_user_ost_data *lod,
2175                                             int stripe_count);
2176 extern void lustre_swab_lov_user_md_join(struct lov_user_md_join *lumj);
2177
2178 /* llog_swab.c */
2179 extern void lustre_swab_llogd_body (struct llogd_body *d);
2180 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
2181 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
2182 extern void lustre_swab_llog_rec(struct llog_rec_hdr  *rec,
2183                                  struct llog_rec_tail *tail);
2184
2185 struct lustre_cfg;
2186 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
2187
2188 /* quota. fixed by tianzy for bug10707 */
2189 #define QUOTA_IS_GRP   0X1UL  /* 0 is user, 1 is group. Used by qd_flags*/
2190 #define QUOTA_IS_BLOCK 0x2UL  /* 0 is inode, 1 is block. Used by qd_flags*/
2191
2192 struct qunit_data {
2193         __u32 qd_id; /* ID appiles to (uid, gid) */
2194         __u32 qd_flags; /* Quota type (USRQUOTA, GRPQUOTA) occupy one bit;
2195                          * Block quota or file quota occupy one bit */
2196         __u64 qd_count; /* acquire/release count (bytes for block quota) */
2197 };
2198
2199 struct qunit_data_old {
2200         __u32 qd_id;    /* ID appiles to (uid, gid) */
2201         __u32 qd_type;  /* Quota type (USRQUOTA, GRPQUOTA) */
2202         __u32 qd_count; /* acquire/release count (bytes for block quota) */
2203         __u32 qd_isblk; /* Block quota or file quota */
2204 };
2205
2206 extern void lustre_swab_qdata(struct qunit_data *d);
2207 extern void lustre_swab_qdata_old(struct qunit_data_old *d);
2208 extern struct qunit_data *lustre_quota_old_to_new(struct qunit_data_old *d);
2209 extern struct qunit_data_old *lustre_quota_new_to_old(struct qunit_data *d);
2210
2211 typedef enum {
2212         QUOTA_DQACQ     = 601,
2213         QUOTA_DQREL     = 602,
2214 } quota_cmd_t;
2215
2216 #define JOIN_FILE_ALIGN 4096
2217
2218 /* security opcodes */
2219 typedef enum {
2220         SEC_CTX_INIT            = 801,
2221         SEC_CTX_INIT_CONT       = 802,
2222         SEC_CTX_FINI            = 803,
2223         SEC_LAST_OPC,
2224         SEC_FIRST_OPC           = SEC_CTX_INIT
2225 } sec_cmd_t;
2226
2227 /*
2228  * capa related definitions
2229  */
2230 #define CAPA_HMAC_MAX_LEN       64
2231 #define CAPA_HMAC_KEY_MAX_LEN   56
2232
2233 /* NB take care when changing the sequence of elements this struct,
2234  * because the offset info is used in find_capa() */
2235 struct lustre_capa {
2236         struct lu_fid   lc_fid;     /* fid */
2237         __u64           lc_opc;     /* operations allowed */
2238         __u32           lc_uid;     /* uid, it is obsolete, but maybe used in
2239                                      * future, reserve it for 64-bits aligned.*/
2240         __u32           lc_flags;   /* HMAC algorithm & flags */
2241         __u32           lc_keyid;   /* key used for the capability */
2242         __u32           lc_timeout; /* capa timeout value (sec) */
2243         __u64           lc_expiry;  /* expiry time (sec) */
2244         __u8            lc_hmac[CAPA_HMAC_MAX_LEN];   /* HMAC */
2245 } __attribute__((packed));
2246
2247 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
2248
2249 /* lustre_capa.lc_opc */
2250 enum {
2251         CAPA_OPC_BODY_WRITE   = 1<<0,  /* write object data */
2252         CAPA_OPC_BODY_READ    = 1<<1,  /* read object data */
2253         CAPA_OPC_INDEX_LOOKUP = 1<<2,  /* lookup object fid */
2254         CAPA_OPC_INDEX_INSERT = 1<<3,  /* insert object fid */
2255         CAPA_OPC_INDEX_DELETE = 1<<4,  /* delete object fid */
2256         CAPA_OPC_OSS_WRITE    = 1<<5,  /* write oss object data */
2257         CAPA_OPC_OSS_READ     = 1<<6,  /* read oss object data */
2258         CAPA_OPC_OSS_TRUNC    = 1<<7,  /* truncate oss object */
2259         CAPA_OPC_META_WRITE   = 1<<8,  /* write object meta data */
2260         CAPA_OPC_META_READ    = 1<<9,  /* read object meta data */
2261
2262 };
2263
2264 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
2265 #define CAPA_OPC_MDS_ONLY                                                   \
2266         (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
2267          CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
2268 #define CAPA_OPC_OSS_ONLY                                                   \
2269         (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC)
2270 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
2271 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
2272
2273 /* MDS capability covers object capability for operations of body r/w
2274  * (dir readpage/sendpage), index lookup/insert/delete and meta data r/w,
2275  * while OSS capability only covers object capability for operations of
2276  * oss data(file content) r/w/truncate.
2277  */
2278 static inline int capa_for_mds(struct lustre_capa *c)
2279 {
2280         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) != 0;
2281 }
2282
2283 static inline int capa_for_oss(struct lustre_capa *c)
2284 {
2285         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) == 0;
2286 }
2287
2288 /* lustre_capa.lc_hmac_alg */
2289 enum {
2290         CAPA_HMAC_ALG_SHA1 = 1, /* sha1 algorithm */
2291         CAPA_HMAC_ALG_MAX,
2292 };
2293
2294 #define CAPA_FL_MASK            0x00ffffff
2295 #define CAPA_HMAC_ALG_MASK      0xff000000
2296
2297 struct lustre_capa_key {
2298         __u64   lk_mdsid;     /* mds# */
2299         __u32   lk_keyid;     /* key# */
2300         __u32   lk_padding;
2301         __u8    lk_key[CAPA_HMAC_KEY_MAX_LEN];    /* key */
2302 } __attribute__((packed));
2303
2304 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
2305
2306 /* quota check function */
2307 #define QUOTA_RET_OK           0 /* return successfully */
2308 #define QUOTA_RET_NOQUOTA      1 /* not support quota */
2309 #define QUOTA_RET_NOLIMIT      2 /* quota limit isn't set */
2310 #define QUOTA_RET_ACQUOTA      3 /* need to acquire extra quota */
2311 #endif