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