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