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