Whamcloud - gitweb
LU-1842 ldlm: add support for quota LVB
[fs/lustre-release.git] / lustre / include / lustre / lustre_idl.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2012, Whamcloud, Inc.
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 /** \defgroup lustreidl lustreidl
42  *
43  * Lustre wire protocol definitions.
44  *
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  * We assume all nodes are either little-endian or big-endian, and we
72  * always send messages in the sender's native format.  The receiver
73  * detects the message format by checking the 'magic' field of the message
74  * (see lustre_msg_swabbed() below).
75  *
76  * Each wire type has corresponding 'lustre_swab_xxxtypexxx()' routines,
77  * implemented either here, inline (trivial implementations) or in
78  * ptlrpc/pack_generic.c.  These 'swabbers' convert the type from "other"
79  * endian, in-place in the message buffer.
80  *
81  * A swabber takes a single pointer argument.  The caller must already have
82  * verified that the length of the message buffer >= sizeof (type).
83  *
84  * For variable length types, a second 'lustre_swab_v_xxxtypexxx()' routine
85  * may be defined that swabs just the variable part, after the caller has
86  * verified that the message buffer is large enough.
87  *
88  * @{
89  */
90
91 #ifndef _LUSTRE_IDL_H_
92 #define _LUSTRE_IDL_H_
93
94 #if !defined(LASSERT) && !defined(LPU64)
95 #include <libcfs/libcfs.h> /* for LASSERT, LPUX64, etc */
96 #endif
97
98 /* Defn's shared with user-space. */
99 #include <lustre/lustre_user.h>
100
101 /*
102  *  GENERAL STUFF
103  */
104 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
105  * FOO_REPLY_PORTAL   is for incoming replies on the FOO
106  * FOO_BULK_PORTAL    is for incoming bulk on the FOO
107  */
108
109 #define CONNMGR_REQUEST_PORTAL          1
110 #define CONNMGR_REPLY_PORTAL            2
111 //#define OSC_REQUEST_PORTAL            3
112 #define OSC_REPLY_PORTAL                4
113 //#define OSC_BULK_PORTAL               5
114 #define OST_IO_PORTAL                   6
115 #define OST_CREATE_PORTAL               7
116 #define OST_BULK_PORTAL                 8
117 //#define MDC_REQUEST_PORTAL            9
118 #define MDC_REPLY_PORTAL               10
119 //#define MDC_BULK_PORTAL              11
120 #define MDS_REQUEST_PORTAL             12
121 //#define MDS_REPLY_PORTAL             13
122 #define MDS_BULK_PORTAL                14
123 #define LDLM_CB_REQUEST_PORTAL         15
124 #define LDLM_CB_REPLY_PORTAL           16
125 #define LDLM_CANCEL_REQUEST_PORTAL     17
126 #define LDLM_CANCEL_REPLY_PORTAL       18
127 //#define PTLBD_REQUEST_PORTAL           19
128 //#define PTLBD_REPLY_PORTAL             20
129 //#define PTLBD_BULK_PORTAL              21
130 #define MDS_SETATTR_PORTAL             22
131 #define MDS_READPAGE_PORTAL            23
132 #define MDS_MDS_PORTAL                 24
133
134 #define MGC_REPLY_PORTAL               25
135 #define MGS_REQUEST_PORTAL             26
136 #define MGS_REPLY_PORTAL               27
137 #define OST_REQUEST_PORTAL             28
138 #define FLD_REQUEST_PORTAL             29
139 #define SEQ_METADATA_PORTAL            30
140 #define SEQ_DATA_PORTAL                31
141 #define SEQ_CONTROLLER_PORTAL          32
142 #define MGS_BULK_PORTAL                33
143
144 /* Portal 63 is reserved for the Cray Inc DVS - nic@cray.com, roe@cray.com, n8851@cray.com */
145
146 /* packet types */
147 #define PTL_RPC_MSG_REQUEST 4711
148 #define PTL_RPC_MSG_ERR     4712
149 #define PTL_RPC_MSG_REPLY   4713
150
151 /* DON'T use swabbed values of MAGIC as magic! */
152 #define LUSTRE_MSG_MAGIC_V1 0x0BD00BD0
153 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
154
155 #define LUSTRE_MSG_MAGIC_V1_SWABBED 0xD00BD00B
156 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
157
158 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
159
160 #define PTLRPC_MSG_VERSION  0x00000003
161 #define LUSTRE_VERSION_MASK 0xffff0000
162 #define LUSTRE_OBD_VERSION  0x00010000
163 #define LUSTRE_MDS_VERSION  0x00020000
164 #define LUSTRE_OST_VERSION  0x00030000
165 #define LUSTRE_DLM_VERSION  0x00040000
166 #define LUSTRE_LOG_VERSION  0x00050000
167 #define LUSTRE_MGS_VERSION  0x00060000
168
169 typedef __u32 mdsno_t;
170 typedef __u64 seqno_t;
171 typedef __u64 obd_id;
172 typedef __u64 obd_seq;
173 typedef __s64 obd_time;
174 typedef __u64 obd_size;
175 typedef __u64 obd_off;
176 typedef __u64 obd_blocks;
177 typedef __u64 obd_valid;
178 typedef __u32 obd_blksize;
179 typedef __u32 obd_mode;
180 typedef __u32 obd_uid;
181 typedef __u32 obd_gid;
182 typedef __u32 obd_flag;
183 typedef __u32 obd_count;
184
185 /**
186  * Describes a range of sequence, lsr_start is included but lsr_end is
187  * not in the range.
188  * Same structure is used in fld module where lsr_index field holds mdt id
189  * of the home mdt.
190  */
191
192 #define LU_SEQ_RANGE_MDT        0x0
193 #define LU_SEQ_RANGE_OST        0x1
194
195 struct lu_seq_range {
196         __u64 lsr_start;
197         __u64 lsr_end;
198         __u32 lsr_index;
199         __u32 lsr_flags;
200 };
201
202 /**
203  * returns  width of given range \a r
204  */
205
206 static inline __u64 range_space(const struct lu_seq_range *range)
207 {
208         return range->lsr_end - range->lsr_start;
209 }
210
211 /**
212  * initialize range to zero
213  */
214
215 static inline void range_init(struct lu_seq_range *range)
216 {
217         range->lsr_start = range->lsr_end = range->lsr_index = 0;
218 }
219
220 /**
221  * check if given seq id \a s is within given range \a r
222  */
223
224 static inline int range_within(const struct lu_seq_range *range,
225                                __u64 s)
226 {
227         return s >= range->lsr_start && s < range->lsr_end;
228 }
229
230 static inline int range_is_sane(const struct lu_seq_range *range)
231 {
232         return (range->lsr_end >= range->lsr_start);
233 }
234
235 static inline int range_is_zero(const struct lu_seq_range *range)
236 {
237         return (range->lsr_start == 0 && range->lsr_end == 0);
238 }
239
240 static inline int range_is_exhausted(const struct lu_seq_range *range)
241
242 {
243         return range_space(range) == 0;
244 }
245
246 /* return 0 if two range have the same location */
247 static inline int range_compare_loc(const struct lu_seq_range *r1,
248                                     const struct lu_seq_range *r2)
249 {
250         return r1->lsr_index != r2->lsr_index ||
251                r1->lsr_flags != r2->lsr_flags;
252 }
253
254 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x):%x:%s"
255
256 #define PRANGE(range)      \
257         (range)->lsr_start, \
258         (range)->lsr_end,    \
259         (range)->lsr_index,  \
260         (range)->lsr_flags == LU_SEQ_RANGE_MDT ? "mdt" : "ost"
261
262
263 /** \defgroup lu_fid lu_fid
264  * @{ */
265
266 /**
267  * Flags for lustre_mdt_attrs::lma_compat and lustre_mdt_attrs::lma_incompat.
268  */
269 enum lma_compat {
270         LMAC_HSM = 0x00000001,
271         LMAC_SOM = 0x00000002,
272 };
273
274 /**
275  * Masks for all features that should be supported by a Lustre version to
276  * access a specific file.
277  * This information is stored in lustre_mdt_attrs::lma_incompat.
278  *
279  * NOTE: No incompat feature should be added before bug #17670 is landed.
280  */
281 #define LMA_INCOMPAT_SUPP 0x0
282
283 /**
284  * Following struct for MDT attributes, that will be kept inode's EA.
285  * Introduced in 2.0 release (please see b15993, for details)
286  */
287 struct lustre_mdt_attrs {
288         /**
289          * Bitfield for supported data in this structure. From enum lma_compat.
290          * lma_self_fid and lma_flags are always available.
291          */
292         __u32   lma_compat;
293         /**
294          * Per-file incompat feature list. Lustre version should support all
295          * flags set in this field. The supported feature mask is available in
296          * LMA_INCOMPAT_SUPP.
297          */
298         __u32   lma_incompat;
299         /** FID of this inode */
300         struct lu_fid  lma_self_fid;
301         /** mdt/ost type, others */
302         __u64   lma_flags;
303         /* IO Epoch SOM attributes belongs to */
304         __u64   lma_ioepoch;
305         /** total file size in objects */
306         __u64   lma_som_size;
307         /** total fs blocks in objects */
308         __u64   lma_som_blocks;
309         /** mds mount id the size is valid for */
310         __u64   lma_som_mountid;
311 };
312
313 /**
314  * Fill \a lma with its first content.
315  * Only fid is stored.
316  */
317 static inline void lustre_lma_init(struct lustre_mdt_attrs *lma,
318                                    const struct lu_fid *fid)
319 {
320         lma->lma_compat      = 0;
321         lma->lma_incompat    = 0;
322         memcpy(&lma->lma_self_fid, fid, sizeof(*fid));
323         lma->lma_flags       = 0;
324         lma->lma_ioepoch     = 0;
325         lma->lma_som_size    = 0;
326         lma->lma_som_blocks  = 0;
327         lma->lma_som_mountid = 0;
328
329         /* If a field is added in struct lustre_mdt_attrs, zero it explicitly
330          * and change the test below. */
331         LASSERT(sizeof(*lma) ==
332                 (offsetof(struct lustre_mdt_attrs, lma_som_mountid) +
333                  sizeof(lma->lma_som_mountid)));
334 };
335
336 extern void lustre_swab_lu_fid(struct lu_fid *fid);
337
338 /**
339  * Swab, if needed, lustre_mdt_attr struct to on-disk format.
340  * Otherwise, do not touch it.
341  */
342 static inline void lustre_lma_swab(struct lustre_mdt_attrs *lma)
343 {
344         /* Use LUSTRE_MSG_MAGIC to detect local endianess. */
345         if (LUSTRE_MSG_MAGIC != cpu_to_le32(LUSTRE_MSG_MAGIC)) {
346                 __swab32s(&lma->lma_compat);
347                 __swab32s(&lma->lma_incompat);
348                 lustre_swab_lu_fid(&lma->lma_self_fid);
349                 __swab64s(&lma->lma_flags);
350                 __swab64s(&lma->lma_ioepoch);
351                 __swab64s(&lma->lma_som_size);
352                 __swab64s(&lma->lma_som_blocks);
353                 __swab64s(&lma->lma_som_mountid);
354         }
355 };
356
357 /* This is the maximum number of MDTs allowed in CMD testing until such
358  * a time that FID-on-OST is implemented.  This is due to the limitations
359  * of packing non-0-MDT numbers into the FID SEQ namespace.  Once FID-on-OST
360  * is implemented this limit will be virtually unlimited. */
361 #define MAX_MDT_COUNT 8
362
363
364 /**
365  * fid constants
366  */
367 enum {
368         /** initial fid id value */
369         LUSTRE_FID_INIT_OID  = 1UL
370 };
371
372 /** returns fid object sequence */
373 static inline __u64 fid_seq(const struct lu_fid *fid)
374 {
375         return fid->f_seq;
376 }
377
378 /** returns fid object id */
379 static inline __u32 fid_oid(const struct lu_fid *fid)
380 {
381         return fid->f_oid;
382 }
383
384 /** returns fid object version */
385 static inline __u32 fid_ver(const struct lu_fid *fid)
386 {
387         return fid->f_ver;
388 }
389
390 static inline void fid_zero(struct lu_fid *fid)
391 {
392         memset(fid, 0, sizeof(*fid));
393 }
394
395 static inline obd_id fid_ver_oid(const struct lu_fid *fid)
396 {
397         return ((__u64)fid_ver(fid) << 32 | fid_oid(fid));
398 }
399
400 /**
401  * Note that reserved SEQ numbers below 12 will conflict with ldiskfs
402  * inodes in the IGIF namespace, so these reserved SEQ numbers can be
403  * used for other purposes and not risk collisions with existing inodes.
404  *
405  * Different FID Format
406  * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs#NEW.0
407  */
408 enum fid_seq {
409         FID_SEQ_OST_MDT0   = 0,
410         FID_SEQ_LLOG       = 1,
411         FID_SEQ_ECHO       = 2,
412         FID_SEQ_OST_MDT1   = 3,
413         FID_SEQ_OST_MAX    = 9, /* Max MDT count before OST_on_FID */
414         FID_SEQ_RSVD       = 11,
415         FID_SEQ_IGIF       = 12,
416         FID_SEQ_IGIF_MAX   = 0x0ffffffffULL,
417         FID_SEQ_IDIF       = 0x100000000ULL,
418         FID_SEQ_IDIF_MAX   = 0x1ffffffffULL,
419         /* Normal FID sequence starts from this value, i.e. 1<<33 */
420         FID_SEQ_START      = 0x200000000ULL,
421         /* sequence for local pre-defined FIDs listed in local_oid */
422         FID_SEQ_LOCAL_FILE = 0x200000001ULL,
423         FID_SEQ_DOT_LUSTRE = 0x200000002ULL,
424         /* XXX 0x200000003ULL is reserved for FID_SEQ_LLOG_OBJ */
425         /* sequence is used for local named objects FIDs generated
426          * by local_object_storage library */
427         FID_SEQ_SPECIAL    = 0x200000004ULL,
428         FID_SEQ_QUOTA      = 0x200000005ULL,
429         FID_SEQ_QUOTA_GLB  = 0x200000006ULL,
430         FID_SEQ_LOCAL_NAME = 0x200000007ULL,
431         FID_SEQ_NORMAL     = 0x200000400ULL,
432         FID_SEQ_LOV_DEFAULT= 0xffffffffffffffffULL
433 };
434
435 #define OBIF_OID_MAX_BITS           32
436 #define OBIF_MAX_OID                (1ULL << OBIF_OID_MAX_BITS)
437 #define OBIF_OID_MASK               ((1ULL << OBIF_OID_MAX_BITS) - 1)
438 #define IDIF_OID_MAX_BITS           48
439 #define IDIF_MAX_OID                (1ULL << IDIF_OID_MAX_BITS)
440 #define IDIF_OID_MASK               ((1ULL << IDIF_OID_MAX_BITS) - 1)
441
442 /** OID for FID_SEQ_SPECIAL */
443 enum special_oid {
444         /* Big Filesystem Lock to serialize rename operations */
445         FID_OID_SPECIAL_BFL     = 1UL,
446 };
447
448 /** OID for FID_SEQ_DOT_LUSTRE */
449 enum dot_lustre_oid {
450         FID_OID_DOT_LUSTRE  = 1UL,
451         FID_OID_DOT_LUSTRE_OBF = 2UL,
452 };
453
454 static inline int fid_seq_is_mdt0(obd_seq seq)
455 {
456         return (seq == FID_SEQ_OST_MDT0);
457 }
458
459 static inline int fid_seq_is_cmd(const __u64 seq)
460 {
461         return (seq >= FID_SEQ_OST_MDT1 && seq <= FID_SEQ_OST_MAX);
462 };
463
464 static inline int fid_seq_is_mdt(const __u64 seq)
465 {
466         return seq == FID_SEQ_OST_MDT0 ||
467                (seq >= FID_SEQ_OST_MDT1 && seq <= FID_SEQ_OST_MAX);
468 };
469
470 static inline int fid_seq_is_rsvd(const __u64 seq)
471 {
472         return (seq > FID_SEQ_OST_MDT0 && seq <= FID_SEQ_RSVD);
473 };
474
475 static inline int fid_is_mdt0(const struct lu_fid *fid)
476 {
477         return fid_seq_is_mdt0(fid_seq(fid));
478 }
479
480 /**
481  * Check if a fid is igif or not.
482  * \param fid the fid to be tested.
483  * \return true if the fid is a igif; otherwise false.
484  */
485 static inline int fid_seq_is_igif(const __u64 seq)
486 {
487         return seq >= FID_SEQ_IGIF && seq <= FID_SEQ_IGIF_MAX;
488 }
489
490 static inline int fid_is_igif(const struct lu_fid *fid)
491 {
492         return fid_seq_is_igif(fid_seq(fid));
493 }
494
495 /**
496  * Check if a fid is idif or not.
497  * \param fid the fid to be tested.
498  * \return true if the fid is a idif; otherwise false.
499  */
500 static inline int fid_seq_is_idif(const __u64 seq)
501 {
502         return seq >= FID_SEQ_IDIF && seq <= FID_SEQ_IDIF_MAX;
503 }
504
505 static inline int fid_is_idif(const struct lu_fid *fid)
506 {
507         return fid_seq_is_idif(fid_seq(fid));
508 }
509
510 struct ost_id {
511         obd_id                 oi_id;
512         obd_seq                oi_seq;
513 };
514
515 static inline int fid_seq_is_norm(const __u64 seq)
516 {
517         return (seq >= FID_SEQ_NORMAL);
518 }
519
520 static inline int fid_is_norm(const struct lu_fid *fid)
521 {
522         return fid_seq_is_norm(fid_seq(fid));
523 }
524
525 /* convert an OST objid into an IDIF FID SEQ number */
526 static inline obd_seq fid_idif_seq(obd_id id, __u32 ost_idx)
527 {
528         return FID_SEQ_IDIF | (ost_idx << 16) | ((id >> 32) & 0xffff);
529 }
530
531 /* convert a packed IDIF FID into an OST objid */
532 static inline obd_id fid_idif_id(obd_seq seq, __u32 oid, __u32 ver)
533 {
534         return ((__u64)ver << 48) | ((seq & 0xffff) << 32) | oid;
535 }
536
537 /* unpack an ostid (id/seq) from a wire/disk structure into an IDIF FID */
538 static inline void ostid_idif_unpack(struct ost_id *ostid,
539                                      struct lu_fid *fid, __u32 ost_idx)
540 {
541         fid->f_seq = fid_idif_seq(ostid->oi_id, ost_idx);
542         fid->f_oid = ostid->oi_id;       /* truncate to 32 bits by assignment */
543         fid->f_ver = ostid->oi_id >> 48; /* in theory, not currently used */
544 }
545
546 /* unpack an ostid (id/seq) from a wire/disk structure into a non-IDIF FID */
547 static inline void ostid_fid_unpack(struct ost_id *ostid, struct lu_fid *fid)
548 {
549         fid->f_seq = ostid->oi_seq;
550         fid->f_oid = ostid->oi_id;       /* truncate to 32 bits by assignment */
551         fid->f_ver = ostid->oi_id >> 32; /* in theory, not currently used */
552 }
553
554 /* Unpack an OST object id/seq (group) into a FID.  This is needed for
555  * converting all obdo, lmm, lsm, etc. 64-bit id/seq pairs into proper
556  * FIDs.  Note that if an id/seq is already in FID/IDIF format it will
557  * be passed through unchanged.  Only legacy OST objects in "group 0"
558  * will be mapped into the IDIF namespace so that they can fit into the
559  * struct lu_fid fields without loss.  For reference see:
560  * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs
561  */
562 static inline int fid_ostid_unpack(struct lu_fid *fid, struct ost_id *ostid,
563                                    __u32 ost_idx)
564 {
565         if (ost_idx > 0xffff) {
566                 CERROR("bad ost_idx, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
567                        ostid->oi_seq, ostid->oi_id, ost_idx);
568                 return -EBADF;
569         }
570
571         if (fid_seq_is_mdt0(ostid->oi_seq)) {
572                 /* This is a "legacy" (old 1.x/2.early) OST object in "group 0"
573                  * that we map into the IDIF namespace.  It allows up to 2^48
574                  * objects per OST, as this is the object namespace that has
575                  * been in production for years.  This can handle create rates
576                  * of 1M objects/s/OST for 9 years, or combinations thereof. */
577                 if (ostid->oi_id >= IDIF_MAX_OID) {
578                          CERROR("bad MDT0 id, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
579                                 ostid->oi_seq, ostid->oi_id, ost_idx);
580                          return -EBADF;
581                 }
582                 ostid_idif_unpack(ostid, fid, ost_idx);
583
584         } else if (fid_seq_is_rsvd(ostid->oi_seq)) {
585                 /* These are legacy OST objects for LLOG/ECHO and CMD testing.
586                  * We only support 2^32 objects in these groups, and cannot
587                  * uniquely identify them in the system (i.e. they are the
588                  * duplicated on all OSTs), but this is not strictly required
589                  * for the old object protocol, which has a separate ost_idx. */
590                 if (ostid->oi_id >= 0xffffffffULL) {
591                          CERROR("bad RSVD id, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
592                                 ostid->oi_seq, ostid->oi_id, ost_idx);
593                          return -EBADF;
594                 }
595                 ostid_fid_unpack(ostid, fid);
596
597         } else if (unlikely(fid_seq_is_igif(ostid->oi_seq))) {
598                 /* This is an MDT inode number, which should never collide with
599                  * proper OST object IDs, and is probably a broken filesystem */
600                 CERROR("bad IGIF, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
601                        ostid->oi_seq, ostid->oi_id, ost_idx);
602                 return -EBADF;
603
604         } else /* if (fid_seq_is_idif(seq) || fid_seq_is_norm(seq)) */ {
605                /* This is either an IDIF object, which identifies objects across
606                 * all OSTs, or a regular FID.  The IDIF namespace maps legacy
607                 * OST objects into the FID namespace.  In both cases, we just
608                 * pass the FID through, no conversion needed. */
609                 ostid_fid_unpack(ostid, fid);
610         }
611
612         return 0;
613 }
614
615 /* pack an IDIF FID into an ostid (id/seq) for the wire/disk */
616 static inline void ostid_idif_pack(const struct lu_fid *fid,
617                                    struct ost_id *ostid)
618 {
619         ostid->oi_seq = FID_SEQ_OST_MDT0;
620         ostid->oi_id  = fid_idif_id(fid->f_seq, fid->f_oid, fid->f_ver);
621 }
622
623 /* pack a non-IDIF FID into an ostid (id/seq) for the wire/disk */
624 static inline void ostid_fid_pack(const struct lu_fid *fid,
625                                   struct ost_id *ostid)
626 {
627         ostid->oi_seq = fid_seq(fid);
628         ostid->oi_id  = fid_ver_oid(fid);
629 }
630
631 /* pack any OST FID into an ostid (id/seq) for the wire/disk */
632 static inline int fid_ostid_pack(const struct lu_fid *fid,
633                                  struct ost_id *ostid)
634 {
635         if (unlikely(fid_seq_is_igif(fid->f_seq))) {
636                 CERROR("bad IGIF, "DFID"\n", PFID(fid));
637                 return -EBADF;
638         }
639
640         if (fid_is_idif(fid))
641                 ostid_idif_pack(fid, ostid);
642         else
643                 ostid_fid_pack(fid, ostid);
644
645         return 0;
646 }
647
648 /* extract OST sequence (group) from a wire ost_id (id/seq) pair */
649 static inline obd_seq ostid_seq(struct ost_id *ostid)
650 {
651         if (unlikely(fid_seq_is_igif(ostid->oi_seq)))
652                 CWARN("bad IGIF, oi_seq: "LPU64" oi_id: "LPX64"\n",
653                       ostid->oi_seq, ostid->oi_id);
654
655         if (unlikely(fid_seq_is_idif(ostid->oi_seq)))
656                 return FID_SEQ_OST_MDT0;
657
658         return ostid->oi_seq;
659 }
660
661 /* extract OST objid from a wire ost_id (id/seq) pair */
662 static inline obd_id ostid_id(struct ost_id *ostid)
663 {
664         if (ostid->oi_seq == FID_SEQ_OST_MDT0)
665                 return ostid->oi_id & IDIF_OID_MASK;
666
667         if (fid_seq_is_rsvd(ostid->oi_seq))
668                 return ostid->oi_id & OBIF_OID_MASK;
669
670         if (fid_seq_is_idif(ostid->oi_seq))
671                 return fid_idif_id(ostid->oi_seq, ostid->oi_id, 0);
672
673         return ostid->oi_id;
674 }
675
676 /**
677  * Get inode number from a igif.
678  * \param fid a igif to get inode number from.
679  * \return inode number for the igif.
680  */
681 static inline ino_t lu_igif_ino(const struct lu_fid *fid)
682 {
683         return fid_seq(fid);
684 }
685
686 /**
687  * Build igif from the inode number/generation.
688  */
689 #define LU_IGIF_BUILD(fid, ino, gen)                    \
690 do {                                                    \
691         fid->f_seq = ino;                               \
692         fid->f_oid = gen;                               \
693         fid->f_ver = 0;                                 \
694 } while(0)
695 static inline void lu_igif_build(struct lu_fid *fid, __u32 ino, __u32 gen)
696 {
697         LU_IGIF_BUILD(fid, ino, gen);
698         LASSERT(fid_is_igif(fid));
699 }
700
701 /**
702  * Get inode generation from a igif.
703  * \param fid a igif to get inode generation from.
704  * \return inode generation for the igif.
705  */
706 static inline __u32 lu_igif_gen(const struct lu_fid *fid)
707 {
708         return fid_oid(fid);
709 }
710
711 /*
712  * Fids are transmitted across network (in the sender byte-ordering),
713  * and stored on disk in big-endian order.
714  */
715 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
716 {
717         /* check that all fields are converted */
718         CLASSERT(sizeof *src ==
719                  sizeof fid_seq(src) +
720                  sizeof fid_oid(src) + sizeof fid_ver(src));
721         LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
722         dst->f_seq = cpu_to_le64(fid_seq(src));
723         dst->f_oid = cpu_to_le32(fid_oid(src));
724         dst->f_ver = cpu_to_le32(fid_ver(src));
725 }
726
727 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
728 {
729         /* check that all fields are converted */
730         CLASSERT(sizeof *src ==
731                  sizeof fid_seq(src) +
732                  sizeof fid_oid(src) + sizeof fid_ver(src));
733         dst->f_seq = le64_to_cpu(fid_seq(src));
734         dst->f_oid = le32_to_cpu(fid_oid(src));
735         dst->f_ver = le32_to_cpu(fid_ver(src));
736         LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
737 }
738
739 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
740 {
741         /* check that all fields are converted */
742         CLASSERT(sizeof *src ==
743                  sizeof fid_seq(src) +
744                  sizeof fid_oid(src) + sizeof fid_ver(src));
745         LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
746         dst->f_seq = cpu_to_be64(fid_seq(src));
747         dst->f_oid = cpu_to_be32(fid_oid(src));
748         dst->f_ver = cpu_to_be32(fid_ver(src));
749 }
750
751 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
752 {
753         /* check that all fields are converted */
754         CLASSERT(sizeof *src ==
755                  sizeof fid_seq(src) +
756                  sizeof fid_oid(src) + sizeof fid_ver(src));
757         dst->f_seq = be64_to_cpu(fid_seq(src));
758         dst->f_oid = be32_to_cpu(fid_oid(src));
759         dst->f_ver = be32_to_cpu(fid_ver(src));
760         LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
761 }
762
763 static inline int fid_is_sane(const struct lu_fid *fid)
764 {
765         return
766                 fid != NULL &&
767                 ((fid_seq(fid) >= FID_SEQ_START && fid_oid(fid) != 0
768                                                 && fid_ver(fid) == 0) ||
769                 fid_is_igif(fid) || fid_seq_is_rsvd(fid_seq(fid)));
770 }
771
772 static inline int fid_is_zero(const struct lu_fid *fid)
773 {
774         return fid_seq(fid) == 0 && fid_oid(fid) == 0;
775 }
776
777 extern void lustre_swab_lu_fid(struct lu_fid *fid);
778 extern void lustre_swab_lu_seq_range(struct lu_seq_range *range);
779
780 static inline int lu_fid_eq(const struct lu_fid *f0,
781                             const struct lu_fid *f1)
782 {
783         /* Check that there is no alignment padding. */
784         CLASSERT(sizeof *f0 ==
785                  sizeof f0->f_seq + sizeof f0->f_oid + sizeof f0->f_ver);
786         LASSERTF((fid_is_igif(f0) || fid_is_idif(f0)) ||
787                  fid_ver(f0) == 0, DFID, PFID(f0));
788         LASSERTF((fid_is_igif(f1) || fid_is_idif(f1)) ||
789                  fid_ver(f1) == 0, DFID, PFID(f1));
790         return memcmp(f0, f1, sizeof *f0) == 0;
791 }
792
793 #define __diff_normalize(val0, val1)                            \
794 ({                                                              \
795         typeof(val0) __val0 = (val0);                           \
796         typeof(val1) __val1 = (val1);                           \
797                                                                 \
798         (__val0 == __val1 ? 0 : __val0 > __val1 ? +1 : -1);     \
799 })
800
801 static inline int lu_fid_cmp(const struct lu_fid *f0,
802                              const struct lu_fid *f1)
803 {
804         return
805                 __diff_normalize(fid_seq(f0), fid_seq(f1)) ?:
806                 __diff_normalize(fid_oid(f0), fid_oid(f1)) ?:
807                 __diff_normalize(fid_ver(f0), fid_ver(f1));
808 }
809
810 /** @} lu_fid */
811
812 /** \defgroup lu_dir lu_dir
813  * @{ */
814
815 /**
816  * Enumeration of possible directory entry attributes.
817  *
818  * Attributes follow directory entry header in the order they appear in this
819  * enumeration.
820  */
821 enum lu_dirent_attrs {
822         LUDA_FID        = 0x0001,
823         LUDA_TYPE       = 0x0002,
824         LUDA_64BITHASH  = 0x0004,
825 };
826
827 /**
828  * Layout of readdir pages, as transmitted on wire.
829  */
830 struct lu_dirent {
831         /** valid if LUDA_FID is set. */
832         struct lu_fid lde_fid;
833         /** a unique entry identifier: a hash or an offset. */
834         __u64         lde_hash;
835         /** total record length, including all attributes. */
836         __u16         lde_reclen;
837         /** name length */
838         __u16         lde_namelen;
839         /** optional variable size attributes following this entry.
840          *  taken from enum lu_dirent_attrs.
841          */
842         __u32         lde_attrs;
843         /** name is followed by the attributes indicated in ->ldp_attrs, in
844          *  their natural order. After the last attribute, padding bytes are
845          *  added to make ->lde_reclen a multiple of 8.
846          */
847         char          lde_name[0];
848 };
849
850 /*
851  * Definitions of optional directory entry attributes formats.
852  *
853  * Individual attributes do not have their length encoded in a generic way. It
854  * is assumed that consumer of an attribute knows its format. This means that
855  * it is impossible to skip over an unknown attribute, except by skipping over all
856  * remaining attributes (by using ->lde_reclen), which is not too
857  * constraining, because new server versions will append new attributes at
858  * the end of an entry.
859  */
860
861 /**
862  * Fid directory attribute: a fid of an object referenced by the entry. This
863  * will be almost always requested by the client and supplied by the server.
864  *
865  * Aligned to 8 bytes.
866  */
867 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
868
869 /**
870  * File type.
871  *
872  * Aligned to 2 bytes.
873  */
874 struct luda_type {
875         __u16 lt_type;
876 };
877
878 struct lu_dirpage {
879         __u64            ldp_hash_start;
880         __u64            ldp_hash_end;
881         __u32            ldp_flags;
882         __u32            ldp_pad0;
883         struct lu_dirent ldp_entries[0];
884 };
885
886 enum lu_dirpage_flags {
887         /**
888          * dirpage contains no entry.
889          */
890         LDF_EMPTY   = 1 << 0,
891         /**
892          * last entry's lde_hash equals ldp_hash_end.
893          */
894         LDF_COLLIDE = 1 << 1
895 };
896
897 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
898 {
899         if (le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
900                 return NULL;
901         else
902                 return dp->ldp_entries;
903 }
904
905 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
906 {
907         struct lu_dirent *next;
908
909         if (le16_to_cpu(ent->lde_reclen) != 0)
910                 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
911         else
912                 next = NULL;
913
914         return next;
915 }
916
917 static inline int lu_dirent_calc_size(int namelen, __u16 attr)
918 {
919         int size;
920
921         if (attr & LUDA_TYPE) {
922                 const unsigned align = sizeof(struct luda_type) - 1;
923                 size = (sizeof(struct lu_dirent) + namelen + align) & ~align;
924                 size += sizeof(struct luda_type);
925         } else
926                 size = sizeof(struct lu_dirent) + namelen;
927
928         return (size + 7) & ~7;
929 }
930
931 static inline int lu_dirent_size(struct lu_dirent *ent)
932 {
933         if (le16_to_cpu(ent->lde_reclen) == 0) {
934                 return lu_dirent_calc_size(le16_to_cpu(ent->lde_namelen),
935                                            le32_to_cpu(ent->lde_attrs));
936         }
937         return le16_to_cpu(ent->lde_reclen);
938 }
939
940 #define MDS_DIR_END_OFF 0xfffffffffffffffeULL
941
942 /**
943  * MDS_READPAGE page size
944  *
945  * This is the directory page size packed in MDS_READPAGE RPC.
946  * It's different than CFS_PAGE_SIZE because the client needs to
947  * access the struct lu_dirpage header packed at the beginning of
948  * the "page" and without this there isn't any way to know find the
949  * lu_dirpage header is if client and server CFS_PAGE_SIZE differ.
950  */
951 #define LU_PAGE_SHIFT 12
952 #define LU_PAGE_SIZE  (1UL << LU_PAGE_SHIFT)
953 #define LU_PAGE_MASK  (~(LU_PAGE_SIZE - 1))
954
955 #define LU_PAGE_COUNT (1 << (CFS_PAGE_SHIFT - LU_PAGE_SHIFT))
956
957 /** @} lu_dir */
958
959 struct lustre_handle {
960         __u64 cookie;
961 };
962 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
963
964 static inline int lustre_handle_is_used(struct lustre_handle *lh)
965 {
966         return lh->cookie != 0ull;
967 }
968
969 static inline int lustre_handle_equal(const struct lustre_handle *lh1,
970                                       const struct lustre_handle *lh2)
971 {
972         return lh1->cookie == lh2->cookie;
973 }
974
975 static inline void lustre_handle_copy(struct lustre_handle *tgt,
976                                       struct lustre_handle *src)
977 {
978         tgt->cookie = src->cookie;
979 }
980
981 /* flags for lm_flags */
982 #define MSGHDR_AT_SUPPORT               0x1
983 #define MSGHDR_CKSUM_INCOMPAT18         0x2
984
985 #define lustre_msg lustre_msg_v2
986 /* we depend on this structure to be 8-byte aligned */
987 /* this type is only endian-adjusted in lustre_unpack_msg() */
988 struct lustre_msg_v2 {
989         __u32 lm_bufcount;
990         __u32 lm_secflvr;
991         __u32 lm_magic;
992         __u32 lm_repsize;
993         __u32 lm_cksum;
994         __u32 lm_flags;
995         __u32 lm_padding_2;
996         __u32 lm_padding_3;
997         __u32 lm_buflens[0];
998 };
999
1000 /* without gss, ptlrpc_body is put at the first buffer. */
1001 #define PTLRPC_NUM_VERSIONS     4
1002 #define JOBSTATS_JOBID_SIZE     32  /* 32 bytes string */
1003 struct ptlrpc_body_v3 {
1004         struct lustre_handle pb_handle;
1005         __u32 pb_type;
1006         __u32 pb_version;
1007         __u32 pb_opc;
1008         __u32 pb_status;
1009         __u64 pb_last_xid;
1010         __u64 pb_last_seen;
1011         __u64 pb_last_committed;
1012         __u64 pb_transno;
1013         __u32 pb_flags;
1014         __u32 pb_op_flags;
1015         __u32 pb_conn_cnt;
1016         __u32 pb_timeout;  /* for req, the deadline, for rep, the service est */
1017         __u32 pb_service_time; /* for rep, actual service time */
1018         __u32 pb_limit;
1019         __u64 pb_slv;
1020         /* VBR: pre-versions */
1021         __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1022         /* padding for future needs */
1023         __u64 pb_padding[4];
1024         char  pb_jobid[JOBSTATS_JOBID_SIZE];
1025 };
1026 #define ptlrpc_body     ptlrpc_body_v3
1027
1028 struct ptlrpc_body_v2 {
1029         struct lustre_handle pb_handle;
1030         __u32 pb_type;
1031         __u32 pb_version;
1032         __u32 pb_opc;
1033         __u32 pb_status;
1034         __u64 pb_last_xid;
1035         __u64 pb_last_seen;
1036         __u64 pb_last_committed;
1037         __u64 pb_transno;
1038         __u32 pb_flags;
1039         __u32 pb_op_flags;
1040         __u32 pb_conn_cnt;
1041         __u32 pb_timeout;  /* for req, the deadline, for rep, the service est */
1042         __u32 pb_service_time; /* for rep, actual service time, also used for
1043                                   net_latency of req */
1044         __u32 pb_limit;
1045         __u64 pb_slv;
1046         /* VBR: pre-versions */
1047         __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1048         /* padding for future needs */
1049         __u64 pb_padding[4];
1050 };
1051
1052 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
1053
1054 /* message body offset for lustre_msg_v2 */
1055 /* ptlrpc body offset in all request/reply messages */
1056 #define MSG_PTLRPC_BODY_OFF             0
1057
1058 /* normal request/reply message record offset */
1059 #define REQ_REC_OFF                     1
1060 #define REPLY_REC_OFF                   1
1061
1062 /* ldlm request message body offset */
1063 #define DLM_LOCKREQ_OFF                 1 /* lockreq offset */
1064 #define DLM_REQ_REC_OFF                 2 /* normal dlm request record offset */
1065
1066 /* ldlm intent lock message body offset */
1067 #define DLM_INTENT_IT_OFF               2 /* intent lock it offset */
1068 #define DLM_INTENT_REC_OFF              3 /* intent lock record offset */
1069
1070 /* ldlm reply message body offset */
1071 #define DLM_LOCKREPLY_OFF               1 /* lockrep offset */
1072 #define DLM_REPLY_REC_OFF               2 /* reply record offset */
1073
1074 /** only use in req->rq_{req,rep}_swab_mask */
1075 #define MSG_PTLRPC_HEADER_OFF           31
1076
1077 /* Flags that are operation-specific go in the top 16 bits. */
1078 #define MSG_OP_FLAG_MASK   0xffff0000
1079 #define MSG_OP_FLAG_SHIFT  16
1080
1081 /* Flags that apply to all requests are in the bottom 16 bits */
1082 #define MSG_GEN_FLAG_MASK     0x0000ffff
1083 #define MSG_LAST_REPLAY           0x0001
1084 #define MSG_RESENT                0x0002
1085 #define MSG_REPLAY                0x0004
1086 /* #define MSG_AT_SUPPORT         0x0008
1087  * This was used in early prototypes of adaptive timeouts, and while there
1088  * shouldn't be any users of that code there also isn't a need for using this
1089  * bits. Defer usage until at least 1.10 to avoid potential conflict. */
1090 #define MSG_DELAY_REPLAY          0x0010
1091 #define MSG_VERSION_REPLAY        0x0020
1092 #define MSG_REQ_REPLAY_DONE       0x0040
1093 #define MSG_LOCK_REPLAY_DONE      0x0080
1094
1095 /*
1096  * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
1097  */
1098
1099 #define MSG_CONNECT_RECOVERING  0x00000001
1100 #define MSG_CONNECT_RECONNECT   0x00000002
1101 #define MSG_CONNECT_REPLAYABLE  0x00000004
1102 //#define MSG_CONNECT_PEER        0x8
1103 #define MSG_CONNECT_LIBCLIENT   0x00000010
1104 #define MSG_CONNECT_INITIAL     0x00000020
1105 #define MSG_CONNECT_ASYNC       0x00000040
1106 #define MSG_CONNECT_NEXT_VER    0x00000080 /* use next version of lustre_msg */
1107 #define MSG_CONNECT_TRANSNO     0x00000100 /* report transno */
1108
1109 /* Connect flags */
1110 #define OBD_CONNECT_RDONLY                0x1ULL /*client has read-only access*/
1111 #define OBD_CONNECT_INDEX                 0x2ULL /*connect specific LOV idx */
1112 #define OBD_CONNECT_MDS                   0x4ULL /*connect from MDT to OST */
1113 #define OBD_CONNECT_GRANT                 0x8ULL /*OSC gets grant at connect */
1114 #define OBD_CONNECT_SRVLOCK              0x10ULL /*server takes locks for cli */
1115 #define OBD_CONNECT_VERSION              0x20ULL /*Lustre versions in ocd */
1116 #define OBD_CONNECT_REQPORTAL            0x40ULL /*Separate non-IO req portal */
1117 #define OBD_CONNECT_ACL                  0x80ULL /*access control lists */
1118 #define OBD_CONNECT_XATTR               0x100ULL /*client use extended attr */
1119 #define OBD_CONNECT_CROW                0x200ULL /*MDS+OST create obj on write*/
1120 #define OBD_CONNECT_TRUNCLOCK           0x400ULL /*locks on server for punch */
1121 #define OBD_CONNECT_TRANSNO             0x800ULL /*replay sends init transno */
1122 #define OBD_CONNECT_IBITS              0x1000ULL /*support for inodebits locks*/
1123 #define OBD_CONNECT_JOIN               0x2000ULL /*files can be concatenated.
1124                                                   *We do not support JOIN FILE
1125                                                   *anymore, reserve this flags
1126                                                   *just for preventing such bit
1127                                                   *to be reused.*/
1128 #define OBD_CONNECT_ATTRFID            0x4000ULL /*Server can GetAttr By Fid*/
1129 #define OBD_CONNECT_NODEVOH            0x8000ULL /*No open hndl on specl nodes*/
1130 #define OBD_CONNECT_RMT_CLIENT        0x10000ULL /*Remote client */
1131 #define OBD_CONNECT_RMT_CLIENT_FORCE  0x20000ULL /*Remote client by force */
1132 #define OBD_CONNECT_BRW_SIZE          0x40000ULL /*Max bytes per rpc */
1133 #define OBD_CONNECT_QUOTA64           0x80000ULL /*64bit qunit_data.qd_count */
1134 #define OBD_CONNECT_MDS_CAPA         0x100000ULL /*MDS capability */
1135 #define OBD_CONNECT_OSS_CAPA         0x200000ULL /*OSS capability */
1136 #define OBD_CONNECT_CANCELSET        0x400000ULL /*Early batched cancels. */
1137 #define OBD_CONNECT_SOM              0x800000ULL /*Size on MDS */
1138 #define OBD_CONNECT_AT              0x1000000ULL /*client uses AT */
1139 #define OBD_CONNECT_LRU_RESIZE      0x2000000ULL /*LRU resize feature. */
1140 #define OBD_CONNECT_MDS_MDS         0x4000000ULL /*MDS-MDS connection */
1141 #define OBD_CONNECT_REAL            0x8000000ULL /*real connection */
1142 #define OBD_CONNECT_CHANGE_QS      0x10000000ULL /*shrink/enlarge qunit */
1143 #define OBD_CONNECT_CKSUM          0x20000000ULL /*support several cksum algos*/
1144 #define OBD_CONNECT_FID            0x40000000ULL /*FID is supported by server */
1145 #define OBD_CONNECT_VBR            0x80000000ULL /*version based recovery */
1146 #define OBD_CONNECT_LOV_V3        0x100000000ULL /*client supports LOV v3 EA */
1147 #define OBD_CONNECT_GRANT_SHRINK  0x200000000ULL /* support grant shrink */
1148 #define OBD_CONNECT_SKIP_ORPHAN   0x400000000ULL /* don't reuse orphan objids */
1149 #define OBD_CONNECT_MAX_EASIZE    0x800000000ULL /* preserved for large EA */
1150 #define OBD_CONNECT_FULL20       0x1000000000ULL /* it is 2.0 client */
1151 #define OBD_CONNECT_LAYOUTLOCK   0x2000000000ULL /* client uses layout lock */
1152 #define OBD_CONNECT_64BITHASH    0x4000000000ULL /* client supports 64-bits
1153                                                   * directory hash */
1154 #define OBD_CONNECT_MAXBYTES     0x8000000000ULL /* max stripe size */
1155 #define OBD_CONNECT_IMP_RECOV   0x10000000000ULL /* imp recovery support */
1156 #define OBD_CONNECT_JOBSTATS    0x20000000000ULL /* jobid in ptlrpc_body */
1157 #define OBD_CONNECT_UMASK       0x40000000000ULL /* create uses client umask */
1158 #define OBD_CONNECT_EINPROGRESS 0x80000000000ULL /* client handles -EINPROGRESS
1159                                                   * RPC error properly */
1160 #define OBD_CONNECT_GRANT_PARAM 0x100000000000ULL/* extra grant params used for
1161                                                   * finer space reservation */
1162 #define OBD_CONNECT_NANOSEC_TIME 0x200000000000ULL /* nanosecond timestamps */
1163 #define OBD_CONNECT_LVB_TYPE    0x400000000000ULL /* variable type of LVB */
1164 #define OBD_CONNECT_LIGHTWEIGHT 0x1000000000000ULL/* lightweight connection */
1165 /* XXX README XXX:
1166  * Please DO NOT add flag values here before first ensuring that this same
1167  * flag value is not in use on some other branch.  Please clear any such
1168  * changes with senior engineers before starting to use a new flag.  Then,
1169  * submit a small patch against EVERY branch that ONLY adds the new flag
1170  * and updates obd_connect_names[] for lprocfs_rd_connect_flags(), so it
1171  * can be approved and landed easily to reserve the flag for future use. */
1172
1173 /* The MNE_SWAB flag is overloading the MDS_MDS bit only for the MGS
1174  * connection.  It is a temporary bug fix for Imperative Recovery interop
1175  * between 2.2 and 2.3 x86/ppc nodes, and can be removed when interop for
1176  * 2.2 clients/servers is no longer needed.  LU-1252/LU-1644. */
1177 #define OBD_CONNECT_MNE_SWAB             OBD_CONNECT_MDS_MDS
1178
1179 #define OCD_HAS_FLAG(ocd, flg)  \
1180         (!!((ocd)->ocd_connect_flags & OBD_CONNECT_##flg))
1181
1182
1183 #ifdef HAVE_LRU_RESIZE_SUPPORT
1184 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
1185 #else
1186 #define LRU_RESIZE_CONNECT_FLAG 0
1187 #endif
1188
1189 #define MDT_CONNECT_SUPPORTED  (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
1190                                 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
1191                                 OBD_CONNECT_IBITS | \
1192                                 OBD_CONNECT_NODEVOH | OBD_CONNECT_ATTRFID | \
1193                                 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1194                                 OBD_CONNECT_RMT_CLIENT | \
1195                                 OBD_CONNECT_RMT_CLIENT_FORCE | \
1196                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_MDS_CAPA | \
1197                                 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_MDS_MDS | \
1198                                 OBD_CONNECT_FID | LRU_RESIZE_CONNECT_FLAG | \
1199                                 OBD_CONNECT_VBR | OBD_CONNECT_LOV_V3 | \
1200                                 OBD_CONNECT_SOM | OBD_CONNECT_FULL20 | \
1201                                 OBD_CONNECT_64BITHASH | OBD_CONNECT_JOBSTATS | \
1202                                 OBD_CONNECT_EINPROGRESS | \
1203                                 OBD_CONNECT_LIGHTWEIGHT)
1204 #define OST_CONNECT_SUPPORTED  (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
1205                                 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
1206                                 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
1207                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_QUOTA64 | \
1208                                 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1209                                 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_CKSUM | \
1210                                 OBD_CONNECT_CHANGE_QS | \
1211                                 OBD_CONNECT_OSS_CAPA  | \
1212                                 OBD_CONNECT_RMT_CLIENT | \
1213                                 OBD_CONNECT_RMT_CLIENT_FORCE | OBD_CONNECT_VBR | \
1214                                 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
1215                                 OBD_CONNECT_GRANT_SHRINK | OBD_CONNECT_FULL20 | \
1216                                 OBD_CONNECT_64BITHASH | OBD_CONNECT_MAXBYTES | \
1217                                 OBD_CONNECT_MAX_EASIZE | \
1218                                 OBD_CONNECT_EINPROGRESS | \
1219                                 OBD_CONNECT_JOBSTATS | OBD_CONNECT_LIGHTWEIGHT)
1220 #define ECHO_CONNECT_SUPPORTED (0)
1221 #define MGS_CONNECT_SUPPORTED  (OBD_CONNECT_VERSION | OBD_CONNECT_AT | \
1222                                 OBD_CONNECT_FULL20 | OBD_CONNECT_IMP_RECOV | \
1223                                 OBD_CONNECT_MNE_SWAB)
1224
1225 /* Features required for this version of the client to work with server */
1226 #define CLIENT_CONNECT_MDT_REQD (OBD_CONNECT_IBITS | OBD_CONNECT_FID | \
1227                                  OBD_CONNECT_FULL20)
1228
1229 #define OBD_OCD_VERSION(major,minor,patch,fix) (((major)<<24) + ((minor)<<16) +\
1230                                                 ((patch)<<8) + (fix))
1231 #define OBD_OCD_VERSION_MAJOR(version) ((int)((version)>>24)&255)
1232 #define OBD_OCD_VERSION_MINOR(version) ((int)((version)>>16)&255)
1233 #define OBD_OCD_VERSION_PATCH(version) ((int)((version)>>8)&255)
1234 #define OBD_OCD_VERSION_FIX(version)   ((int)(version)&255)
1235
1236 /* This structure is used for both request and reply.
1237  *
1238  * If we eventually have separate connect data for different types, which we
1239  * almost certainly will, then perhaps we stick a union in here. */
1240 struct obd_connect_data_v1 {
1241         __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1242         __u32 ocd_version;       /* lustre release version number */
1243         __u32 ocd_grant;         /* initial cache grant amount (bytes) */
1244         __u32 ocd_index;         /* LOV index to connect to */
1245         __u32 ocd_brw_size;      /* Maximum BRW size in bytes */
1246         __u64 ocd_ibits_known;   /* inode bits this client understands */
1247         __u8  ocd_blocksize;     /* log2 of the backend filesystem blocksize */
1248         __u8  ocd_inodespace;    /* log2 of the per-inode space consumption */
1249         __u16 ocd_grant_extent;  /* per-extent grant overhead, in 1K blocks */
1250         __u32 ocd_unused;        /* also fix lustre_swab_connect */
1251         __u64 ocd_transno;       /* first transno from client to be replayed */
1252         __u32 ocd_group;         /* MDS group on OST */
1253         __u32 ocd_cksum_types;   /* supported checksum algorithms */
1254         __u32 ocd_max_easize;    /* How big LOV EA can be on MDS */
1255         __u32 ocd_instance;      /* also fix lustre_swab_connect */
1256         __u64 ocd_maxbytes;      /* Maximum stripe size in bytes */
1257 };
1258
1259 struct obd_connect_data {
1260         __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1261         __u32 ocd_version;       /* lustre release version number */
1262         __u32 ocd_grant;         /* initial cache grant amount (bytes) */
1263         __u32 ocd_index;         /* LOV index to connect to */
1264         __u32 ocd_brw_size;      /* Maximum BRW size in bytes */
1265         __u64 ocd_ibits_known;   /* inode bits this client understands */
1266         __u8  ocd_blocksize;     /* log2 of the backend filesystem blocksize */
1267         __u8  ocd_inodespace;    /* log2 of the per-inode space consumption */
1268         __u16 ocd_grant_extent;  /* per-extent grant overhead, in 1K blocks */
1269         __u32 ocd_unused;        /* also fix lustre_swab_connect */
1270         __u64 ocd_transno;       /* first transno from client to be replayed */
1271         __u32 ocd_group;         /* MDS group on OST */
1272         __u32 ocd_cksum_types;   /* supported checksum algorithms */
1273         __u32 ocd_max_easize;    /* How big LOV EA can be on MDS */
1274         __u32 ocd_instance;      /* instance # of this target */
1275         __u64 ocd_maxbytes;      /* Maximum stripe size in bytes */
1276         /* Fields after ocd_maxbytes are only accessible by the receiver
1277          * if the corresponding flag in ocd_connect_flags is set. Accessing
1278          * any field after ocd_maxbytes on the receiver without a valid flag
1279          * may result in out-of-bound memory access and kernel oops. */
1280         __u64 padding1;          /* added 2.1.0. also fix lustre_swab_connect */
1281         __u64 padding2;          /* added 2.1.0. also fix lustre_swab_connect */
1282         __u64 padding3;          /* added 2.1.0. also fix lustre_swab_connect */
1283         __u64 padding4;          /* added 2.1.0. also fix lustre_swab_connect */
1284         __u64 padding5;          /* added 2.1.0. also fix lustre_swab_connect */
1285         __u64 padding6;          /* added 2.1.0. also fix lustre_swab_connect */
1286         __u64 padding7;          /* added 2.1.0. also fix lustre_swab_connect */
1287         __u64 padding8;          /* added 2.1.0. also fix lustre_swab_connect */
1288         __u64 padding9;          /* added 2.1.0. also fix lustre_swab_connect */
1289         __u64 paddingA;          /* added 2.1.0. also fix lustre_swab_connect */
1290         __u64 paddingB;          /* added 2.1.0. also fix lustre_swab_connect */
1291         __u64 paddingC;          /* added 2.1.0. also fix lustre_swab_connect */
1292         __u64 paddingD;          /* added 2.1.0. also fix lustre_swab_connect */
1293         __u64 paddingE;          /* added 2.1.0. also fix lustre_swab_connect */
1294         __u64 paddingF;          /* added 2.1.0. also fix lustre_swab_connect */
1295 };
1296 /* XXX README XXX:
1297  * Please DO NOT use any fields here before first ensuring that this same
1298  * field is not in use on some other branch.  Please clear any such changes
1299  * with senior engineers before starting to use a new field.  Then, submit
1300  * a small patch against EVERY branch that ONLY adds the new field along with
1301  * the matching OBD_CONNECT flag, so that can be approved and landed easily to
1302  * reserve the flag for future use. */
1303
1304
1305 extern void lustre_swab_connect(struct obd_connect_data *ocd);
1306
1307 /*
1308  * Supported checksum algorithms. Up to 32 checksum types are supported.
1309  * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
1310  * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
1311  * algorithm and also the OBD_FL_CKSUM* flags.
1312  */
1313 typedef enum {
1314         OBD_CKSUM_CRC32 = 0x00000001,
1315         OBD_CKSUM_ADLER = 0x00000002,
1316         OBD_CKSUM_CRC32C= 0x00000004,
1317 } cksum_type_t;
1318
1319 /*
1320  *   OST requests: OBDO & OBD request records
1321  */
1322
1323 /* opcodes */
1324 typedef enum {
1325         OST_REPLY      =  0,       /* reply ? */
1326         OST_GETATTR    =  1,
1327         OST_SETATTR    =  2,
1328         OST_READ       =  3,
1329         OST_WRITE      =  4,
1330         OST_CREATE     =  5,
1331         OST_DESTROY    =  6,
1332         OST_GET_INFO   =  7,
1333         OST_CONNECT    =  8,
1334         OST_DISCONNECT =  9,
1335         OST_PUNCH      = 10,
1336         OST_OPEN       = 11,
1337         OST_CLOSE      = 12,
1338         OST_STATFS     = 13,
1339         OST_SYNC       = 16,
1340         OST_SET_INFO   = 17,
1341         OST_QUOTACHECK = 18,
1342         OST_QUOTACTL   = 19,
1343         OST_QUOTA_ADJUST_QUNIT = 20,
1344         OST_LAST_OPC
1345 } ost_cmd_t;
1346 #define OST_FIRST_OPC  OST_REPLY
1347
1348 enum obdo_flags {
1349         OBD_FL_INLINEDATA   = 0x00000001,
1350         OBD_FL_OBDMDEXISTS  = 0x00000002,
1351         OBD_FL_DELORPHAN    = 0x00000004, /* if set in o_flags delete orphans */
1352         OBD_FL_NORPC        = 0x00000008, /* set in o_flags do in OSC not OST */
1353         OBD_FL_IDONLY       = 0x00000010, /* set in o_flags only adjust obj id*/
1354         OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
1355         OBD_FL_DEBUG_CHECK  = 0x00000040, /* echo client/server debug check */
1356         OBD_FL_NO_USRQUOTA  = 0x00000100, /* the object's owner is over quota */
1357         OBD_FL_NO_GRPQUOTA  = 0x00000200, /* the object's group is over quota */
1358         OBD_FL_CREATE_CROW  = 0x00000400, /* object should be create on write */
1359         OBD_FL_SRVLOCK      = 0x00000800, /* delegate DLM locking to server */
1360         OBD_FL_CKSUM_CRC32  = 0x00001000, /* CRC32 checksum type */
1361         OBD_FL_CKSUM_ADLER  = 0x00002000, /* ADLER checksum type */
1362         OBD_FL_CKSUM_CRC32C = 0x00004000, /* CRC32C checksum type */
1363         OBD_FL_CKSUM_RSVD2  = 0x00008000, /* for future cksum types */
1364         OBD_FL_CKSUM_RSVD3  = 0x00010000, /* for future cksum types */
1365         OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
1366         OBD_FL_MMAP         = 0x00040000, /* object is mmapped on the client.
1367                                            * XXX: obsoleted - reserved for old
1368                                            * clients prior than 2.2 */
1369         OBD_FL_RECOV_RESEND = 0x00080000, /* recoverable resent */
1370         OBD_FL_NOSPC_BLK    = 0x00100000, /* no more block space on OST */
1371
1372         /* Note that while these checksum values are currently separate bits,
1373          * in 2.x we can actually allow all values from 1-31 if we wanted. */
1374         OBD_FL_CKSUM_ALL    = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER |
1375                               OBD_FL_CKSUM_CRC32C,
1376
1377         /* mask for local-only flag, which won't be sent over network */
1378         OBD_FL_LOCAL_MASK   = 0xF0000000,
1379 };
1380
1381 #define LOV_MAGIC_V1      0x0BD10BD0
1382 #define LOV_MAGIC         LOV_MAGIC_V1
1383 #define LOV_MAGIC_JOIN_V1 0x0BD20BD0
1384 #define LOV_MAGIC_V3      0x0BD30BD0
1385
1386 #define LOV_PATTERN_RAID0 0x001   /* stripes are used round-robin */
1387 #define LOV_PATTERN_RAID1 0x002   /* stripes are mirrors of each other */
1388 #define LOV_PATTERN_FIRST 0x100   /* first stripe is not in round-robin */
1389 #define LOV_PATTERN_CMOBD 0x200
1390
1391 #define lov_ost_data lov_ost_data_v1
1392 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
1393         __u64 l_object_id;        /* OST object ID */
1394         __u64 l_object_seq;       /* OST object seq number */
1395         __u32 l_ost_gen;          /* generation of this l_ost_idx */
1396         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
1397 };
1398
1399 #define lov_mds_md lov_mds_md_v1
1400 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
1401         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
1402         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1403         __u64 lmm_object_id;      /* LOV object ID */
1404         __u64 lmm_object_seq;     /* LOV object seq number */
1405         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1406         /* lmm_stripe_count used to be __u32 */
1407         __u16 lmm_stripe_count;   /* num stripes in use for this object */
1408         __u16 lmm_layout_gen;     /* layout generation number */
1409         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1410 };
1411
1412 /* extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm); */
1413
1414 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
1415 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
1416
1417 #define XATTR_NAME_ACL_ACCESS   "system.posix_acl_access"
1418 #define XATTR_NAME_ACL_DEFAULT  "system.posix_acl_default"
1419 #define XATTR_USER_PREFIX       "user."
1420 #define XATTR_TRUSTED_PREFIX    "trusted."
1421 #define XATTR_SECURITY_PREFIX   "security."
1422 #define XATTR_LUSTRE_PREFIX     "lustre."
1423
1424 #define XATTR_NAME_LOV          "trusted.lov"
1425 #define XATTR_NAME_LMA          "trusted.lma"
1426 #define XATTR_NAME_LMV          "trusted.lmv"
1427 #define XATTR_NAME_LINK         "trusted.link"
1428 #define XATTR_NAME_FID          "trusted.fid"
1429 #define XATTR_NAME_VERSION      "trusted.version"
1430
1431
1432 struct lov_mds_md_v3 {            /* LOV EA mds/wire data (little-endian) */
1433         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V3 */
1434         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1435         __u64 lmm_object_id;      /* LOV object ID */
1436         __u64 lmm_object_seq;     /* LOV object seq number */
1437         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1438         /* lmm_stripe_count used to be __u32 */
1439         __u16 lmm_stripe_count;   /* num stripes in use for this object */
1440         __u16 lmm_layout_gen;     /* layout generation number */
1441         char  lmm_pool_name[LOV_MAXPOOLNAME]; /* must be 32bit aligned */
1442         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1443 };
1444
1445
1446 #define OBD_MD_FLID        (0x00000001ULL) /* object ID */
1447 #define OBD_MD_FLATIME     (0x00000002ULL) /* access time */
1448 #define OBD_MD_FLMTIME     (0x00000004ULL) /* data modification time */
1449 #define OBD_MD_FLCTIME     (0x00000008ULL) /* change time */
1450 #define OBD_MD_FLSIZE      (0x00000010ULL) /* size */
1451 #define OBD_MD_FLBLOCKS    (0x00000020ULL) /* allocated blocks count */
1452 #define OBD_MD_FLBLKSZ     (0x00000040ULL) /* block size */
1453 #define OBD_MD_FLMODE      (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1454 #define OBD_MD_FLTYPE      (0x00000100ULL) /* object type (mode & S_IFMT) */
1455 #define OBD_MD_FLUID       (0x00000200ULL) /* user ID */
1456 #define OBD_MD_FLGID       (0x00000400ULL) /* group ID */
1457 #define OBD_MD_FLFLAGS     (0x00000800ULL) /* flags word */
1458 #define OBD_MD_FLNLINK     (0x00002000ULL) /* link count */
1459 #define OBD_MD_FLGENER     (0x00004000ULL) /* generation number */
1460 /*#define OBD_MD_FLINLINE    (0x00008000ULL)  inline data. used until 1.6.5 */
1461 #define OBD_MD_FLRDEV      (0x00010000ULL) /* device number */
1462 #define OBD_MD_FLEASIZE    (0x00020000ULL) /* extended attribute data */
1463 #define OBD_MD_LINKNAME    (0x00040000ULL) /* symbolic link target */
1464 #define OBD_MD_FLHANDLE    (0x00080000ULL) /* file/lock handle */
1465 #define OBD_MD_FLCKSUM     (0x00100000ULL) /* bulk data checksum */
1466 #define OBD_MD_FLQOS       (0x00200000ULL) /* quality of service stats */
1467 /*#define OBD_MD_FLOSCOPQ    (0x00400000ULL) osc opaque data, never used */
1468 #define OBD_MD_FLCOOKIE    (0x00800000ULL) /* log cancellation cookie */
1469 #define OBD_MD_FLGROUP     (0x01000000ULL) /* group */
1470 #define OBD_MD_FLFID       (0x02000000ULL) /* ->ost write inline fid */
1471 #define OBD_MD_FLEPOCH     (0x04000000ULL) /* ->ost write with ioepoch */
1472                                            /* ->mds if epoch opens or closes */
1473 #define OBD_MD_FLGRANT     (0x08000000ULL) /* ost preallocation space grant */
1474 #define OBD_MD_FLDIREA     (0x10000000ULL) /* dir's extended attribute data */
1475 #define OBD_MD_FLUSRQUOTA  (0x20000000ULL) /* over quota flags sent from ost */
1476 #define OBD_MD_FLGRPQUOTA  (0x40000000ULL) /* over quota flags sent from ost */
1477 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1478
1479 #define OBD_MD_MDS         (0x0000000100000000ULL) /* where an inode lives on */
1480 #define OBD_MD_REINT       (0x0000000200000000ULL) /* reintegrate oa */
1481 #define OBD_MD_MEA         (0x0000000400000000ULL) /* CMD split EA  */
1482 #define OBD_MD_MDTIDX      (0x0000000800000000ULL) /* Get MDT index  */
1483
1484 #define OBD_MD_FLXATTR       (0x0000001000000000ULL) /* xattr */
1485 #define OBD_MD_FLXATTRLS     (0x0000002000000000ULL) /* xattr list */
1486 #define OBD_MD_FLXATTRRM     (0x0000004000000000ULL) /* xattr remove */
1487 #define OBD_MD_FLACL         (0x0000008000000000ULL) /* ACL */
1488 #define OBD_MD_FLRMTPERM     (0x0000010000000000ULL) /* remote permission */
1489 #define OBD_MD_FLMDSCAPA     (0x0000020000000000ULL) /* MDS capability */
1490 #define OBD_MD_FLOSSCAPA     (0x0000040000000000ULL) /* OSS capability */
1491 #define OBD_MD_FLCKSPLIT     (0x0000080000000000ULL) /* Check split on server */
1492 #define OBD_MD_FLCROSSREF    (0x0000100000000000ULL) /* Cross-ref case */
1493 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1494                                                       * under lock */
1495 #define OBD_MD_FLOBJCOUNT    (0x0000400000000000ULL) /* for multiple destroy */
1496
1497 #define OBD_MD_FLRMTLSETFACL (0x0001000000000000ULL) /* lfs lsetfacl case */
1498 #define OBD_MD_FLRMTLGETFACL (0x0002000000000000ULL) /* lfs lgetfacl case */
1499 #define OBD_MD_FLRMTRSETFACL (0x0004000000000000ULL) /* lfs rsetfacl case */
1500 #define OBD_MD_FLRMTRGETFACL (0x0008000000000000ULL) /* lfs rgetfacl case */
1501
1502 #define OBD_MD_FLDATAVERSION (0x0010000000000000ULL) /* iversion sum */
1503
1504 #define OBD_MD_FLGETATTR (OBD_MD_FLID    | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1505                           OBD_MD_FLCTIME | OBD_MD_FLSIZE  | OBD_MD_FLBLKSZ | \
1506                           OBD_MD_FLMODE  | OBD_MD_FLTYPE  | OBD_MD_FLUID   | \
1507                           OBD_MD_FLGID   | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1508                           OBD_MD_FLGENER | OBD_MD_FLRDEV  | OBD_MD_FLGROUP)
1509
1510 /* don't forget obdo_fid which is way down at the bottom so it can
1511  * come after the definition of llog_cookie */
1512
1513
1514 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
1515
1516 /* ost_body.data values for OST_BRW */
1517
1518 #define OBD_BRW_READ            0x01
1519 #define OBD_BRW_WRITE           0x02
1520 #define OBD_BRW_RWMASK          (OBD_BRW_READ | OBD_BRW_WRITE)
1521 #define OBD_BRW_SYNC            0x08 /* this page is a part of synchronous
1522                                       * transfer and is not accounted in
1523                                       * the grant. */
1524 #define OBD_BRW_CHECK           0x10
1525 #define OBD_BRW_FROM_GRANT      0x20 /* the osc manages this under llite */
1526 #define OBD_BRW_GRANTED         0x40 /* the ost manages this */
1527 #define OBD_BRW_NOCACHE         0x80 /* this page is a part of non-cached IO */
1528 #define OBD_BRW_NOQUOTA        0x100
1529 #define OBD_BRW_SRVLOCK        0x200 /* Client holds no lock over this page */
1530 #define OBD_BRW_ASYNC          0x400 /* Server may delay commit to disk */
1531 #define OBD_BRW_MEMALLOC       0x800 /* Client runs in the "kswapd" context */
1532 #define OBD_BRW_OVER_USRQUOTA 0x1000 /* Running out of user quota */
1533 #define OBD_BRW_OVER_GRPQUOTA 0x2000 /* Running out of group quota */
1534
1535 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
1536
1537 #define OST_MIN_PRECREATE 32
1538 #define OST_MAX_PRECREATE 20000
1539
1540 struct obd_ioobj {
1541         obd_id               ioo_id;
1542         obd_seq              ioo_seq;
1543         __u32                ioo_type;
1544         __u32                ioo_bufcnt;
1545 };
1546
1547 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
1548
1549 /* multiple of 8 bytes => can array */
1550 struct niobuf_remote {
1551         __u64 offset;
1552         __u32 len;
1553         __u32 flags;
1554 };
1555
1556 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
1557
1558 /* lock value block communicated between the filter and llite */
1559
1560 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1561  * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1562 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1563 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1564 #define OST_LVB_IS_ERR(blocks)                                          \
1565         ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1566 #define OST_LVB_SET_ERR(blocks, rc)                                     \
1567         do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1568 #define OST_LVB_GET_ERR(blocks)    (int)(blocks - OST_LVB_ERR_INIT)
1569
1570 struct ost_lvb {
1571         __u64     lvb_size;
1572         obd_time  lvb_mtime;
1573         obd_time  lvb_atime;
1574         obd_time  lvb_ctime;
1575         __u64     lvb_blocks;
1576 };
1577
1578 /*
1579  *   MDS REQ RECORDS
1580  */
1581
1582 /* opcodes */
1583 typedef enum {
1584         MDS_GETATTR      = 33,
1585         MDS_GETATTR_NAME = 34,
1586         MDS_CLOSE        = 35,
1587         MDS_REINT        = 36,
1588         MDS_READPAGE     = 37,
1589         MDS_CONNECT      = 38,
1590         MDS_DISCONNECT   = 39,
1591         MDS_GETSTATUS    = 40,
1592         MDS_STATFS       = 41,
1593         MDS_PIN          = 42,
1594         MDS_UNPIN        = 43,
1595         MDS_SYNC         = 44,
1596         MDS_DONE_WRITING = 45,
1597         MDS_SET_INFO     = 46,
1598         MDS_QUOTACHECK   = 47,
1599         MDS_QUOTACTL     = 48,
1600         MDS_GETXATTR     = 49,
1601         MDS_SETXATTR     = 50, /* obsolete, now it's MDS_REINT op */
1602         MDS_WRITEPAGE    = 51,
1603         MDS_IS_SUBDIR    = 52,
1604         MDS_GET_INFO     = 53,
1605         MDS_LAST_OPC
1606 } mds_cmd_t;
1607
1608 #define MDS_FIRST_OPC    MDS_GETATTR
1609
1610 /*
1611  * Do not exceed 63
1612  */
1613
1614 typedef enum {
1615         REINT_SETATTR  = 1,
1616         REINT_CREATE   = 2,
1617         REINT_LINK     = 3,
1618         REINT_UNLINK   = 4,
1619         REINT_RENAME   = 5,
1620         REINT_OPEN     = 6,
1621         REINT_SETXATTR = 7,
1622 //      REINT_CLOSE    = 8,
1623 //      REINT_WRITE    = 9,
1624         REINT_MAX
1625 } mds_reint_t, mdt_reint_t;
1626
1627 extern void lustre_swab_generic_32s (__u32 *val);
1628
1629 /* the disposition of the intent outlines what was executed */
1630 #define DISP_IT_EXECD        0x00000001
1631 #define DISP_LOOKUP_EXECD    0x00000002
1632 #define DISP_LOOKUP_NEG      0x00000004
1633 #define DISP_LOOKUP_POS      0x00000008
1634 #define DISP_OPEN_CREATE     0x00000010
1635 #define DISP_OPEN_OPEN       0x00000020
1636 #define DISP_ENQ_COMPLETE    0x00400000
1637 #define DISP_ENQ_OPEN_REF    0x00800000
1638 #define DISP_ENQ_CREATE_REF  0x01000000
1639 #define DISP_OPEN_LOCK       0x02000000
1640
1641 /* INODE LOCK PARTS */
1642 #define MDS_INODELOCK_LOOKUP 0x000001       /* dentry, mode, owner, group */
1643 #define MDS_INODELOCK_UPDATE 0x000002       /* size, links, timestamps */
1644 #define MDS_INODELOCK_OPEN   0x000004       /* For opened files */
1645 #define MDS_INODELOCK_LAYOUT 0x000008       /* for layout */
1646
1647 /* Do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits
1648  * XXX: MDS_INODELOCK_MAXSHIFT should be increased to 3 once the layout lock is
1649  * supported */
1650 #define MDS_INODELOCK_MAXSHIFT 2
1651 /* This FULL lock is useful to take on unlink sort of operations */
1652 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
1653
1654 extern void lustre_swab_ll_fid (struct ll_fid *fid);
1655
1656 /* NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
1657  * but was moved into name[1] along with the OID to avoid consuming the
1658  * name[2,3] fields that need to be used for the quota id (also a FID). */
1659 enum {
1660         LUSTRE_RES_ID_SEQ_OFF = 0,
1661         LUSTRE_RES_ID_VER_OID_OFF = 1,
1662         LUSTRE_RES_ID_WAS_VER_OFF = 2, /* see note above */
1663         LUSTRE_RES_ID_HSH_OFF = 3
1664 };
1665
1666 #define MDS_STATUS_CONN 1
1667 #define MDS_STATUS_LOV 2
1668
1669 /* mdt_thread_info.mti_flags. */
1670 enum md_op_flags {
1671         /* The flag indicates Size-on-MDS attributes are changed. */
1672         MF_SOM_CHANGE           = (1 << 0),
1673         /* Flags indicates an epoch opens or closes. */
1674         MF_EPOCH_OPEN           = (1 << 1),
1675         MF_EPOCH_CLOSE          = (1 << 2),
1676         MF_MDC_CANCEL_FID1      = (1 << 3),
1677         MF_MDC_CANCEL_FID2      = (1 << 4),
1678         MF_MDC_CANCEL_FID3      = (1 << 5),
1679         MF_MDC_CANCEL_FID4      = (1 << 6),
1680         /* There is a pending attribute update. */
1681         MF_SOM_AU               = (1 << 7),
1682         /* Cancel OST locks while getattr OST attributes. */
1683         MF_GETATTR_LOCK         = (1 << 8),
1684 };
1685
1686 #define MF_SOM_LOCAL_FLAGS (MF_SOM_CHANGE | MF_EPOCH_OPEN | MF_EPOCH_CLOSE)
1687
1688 #define LUSTRE_BFLAG_UNCOMMITTED_WRITES   0x1
1689
1690 /* these should be identical to their EXT4_*_FL counterparts, they are
1691  * redefined here only to avoid dragging in fs/ext4/ext4.h */
1692 #define LUSTRE_SYNC_FL         0x00000008 /* Synchronous updates */
1693 #define LUSTRE_IMMUTABLE_FL    0x00000010 /* Immutable file */
1694 #define LUSTRE_APPEND_FL       0x00000020 /* writes to file may only append */
1695 #define LUSTRE_NOATIME_FL      0x00000080 /* do not update atime */
1696 #define LUSTRE_DIRSYNC_FL      0x00010000 /* dirsync behaviour (dir only) */
1697
1698 #ifdef __KERNEL__
1699 /* Convert wire LUSTRE_*_FL to corresponding client local VFS S_* values
1700  * for the client inode i_flags.  The LUSTRE_*_FL are the Lustre wire
1701  * protocol equivalents of LDISKFS_*_FL values stored on disk, while
1702  * the S_* flags are kernel-internal values that change between kernel
1703  * versions.  These flags are set/cleared via FSFILT_IOC_{GET,SET}_FLAGS.
1704  * See b=16526 for a full history. */
1705 static inline int ll_ext_to_inode_flags(int flags)
1706 {
1707         return (((flags & LUSTRE_SYNC_FL)      ? S_SYNC      : 0) |
1708                 ((flags & LUSTRE_NOATIME_FL)   ? S_NOATIME   : 0) |
1709                 ((flags & LUSTRE_APPEND_FL)    ? S_APPEND    : 0) |
1710 #if defined(S_DIRSYNC)
1711                 ((flags & LUSTRE_DIRSYNC_FL)   ? S_DIRSYNC   : 0) |
1712 #endif
1713                 ((flags & LUSTRE_IMMUTABLE_FL) ? S_IMMUTABLE : 0));
1714 }
1715
1716 static inline int ll_inode_to_ext_flags(int iflags)
1717 {
1718         return (((iflags & S_SYNC)      ? LUSTRE_SYNC_FL      : 0) |
1719                 ((iflags & S_NOATIME)   ? LUSTRE_NOATIME_FL   : 0) |
1720                 ((iflags & S_APPEND)    ? LUSTRE_APPEND_FL    : 0) |
1721 #if defined(S_DIRSYNC)
1722                 ((iflags & S_DIRSYNC)   ? LUSTRE_DIRSYNC_FL   : 0) |
1723 #endif
1724                 ((iflags & S_IMMUTABLE) ? LUSTRE_IMMUTABLE_FL : 0));
1725 }
1726 #endif
1727
1728 struct mdt_body {
1729         struct lu_fid  fid1;
1730         struct lu_fid  fid2;
1731         struct lustre_handle handle;
1732         __u64          valid;
1733         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1734        obd_time        mtime;
1735        obd_time        atime;
1736        obd_time        ctime;
1737         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1738         __u64          ioepoch;
1739         __u64          ino;
1740         __u32          fsuid;
1741         __u32          fsgid;
1742         __u32          capability;
1743         __u32          mode;
1744         __u32          uid;
1745         __u32          gid;
1746         __u32          flags; /* from vfs for pin/unpin, LUSTRE_BFLAG close */
1747         __u32          rdev;
1748         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1749         __u32          generation;
1750         __u32          suppgid;
1751         __u32          eadatasize;
1752         __u32          aclsize;
1753         __u32          max_mdsize;
1754         __u32          max_cookiesize;
1755         __u32          uid_h; /* high 32-bits of uid, for FUID */
1756         __u32          gid_h; /* high 32-bits of gid, for FUID */
1757         __u32          padding_5; /* also fix lustre_swab_mdt_body */
1758         __u64          padding_6;
1759         __u64          padding_7;
1760         __u64          padding_8;
1761         __u64          padding_9;
1762         __u64          padding_10;
1763 }; /* 216 */
1764
1765 extern void lustre_swab_mdt_body (struct mdt_body *b);
1766
1767 struct mdt_ioepoch {
1768         struct lustre_handle handle;
1769         __u64  ioepoch;
1770         __u32  flags;
1771         __u32  padding;
1772 };
1773
1774 extern void lustre_swab_mdt_ioepoch (struct mdt_ioepoch *b);
1775
1776 /* The lquota_id structure is an union of all the possible identifier types that
1777  * can be used with quota, this includes:
1778  * - 64-bit user ID
1779  * - 64-bit group ID
1780  * - a FID which can be used for per-directory quota in the future */
1781 union lquota_id {
1782         struct lu_fid   qid_fid; /* FID for per-directory quota */
1783         __u64           qid_uid; /* user identifier */
1784         __u64           qid_gid; /* group identifier */
1785 };
1786
1787 #define Q_QUOTACHECK    0x800100
1788 #define Q_INITQUOTA     0x800101        /* init slave limits */
1789 #define Q_GETOINFO      0x800102        /* get obd quota info */
1790 #define Q_GETOQUOTA     0x800103        /* get obd quotas */
1791 #define Q_FINVALIDATE   0x800104        /* invalidate operational quotas */
1792
1793 #define Q_TYPEMATCH(id, type) \
1794         ((id) == (type) || (id) == UGQUOTA)
1795
1796 #define Q_TYPESET(oqc, type) Q_TYPEMATCH((oqc)->qc_type, type)
1797
1798 #define Q_GETOCMD(oqc) \
1799         ((oqc)->qc_cmd == Q_GETOINFO || (oqc)->qc_cmd == Q_GETOQUOTA)
1800
1801 #define QCTL_COPY(out, in)              \
1802 do {                                    \
1803         Q_COPY(out, in, qc_cmd);        \
1804         Q_COPY(out, in, qc_type);       \
1805         Q_COPY(out, in, qc_id);         \
1806         Q_COPY(out, in, qc_stat);       \
1807         Q_COPY(out, in, qc_dqinfo);     \
1808         Q_COPY(out, in, qc_dqblk);      \
1809 } while (0)
1810
1811 struct obd_quotactl {
1812         __u32                   qc_cmd;
1813         __u32                   qc_type;
1814         __u32                   qc_id;
1815         __u32                   qc_stat;
1816         struct obd_dqinfo       qc_dqinfo;
1817         struct obd_dqblk        qc_dqblk;
1818 };
1819
1820 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1821
1822 #define QUOTA_DQACQ_FL_ACQ      0x1  /* acquire quota */
1823 #define QUOTA_DQACQ_FL_PREACQ   0x2  /* pre-acquire */
1824 #define QUOTA_DQACQ_FL_REL      0x4  /* release quota */
1825 #define QUOTA_DQACQ_FL_REPORT   0x8  /* report usage */
1826
1827 struct quota_body {
1828         struct lu_fid    qb_fid;     /* FID of global index packing the pool ID
1829                                       * and type (data or metadata) as well as
1830                                       * the quota type (user or group). */
1831         union lquota_id  qb_id;      /* uid or gid or directory FID */
1832         __u32            qb_flags;   /* see above */
1833         __u32            qb_padding;
1834         __u64            qb_count;   /* acquire/release count (kbytes/inodes) */
1835         __u64            qb_usage;   /* current slave usage (kbytes/inodes) */
1836         __u64            qb_slv_ver; /* slave index file version */
1837         struct lustre_handle qb_lockh;     /* per-ID lock handle */
1838         struct lustre_handle qb_glb_lockh; /* global lock handle */
1839         __u64            qb_padding1[4];
1840 };
1841
1842 /* When the quota_body is used in the reply of quota global intent
1843  * lock (IT_QUOTA_CONN) reply, qb_fid contains slave index file FID. */
1844 #define qb_slv_fid       qb_fid
1845 /* qb_usage is the current qunit (in kbytes/inodes) when quota_body is used in
1846  * quota reply */
1847 #define qb_qunit         qb_usage
1848
1849 extern void lustre_swab_quota_body(struct quota_body *b);
1850
1851 struct quota_adjust_qunit {
1852         __u32 qaq_flags;
1853         __u32 qaq_id;
1854         __u64 qaq_bunit_sz;
1855         __u64 qaq_iunit_sz;
1856         __u64 padding1;
1857 };
1858 extern void lustre_swab_quota_adjust_qunit(struct quota_adjust_qunit *q);
1859
1860 /* Quota types currently supported */
1861 enum {
1862         LQUOTA_TYPE_USR = 0x00, /* maps to USRQUOTA */
1863         LQUOTA_TYPE_GRP = 0x01, /* maps to GRPQUOTA */
1864         LQUOTA_TYPE_MAX
1865 };
1866
1867 /* There are 2 different resource types on which a quota limit can be enforced:
1868  * - inodes on the MDTs
1869  * - blocks on the OSTs */
1870 enum {
1871         LQUOTA_RES_MD           = 0x01, /* skip 0 to avoid null oid in FID */
1872         LQUOTA_RES_DT           = 0x02,
1873         LQUOTA_LAST_RES,
1874         LQUOTA_FIRST_RES        = LQUOTA_RES_MD
1875 };
1876 #define LQUOTA_NR_RES (LQUOTA_LAST_RES - LQUOTA_FIRST_RES + 1)
1877
1878 /*
1879  * Space accounting support
1880  * Format of an accounting record, providing disk usage information for a given
1881  * user or group
1882  */
1883 struct lquota_acct_rec { /* 16 bytes */
1884         __u64 bspace;  /* current space in use */
1885         __u64 ispace;  /* current # inodes in use */
1886 };
1887
1888 /*
1889  * Global quota index support
1890  * Format of a global record, providing global quota settings for a given quota
1891  * identifier
1892  */
1893 struct lquota_glb_rec { /* 32 bytes */
1894         __u64 qbr_hardlimit; /* quota hard limit, in #inodes or kbytes */
1895         __u64 qbr_softlimit; /* quota soft limit, in #inodes or kbytes */
1896         __u64 qbr_time;      /* grace time, in seconds */
1897         __u64 qbr_granted;   /* how much is granted to slaves, in #inodes or
1898                               * kbytes */
1899 };
1900
1901 /*
1902  * Slave index support
1903  * Format of a slave record, recording how much space is granted to a given
1904  * slave
1905  */
1906 struct lquota_slv_rec { /* 8 bytes */
1907         __u64 qsr_granted; /* space granted to the slave for the key=ID,
1908                             * in #inodes or kbytes */
1909 };
1910
1911 /* flags is shared among quota structures */
1912 #define LQUOTA_FLAGS_GRP       1UL   /* 0 is user, 1 is group */
1913 #define LQUOTA_FLAGS_BLK       2UL   /* 0 is inode, 1 is block */
1914 #define LQUOTA_FLAGS_ADJBLK    4UL   /* adjust the block qunit size */
1915 #define LQUOTA_FLAGS_ADJINO    8UL   /* adjust the inode qunit size */
1916 #define LQUOTA_FLAGS_CHG_QS   16UL   /* indicate whether it has capability of
1917                                       * OBD_CONNECT_CHANGE_QS */
1918 #define LQUOTA_FLAGS_RECOVERY 32UL   /* recovery is going on a uid/gid */
1919 #define LQUOTA_FLAGS_SETQUOTA 64UL   /* being setquota on a uid/gid */
1920
1921 /* flags is specific for quota_adjust_qunit */
1922 #define LQUOTA_QAQ_CREATE_LQS  (1UL << 31) /* when it is set, need create lqs */
1923
1924 /* the status of lqs_flags in struct lustre_qunit_size  */
1925 #define LQUOTA_QUNIT_FLAGS (LQUOTA_FLAGS_GRP | LQUOTA_FLAGS_BLK)
1926
1927 #define QAQ_IS_GRP(qaq)    ((qaq)->qaq_flags & LQUOTA_FLAGS_GRP)
1928 #define QAQ_IS_ADJBLK(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_ADJBLK)
1929 #define QAQ_IS_ADJINO(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_ADJINO)
1930 #define QAQ_IS_CREATE_LQS(qaq)  ((qaq)->qaq_flags & LQUOTA_QAQ_CREATE_LQS)
1931
1932 #define QAQ_SET_GRP(qaq)    ((qaq)->qaq_flags |= LQUOTA_FLAGS_GRP)
1933 #define QAQ_SET_ADJBLK(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_ADJBLK)
1934 #define QAQ_SET_ADJINO(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_ADJINO)
1935 #define QAQ_SET_CREATE_LQS(qaq) ((qaq)->qaq_flags |= LQUOTA_QAQ_CREATE_LQS)
1936
1937 /* permissions for md_perm.mp_perm */
1938 enum {
1939         CFS_SETUID_PERM = 0x01,
1940         CFS_SETGID_PERM = 0x02,
1941         CFS_SETGRP_PERM = 0x04,
1942         CFS_RMTACL_PERM = 0x08,
1943         CFS_RMTOWN_PERM = 0x10
1944 };
1945
1946 /* inode access permission for remote user, the inode info are omitted,
1947  * for client knows them. */
1948 struct mdt_remote_perm {
1949         __u32           rp_uid;
1950         __u32           rp_gid;
1951         __u32           rp_fsuid;
1952         __u32           rp_fsuid_h;
1953         __u32           rp_fsgid;
1954         __u32           rp_fsgid_h;
1955         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
1956         __u32           rp_padding;
1957 };
1958
1959 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
1960
1961 struct mdt_rec_setattr {
1962         __u32           sa_opcode;
1963         __u32           sa_cap;
1964         __u32           sa_fsuid;
1965         __u32           sa_fsuid_h;
1966         __u32           sa_fsgid;
1967         __u32           sa_fsgid_h;
1968         __u32           sa_suppgid;
1969         __u32           sa_suppgid_h;
1970         __u32           sa_padding_1;
1971         __u32           sa_padding_1_h;
1972         struct lu_fid   sa_fid;
1973         __u64           sa_valid;
1974         __u32           sa_uid;
1975         __u32           sa_gid;
1976         __u64           sa_size;
1977         __u64           sa_blocks;
1978         obd_time        sa_mtime;
1979         obd_time        sa_atime;
1980         obd_time        sa_ctime;
1981         __u32           sa_attr_flags;
1982         __u32           sa_mode;
1983         __u32           sa_padding_2;
1984         __u32           sa_padding_3;
1985         __u32           sa_padding_4;
1986         __u32           sa_padding_5;
1987 };
1988
1989 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
1990
1991 /*
1992  * Attribute flags used in mdt_rec_setattr::sa_valid.
1993  * The kernel's #defines for ATTR_* should not be used over the network
1994  * since the client and MDS may run different kernels (see bug 13828)
1995  * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1996  */
1997 #define MDS_ATTR_MODE          0x1ULL /* = 1 */
1998 #define MDS_ATTR_UID           0x2ULL /* = 2 */
1999 #define MDS_ATTR_GID           0x4ULL /* = 4 */
2000 #define MDS_ATTR_SIZE          0x8ULL /* = 8 */
2001 #define MDS_ATTR_ATIME        0x10ULL /* = 16 */
2002 #define MDS_ATTR_MTIME        0x20ULL /* = 32 */
2003 #define MDS_ATTR_CTIME        0x40ULL /* = 64 */
2004 #define MDS_ATTR_ATIME_SET    0x80ULL /* = 128 */
2005 #define MDS_ATTR_MTIME_SET   0x100ULL /* = 256 */
2006 #define MDS_ATTR_FORCE       0x200ULL /* = 512, Not a change, but a change it */
2007 #define MDS_ATTR_ATTR_FLAG   0x400ULL /* = 1024 */
2008 #define MDS_ATTR_KILL_SUID   0x800ULL /* = 2048 */
2009 #define MDS_ATTR_KILL_SGID  0x1000ULL /* = 4096 */
2010 #define MDS_ATTR_CTIME_SET  0x2000ULL /* = 8192 */
2011 #define MDS_ATTR_FROM_OPEN  0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
2012 #define MDS_ATTR_BLOCKS     0x8000ULL /* = 32768 */
2013
2014 #ifndef FMODE_READ
2015 #define FMODE_READ               00000001
2016 #define FMODE_WRITE              00000002
2017 #endif
2018
2019 #define MDS_FMODE_CLOSED         00000000
2020 #define MDS_FMODE_EXEC           00000004
2021 /* IO Epoch is opened on a closed file. */
2022 #define MDS_FMODE_EPOCH          01000000
2023 /* IO Epoch is opened on a file truncate. */
2024 #define MDS_FMODE_TRUNC          02000000
2025 /* Size-on-MDS Attribute Update is pending. */
2026 #define MDS_FMODE_SOM            04000000
2027
2028 #define MDS_OPEN_CREATED         00000010
2029 #define MDS_OPEN_CROSS           00000020
2030
2031 #define MDS_OPEN_CREAT           00000100
2032 #define MDS_OPEN_EXCL            00000200
2033 #define MDS_OPEN_TRUNC           00001000
2034 #define MDS_OPEN_APPEND          00002000
2035 #define MDS_OPEN_SYNC            00010000
2036 #define MDS_OPEN_DIRECTORY       00200000
2037
2038 #define MDS_OPEN_BY_FID         040000000 /* open_by_fid for known object */
2039 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
2040 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
2041 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file.
2042                                            * We do not support JOIN FILE
2043                                            * anymore, reserve this flags
2044                                            * just for preventing such bit
2045                                            * to be reused. */
2046 #define MDS_CREATE_RMT_ACL    01000000000 /* indicate create on remote server
2047                                            * with default ACL */
2048 #define MDS_CREATE_SLAVE_OBJ  02000000000 /* indicate create slave object
2049                                            * actually, this is for create, not
2050                                            * conflict with other open flags */
2051 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
2052 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
2053 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
2054 #define MDS_OPEN_NORESTORE  0100000000000ULL /* Do not restore file at open */
2055 #define MDS_OPEN_NEWSTRIPE  0200000000000ULL /* New stripe needed (restripe or
2056                                               * hsm restore) */
2057
2058 /* permission for create non-directory file */
2059 #define MAY_CREATE      (1 << 7)
2060 /* permission for create directory file */
2061 #define MAY_LINK        (1 << 8)
2062 /* permission for delete from the directory */
2063 #define MAY_UNLINK      (1 << 9)
2064 /* source's permission for rename */
2065 #define MAY_RENAME_SRC  (1 << 10)
2066 /* target's permission for rename */
2067 #define MAY_RENAME_TAR  (1 << 11)
2068 /* part (parent's) VTX permission check */
2069 #define MAY_VTX_PART    (1 << 12)
2070 /* full VTX permission check */
2071 #define MAY_VTX_FULL    (1 << 13)
2072 /* lfs rgetfacl permission check */
2073 #define MAY_RGETFACL    (1 << 14)
2074
2075 enum {
2076         MDS_CHECK_SPLIT   = 1 << 0,
2077         MDS_CROSS_REF     = 1 << 1,
2078         MDS_VTX_BYPASS    = 1 << 2,
2079         MDS_PERM_BYPASS   = 1 << 3,
2080         MDS_SOM           = 1 << 4,
2081         MDS_QUOTA_IGNORE  = 1 << 5,
2082         MDS_CLOSE_CLEANUP = 1 << 6,
2083         MDS_KEEP_ORPHAN   = 1 << 7,
2084         MDS_RECOV_OPEN    = 1 << 8,
2085         MDS_UNLINK_DESTROY = 1 << 9,  /* Destory ost object in mdd_unlink */
2086 };
2087
2088 /* instance of mdt_reint_rec */
2089 struct mdt_rec_create {
2090         __u32           cr_opcode;
2091         __u32           cr_cap;
2092         __u32           cr_fsuid;
2093         __u32           cr_fsuid_h;
2094         __u32           cr_fsgid;
2095         __u32           cr_fsgid_h;
2096         __u32           cr_suppgid1;
2097         __u32           cr_suppgid1_h;
2098         __u32           cr_suppgid2;
2099         __u32           cr_suppgid2_h;
2100         struct lu_fid   cr_fid1;
2101         struct lu_fid   cr_fid2;
2102         struct lustre_handle cr_old_handle; /* handle in case of open replay */
2103         obd_time        cr_time;
2104         __u64           cr_rdev;
2105         __u64           cr_ioepoch;
2106         __u64           cr_padding_1;   /* rr_blocks */
2107         __u32           cr_mode;
2108         __u32           cr_bias;
2109         /* use of helpers set/get_mrc_cr_flags() is needed to access
2110          * 64 bits cr_flags [cr_flags_l, cr_flags_h], this is done to
2111          * extend cr_flags size without breaking 1.8 compat */
2112         __u32           cr_flags_l;     /* for use with open, low  32 bits  */
2113         __u32           cr_flags_h;     /* for use with open, high 32 bits */
2114         __u32           cr_padding_3;   /* rr_padding_3 */
2115         __u32           cr_padding_4;   /* rr_padding_4 */
2116 };
2117
2118 static inline void set_mrc_cr_flags(struct mdt_rec_create *mrc, __u64 flags)
2119 {
2120         mrc->cr_flags_l = (__u32)(flags & 0xFFFFFFFFUll);
2121         mrc->cr_flags_h = (__u32)(flags >> 32);
2122 }
2123
2124 static inline __u64 get_mrc_cr_flags(struct mdt_rec_create *mrc)
2125 {
2126         return ((__u64)(mrc->cr_flags_l) | ((__u64)mrc->cr_flags_h << 32));
2127 }
2128
2129 /* instance of mdt_reint_rec */
2130 struct mdt_rec_link {
2131         __u32           lk_opcode;
2132         __u32           lk_cap;
2133         __u32           lk_fsuid;
2134         __u32           lk_fsuid_h;
2135         __u32           lk_fsgid;
2136         __u32           lk_fsgid_h;
2137         __u32           lk_suppgid1;
2138         __u32           lk_suppgid1_h;
2139         __u32           lk_suppgid2;
2140         __u32           lk_suppgid2_h;
2141         struct lu_fid   lk_fid1;
2142         struct lu_fid   lk_fid2;
2143         obd_time        lk_time;
2144         __u64           lk_padding_1;   /* rr_atime */
2145         __u64           lk_padding_2;   /* rr_ctime */
2146         __u64           lk_padding_3;   /* rr_size */
2147         __u64           lk_padding_4;   /* rr_blocks */
2148         __u32           lk_bias;
2149         __u32           lk_padding_5;   /* rr_mode */
2150         __u32           lk_padding_6;   /* rr_flags */
2151         __u32           lk_padding_7;   /* rr_padding_2 */
2152         __u32           lk_padding_8;   /* rr_padding_3 */
2153         __u32           lk_padding_9;   /* rr_padding_4 */
2154 };
2155
2156 /* instance of mdt_reint_rec */
2157 struct mdt_rec_unlink {
2158         __u32           ul_opcode;
2159         __u32           ul_cap;
2160         __u32           ul_fsuid;
2161         __u32           ul_fsuid_h;
2162         __u32           ul_fsgid;
2163         __u32           ul_fsgid_h;
2164         __u32           ul_suppgid1;
2165         __u32           ul_suppgid1_h;
2166         __u32           ul_suppgid2;
2167         __u32           ul_suppgid2_h;
2168         struct lu_fid   ul_fid1;
2169         struct lu_fid   ul_fid2;
2170         obd_time        ul_time;
2171         __u64           ul_padding_2;   /* rr_atime */
2172         __u64           ul_padding_3;   /* rr_ctime */
2173         __u64           ul_padding_4;   /* rr_size */
2174         __u64           ul_padding_5;   /* rr_blocks */
2175         __u32           ul_bias;
2176         __u32           ul_mode;
2177         __u32           ul_padding_6;   /* rr_flags */
2178         __u32           ul_padding_7;   /* rr_padding_2 */
2179         __u32           ul_padding_8;   /* rr_padding_3 */
2180         __u32           ul_padding_9;   /* rr_padding_4 */
2181 };
2182
2183 /* instance of mdt_reint_rec */
2184 struct mdt_rec_rename {
2185         __u32           rn_opcode;
2186         __u32           rn_cap;
2187         __u32           rn_fsuid;
2188         __u32           rn_fsuid_h;
2189         __u32           rn_fsgid;
2190         __u32           rn_fsgid_h;
2191         __u32           rn_suppgid1;
2192         __u32           rn_suppgid1_h;
2193         __u32           rn_suppgid2;
2194         __u32           rn_suppgid2_h;
2195         struct lu_fid   rn_fid1;
2196         struct lu_fid   rn_fid2;
2197         obd_time        rn_time;
2198         __u64           rn_padding_1;   /* rr_atime */
2199         __u64           rn_padding_2;   /* rr_ctime */
2200         __u64           rn_padding_3;   /* rr_size */
2201         __u64           rn_padding_4;   /* rr_blocks */
2202         __u32           rn_bias;        /* some operation flags */
2203         __u32           rn_mode;        /* cross-ref rename has mode */
2204         __u32           rn_padding_5;   /* rr_flags */
2205         __u32           rn_padding_6;   /* rr_padding_2 */
2206         __u32           rn_padding_7;   /* rr_padding_3 */
2207         __u32           rn_padding_8;   /* rr_padding_4 */
2208 };
2209
2210 /* instance of mdt_reint_rec */
2211 struct mdt_rec_setxattr {
2212         __u32           sx_opcode;
2213         __u32           sx_cap;
2214         __u32           sx_fsuid;
2215         __u32           sx_fsuid_h;
2216         __u32           sx_fsgid;
2217         __u32           sx_fsgid_h;
2218         __u32           sx_suppgid1;
2219         __u32           sx_suppgid1_h;
2220         __u32           sx_suppgid2;
2221         __u32           sx_suppgid2_h;
2222         struct lu_fid   sx_fid;
2223         __u64           sx_padding_1;   /* These three are rr_fid2 */
2224         __u32           sx_padding_2;
2225         __u32           sx_padding_3;
2226         __u64           sx_valid;
2227         obd_time        sx_time;
2228         __u64           sx_padding_5;   /* rr_ctime */
2229         __u64           sx_padding_6;   /* rr_size */
2230         __u64           sx_padding_7;   /* rr_blocks */
2231         __u32           sx_size;
2232         __u32           sx_flags;
2233         __u32           sx_padding_8;   /* rr_flags */
2234         __u32           sx_padding_9;   /* rr_padding_2 */
2235         __u32           sx_padding_10;  /* rr_padding_3 */
2236         __u32           sx_padding_11;  /* rr_padding_4 */
2237 };
2238
2239 /*
2240  * mdt_rec_reint is the template for all mdt_reint_xxx structures.
2241  * Do NOT change the size of various members, otherwise the value
2242  * will be broken in lustre_swab_mdt_rec_reint().
2243  *
2244  * If you add new members in other mdt_reint_xxx structres and need to use the
2245  * rr_padding_x fields, then update lustre_swab_mdt_rec_reint() also.
2246  */
2247 struct mdt_rec_reint {
2248         __u32           rr_opcode;
2249         __u32           rr_cap;
2250         __u32           rr_fsuid;
2251         __u32           rr_fsuid_h;
2252         __u32           rr_fsgid;
2253         __u32           rr_fsgid_h;
2254         __u32           rr_suppgid1;
2255         __u32           rr_suppgid1_h;
2256         __u32           rr_suppgid2;
2257         __u32           rr_suppgid2_h;
2258         struct lu_fid   rr_fid1;
2259         struct lu_fid   rr_fid2;
2260         obd_time        rr_mtime;
2261         obd_time        rr_atime;
2262         obd_time        rr_ctime;
2263         __u64           rr_size;
2264         __u64           rr_blocks;
2265         __u32           rr_bias;
2266         __u32           rr_mode;
2267         __u32           rr_flags;
2268         __u32           rr_padding_2; /* also fix lustre_swab_mdt_rec_reint */
2269         __u32           rr_padding_3; /* also fix lustre_swab_mdt_rec_reint */
2270         __u32           rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
2271 };
2272
2273 extern void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
2274
2275 struct lmv_desc {
2276         __u32 ld_tgt_count;                /* how many MDS's */
2277         __u32 ld_active_tgt_count;         /* how many active */
2278         __u32 ld_default_stripe_count;     /* how many objects are used */
2279         __u32 ld_pattern;                  /* default MEA_MAGIC_* */
2280         __u64 ld_default_hash_size;
2281         __u64 ld_padding_1;                /* also fix lustre_swab_lmv_desc */
2282         __u32 ld_padding_2;                /* also fix lustre_swab_lmv_desc */
2283         __u32 ld_qos_maxage;               /* in second */
2284         __u32 ld_padding_3;                /* also fix lustre_swab_lmv_desc */
2285         __u32 ld_padding_4;                /* also fix lustre_swab_lmv_desc */
2286         struct obd_uuid ld_uuid;
2287 };
2288
2289 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
2290
2291 /* TODO: lmv_stripe_md should contain mds capabilities for all slave fids */
2292 struct lmv_stripe_md {
2293         __u32         mea_magic;
2294         __u32         mea_count;
2295         __u32         mea_master;
2296         __u32         mea_padding;
2297         char          mea_pool_name[LOV_MAXPOOLNAME];
2298         struct lu_fid mea_ids[0];
2299 };
2300
2301 extern void lustre_swab_lmv_stripe_md(struct lmv_stripe_md *mea);
2302
2303 /* lmv structures */
2304 #define MEA_MAGIC_LAST_CHAR      0xb2221ca1
2305 #define MEA_MAGIC_ALL_CHARS      0xb222a11c
2306 #define MEA_MAGIC_HASH_SEGMENT   0xb222a11b
2307
2308 #define MAX_HASH_SIZE_32         0x7fffffffUL
2309 #define MAX_HASH_SIZE            0x7fffffffffffffffULL
2310 #define MAX_HASH_HIGHEST_BIT     0x1000000000000000ULL
2311
2312 enum fld_rpc_opc {
2313         FLD_QUERY                       = 900,
2314         FLD_LAST_OPC,
2315         FLD_FIRST_OPC                   = FLD_QUERY
2316 };
2317
2318 enum seq_rpc_opc {
2319         SEQ_QUERY                       = 700,
2320         SEQ_LAST_OPC,
2321         SEQ_FIRST_OPC                   = SEQ_QUERY
2322 };
2323
2324 enum seq_op {
2325         SEQ_ALLOC_SUPER = 0,
2326         SEQ_ALLOC_META = 1
2327 };
2328
2329 /*
2330  *  LOV data structures
2331  */
2332
2333 #define LOV_MAX_UUID_BUFFER_SIZE  8192
2334 /* The size of the buffer the lov/mdc reserves for the
2335  * array of UUIDs returned by the MDS.  With the current
2336  * protocol, this will limit the max number of OSTs per LOV */
2337
2338 #define LOV_DESC_MAGIC 0xB0CCDE5C
2339
2340 /* LOV settings descriptor (should only contain static info) */
2341 struct lov_desc {
2342         __u32 ld_tgt_count;                /* how many OBD's */
2343         __u32 ld_active_tgt_count;         /* how many active */
2344         __u32 ld_default_stripe_count;     /* how many objects are used */
2345         __u32 ld_pattern;                  /* default PATTERN_RAID0 */
2346         __u64 ld_default_stripe_size;      /* in bytes */
2347         __u64 ld_default_stripe_offset;    /* in bytes */
2348         __u32 ld_padding_0;                /* unused */
2349         __u32 ld_qos_maxage;               /* in second */
2350         __u32 ld_padding_1;                /* also fix lustre_swab_lov_desc */
2351         __u32 ld_padding_2;                /* also fix lustre_swab_lov_desc */
2352         struct obd_uuid ld_uuid;
2353 };
2354
2355 #define ld_magic ld_active_tgt_count       /* for swabbing from llogs */
2356
2357 extern void lustre_swab_lov_desc (struct lov_desc *ld);
2358
2359 /*
2360  *   LDLM requests:
2361  */
2362 /* opcodes -- MUST be distinct from OST/MDS opcodes */
2363 typedef enum {
2364         LDLM_ENQUEUE     = 101,
2365         LDLM_CONVERT     = 102,
2366         LDLM_CANCEL      = 103,
2367         LDLM_BL_CALLBACK = 104,
2368         LDLM_CP_CALLBACK = 105,
2369         LDLM_GL_CALLBACK = 106,
2370         LDLM_SET_INFO    = 107,
2371         LDLM_LAST_OPC
2372 } ldlm_cmd_t;
2373 #define LDLM_FIRST_OPC LDLM_ENQUEUE
2374
2375 #define RES_NAME_SIZE 4
2376 struct ldlm_res_id {
2377         __u64 name[RES_NAME_SIZE];
2378 };
2379
2380 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
2381
2382 static inline int ldlm_res_eq(const struct ldlm_res_id *res0,
2383                               const struct ldlm_res_id *res1)
2384 {
2385         return !memcmp(res0, res1, sizeof(*res0));
2386 }
2387
2388 /* lock types */
2389 typedef enum {
2390         LCK_MINMODE = 0,
2391         LCK_EX      = 1,
2392         LCK_PW      = 2,
2393         LCK_PR      = 4,
2394         LCK_CW      = 8,
2395         LCK_CR      = 16,
2396         LCK_NL      = 32,
2397         LCK_GROUP   = 64,
2398         LCK_COS     = 128,
2399         LCK_MAXMODE
2400 } ldlm_mode_t;
2401
2402 #define LCK_MODE_NUM    8
2403
2404 typedef enum {
2405         LDLM_PLAIN     = 10,
2406         LDLM_EXTENT    = 11,
2407         LDLM_FLOCK     = 12,
2408         LDLM_IBITS     = 13,
2409         LDLM_MAX_TYPE
2410 } ldlm_type_t;
2411
2412 #define LDLM_MIN_TYPE LDLM_PLAIN
2413
2414 struct ldlm_extent {
2415         __u64 start;
2416         __u64 end;
2417         __u64 gid;
2418 };
2419
2420 static inline int ldlm_extent_overlap(struct ldlm_extent *ex1,
2421                                       struct ldlm_extent *ex2)
2422 {
2423         return (ex1->start <= ex2->end) && (ex2->start <= ex1->end);
2424 }
2425
2426 /* check if @ex1 contains @ex2 */
2427 static inline int ldlm_extent_contain(struct ldlm_extent *ex1,
2428                                       struct ldlm_extent *ex2)
2429 {
2430         return (ex1->start <= ex2->start) && (ex1->end >= ex2->end);
2431 }
2432
2433 struct ldlm_inodebits {
2434         __u64 bits;
2435 };
2436
2437 struct ldlm_flock_wire {
2438         __u64 lfw_start;
2439         __u64 lfw_end;
2440         __u64 lfw_owner;
2441         __u32 lfw_padding;
2442         __u32 lfw_pid;
2443 };
2444
2445 /* it's important that the fields of the ldlm_extent structure match
2446  * the first fields of the ldlm_flock structure because there is only
2447  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
2448  * this ever changes we will need to swab the union differently based
2449  * on the resource type. */
2450
2451 typedef union {
2452         struct ldlm_extent l_extent;
2453         struct ldlm_flock_wire l_flock;
2454         struct ldlm_inodebits l_inodebits;
2455 } ldlm_wire_policy_data_t;
2456
2457 extern void lustre_swab_ldlm_policy_data (ldlm_wire_policy_data_t *d);
2458
2459 /* Data structures associated with the quota locks */
2460
2461 /* Glimpse descriptor used for the index & per-ID quota locks */
2462 struct ldlm_gl_lquota_desc {
2463         union lquota_id gl_id;    /* quota ID subject to the glimpse */
2464         __u64           gl_flags; /* see LQUOTA_FL* below */
2465         __u64           gl_ver;   /* new index version */
2466         __u64           gl_hardlimit; /* new hardlimit or qunit value */
2467         __u64           gl_softlimit; /* new softlimit */
2468         __u64           gl_pad1;
2469         __u64           gl_pad2;
2470 };
2471 #define gl_qunit        gl_hardlimit /* current qunit value used when
2472                                       * glimpsing per-ID quota locks */
2473
2474 /* quota glimpse flags */
2475 #define LQUOTA_FL_EDQUOT 0x1 /* user/group out of quota space on QMT */
2476
2477 /* LVB used with quota (global and per-ID) locks */
2478 struct lquota_lvb {
2479         __u64   lvb_flags;      /* see LQUOTA_FL* above */
2480         __u64   lvb_id_may_rel; /* space that might be released later */
2481         __u64   lvb_id_rel;     /* space released by the slave for this ID */
2482         __u64   lvb_id_qunit;   /* current qunit value */
2483         __u64   lvb_pad1;
2484 };
2485
2486 /* LVB used with global quota lock */
2487 #define lvb_glb_ver  lvb_id_may_rel /* current version of the global index */
2488
2489 /* Similarly to ldlm_wire_policy_data_t, there is one common swabber for all
2490  * LVB types. As a result, any new LVB structure must match the fields of the
2491  * ost_lvb structure. */
2492 union ldlm_wire_lvb {
2493         struct ost_lvb          l_ost;
2494         struct lquota_lvb       l_lquota;
2495 };
2496
2497 extern void lustre_swab_lvb(union ldlm_wire_lvb *);
2498
2499 union ldlm_gl_desc {
2500         struct ldlm_gl_lquota_desc      lquota_desc;
2501 };
2502
2503 extern void lustre_swab_gl_desc(union ldlm_gl_desc *);
2504
2505 struct ldlm_intent {
2506         __u64 opc;
2507 };
2508
2509 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
2510
2511 struct ldlm_resource_desc {
2512         ldlm_type_t lr_type;
2513         __u32 lr_padding;       /* also fix lustre_swab_ldlm_resource_desc */
2514         struct ldlm_res_id lr_name;
2515 };
2516
2517 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
2518
2519 struct ldlm_lock_desc {
2520         struct ldlm_resource_desc l_resource;
2521         ldlm_mode_t l_req_mode;
2522         ldlm_mode_t l_granted_mode;
2523         ldlm_wire_policy_data_t l_policy_data;
2524 };
2525
2526 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
2527
2528 #define LDLM_LOCKREQ_HANDLES 2
2529 #define LDLM_ENQUEUE_CANCEL_OFF 1
2530
2531 struct ldlm_request {
2532         __u32 lock_flags;
2533         __u32 lock_count;
2534         struct ldlm_lock_desc lock_desc;
2535         struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
2536 };
2537
2538 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
2539
2540 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
2541  * Otherwise, 2 are available. */
2542 #define ldlm_request_bufsize(count,type)                                \
2543 ({                                                                      \
2544         int _avail = LDLM_LOCKREQ_HANDLES;                              \
2545         _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
2546         sizeof(struct ldlm_request) +                                   \
2547         (count > _avail ? count - _avail : 0) *                         \
2548         sizeof(struct lustre_handle);                                   \
2549 })
2550
2551 struct ldlm_reply {
2552         __u32 lock_flags;
2553         __u32 lock_padding;     /* also fix lustre_swab_ldlm_reply */
2554         struct ldlm_lock_desc lock_desc;
2555         struct lustre_handle lock_handle;
2556         __u64  lock_policy_res1;
2557         __u64  lock_policy_res2;
2558 };
2559
2560 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
2561
2562 /*
2563  * Opcodes for mountconf (mgs and mgc)
2564  */
2565 typedef enum {
2566         MGS_CONNECT = 250,
2567         MGS_DISCONNECT,
2568         MGS_EXCEPTION,         /* node died, etc. */
2569         MGS_TARGET_REG,        /* whenever target starts up */
2570         MGS_TARGET_DEL,
2571         MGS_SET_INFO,
2572         MGS_CONFIG_READ,
2573         MGS_LAST_OPC
2574 } mgs_cmd_t;
2575 #define MGS_FIRST_OPC MGS_CONNECT
2576
2577 #define MGS_PARAM_MAXLEN 1024
2578 #define KEY_SET_INFO "set_info"
2579
2580 struct mgs_send_param {
2581         char             mgs_param[MGS_PARAM_MAXLEN];
2582 };
2583
2584 /* We pass this info to the MGS so it can write config logs */
2585 #define MTI_NAME_MAXLEN  64
2586 #define MTI_PARAM_MAXLEN 4096
2587 #define MTI_NIDS_MAX     32
2588 struct mgs_target_info {
2589         __u32            mti_lustre_ver;
2590         __u32            mti_stripe_index;
2591         __u32            mti_config_ver;
2592         __u32            mti_flags;
2593         __u32            mti_nid_count;
2594         __u32            mti_instance; /* Running instance of target */
2595         char             mti_fsname[MTI_NAME_MAXLEN];
2596         char             mti_svname[MTI_NAME_MAXLEN];
2597         char             mti_uuid[sizeof(struct obd_uuid)];
2598         __u64            mti_nids[MTI_NIDS_MAX];     /* host nids (lnet_nid_t)*/
2599         char             mti_params[MTI_PARAM_MAXLEN];
2600 };
2601 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
2602
2603 struct mgs_nidtbl_entry {
2604         __u64           mne_version;    /* table version of this entry */
2605         __u32           mne_instance;   /* target instance # */
2606         __u32           mne_index;      /* target index */
2607         __u32           mne_length;     /* length of this entry - by bytes */
2608         __u8            mne_type;       /* target type LDD_F_SV_TYPE_OST/MDT */
2609         __u8            mne_nid_type;   /* type of nid(mbz). for ipv6. */
2610         __u8            mne_nid_size;   /* size of each NID, by bytes */
2611         __u8            mne_nid_count;  /* # of NIDs in buffer */
2612         union {
2613                 lnet_nid_t nids[0];     /* variable size buffer for NIDs. */
2614         } u;
2615 };
2616 extern void lustre_swab_mgs_nidtbl_entry(struct mgs_nidtbl_entry *oinfo);
2617
2618 struct mgs_config_body {
2619         char     mcb_name[MTI_NAME_MAXLEN]; /* logname */
2620         __u64    mcb_offset;    /* next index of config log to request */
2621         __u16    mcb_type;      /* type of log: CONFIG_T_[CONFIG|RECOVER] */
2622         __u8     mcb_reserved;
2623         __u8     mcb_bits;      /* bits unit size of config log */
2624         __u32    mcb_units;     /* # of units for bulk transfer */
2625 };
2626 extern void lustre_swab_mgs_config_body(struct mgs_config_body *body);
2627
2628 struct mgs_config_res {
2629         __u64    mcr_offset;    /* index of last config log */
2630         __u64    mcr_size;      /* size of the log */
2631 };
2632 extern void lustre_swab_mgs_config_res(struct mgs_config_res *body);
2633
2634 /* Config marker flags (in config log) */
2635 #define CM_START       0x01
2636 #define CM_END         0x02
2637 #define CM_SKIP        0x04
2638 #define CM_UPGRADE146  0x08
2639 #define CM_EXCLUDE     0x10
2640 #define CM_START_SKIP (CM_START | CM_SKIP)
2641
2642 struct cfg_marker {
2643         __u32             cm_step;       /* aka config version */
2644         __u32             cm_flags;
2645         __u32             cm_vers;       /* lustre release version number */
2646         __u32             cm_padding;    /* 64 bit align */
2647         obd_time          cm_createtime; /*when this record was first created */
2648         obd_time          cm_canceltime; /*when this record is no longer valid*/
2649         char              cm_tgtname[MTI_NAME_MAXLEN];
2650         char              cm_comment[MTI_NAME_MAXLEN];
2651 };
2652
2653 extern void lustre_swab_cfg_marker(struct cfg_marker *marker,
2654                                    int swab, int size);
2655
2656 /*
2657  * Opcodes for multiple servers.
2658  */
2659
2660 typedef enum {
2661         OBD_PING = 400,
2662         OBD_LOG_CANCEL,
2663         OBD_QC_CALLBACK,
2664         OBD_IDX_READ,
2665         OBD_LAST_OPC
2666 } obd_cmd_t;
2667 #define OBD_FIRST_OPC OBD_PING
2668
2669 /* catalog of log objects */
2670
2671 /** Identifier for a single log object */
2672 struct llog_logid {
2673         __u64                   lgl_oid;
2674         __u64                   lgl_oseq;
2675         __u32                   lgl_ogen;
2676 } __attribute__((packed));
2677
2678 /** Records written to the CATALOGS list */
2679 #define CATLIST "CATALOGS"
2680 struct llog_catid {
2681         struct llog_logid       lci_logid;
2682         __u32                   lci_padding1;
2683         __u32                   lci_padding2;
2684         __u32                   lci_padding3;
2685 } __attribute__((packed));
2686
2687 /* Log data record types - there is no specific reason that these need to
2688  * be related to the RPC opcodes, but no reason not to (may be handy later?)
2689  */
2690 #define LLOG_OP_MAGIC 0x10600000
2691 #define LLOG_OP_MASK  0xfff00000
2692
2693 typedef enum {
2694         LLOG_PAD_MAGIC          = LLOG_OP_MAGIC | 0x00000,
2695         OST_SZ_REC              = LLOG_OP_MAGIC | 0x00f00,
2696         /* OST_RAID1_REC        = LLOG_OP_MAGIC | 0x01000, never used */
2697         MDS_UNLINK_REC          = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) |
2698                                   REINT_UNLINK, /* obsolete after 2.5.0 */
2699         MDS_UNLINK64_REC        = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2700                                   REINT_UNLINK,
2701         /* MDS_SETATTR_REC      = LLOG_OP_MAGIC | 0x12401, obsolete 1.8.0 */
2702         MDS_SETATTR64_REC       = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2703                                   REINT_SETATTR,
2704         OBD_CFG_REC             = LLOG_OP_MAGIC | 0x20000,
2705         /* PTL_CFG_REC          = LLOG_OP_MAGIC | 0x30000, obsolete 1.4.0 */
2706         LLOG_GEN_REC            = LLOG_OP_MAGIC | 0x40000,
2707         /* LLOG_JOIN_REC        = LLOG_OP_MAGIC | 0x50000, obsolete  1.8.0 */
2708         CHANGELOG_REC           = LLOG_OP_MAGIC | 0x60000,
2709         CHANGELOG_USER_REC      = LLOG_OP_MAGIC | 0x70000,
2710         LLOG_HDR_MAGIC          = LLOG_OP_MAGIC | 0x45539,
2711         LLOG_LOGID_MAGIC        = LLOG_OP_MAGIC | 0x4553b,
2712 } llog_op_type;
2713
2714 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
2715         (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == __swab32(LLOG_OP_MAGIC))
2716
2717 /** Log record header - stored in little endian order.
2718  * Each record must start with this struct, end with a llog_rec_tail,
2719  * and be a multiple of 256 bits in size.
2720  */
2721 struct llog_rec_hdr {
2722         __u32   lrh_len;
2723         __u32   lrh_index;
2724         __u32   lrh_type;
2725         __u32   lrh_id;
2726 };
2727
2728 struct llog_rec_tail {
2729         __u32   lrt_len;
2730         __u32   lrt_index;
2731 };
2732
2733 struct llog_logid_rec {
2734         struct llog_rec_hdr     lid_hdr;
2735         struct llog_logid       lid_id;
2736         __u32                   lid_padding1;
2737         __u64                   lid_padding2;
2738         __u64                   lid_padding3;
2739         struct llog_rec_tail    lid_tail;
2740 } __attribute__((packed));
2741
2742 struct llog_unlink_rec {
2743         struct llog_rec_hdr     lur_hdr;
2744         obd_id                  lur_oid;
2745         obd_count               lur_oseq;
2746         obd_count               lur_count;
2747         struct llog_rec_tail    lur_tail;
2748 } __attribute__((packed));
2749
2750 struct llog_unlink64_rec {
2751         struct llog_rec_hdr     lur_hdr;
2752         struct lu_fid           lur_fid;
2753         obd_count               lur_count; /* to destroy the lost precreated */
2754         __u32                   lur_padding1;
2755         __u64                   lur_padding2;
2756         __u64                   lur_padding3;
2757         struct llog_rec_tail    lur_tail;
2758 } __attribute__((packed));
2759
2760 struct llog_setattr64_rec {
2761         struct llog_rec_hdr     lsr_hdr;
2762         obd_id                  lsr_oid;
2763         obd_seq                 lsr_oseq;
2764         __u32                   lsr_uid;
2765         __u32                   lsr_uid_h;
2766         __u32                   lsr_gid;
2767         __u32                   lsr_gid_h;
2768         __u64                   lsr_padding;
2769         struct llog_rec_tail    lsr_tail;
2770 } __attribute__((packed));
2771
2772 struct llog_size_change_rec {
2773         struct llog_rec_hdr     lsc_hdr;
2774         struct ll_fid           lsc_fid;
2775         __u32                   lsc_ioepoch;
2776         __u32                   lsc_padding1;
2777         __u64                   lsc_padding2;
2778         __u64                   lsc_padding3;
2779         struct llog_rec_tail    lsc_tail;
2780 } __attribute__((packed));
2781
2782 #define CHANGELOG_MAGIC 0xca103000
2783
2784 /** \a changelog_rec_type's that can't be masked */
2785 #define CHANGELOG_MINMASK (1 << CL_MARK)
2786 /** bits covering all \a changelog_rec_type's */
2787 #define CHANGELOG_ALLMASK 0XFFFFFFFF
2788 /** default \a changelog_rec_type mask */
2789 #define CHANGELOG_DEFMASK CHANGELOG_ALLMASK & ~(1 << CL_ATIME | 1 << CL_CLOSE)
2790
2791 /* changelog llog name, needed by client replicators */
2792 #define CHANGELOG_CATALOG "changelog_catalog"
2793
2794 struct changelog_setinfo {
2795         __u64 cs_recno;
2796         __u32 cs_id;
2797 } __attribute__((packed));
2798
2799 /** changelog record */
2800 struct llog_changelog_rec {
2801         struct llog_rec_hdr  cr_hdr;
2802         struct changelog_rec cr;
2803         struct llog_rec_tail cr_tail; /**< for_sizezof_only */
2804 } __attribute__((packed));
2805
2806 struct llog_changelog_ext_rec {
2807         struct llog_rec_hdr      cr_hdr;
2808         struct changelog_ext_rec cr;
2809         struct llog_rec_tail     cr_tail; /**< for_sizezof_only */
2810 } __attribute__((packed));
2811
2812 #define CHANGELOG_USER_PREFIX "cl"
2813
2814 struct llog_changelog_user_rec {
2815         struct llog_rec_hdr   cur_hdr;
2816         __u32                 cur_id;
2817         __u32                 cur_padding;
2818         __u64                 cur_endrec;
2819         struct llog_rec_tail  cur_tail;
2820 } __attribute__((packed));
2821
2822 /* Old llog gen for compatibility */
2823 struct llog_gen {
2824         __u64 mnt_cnt;
2825         __u64 conn_cnt;
2826 } __attribute__((packed));
2827
2828 struct llog_gen_rec {
2829         struct llog_rec_hdr     lgr_hdr;
2830         struct llog_gen         lgr_gen;
2831         __u64                   padding1;
2832         __u64                   padding2;
2833         __u64                   padding3;
2834         struct llog_rec_tail    lgr_tail;
2835 };
2836
2837 /* On-disk header structure of each log object, stored in little endian order */
2838 #define LLOG_CHUNK_SIZE         8192
2839 #define LLOG_HEADER_SIZE        (96)
2840 #define LLOG_BITMAP_BYTES       (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
2841
2842 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
2843
2844 /* flags for the logs */
2845 enum llog_flag {
2846         LLOG_F_ZAP_WHEN_EMPTY   = 0x1,
2847         LLOG_F_IS_CAT           = 0x2,
2848         LLOG_F_IS_PLAIN         = 0x4,
2849 };
2850
2851 struct llog_log_hdr {
2852         struct llog_rec_hdr     llh_hdr;
2853         obd_time                llh_timestamp;
2854         __u32                   llh_count;
2855         __u32                   llh_bitmap_offset;
2856         __u32                   llh_size;
2857         __u32                   llh_flags;
2858         __u32                   llh_cat_idx;
2859         /* for a catalog the first plain slot is next to it */
2860         struct obd_uuid         llh_tgtuuid;
2861         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
2862         __u32                   llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
2863         struct llog_rec_tail    llh_tail;
2864 } __attribute__((packed));
2865
2866 #define LLOG_BITMAP_SIZE(llh)  (__u32)((llh->llh_hdr.lrh_len -          \
2867                                         llh->llh_bitmap_offset -        \
2868                                         sizeof(llh->llh_tail)) * 8)
2869
2870 /** log cookies are used to reference a specific log file and a record therein */
2871 struct llog_cookie {
2872         struct llog_logid       lgc_lgl;
2873         __u32                   lgc_subsys;
2874         __u32                   lgc_index;
2875         __u32                   lgc_padding;
2876 } __attribute__((packed));
2877
2878 /** llog protocol */
2879 enum llogd_rpc_ops {
2880         LLOG_ORIGIN_HANDLE_CREATE       = 501,
2881         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
2882         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
2883         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
2884         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
2885         LLOG_ORIGIN_CONNECT             = 506,
2886         LLOG_CATINFO                    = 507,  /* deprecated */
2887         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
2888         LLOG_ORIGIN_HANDLE_DESTROY      = 509,  /* for destroy llog object*/
2889         LLOG_LAST_OPC,
2890         LLOG_FIRST_OPC                  = LLOG_ORIGIN_HANDLE_CREATE
2891 };
2892
2893 struct llogd_body {
2894         struct llog_logid  lgd_logid;
2895         __u32 lgd_ctxt_idx;
2896         __u32 lgd_llh_flags;
2897         __u32 lgd_index;
2898         __u32 lgd_saved_index;
2899         __u32 lgd_len;
2900         __u64 lgd_cur_offset;
2901 } __attribute__((packed));
2902
2903 struct llogd_conn_body {
2904         struct llog_gen         lgdc_gen;
2905         struct llog_logid       lgdc_logid;
2906         __u32                   lgdc_ctxt_idx;
2907 } __attribute__((packed));
2908
2909 /* Note: 64-bit types are 64-bit aligned in structure */
2910 struct obdo {
2911         obd_valid               o_valid;        /* hot fields in this obdo */
2912         struct ost_id           o_oi;
2913         obd_id                  o_parent_seq;
2914         obd_size                o_size;         /* o_size-o_blocks == ost_lvb */
2915         obd_time                o_mtime;
2916         obd_time                o_atime;
2917         obd_time                o_ctime;
2918         obd_blocks              o_blocks;       /* brw: cli sent cached bytes */
2919         obd_size                o_grant;
2920
2921         /* 32-bit fields start here: keep an even number of them via padding */
2922         obd_blksize             o_blksize;      /* optimal IO blocksize */
2923         obd_mode                o_mode;         /* brw: cli sent cache remain */
2924         obd_uid                 o_uid;
2925         obd_gid                 o_gid;
2926         obd_flag                o_flags;
2927         obd_count               o_nlink;        /* brw: checksum */
2928         obd_count               o_parent_oid;
2929         obd_count               o_misc;         /* brw: o_dropped */
2930         __u64                   o_ioepoch;      /* epoch in ost writes */
2931         __u32                   o_stripe_idx;   /* holds stripe idx */
2932         __u32                   o_parent_ver;
2933         struct lustre_handle    o_handle;       /* brw: lock handle to prolong
2934                                                  * locks */
2935         struct llog_cookie      o_lcookie;      /* destroy: unlink cookie from
2936                                                  * MDS */
2937         __u32                   o_uid_h;
2938         __u32                   o_gid_h;
2939
2940         __u64                   o_data_version; /* getattr: sum of iversion for
2941                                                  * each stripe.
2942                                                  * brw: grant space consumed on
2943                                                  * the client for the write */
2944         __u64                   o_padding_4;
2945         __u64                   o_padding_5;
2946         __u64                   o_padding_6;
2947 };
2948
2949 #define o_id     o_oi.oi_id
2950 #define o_seq    o_oi.oi_seq
2951 #define o_dirty   o_blocks
2952 #define o_undirty o_mode
2953 #define o_dropped o_misc
2954 #define o_cksum   o_nlink
2955 #define o_grant_used o_data_version
2956
2957 static inline void lustre_set_wire_obdo(struct obdo *wobdo, struct obdo *lobdo)
2958 {
2959         memcpy(wobdo, lobdo, sizeof(*lobdo));
2960         wobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
2961 }
2962
2963 static inline void lustre_get_wire_obdo(struct obdo *lobdo, struct obdo *wobdo)
2964 {
2965         obd_flag local_flags = 0;
2966
2967         if (lobdo->o_valid & OBD_MD_FLFLAGS)
2968                  local_flags = lobdo->o_flags & OBD_FL_LOCAL_MASK;
2969
2970         LASSERT(!(wobdo->o_flags & OBD_FL_LOCAL_MASK));
2971
2972         memcpy(lobdo, wobdo, sizeof(*lobdo));
2973         if (local_flags != 0) {
2974                  lobdo->o_valid |= OBD_MD_FLFLAGS;
2975                  lobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
2976                  lobdo->o_flags |= local_flags;
2977         }
2978 }
2979
2980 extern void lustre_swab_obdo (struct obdo *o);
2981
2982 /* request structure for OST's */
2983 struct ost_body {
2984         struct  obdo oa;
2985 };
2986
2987 /* Key for FIEMAP to be used in get_info calls */
2988 struct ll_fiemap_info_key {
2989         char    name[8];
2990         struct  obdo oa;
2991         struct  ll_user_fiemap fiemap;
2992 };
2993
2994 extern void lustre_swab_ost_body (struct ost_body *b);
2995 extern void lustre_swab_ost_last_id(obd_id *id);
2996 extern void lustre_swab_fiemap(struct ll_user_fiemap *fiemap);
2997
2998 extern void lustre_swab_lov_user_md_v1(struct lov_user_md_v1 *lum);
2999 extern void lustre_swab_lov_user_md_v3(struct lov_user_md_v3 *lum);
3000 extern void lustre_swab_lov_user_md_objects(struct lov_user_ost_data *lod,
3001                                             int stripe_count);
3002 extern void lustre_swab_lov_mds_md(struct lov_mds_md *lmm);
3003
3004 /* llog_swab.c */
3005 extern void lustre_swab_llogd_body (struct llogd_body *d);
3006 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
3007 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
3008 extern void lustre_swab_llog_rec(struct llog_rec_hdr *rec);
3009
3010 struct lustre_cfg;
3011 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
3012
3013 /* Functions for dumping PTLRPC fields */
3014 void dump_rniobuf(struct niobuf_remote *rnb);
3015 void dump_ioo(struct obd_ioobj *nb);
3016 void dump_obdo(struct obdo *oa);
3017 void dump_ost_body(struct ost_body *ob);
3018 void dump_rcs(__u32 *rc);
3019
3020 #define IDX_INFO_MAGIC 0x3D37CC37
3021
3022 /* Index file transfer through the network. The server serializes the index into
3023  * a byte stream which is sent to the client via a bulk transfer */
3024 struct idx_info {
3025         __u32           ii_magic;
3026
3027         /* reply: see idx_info_flags below */
3028         __u32           ii_flags;
3029
3030         /* request & reply: number of lu_idxpage (to be) transferred */
3031         __u16           ii_count;
3032         __u16           ii_pad0;
3033
3034         /* request: requested attributes passed down to the iterator API */
3035         __u32           ii_attrs;
3036
3037         /* request & reply: index file identifier (FID) */
3038         struct lu_fid   ii_fid;
3039
3040         /* reply: version of the index file before starting to walk the index.
3041          * Please note that the version can be modified at any time during the
3042          * transfer */
3043         __u64           ii_version;
3044
3045         /* request: hash to start with:
3046          * reply: hash of the first entry of the first lu_idxpage and hash
3047          *        of the entry to read next if any */
3048         __u64           ii_hash_start;
3049         __u64           ii_hash_end;
3050
3051         /* reply: size of keys in lu_idxpages, minimal one if II_FL_VARKEY is
3052          * set */
3053         __u16           ii_keysize;
3054
3055         /* reply: size of records in lu_idxpages, minimal one if II_FL_VARREC
3056          * is set */
3057         __u16           ii_recsize;
3058
3059         __u32           ii_pad1;
3060         __u64           ii_pad2;
3061         __u64           ii_pad3;
3062 };
3063 extern void lustre_swab_idx_info(struct idx_info *ii);
3064
3065 #define II_END_OFF      MDS_DIR_END_OFF /* all entries have been read */
3066
3067 /* List of flags used in idx_info::ii_flags */
3068 enum idx_info_flags {
3069         II_FL_NOHASH    = 1 << 0, /* client doesn't care about hash value */
3070         II_FL_VARKEY    = 1 << 1, /* keys can be of variable size */
3071         II_FL_VARREC    = 1 << 2, /* records can be of variable size */
3072         II_FL_NONUNQ    = 1 << 3, /* index supports non-unique keys */
3073 };
3074
3075 #define LIP_MAGIC 0x8A6D6B6C
3076
3077 /* 4KB (= LU_PAGE_SIZE) container gathering key/record pairs */
3078 struct lu_idxpage {
3079         /* 16-byte header */
3080         __u32   lip_magic;
3081         __u16   lip_flags;
3082         __u16   lip_nr;   /* number of entries in the container */
3083         __u64   lip_pad0; /* additional padding for future use */
3084
3085         /* key/record pairs are stored in the remaining 4080 bytes.
3086          * depending upon the flags in idx_info::ii_flags, each key/record
3087          * pair might be preceded by:
3088          * - a hash value
3089          * - the key size (II_FL_VARKEY is set)
3090          * - the record size (II_FL_VARREC is set)
3091          *
3092          * For the time being, we only support fixed-size key & record. */
3093         char    lip_entries[0];
3094 };
3095
3096 #define LIP_HDR_SIZE (offsetof(struct lu_idxpage, lip_entries))
3097
3098 /* Gather all possible type associated with a 4KB container */
3099 union lu_page {
3100         struct lu_dirpage       lp_dir; /* for MDS_READPAGE */
3101         struct lu_idxpage       lp_idx; /* for OBD_IDX_READ */
3102         char                    lp_array[LU_PAGE_SIZE];
3103 };
3104
3105 /* this will be used when OBD_CONNECT_CHANGE_QS is set */
3106 struct qunit_data {
3107         /**
3108          * ID appiles to (uid, gid)
3109          */
3110         __u32 qd_id;
3111         /**
3112          * LQUOTA_FLAGS_* affect the responding bits
3113          */
3114         __u32 qd_flags;
3115         /**
3116          * acquire/release count (bytes for block quota)
3117          */
3118         __u64 qd_count;
3119         /**
3120          * when a master returns the reply to a slave, it will
3121          * contain the current corresponding qunit size
3122          */
3123         __u64 qd_qunit;
3124         __u64 padding;
3125 };
3126
3127 #define QDATA_IS_GRP(qdata)    ((qdata)->qd_flags & LQUOTA_FLAGS_GRP)
3128 #define QDATA_IS_BLK(qdata)    ((qdata)->qd_flags & LQUOTA_FLAGS_BLK)
3129 #define QDATA_IS_ADJBLK(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_ADJBLK)
3130 #define QDATA_IS_ADJINO(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_ADJINO)
3131 #define QDATA_IS_CHANGE_QS(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_CHG_QS)
3132
3133 #define QDATA_SET_GRP(qdata)    ((qdata)->qd_flags |= LQUOTA_FLAGS_GRP)
3134 #define QDATA_SET_BLK(qdata)    ((qdata)->qd_flags |= LQUOTA_FLAGS_BLK)
3135 #define QDATA_SET_ADJBLK(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_ADJBLK)
3136 #define QDATA_SET_ADJINO(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_ADJINO)
3137 #define QDATA_SET_CHANGE_QS(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_CHG_QS)
3138
3139 #define QDATA_CLR_GRP(qdata)        ((qdata)->qd_flags &= ~LQUOTA_FLAGS_GRP)
3140 #define QDATA_CLR_CHANGE_QS(qdata)  ((qdata)->qd_flags &= ~LQUOTA_FLAGS_CHG_QS)
3141
3142 extern void lustre_swab_qdata(struct qunit_data *d);
3143 extern struct qunit_data *quota_get_qdata(void *req, int is_req, int is_exp);
3144 extern int quota_copy_qdata(void *request, struct qunit_data *qdata,
3145                             int is_req, int is_exp);
3146
3147 typedef enum {
3148         QUOTA_DQACQ     = 601,
3149         QUOTA_DQREL     = 602,
3150         QUOTA_LAST_OPC
3151 } quota_cmd_t;
3152 #define QUOTA_FIRST_OPC QUOTA_DQACQ
3153
3154 #define QUOTA_REQUEST   1
3155 #define QUOTA_REPLY     0
3156 #define QUOTA_EXPORT    1
3157 #define QUOTA_IMPORT    0
3158
3159 /* quota check function */
3160 #define QUOTA_RET_OK           0 /**< return successfully */
3161 #define QUOTA_RET_NOQUOTA      1 /**< not support quota */
3162 #define QUOTA_RET_NOLIMIT      2 /**< quota limit isn't set */
3163 #define QUOTA_RET_ACQUOTA      4 /**< need to acquire extra quota */
3164
3165
3166 /* security opcodes */
3167 typedef enum {
3168         SEC_CTX_INIT            = 801,
3169         SEC_CTX_INIT_CONT       = 802,
3170         SEC_CTX_FINI            = 803,
3171         SEC_LAST_OPC,
3172         SEC_FIRST_OPC           = SEC_CTX_INIT
3173 } sec_cmd_t;
3174
3175 /*
3176  * capa related definitions
3177  */
3178 #define CAPA_HMAC_MAX_LEN       64
3179 #define CAPA_HMAC_KEY_MAX_LEN   56
3180
3181 /* NB take care when changing the sequence of elements this struct,
3182  * because the offset info is used in find_capa() */
3183 struct lustre_capa {
3184         struct lu_fid   lc_fid;         /** fid */
3185         __u64           lc_opc;         /** operations allowed */
3186         __u64           lc_uid;         /** file owner */
3187         __u64           lc_gid;         /** file group */
3188         __u32           lc_flags;       /** HMAC algorithm & flags */
3189         __u32           lc_keyid;       /** key# used for the capability */
3190         __u32           lc_timeout;     /** capa timeout value (sec) */
3191         __u32           lc_expiry;      /** expiry time (sec) */
3192         __u8            lc_hmac[CAPA_HMAC_MAX_LEN];   /** HMAC */
3193 } __attribute__((packed));
3194
3195 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
3196
3197 /** lustre_capa::lc_opc */
3198 enum {
3199         CAPA_OPC_BODY_WRITE   = 1<<0,  /**< write object data */
3200         CAPA_OPC_BODY_READ    = 1<<1,  /**< read object data */
3201         CAPA_OPC_INDEX_LOOKUP = 1<<2,  /**< lookup object fid */
3202         CAPA_OPC_INDEX_INSERT = 1<<3,  /**< insert object fid */
3203         CAPA_OPC_INDEX_DELETE = 1<<4,  /**< delete object fid */
3204         CAPA_OPC_OSS_WRITE    = 1<<5,  /**< write oss object data */
3205         CAPA_OPC_OSS_READ     = 1<<6,  /**< read oss object data */
3206         CAPA_OPC_OSS_TRUNC    = 1<<7,  /**< truncate oss object */
3207         CAPA_OPC_OSS_DESTROY  = 1<<8,  /**< destroy oss object */
3208         CAPA_OPC_META_WRITE   = 1<<9,  /**< write object meta data */
3209         CAPA_OPC_META_READ    = 1<<10, /**< read object meta data */
3210 };
3211
3212 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
3213 #define CAPA_OPC_MDS_ONLY                                                   \
3214         (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
3215          CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
3216 #define CAPA_OPC_OSS_ONLY                                                   \
3217         (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC |      \
3218          CAPA_OPC_OSS_DESTROY)
3219 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
3220 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
3221
3222 /* MDS capability covers object capability for operations of body r/w
3223  * (dir readpage/sendpage), index lookup/insert/delete and m