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