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