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