Whamcloud - gitweb
1b9d47dcca9a203a177b180698ef68fc83044871
[fs/lustre-release.git] / lustre / include / lustre / lustre_idl.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2013, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/include/lustre/lustre_idl.h
37  *
38  * Lustre wire protocol definitions.
39  */
40
41 /** \defgroup lustreidl lustreidl
42  *
43  * Lustre wire protocol definitions.
44  *
45  * ALL structs passing over the wire should be declared here.  Structs
46  * that are used in interfaces with userspace should go in lustre_user.h.
47  *
48  * All structs being declared here should be built from simple fixed-size
49  * types (__u8, __u16, __u32, __u64) or be built from other types or
50  * structs also declared in this file.  Similarly, all flags and magic
51  * values in those structs should also be declared here.  This ensures
52  * that the Lustre wire protocol is not influenced by external dependencies.
53  *
54  * The only other acceptable items in this file are VERY SIMPLE accessor
55  * functions to avoid callers grubbing inside the structures, and the
56  * prototypes of the swabber functions for each struct.  Nothing that
57  * depends on external functions or definitions should be in here.
58  *
59  * Structs must be properly aligned to put 64-bit values on an 8-byte
60  * boundary.  Any structs being added here must also be added to
61  * utils/wirecheck.c and "make newwiretest" run to regenerate the
62  * utils/wiretest.c sources.  This allows us to verify that wire structs
63  * have the proper alignment/size on all architectures.
64  *
65  * DO NOT CHANGE any of the structs, flags, values declared here and used
66  * in released Lustre versions.  Some structs may have padding fields that
67  * can be used.  Some structs might allow addition at the end (verify this
68  * in the code to ensure that new/old clients that see this larger struct
69  * do not fail, otherwise you need to implement protocol compatibility).
70  *
71  * We assume all nodes are either little-endian or big-endian, and we
72  * always send messages in the sender's native format.  The receiver
73  * detects the message format by checking the 'magic' field of the message
74  * (see lustre_msg_swabbed() below).
75  *
76  * Each wire type has corresponding 'lustre_swab_xxxtypexxx()' routines,
77  * implemented either here, inline (trivial implementations) or in
78  * ptlrpc/pack_generic.c.  These 'swabbers' convert the type from "other"
79  * endian, in-place in the message buffer.
80  *
81  * A swabber takes a single pointer argument.  The caller must already have
82  * verified that the length of the message buffer >= sizeof (type).
83  *
84  * For variable length types, a second 'lustre_swab_v_xxxtypexxx()' routine
85  * may be defined that swabs just the variable part, after the caller has
86  * verified that the message buffer is large enough.
87  *
88  * @{
89  */
90
91 #ifndef _LUSTRE_IDL_H_
92 #define _LUSTRE_IDL_H_
93
94 #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 typedef __u64 obd_id;
168 typedef __u64 obd_seq;
169 typedef __s64 obd_time;
170 typedef __u64 obd_size;
171 typedef __u64 obd_off;
172 typedef __u64 obd_blocks;
173 typedef __u64 obd_valid;
174 typedef __u32 obd_blksize;
175 typedef __u32 obd_mode;
176 typedef __u32 obd_uid;
177 typedef __u32 obd_gid;
178 typedef __u32 obd_flag;
179 typedef __u32 obd_count;
180
181 /**
182  * Describes a range of sequence, lsr_start is included but lsr_end is
183  * not in the range.
184  * Same structure is used in fld module where lsr_index field holds mdt id
185  * of the home mdt.
186  */
187 struct lu_seq_range {
188         __u64 lsr_start;
189         __u64 lsr_end;
190         __u32 lsr_index;
191         __u32 lsr_flags;
192 };
193
194 struct lu_seq_range_array {
195         __u32 lsra_count;
196         __u32 lsra_padding;
197         struct lu_seq_range lsra_lsr[0];
198 };
199
200 #define LU_SEQ_RANGE_MDT        0x0
201 #define LU_SEQ_RANGE_OST        0x1
202 #define LU_SEQ_RANGE_ANY        0x3
203
204 #define LU_SEQ_RANGE_MASK       0x3
205
206 static inline unsigned fld_range_type(const struct lu_seq_range *range)
207 {
208         return range->lsr_flags & LU_SEQ_RANGE_MASK;
209 }
210
211 static inline bool fld_range_is_ost(const struct lu_seq_range *range)
212 {
213         return fld_range_type(range) == LU_SEQ_RANGE_OST;
214 }
215
216 static inline bool fld_range_is_mdt(const struct lu_seq_range *range)
217 {
218         return fld_range_type(range) == LU_SEQ_RANGE_MDT;
219 }
220
221 /**
222  * This all range is only being used when fld client sends fld query request,
223  * but it does not know whether the seq is MDT or OST, so it will send req
224  * with ALL type, which means either seq type gotten from lookup can be
225  * expected.
226  */
227 static inline unsigned fld_range_is_any(const struct lu_seq_range *range)
228 {
229         return fld_range_type(range) == LU_SEQ_RANGE_ANY;
230 }
231
232 static inline void fld_range_set_type(struct lu_seq_range *range,
233                                       unsigned flags)
234 {
235         range->lsr_flags |= flags;
236 }
237
238 static inline void fld_range_set_mdt(struct lu_seq_range *range)
239 {
240         fld_range_set_type(range, LU_SEQ_RANGE_MDT);
241 }
242
243 static inline void fld_range_set_ost(struct lu_seq_range *range)
244 {
245         fld_range_set_type(range, LU_SEQ_RANGE_OST);
246 }
247
248 static inline void fld_range_set_any(struct lu_seq_range *range)
249 {
250         fld_range_set_type(range, LU_SEQ_RANGE_ANY);
251 }
252
253 /**
254  * returns  width of given range \a r
255  */
256
257 static inline __u64 range_space(const struct lu_seq_range *range)
258 {
259         return range->lsr_end - range->lsr_start;
260 }
261
262 /**
263  * initialize range to zero
264  */
265
266 static inline void range_init(struct lu_seq_range *range)
267 {
268         memset(range, 0, sizeof(*range));
269 }
270
271 /**
272  * check if given seq id \a s is within given range \a r
273  */
274
275 static inline bool range_within(const struct lu_seq_range *range,
276                                 __u64 s)
277 {
278         return s >= range->lsr_start && s < range->lsr_end;
279 }
280
281 static inline bool range_is_sane(const struct lu_seq_range *range)
282 {
283         return range->lsr_end >= range->lsr_start;
284 }
285
286 static inline bool range_is_zero(const struct lu_seq_range *range)
287 {
288         return range->lsr_start == 0 && range->lsr_end == 0;
289 }
290
291 static inline bool range_is_exhausted(const struct lu_seq_range *range)
292 {
293         return range_space(range) == 0;
294 }
295
296 /* return 0 if two range have the same location */
297 static inline int range_compare_loc(const struct lu_seq_range *r1,
298                                     const struct lu_seq_range *r2)
299 {
300         return r1->lsr_index != r2->lsr_index ||
301                r1->lsr_flags != r2->lsr_flags;
302 }
303
304 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x):%x:%s"
305
306 #define PRANGE(range)           \
307         (range)->lsr_start,     \
308         (range)->lsr_end,       \
309         (range)->lsr_index,     \
310         fld_range_is_mdt(range) ? "mdt" : "ost"
311
312
313 /** \defgroup lu_fid lu_fid
314  * @{ */
315
316 /**
317  * Flags for lustre_mdt_attrs::lma_compat and lustre_mdt_attrs::lma_incompat.
318  * Deprecated since HSM and SOM attributes are now stored in separate on-disk
319  * xattr.
320  */
321 enum lma_compat {
322         LMAC_HSM        = 0x00000001,
323         LMAC_SOM        = 0x00000002,
324         LMAC_NOT_IN_OI  = 0x00000004, /* the object does NOT need OI mapping */
325         LMAC_FID_ON_OST = 0x00000008, /* For OST-object, its OI mapping is
326                                        * under /O/<seq>/d<x>. */
327 };
328
329 /**
330  * Masks for all features that should be supported by a Lustre version to
331  * access a specific file.
332  * This information is stored in lustre_mdt_attrs::lma_incompat.
333  */
334 enum lma_incompat {
335         LMAI_RELEASED           = 0x00000001, /* file is released */
336         LMAI_AGENT              = 0x00000002, /* agent inode */
337         LMAI_REMOTE_PARENT      = 0x00000004, /* the parent of the object
338                                                  is on the remote MDT */
339         LMAI_STRIPED            = 0x00000008, /* striped directory inode */
340 };
341 #define LMA_INCOMPAT_SUPP       (LMAI_AGENT | LMAI_REMOTE_PARENT | LMAI_STRIPED)
342
343 extern void lustre_lma_swab(struct lustre_mdt_attrs *lma);
344 extern void lustre_lma_init(struct lustre_mdt_attrs *lma,
345                             const struct lu_fid *fid,
346                             __u32 compat, __u32 incompat);
347 /**
348  * SOM on-disk attributes stored in a separate xattr.
349  */
350 struct som_attrs {
351         /** Bitfield for supported data in this structure. For future use. */
352         __u32   som_compat;
353
354         /** Incompat feature list. The supported feature mask is availabe in
355          * SOM_INCOMPAT_SUPP */
356         __u32   som_incompat;
357
358         /** IO Epoch SOM attributes belongs to */
359         __u64   som_ioepoch;
360         /** total file size in objects */
361         __u64   som_size;
362         /** total fs blocks in objects */
363         __u64   som_blocks;
364         /** mds mount id the size is valid for */
365         __u64   som_mountid;
366 };
367 extern void lustre_som_swab(struct som_attrs *attrs);
368
369 #define SOM_INCOMPAT_SUPP 0x0
370
371 /**
372  * HSM on-disk attributes stored in a separate xattr.
373  */
374 struct hsm_attrs {
375         /** Bitfield for supported data in this structure. For future use. */
376         __u32   hsm_compat;
377
378         /** HSM flags, see hsm_flags enum below */
379         __u32   hsm_flags;
380         /** backend archive id associated with the file */
381         __u64   hsm_arch_id;
382         /** version associated with the last archiving, if any */
383         __u64   hsm_arch_ver;
384 };
385 extern void lustre_hsm_swab(struct hsm_attrs *attrs);
386
387 /**
388  * fid constants
389  */
390 enum {
391         /** LASTID file has zero OID */
392         LUSTRE_FID_LASTID_OID = 0UL,
393         /** initial fid id value */
394         LUSTRE_FID_INIT_OID  = 1UL
395 };
396
397 /** returns fid object sequence */
398 static inline __u64 fid_seq(const struct lu_fid *fid)
399 {
400         return fid->f_seq;
401 }
402
403 /** returns fid object id */
404 static inline __u32 fid_oid(const struct lu_fid *fid)
405 {
406         return fid->f_oid;
407 }
408
409 /** returns fid object version */
410 static inline __u32 fid_ver(const struct lu_fid *fid)
411 {
412         return fid->f_ver;
413 }
414
415 static inline void fid_zero(struct lu_fid *fid)
416 {
417         memset(fid, 0, sizeof(*fid));
418 }
419
420 static inline obd_id fid_ver_oid(const struct lu_fid *fid)
421 {
422         return ((__u64)fid_ver(fid) << 32 | fid_oid(fid));
423 }
424
425 /**
426  * Note that reserved SEQ numbers below 12 will conflict with ldiskfs
427  * inodes in the IGIF namespace, so these reserved SEQ numbers can be
428  * used for other purposes and not risk collisions with existing inodes.
429  *
430  * Different FID Format
431  * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs#NEW.0
432  */
433 enum fid_seq {
434         FID_SEQ_OST_MDT0        = 0,
435         FID_SEQ_LLOG            = 1, /* unnamed llogs */
436         FID_SEQ_ECHO            = 2,
437         FID_SEQ_OST_MDT1        = 3,
438         FID_SEQ_OST_MAX         = 9, /* Max MDT count before OST_on_FID */
439         FID_SEQ_LLOG_NAME       = 10, /* named llogs */
440         FID_SEQ_RSVD            = 11,
441         FID_SEQ_IGIF            = 12,
442         FID_SEQ_IGIF_MAX        = 0x0ffffffffULL,
443         FID_SEQ_IDIF            = 0x100000000ULL,
444         FID_SEQ_IDIF_MAX        = 0x1ffffffffULL,
445         /* Normal FID sequence starts from this value, i.e. 1<<33 */
446         FID_SEQ_START           = 0x200000000ULL,
447         /* sequence for local pre-defined FIDs listed in local_oid */
448         FID_SEQ_LOCAL_FILE      = 0x200000001ULL,
449         FID_SEQ_DOT_LUSTRE      = 0x200000002ULL,
450         /* sequence is used for local named objects FIDs generated
451          * by local_object_storage library */
452         FID_SEQ_LOCAL_NAME      = 0x200000003ULL,
453         /* Because current FLD will only cache the fid sequence, instead
454          * of oid on the client side, if the FID needs to be exposed to
455          * clients sides, it needs to make sure all of fids under one
456          * sequence will be located in one MDT. */
457         FID_SEQ_SPECIAL         = 0x200000004ULL,
458         FID_SEQ_QUOTA           = 0x200000005ULL,
459         FID_SEQ_QUOTA_GLB       = 0x200000006ULL,
460         FID_SEQ_ROOT            = 0x200000007ULL,  /* Located on MDT0 */
461         FID_SEQ_LAYOUT_RBTREE   = 0x200000008ULL,
462         FID_SEQ_NORMAL          = 0x200000400ULL,
463         FID_SEQ_LOV_DEFAULT     = 0xffffffffffffffffULL
464 };
465
466 #define OBIF_OID_MAX_BITS           32
467 #define OBIF_MAX_OID                (1ULL << OBIF_OID_MAX_BITS)
468 #define OBIF_OID_MASK               ((1ULL << OBIF_OID_MAX_BITS) - 1)
469 #define IDIF_OID_MAX_BITS           48
470 #define IDIF_MAX_OID                (1ULL << IDIF_OID_MAX_BITS)
471 #define IDIF_OID_MASK               ((1ULL << IDIF_OID_MAX_BITS) - 1)
472
473 /** OID for FID_SEQ_SPECIAL */
474 enum special_oid {
475         /* Big Filesystem Lock to serialize rename operations */
476         FID_OID_SPECIAL_BFL     = 1UL,
477 };
478
479 /** OID for FID_SEQ_DOT_LUSTRE */
480 enum dot_lustre_oid {
481         FID_OID_DOT_LUSTRE      = 1UL,
482         FID_OID_DOT_LUSTRE_OBF  = 2UL,
483         FID_OID_DOT_LUSTRE_LPF  = 3UL,
484 };
485
486 static inline bool fid_seq_is_mdt0(obd_seq seq)
487 {
488         return seq == FID_SEQ_OST_MDT0;
489 }
490
491 static inline bool fid_seq_is_mdt(__u64 seq)
492 {
493         return seq == FID_SEQ_OST_MDT0 || seq >= FID_SEQ_NORMAL;
494 };
495
496 static inline bool fid_seq_is_echo(obd_seq seq)
497 {
498         return seq == FID_SEQ_ECHO;
499 }
500
501 static inline bool fid_is_echo(const struct lu_fid *fid)
502 {
503         return fid_seq_is_echo(fid_seq(fid));
504 }
505
506 static inline bool fid_seq_is_llog(obd_seq seq)
507 {
508         return seq == FID_SEQ_LLOG;
509 }
510
511 static inline bool fid_is_llog(const struct lu_fid *fid)
512 {
513         /* file with OID == 0 is not llog but contains last oid */
514         return fid_seq_is_llog(fid_seq(fid)) && fid_oid(fid) > 0;
515 }
516
517 static inline bool fid_seq_is_rsvd(__u64 seq)
518 {
519         return seq > FID_SEQ_OST_MDT0 && seq <= FID_SEQ_RSVD;
520 };
521
522 static inline bool fid_seq_is_special(__u64 seq)
523 {
524         return seq == FID_SEQ_SPECIAL;
525 };
526
527 static inline bool fid_seq_is_local_file(__u64 seq)
528 {
529         return seq == FID_SEQ_LOCAL_FILE ||
530                seq == FID_SEQ_LOCAL_NAME;
531 };
532
533 static inline bool fid_seq_is_root(__u64 seq)
534 {
535         return seq == FID_SEQ_ROOT;
536 }
537
538 static inline bool fid_seq_is_dot(__u64 seq)
539 {
540         return seq == FID_SEQ_DOT_LUSTRE;
541 }
542
543 static inline bool fid_seq_is_default(__u64 seq)
544 {
545         return seq == FID_SEQ_LOV_DEFAULT;
546 }
547
548 static inline bool fid_is_mdt0(const struct lu_fid *fid)
549 {
550         return fid_seq_is_mdt0(fid_seq(fid));
551 }
552
553 static inline void lu_root_fid(struct lu_fid *fid)
554 {
555         fid->f_seq = FID_SEQ_ROOT;
556         fid->f_oid = 1;
557         fid->f_ver = 0;
558 }
559
560 /**
561  * Check if a fid is igif or not.
562  * \param fid the fid to be tested.
563  * \return true if the fid is a igif; otherwise false.
564  */
565 static inline bool fid_seq_is_igif(__u64 seq)
566 {
567         return seq >= FID_SEQ_IGIF && seq <= FID_SEQ_IGIF_MAX;
568 }
569
570 static inline bool fid_is_igif(const struct lu_fid *fid)
571 {
572         return fid_seq_is_igif(fid_seq(fid));
573 }
574
575 /**
576  * Check if a fid is idif or not.
577  * \param fid the fid to be tested.
578  * \return true if the fid is a idif; otherwise false.
579  */
580 static inline bool fid_seq_is_idif(__u64 seq)
581 {
582         return seq >= FID_SEQ_IDIF && seq <= FID_SEQ_IDIF_MAX;
583 }
584
585 static inline bool fid_is_idif(const struct lu_fid *fid)
586 {
587         return fid_seq_is_idif(fid_seq(fid));
588 }
589
590 static inline bool fid_is_local_file(const struct lu_fid *fid)
591 {
592         return fid_seq_is_local_file(fid_seq(fid));
593 }
594
595 static inline bool fid_seq_is_norm(__u64 seq)
596 {
597         return (seq >= FID_SEQ_NORMAL);
598 }
599
600 static inline bool fid_is_norm(const struct lu_fid *fid)
601 {
602         return fid_seq_is_norm(fid_seq(fid));
603 }
604
605 static inline int fid_is_layout_rbtree(const struct lu_fid *fid)
606 {
607         return fid_seq(fid) == FID_SEQ_LAYOUT_RBTREE;
608 }
609
610 /* convert an OST objid into an IDIF FID SEQ number */
611 static inline obd_seq fid_idif_seq(obd_id id, __u32 ost_idx)
612 {
613         return FID_SEQ_IDIF | (ost_idx << 16) | ((id >> 32) & 0xffff);
614 }
615
616 /* convert a packed IDIF FID into an OST objid */
617 static inline obd_id fid_idif_id(obd_seq seq, __u32 oid, __u32 ver)
618 {
619         return ((__u64)ver << 48) | ((seq & 0xffff) << 32) | oid;
620 }
621
622 static inline __u32 idif_ost_idx(obd_seq seq)
623 {
624         return (seq >> 16) & 0xffff;
625 }
626
627 /* extract ost index from IDIF FID */
628 static inline __u32 fid_idif_ost_idx(const struct lu_fid *fid)
629 {
630         return idif_ost_idx(fid_seq(fid));
631 }
632
633 /* extract OST sequence (group) from a wire ost_id (id/seq) pair */
634 static inline obd_seq ostid_seq(const struct ost_id *ostid)
635 {
636         if (fid_seq_is_mdt0(ostid->oi.oi_seq))
637                 return FID_SEQ_OST_MDT0;
638
639         if (unlikely(fid_seq_is_default(ostid->oi.oi_seq)))
640                 return FID_SEQ_LOV_DEFAULT;
641
642         if (fid_is_idif(&ostid->oi_fid))
643                 return FID_SEQ_OST_MDT0;
644
645         return fid_seq(&ostid->oi_fid);
646 }
647
648 /* extract OST objid from a wire ost_id (id/seq) pair */
649 static inline obd_id ostid_id(const struct ost_id *ostid)
650 {
651         if (fid_seq_is_mdt0(ostid->oi.oi_seq))
652                 return ostid->oi.oi_id & IDIF_OID_MASK;
653
654         if (unlikely(fid_seq_is_default(ostid->oi.oi_seq)))
655                 return ostid->oi.oi_id;
656
657         if (fid_is_idif(&ostid->oi_fid))
658                 return fid_idif_id(fid_seq(&ostid->oi_fid),
659                                    fid_oid(&ostid->oi_fid), 0);
660
661         return fid_oid(&ostid->oi_fid);
662 }
663
664 static inline void ostid_set_seq(struct ost_id *oi, __u64 seq)
665 {
666         if (fid_seq_is_mdt0(seq) || fid_seq_is_default(seq)) {
667                 oi->oi.oi_seq = seq;
668         } else {
669                 oi->oi_fid.f_seq = seq;
670                 /* Note: if f_oid + f_ver is zero, we need init it
671                  * to be 1, otherwise, ostid_seq will treat this
672                  * as old ostid (oi_seq == 0) */
673                 if (oi->oi_fid.f_oid == 0 && oi->oi_fid.f_ver == 0)
674                         oi->oi_fid.f_oid = LUSTRE_FID_INIT_OID;
675         }
676 }
677
678 static inline void ostid_set_seq_mdt0(struct ost_id *oi)
679 {
680         ostid_set_seq(oi, FID_SEQ_OST_MDT0);
681 }
682
683 static inline void ostid_set_seq_echo(struct ost_id *oi)
684 {
685         ostid_set_seq(oi, FID_SEQ_ECHO);
686 }
687
688 static inline void ostid_set_seq_llog(struct ost_id *oi)
689 {
690         ostid_set_seq(oi, FID_SEQ_LLOG);
691 }
692
693 /**
694  * Note: we need check oi_seq to decide where to set oi_id,
695  * so oi_seq should always be set ahead of oi_id.
696  */
697 static inline void ostid_set_id(struct ost_id *oi, __u64 oid)
698 {
699         if (fid_seq_is_mdt0(oi->oi.oi_seq)) {
700                 if (oid >= IDIF_MAX_OID) {
701                         CERROR("Bad "LPU64" to set "DOSTID"\n",
702                                 oid, POSTID(oi));
703                         return;
704                 }
705                 oi->oi.oi_id = oid;
706         } else if (fid_is_idif(&oi->oi_fid)) {
707                 if (oid >= IDIF_MAX_OID) {
708                         CERROR("Bad "LPU64" to set "DOSTID"\n",
709                                 oid, POSTID(oi));
710                         return;
711                 }
712                 oi->oi_fid.f_seq = fid_idif_seq(oid,
713                                                 fid_idif_ost_idx(&oi->oi_fid));
714                 oi->oi_fid.f_oid = oid;
715                 oi->oi_fid.f_ver = oid >> 48;
716         } else {
717                 if (oid > OBIF_MAX_OID) {
718                         CERROR("Bad "LPU64" to set "DOSTID"\n",
719                                 oid, POSTID(oi));
720                         return;
721                 }
722                 oi->oi_fid.f_oid = oid;
723         }
724 }
725
726 static inline int fid_set_id(struct lu_fid *fid, __u64 oid)
727 {
728         if (unlikely(fid_seq_is_igif(fid->f_seq))) {
729                 CERROR("bad IGIF, "DFID"\n", PFID(fid));
730                 return -EBADF;
731         }
732
733         if (fid_is_idif(fid)) {
734                 if (oid >= IDIF_MAX_OID) {
735                         CERROR("Bad "LPU64" to set "DFID"\n",
736                                 oid, PFID(fid));
737                         return -EBADF;
738                 }
739                 fid->f_seq = fid_idif_seq(oid, fid_idif_ost_idx(fid));
740                 fid->f_oid = oid;
741                 fid->f_ver = oid >> 48;
742         } else {
743                 if (oid > OBIF_MAX_OID) {
744                         CERROR("Bad "LPU64" to set "DFID"\n",
745                                 oid, PFID(fid));
746                         return -EBADF;
747                 }
748                 fid->f_oid = oid;
749         }
750         return 0;
751 }
752
753 /**
754  * Unpack an OST object id/seq (group) into a FID.  This is needed for
755  * converting all obdo, lmm, lsm, etc. 64-bit id/seq pairs into proper
756  * FIDs.  Note that if an id/seq is already in FID/IDIF format it will
757  * be passed through unchanged.  Only legacy OST objects in "group 0"
758  * will be mapped into the IDIF namespace so that they can fit into the
759  * struct lu_fid fields without loss.  For reference see:
760  * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs
761  */
762 static inline int ostid_to_fid(struct lu_fid *fid, const struct ost_id *ostid,
763                                __u32 ost_idx)
764 {
765         obd_seq seq = ostid_seq(ostid);
766
767         if (ost_idx > 0xffff) {
768                 CERROR("bad ost_idx, "DOSTID" ost_idx:%u\n", POSTID(ostid),
769                        ost_idx);
770                 return -EBADF;
771         }
772
773         if (fid_seq_is_mdt0(seq)) {
774                 obd_id oid = ostid_id(ostid);
775
776                 /* This is a "legacy" (old 1.x/2.early) OST object in "group 0"
777                  * that we map into the IDIF namespace.  It allows up to 2^48
778                  * objects per OST, as this is the object namespace that has
779                  * been in production for years.  This can handle create rates
780                  * of 1M objects/s/OST for 9 years, or combinations thereof. */
781                 if (oid >= IDIF_MAX_OID) {
782                         CERROR("bad MDT0 id(1), "DOSTID" ost_idx:%u\n",
783                                POSTID(ostid), ost_idx);
784                         return -EBADF;
785                 }
786                 fid->f_seq = fid_idif_seq(oid, ost_idx);
787                 /* truncate to 32 bits by assignment */
788                 fid->f_oid = oid;
789                 /* in theory, not currently used */
790                 fid->f_ver = oid >> 48;
791         } else if (likely(!fid_seq_is_default(seq)))
792                 /* if (fid_seq_is_idif(seq) || fid_seq_is_norm(seq)) */ {
793                 /* This is either an IDIF object, which identifies objects across
794                  * all OSTs, or a regular FID.  The IDIF namespace maps legacy
795                  * OST objects into the FID namespace.  In both cases, we just
796                  * pass the FID through, no conversion needed. */
797                 if (ostid->oi_fid.f_ver != 0) {
798                         CERROR("bad MDT0 id(2), "DOSTID" ost_idx:%u\n",
799                                 POSTID(ostid), ost_idx);
800                         return -EBADF;
801                 }
802                 *fid = ostid->oi_fid;
803         }
804
805         return 0;
806 }
807
808 /* pack any OST FID into an ostid (id/seq) for the wire/disk */
809 static inline int fid_to_ostid(const struct lu_fid *fid, struct ost_id *ostid)
810 {
811         if (unlikely(fid_seq_is_igif(fid->f_seq))) {
812                 CERROR("bad IGIF, "DFID"\n", PFID(fid));
813                 return -EBADF;
814         }
815
816         if (fid_is_idif(fid)) {
817                 ostid_set_seq_mdt0(ostid);
818                 ostid_set_id(ostid, fid_idif_id(fid_seq(fid), fid_oid(fid),
819                                                 fid_ver(fid)));
820         } else {
821                 ostid->oi_fid = *fid;
822         }
823
824         return 0;
825 }
826
827 /* Check whether the fid is for LAST_ID */
828 static inline bool fid_is_last_id(const struct lu_fid *fid)
829 {
830         return fid_oid(fid) == 0;
831 }
832
833 /**
834  * Get inode number from a igif.
835  * \param fid a igif to get inode number from.
836  * \return inode number for the igif.
837  */
838 static inline ino_t lu_igif_ino(const struct lu_fid *fid)
839 {
840         return fid_seq(fid);
841 }
842
843 extern void lustre_swab_ost_id(struct ost_id *oid);
844
845 /**
846  * Get inode generation from a igif.
847  * \param fid a igif to get inode generation from.
848  * \return inode generation for the igif.
849  */
850 static inline __u32 lu_igif_gen(const struct lu_fid *fid)
851 {
852         return fid_oid(fid);
853 }
854
855 /**
856  * Build igif from the inode number/generation.
857  */
858 static inline void lu_igif_build(struct lu_fid *fid, __u32 ino, __u32 gen)
859 {
860         fid->f_seq = ino;
861         fid->f_oid = gen;
862         fid->f_ver = 0;
863 }
864
865 /*
866  * Fids are transmitted across network (in the sender byte-ordering),
867  * and stored on disk in big-endian order.
868  */
869 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
870 {
871         dst->f_seq = cpu_to_le64(fid_seq(src));
872         dst->f_oid = cpu_to_le32(fid_oid(src));
873         dst->f_ver = cpu_to_le32(fid_ver(src));
874 }
875
876 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
877 {
878         dst->f_seq = le64_to_cpu(fid_seq(src));
879         dst->f_oid = le32_to_cpu(fid_oid(src));
880         dst->f_ver = le32_to_cpu(fid_ver(src));
881 }
882
883 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
884 {
885         dst->f_seq = cpu_to_be64(fid_seq(src));
886         dst->f_oid = cpu_to_be32(fid_oid(src));
887         dst->f_ver = cpu_to_be32(fid_ver(src));
888 }
889
890 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
891 {
892         dst->f_seq = be64_to_cpu(fid_seq(src));
893         dst->f_oid = be32_to_cpu(fid_oid(src));
894         dst->f_ver = be32_to_cpu(fid_ver(src));
895 }
896
897 static inline bool fid_is_sane(const struct lu_fid *fid)
898 {
899         return fid != NULL &&
900                ((fid_seq(fid) >= FID_SEQ_START && fid_ver(fid) == 0) ||
901                 fid_is_igif(fid) || fid_is_idif(fid) ||
902                 fid_seq_is_rsvd(fid_seq(fid)));
903 }
904
905 extern void lustre_swab_lu_fid(struct lu_fid *fid);
906 extern void lustre_swab_lu_seq_range(struct lu_seq_range *range);
907
908 static inline bool lu_fid_eq(const struct lu_fid *f0, const struct lu_fid *f1)
909 {
910         return memcmp(f0, f1, sizeof *f0) == 0;
911 }
912
913 #define __diff_normalize(val0, val1)                            \
914 ({                                                              \
915         typeof(val0) __val0 = (val0);                           \
916         typeof(val1) __val1 = (val1);                           \
917                                                                 \
918         (__val0 == __val1 ? 0 : __val0 > __val1 ? +1 : -1);     \
919 })
920
921 static inline int lu_fid_cmp(const struct lu_fid *f0,
922                              const struct lu_fid *f1)
923 {
924         return
925                 __diff_normalize(fid_seq(f0), fid_seq(f1)) ?:
926                 __diff_normalize(fid_oid(f0), fid_oid(f1)) ?:
927                 __diff_normalize(fid_ver(f0), fid_ver(f1));
928 }
929
930 static inline void ostid_cpu_to_le(const struct ost_id *src_oi,
931                                    struct ost_id *dst_oi)
932 {
933         if (fid_seq_is_mdt0(src_oi->oi.oi_seq)) {
934                 dst_oi->oi.oi_id = cpu_to_le64(src_oi->oi.oi_id);
935                 dst_oi->oi.oi_seq = cpu_to_le64(src_oi->oi.oi_seq);
936         } else {
937                 fid_cpu_to_le(&dst_oi->oi_fid, &src_oi->oi_fid);
938         }
939 }
940
941 static inline void ostid_le_to_cpu(const struct ost_id *src_oi,
942                                    struct ost_id *dst_oi)
943 {
944         if (fid_seq_is_mdt0(src_oi->oi.oi_seq)) {
945                 dst_oi->oi.oi_id = le64_to_cpu(src_oi->oi.oi_id);
946                 dst_oi->oi.oi_seq = le64_to_cpu(src_oi->oi.oi_seq);
947         } else {
948                 fid_le_to_cpu(&dst_oi->oi_fid, &src_oi->oi_fid);
949         }
950 }
951
952 struct lu_orphan_rec {
953         /* The MDT-object's FID referenced by the orphan OST-object */
954         struct lu_fid   lor_fid;
955         __u32           lor_uid;
956         __u32           lor_gid;
957 };
958
959 struct lu_orphan_ent {
960         /* The orphan OST-object's FID */
961         struct lu_fid           loe_key;
962         struct lu_orphan_rec    loe_rec;
963 };
964 void lustre_swab_orphan_ent(struct lu_orphan_ent *ent);
965
966 /** @} lu_fid */
967
968 /** \defgroup lu_dir lu_dir
969  * @{ */
970
971 /**
972  * Enumeration of possible directory entry attributes.
973  *
974  * Attributes follow directory entry header in the order they appear in this
975  * enumeration.
976  */
977 enum lu_dirent_attrs {
978         LUDA_FID                = 0x0001,
979         LUDA_TYPE               = 0x0002,
980         LUDA_64BITHASH          = 0x0004,
981
982         /* The following attrs are used for MDT interanl only,
983          * not visible to client */
984
985         /* Verify the dirent consistency */
986         LUDA_VERIFY             = 0x8000,
987         /* Only check but not repair the dirent inconsistency */
988         LUDA_VERIFY_DRYRUN      = 0x4000,
989         /* The dirent has been repaired, or to be repaired (dryrun). */
990         LUDA_REPAIR             = 0x2000,
991         /* The system is upgraded, has beed or to be repaired (dryrun). */
992         LUDA_UPGRADE            = 0x1000,
993         /* Ignore this record, go to next directly. */
994         LUDA_IGNORE             = 0x0800,
995 };
996
997 #define LU_DIRENT_ATTRS_MASK    0xf800
998
999 /**
1000  * Layout of readdir pages, as transmitted on wire.
1001  */
1002 struct lu_dirent {
1003         /** valid if LUDA_FID is set. */
1004         struct lu_fid lde_fid;
1005         /** a unique entry identifier: a hash or an offset. */
1006         __u64         lde_hash;
1007         /** total record length, including all attributes. */
1008         __u16         lde_reclen;
1009         /** name length */
1010         __u16         lde_namelen;
1011         /** optional variable size attributes following this entry.
1012          *  taken from enum lu_dirent_attrs.
1013          */
1014         __u32         lde_attrs;
1015         /** name is followed by the attributes indicated in ->ldp_attrs, in
1016          *  their natural order. After the last attribute, padding bytes are
1017          *  added to make ->lde_reclen a multiple of 8.
1018          */
1019         char          lde_name[0];
1020 };
1021
1022 /*
1023  * Definitions of optional directory entry attributes formats.
1024  *
1025  * Individual attributes do not have their length encoded in a generic way. It
1026  * is assumed that consumer of an attribute knows its format. This means that
1027  * it is impossible to skip over an unknown attribute, except by skipping over all
1028  * remaining attributes (by using ->lde_reclen), which is not too
1029  * constraining, because new server versions will append new attributes at
1030  * the end of an entry.
1031  */
1032
1033 /**
1034  * Fid directory attribute: a fid of an object referenced by the entry. This
1035  * will be almost always requested by the client and supplied by the server.
1036  *
1037  * Aligned to 8 bytes.
1038  */
1039 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
1040
1041 /**
1042  * File type.
1043  *
1044  * Aligned to 2 bytes.
1045  */
1046 struct luda_type {
1047         __u16 lt_type;
1048 };
1049
1050 struct lu_dirpage {
1051         __u64            ldp_hash_start;
1052         __u64            ldp_hash_end;
1053         __u32            ldp_flags;
1054         __u32            ldp_pad0;
1055         struct lu_dirent ldp_entries[0];
1056 };
1057
1058 enum lu_dirpage_flags {
1059         /**
1060          * dirpage contains no entry.
1061          */
1062         LDF_EMPTY   = 1 << 0,
1063         /**
1064          * last entry's lde_hash equals ldp_hash_end.
1065          */
1066         LDF_COLLIDE = 1 << 1
1067 };
1068
1069 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
1070 {
1071         if (le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
1072                 return NULL;
1073         else
1074                 return dp->ldp_entries;
1075 }
1076
1077 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
1078 {
1079         struct lu_dirent *next;
1080
1081         if (le16_to_cpu(ent->lde_reclen) != 0)
1082                 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
1083         else
1084                 next = NULL;
1085
1086         return next;
1087 }
1088
1089 static inline size_t lu_dirent_calc_size(size_t namelen, __u16 attr)
1090 {
1091         size_t size;
1092
1093         if (attr & LUDA_TYPE) {
1094                 const size_t align = sizeof(struct luda_type) - 1;
1095                 size = (sizeof(struct lu_dirent) + namelen + align) & ~align;
1096                 size += sizeof(struct luda_type);
1097         } else
1098                 size = sizeof(struct lu_dirent) + namelen;
1099
1100         return (size + 7) & ~7;
1101 }
1102
1103 #define MDS_DIR_END_OFF 0xfffffffffffffffeULL
1104
1105 /**
1106  * MDS_READPAGE page size
1107  *
1108  * This is the directory page size packed in MDS_READPAGE RPC.
1109  * It's different than PAGE_CACHE_SIZE because the client needs to
1110  * access the struct lu_dirpage header packed at the beginning of
1111  * the "page" and without this there isn't any way to know find the
1112  * lu_dirpage header is if client and server PAGE_CACHE_SIZE differ.
1113  */
1114 #define LU_PAGE_SHIFT 12
1115 #define LU_PAGE_SIZE  (1UL << LU_PAGE_SHIFT)
1116 #define LU_PAGE_MASK  (~(LU_PAGE_SIZE - 1))
1117
1118 #define LU_PAGE_COUNT (1 << (PAGE_CACHE_SHIFT - LU_PAGE_SHIFT))
1119
1120 /** @} lu_dir */
1121
1122 struct lustre_handle {
1123         __u64 cookie;
1124 };
1125 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
1126
1127 static inline bool lustre_handle_is_used(const struct lustre_handle *lh)
1128 {
1129         return lh->cookie != 0;
1130 }
1131
1132 static inline bool lustre_handle_equal(const struct lustre_handle *lh1,
1133                                        const struct lustre_handle *lh2)
1134 {
1135         return lh1->cookie == lh2->cookie;
1136 }
1137
1138 static inline void lustre_handle_copy(struct lustre_handle *tgt,
1139                                       const struct lustre_handle *src)
1140 {
1141         tgt->cookie = src->cookie;
1142 }
1143
1144 /* flags for lm_flags */
1145 #define MSGHDR_AT_SUPPORT               0x1
1146 #define MSGHDR_CKSUM_INCOMPAT18         0x2
1147
1148 #define lustre_msg lustre_msg_v2
1149 /* we depend on this structure to be 8-byte aligned */
1150 /* this type is only endian-adjusted in lustre_unpack_msg() */
1151 struct lustre_msg_v2 {
1152         __u32 lm_bufcount;
1153         __u32 lm_secflvr;
1154         __u32 lm_magic;
1155         __u32 lm_repsize;
1156         __u32 lm_cksum;
1157         __u32 lm_flags;
1158         __u32 lm_padding_2;
1159         __u32 lm_padding_3;
1160         __u32 lm_buflens[0];
1161 };
1162
1163 /* without gss, ptlrpc_body is put at the first buffer. */
1164 #define PTLRPC_NUM_VERSIONS     4
1165 struct ptlrpc_body_v3 {
1166         struct lustre_handle pb_handle;
1167         __u32 pb_type;
1168         __u32 pb_version;
1169         __u32 pb_opc;
1170         __u32 pb_status;
1171         __u64 pb_last_xid;
1172         __u64 pb_last_seen;
1173         __u64 pb_last_committed;
1174         __u64 pb_transno;
1175         __u32 pb_flags;
1176         __u32 pb_op_flags;
1177         __u32 pb_conn_cnt;
1178         __u32 pb_timeout;  /* for req, the deadline, for rep, the service est */
1179         __u32 pb_service_time; /* for rep, actual service time */
1180         __u32 pb_limit;
1181         __u64 pb_slv;
1182         /* VBR: pre-versions */
1183         __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1184         /* padding for future needs */
1185         __u64 pb_padding[4];
1186         char  pb_jobid[LUSTRE_JOBID_SIZE];
1187 };
1188 #define ptlrpc_body     ptlrpc_body_v3
1189
1190 struct ptlrpc_body_v2 {
1191         struct lustre_handle pb_handle;
1192         __u32 pb_type;
1193         __u32 pb_version;
1194         __u32 pb_opc;
1195         __u32 pb_status;
1196         __u64 pb_last_xid;
1197         __u64 pb_last_seen;
1198         __u64 pb_last_committed;
1199         __u64 pb_transno;
1200         __u32 pb_flags;
1201         __u32 pb_op_flags;
1202         __u32 pb_conn_cnt;
1203         __u32 pb_timeout;  /* for req, the deadline, for rep, the service est */
1204         __u32 pb_service_time; /* for rep, actual service time, also used for
1205                                   net_latency of req */
1206         __u32 pb_limit;
1207         __u64 pb_slv;
1208         /* VBR: pre-versions */
1209         __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1210         /* padding for future needs */
1211         __u64 pb_padding[4];
1212 };
1213
1214 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
1215
1216 /* message body offset for lustre_msg_v2 */
1217 /* ptlrpc body offset in all request/reply messages */
1218 #define MSG_PTLRPC_BODY_OFF             0
1219
1220 /* normal request/reply message record offset */
1221 #define REQ_REC_OFF                     1
1222 #define REPLY_REC_OFF                   1
1223
1224 /* ldlm request message body offset */
1225 #define DLM_LOCKREQ_OFF                 1 /* lockreq offset */
1226 #define DLM_REQ_REC_OFF                 2 /* normal dlm request record offset */
1227
1228 /* ldlm intent lock message body offset */
1229 #define DLM_INTENT_IT_OFF               2 /* intent lock it offset */
1230 #define DLM_INTENT_REC_OFF              3 /* intent lock record offset */
1231
1232 /* ldlm reply message body offset */
1233 #define DLM_LOCKREPLY_OFF               1 /* lockrep offset */
1234 #define DLM_REPLY_REC_OFF               2 /* reply record offset */
1235
1236 /** only use in req->rq_{req,rep}_swab_mask */
1237 #define MSG_PTLRPC_HEADER_OFF           31
1238
1239 /* Flags that are operation-specific go in the top 16 bits. */
1240 #define MSG_OP_FLAG_MASK   0xffff0000
1241 #define MSG_OP_FLAG_SHIFT  16
1242
1243 /* Flags that apply to all requests are in the bottom 16 bits */
1244 #define MSG_GEN_FLAG_MASK     0x0000ffff
1245 #define MSG_LAST_REPLAY           0x0001
1246 #define MSG_RESENT                0x0002
1247 #define MSG_REPLAY                0x0004
1248 /* #define MSG_AT_SUPPORT         0x0008
1249  * This was used in early prototypes of adaptive timeouts, and while there
1250  * shouldn't be any users of that code there also isn't a need for using this
1251  * bits. Defer usage until at least 1.10 to avoid potential conflict. */
1252 #define MSG_DELAY_REPLAY          0x0010
1253 #define MSG_VERSION_REPLAY        0x0020
1254 #define MSG_REQ_REPLAY_DONE       0x0040
1255 #define MSG_LOCK_REPLAY_DONE      0x0080
1256
1257 /*
1258  * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
1259  */
1260
1261 #define MSG_CONNECT_RECOVERING  0x00000001
1262 #define MSG_CONNECT_RECONNECT   0x00000002
1263 #define MSG_CONNECT_REPLAYABLE  0x00000004
1264 //#define MSG_CONNECT_PEER        0x8
1265 #define MSG_CONNECT_LIBCLIENT   0x00000010
1266 #define MSG_CONNECT_INITIAL     0x00000020
1267 #define MSG_CONNECT_ASYNC       0x00000040
1268 #define MSG_CONNECT_NEXT_VER    0x00000080 /* use next version of lustre_msg */
1269 #define MSG_CONNECT_TRANSNO     0x00000100 /* report transno */
1270
1271 /* Connect flags */
1272 #define OBD_CONNECT_RDONLY                0x1ULL /*client has read-only access*/
1273 #define OBD_CONNECT_INDEX                 0x2ULL /*connect specific LOV idx */
1274 #define OBD_CONNECT_MDS                   0x4ULL /*connect from MDT to OST */
1275 #define OBD_CONNECT_GRANT                 0x8ULL /*OSC gets grant at connect */
1276 #define OBD_CONNECT_SRVLOCK              0x10ULL /*server takes locks for cli */
1277 #define OBD_CONNECT_VERSION              0x20ULL /*Lustre versions in ocd */
1278 #define OBD_CONNECT_REQPORTAL            0x40ULL /*Separate non-IO req portal */
1279 #define OBD_CONNECT_ACL                  0x80ULL /*access control lists */
1280 #define OBD_CONNECT_XATTR               0x100ULL /*client use extended attr */
1281 #define OBD_CONNECT_CROW                0x200ULL /*MDS+OST create obj on write*/
1282 #define OBD_CONNECT_TRUNCLOCK           0x400ULL /*locks on server for punch */
1283 #define OBD_CONNECT_TRANSNO             0x800ULL /*replay sends init transno */
1284 #define OBD_CONNECT_IBITS              0x1000ULL /*support for inodebits locks*/
1285 #define OBD_CONNECT_JOIN               0x2000ULL /*files can be concatenated.
1286                                                   *We do not support JOIN FILE
1287                                                   *anymore, reserve this flags
1288                                                   *just for preventing such bit
1289                                                   *to be reused.*/
1290 #define OBD_CONNECT_ATTRFID            0x4000ULL /*Server can GetAttr By Fid*/
1291 #define OBD_CONNECT_NODEVOH            0x8000ULL /*No open hndl on specl nodes*/
1292 #define OBD_CONNECT_RMT_CLIENT        0x10000ULL /*Remote client */
1293 #define OBD_CONNECT_RMT_CLIENT_FORCE  0x20000ULL /*Remote client by force */
1294 #define OBD_CONNECT_BRW_SIZE          0x40000ULL /*Max bytes per rpc */
1295 #define OBD_CONNECT_QUOTA64           0x80000ULL /*Not used since 2.4 */
1296 #define OBD_CONNECT_MDS_CAPA         0x100000ULL /*MDS capability */
1297 #define OBD_CONNECT_OSS_CAPA         0x200000ULL /*OSS capability */
1298 #define OBD_CONNECT_CANCELSET        0x400000ULL /*Early batched cancels. */
1299 #define OBD_CONNECT_SOM              0x800000ULL /*Size on MDS */
1300 #define OBD_CONNECT_AT              0x1000000ULL /*client uses AT */
1301 #define OBD_CONNECT_LRU_RESIZE      0x2000000ULL /*LRU resize feature. */
1302 #define OBD_CONNECT_MDS_MDS         0x4000000ULL /*MDS-MDS connection */
1303 #define OBD_CONNECT_REAL            0x8000000ULL /*real connection */
1304 #define OBD_CONNECT_CHANGE_QS      0x10000000ULL /*Not used since 2.4 */
1305 #define OBD_CONNECT_CKSUM          0x20000000ULL /*support several cksum algos*/
1306 #define OBD_CONNECT_FID            0x40000000ULL /*FID is supported by server */
1307 #define OBD_CONNECT_VBR            0x80000000ULL /*version based recovery */
1308 #define OBD_CONNECT_LOV_V3        0x100000000ULL /*client supports LOV v3 EA */
1309 #define OBD_CONNECT_GRANT_SHRINK  0x200000000ULL /* support grant shrink */
1310 #define OBD_CONNECT_SKIP_ORPHAN   0x400000000ULL /* don't reuse orphan objids */
1311 #define OBD_CONNECT_MAX_EASIZE    0x800000000ULL /* preserved for large EA */
1312 #define OBD_CONNECT_FULL20       0x1000000000ULL /* it is 2.0 client */
1313 #define OBD_CONNECT_LAYOUTLOCK   0x2000000000ULL /* client uses layout lock */
1314 #define OBD_CONNECT_64BITHASH    0x4000000000ULL /* client supports 64-bits
1315                                                   * directory hash */
1316 #define OBD_CONNECT_MAXBYTES     0x8000000000ULL /* max stripe size */
1317 #define OBD_CONNECT_IMP_RECOV   0x10000000000ULL /* imp recovery support */
1318 #define OBD_CONNECT_JOBSTATS    0x20000000000ULL /* jobid in ptlrpc_body */
1319 #define OBD_CONNECT_UMASK       0x40000000000ULL /* create uses client umask */
1320 #define OBD_CONNECT_EINPROGRESS 0x80000000000ULL /* client handles -EINPROGRESS
1321                                                   * RPC error properly */
1322 #define OBD_CONNECT_GRANT_PARAM 0x100000000000ULL/* extra grant params used for
1323                                                   * finer space reservation */
1324 #define OBD_CONNECT_FLOCK_OWNER 0x200000000000ULL /* for the fixed 1.8
1325                                                    * policy and 2.x server */
1326 #define OBD_CONNECT_LVB_TYPE    0x400000000000ULL /* variable type of LVB */
1327 #define OBD_CONNECT_NANOSEC_TIME 0x800000000000ULL /* nanosecond timestamps */
1328 #define OBD_CONNECT_LIGHTWEIGHT 0x1000000000000ULL/* lightweight connection */
1329 #define OBD_CONNECT_SHORTIO     0x2000000000000ULL/* short io */
1330 #define OBD_CONNECT_PINGLESS    0x4000000000000ULL/* pings not required */
1331 #define OBD_CONNECT_FLOCK_DEAD  0x8000000000000ULL/* improved flock deadlock detection */
1332 #define OBD_CONNECT_DISP_STRIPE 0x10000000000000ULL/* create stripe disposition*/
1333 #define OBD_CONNECT_OPEN_BY_FID 0x20000000000000ULL /* open by fid won't pack
1334                                                        name in request */
1335 #define OBD_CONNECT_LFSCK      0x40000000000000ULL/* support online LFSCK */
1336 #define OBD_CONNECT_UNLINK_CLOSE 0x100000000000000ULL/* close file in unlink */
1337 #define OBD_CONNECT_DIR_STRIPE   0x400000000000000ULL /* striped DNE dir */
1338
1339 /* XXX README XXX:
1340  * Please DO NOT add flag values here before first ensuring that this same
1341  * flag value is not in use on some other branch.  Please clear any such
1342  * changes with senior engineers before starting to use a new flag.  Then,
1343  * submit a small patch against EVERY branch that ONLY adds the new flag,
1344  * updates obd_connect_names[] for lprocfs_rd_connect_flags(), adds the
1345  * flag to check_obd_connect_data(), and updates wiretests accordingly, so it
1346  * can be approved and landed easily to reserve the flag for future use. */
1347
1348 /* The MNE_SWAB flag is overloading the MDS_MDS bit only for the MGS
1349  * connection.  It is a temporary bug fix for Imperative Recovery interop
1350  * between 2.2 and 2.3 x86/ppc nodes, and can be removed when interop for
1351  * 2.2 clients/servers is no longer needed.  LU-1252/LU-1644. */
1352 #define OBD_CONNECT_MNE_SWAB             OBD_CONNECT_MDS_MDS
1353
1354 #define OCD_HAS_FLAG(ocd, flg)  \
1355         (!!((ocd)->ocd_connect_flags & OBD_CONNECT_##flg))
1356
1357
1358 #ifdef HAVE_LRU_RESIZE_SUPPORT
1359 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
1360 #else
1361 #define LRU_RESIZE_CONNECT_FLAG 0
1362 #endif
1363
1364 #define MDT_CONNECT_SUPPORTED  (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
1365                                 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
1366                                 OBD_CONNECT_IBITS | \
1367                                 OBD_CONNECT_NODEVOH | OBD_CONNECT_ATTRFID | \
1368                                 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1369                                 OBD_CONNECT_RMT_CLIENT | \
1370                                 OBD_CONNECT_RMT_CLIENT_FORCE | \
1371                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_MDS_CAPA | \
1372                                 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_MDS_MDS | \
1373                                 OBD_CONNECT_FID | LRU_RESIZE_CONNECT_FLAG | \
1374                                 OBD_CONNECT_VBR | OBD_CONNECT_LOV_V3 | \
1375                                 OBD_CONNECT_SOM | OBD_CONNECT_FULL20 | \
1376                                 OBD_CONNECT_64BITHASH | OBD_CONNECT_JOBSTATS | \
1377                                 OBD_CONNECT_EINPROGRESS | \
1378                                 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_UMASK | \
1379                                 OBD_CONNECT_LVB_TYPE | OBD_CONNECT_LAYOUTLOCK |\
1380                                 OBD_CONNECT_PINGLESS | OBD_CONNECT_MAX_EASIZE |\
1381                                 OBD_CONNECT_FLOCK_DEAD | \
1382                                 OBD_CONNECT_DISP_STRIPE | OBD_CONNECT_LFSCK | \
1383                                 OBD_CONNECT_OPEN_BY_FID | \
1384                                 OBD_CONNECT_DIR_STRIPE)
1385
1386 #define OST_CONNECT_SUPPORTED  (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
1387                                 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
1388                                 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
1389                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_OSS_CAPA | \
1390                                 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1391                                 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_CKSUM | \
1392                                 OBD_CONNECT_RMT_CLIENT | \
1393                                 OBD_CONNECT_RMT_CLIENT_FORCE | OBD_CONNECT_VBR | \
1394                                 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
1395                                 OBD_CONNECT_GRANT_SHRINK | OBD_CONNECT_FULL20 | \
1396                                 OBD_CONNECT_64BITHASH | OBD_CONNECT_MAXBYTES | \
1397                                 OBD_CONNECT_MAX_EASIZE | \
1398                                 OBD_CONNECT_EINPROGRESS | \
1399                                 OBD_CONNECT_JOBSTATS | \
1400                                 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_LVB_TYPE|\
1401                                 OBD_CONNECT_LAYOUTLOCK | OBD_CONNECT_FID | \
1402                                 OBD_CONNECT_PINGLESS | OBD_CONNECT_LFSCK)
1403 #define ECHO_CONNECT_SUPPORTED (0)
1404 #define MGS_CONNECT_SUPPORTED  (OBD_CONNECT_VERSION | OBD_CONNECT_AT | \
1405                                 OBD_CONNECT_FULL20 | OBD_CONNECT_IMP_RECOV | \
1406                                 OBD_CONNECT_MNE_SWAB | OBD_CONNECT_PINGLESS)
1407
1408 /* Features required for this version of the client to work with server */
1409 #define CLIENT_CONNECT_MDT_REQD (OBD_CONNECT_IBITS | OBD_CONNECT_FID | \
1410                                  OBD_CONNECT_FULL20)
1411
1412 /* This structure is used for both request and reply.
1413  *
1414  * If we eventually have separate connect data for different types, which we
1415  * almost certainly will, then perhaps we stick a union in here. */
1416 struct obd_connect_data_v1 {
1417         __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1418         __u32 ocd_version;       /* lustre release version number */
1419         __u32 ocd_grant;         /* initial cache grant amount (bytes) */
1420         __u32 ocd_index;         /* LOV index to connect to */
1421         __u32 ocd_brw_size;      /* Maximum BRW size in bytes, must be 2^n */
1422         __u64 ocd_ibits_known;   /* inode bits this client understands */
1423         __u8  ocd_blocksize;     /* log2 of the backend filesystem blocksize */
1424         __u8  ocd_inodespace;    /* log2 of the per-inode space consumption */
1425         __u16 ocd_grant_extent;  /* per-extent grant overhead, in 1K blocks */
1426         __u32 ocd_unused;        /* also fix lustre_swab_connect */
1427         __u64 ocd_transno;       /* first transno from client to be replayed */
1428         __u32 ocd_group;         /* MDS group on OST */
1429         __u32 ocd_cksum_types;   /* supported checksum algorithms */
1430         __u32 ocd_max_easize;    /* How big LOV EA can be on MDS */
1431         __u32 ocd_instance;      /* also fix lustre_swab_connect */
1432         __u64 ocd_maxbytes;      /* Maximum stripe size in bytes */
1433 };
1434
1435 struct obd_connect_data {
1436         __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1437         __u32 ocd_version;       /* lustre release version number */
1438         __u32 ocd_grant;         /* initial cache grant amount (bytes) */
1439         __u32 ocd_index;         /* LOV index to connect to */
1440         __u32 ocd_brw_size;      /* Maximum BRW size in bytes */
1441         __u64 ocd_ibits_known;   /* inode bits this client understands */
1442         __u8  ocd_blocksize;     /* log2 of the backend filesystem blocksize */
1443         __u8  ocd_inodespace;    /* log2 of the per-inode space consumption */
1444         __u16 ocd_grant_extent;  /* per-extent grant overhead, in 1K blocks */
1445         __u32 ocd_unused;        /* also fix lustre_swab_connect */
1446         __u64 ocd_transno;       /* first transno from client to be replayed */
1447         __u32 ocd_group;         /* MDS group on OST */
1448         __u32 ocd_cksum_types;   /* supported checksum algorithms */
1449         __u32 ocd_max_easize;    /* How big LOV EA can be on MDS */
1450         __u32 ocd_instance;      /* instance # of this target */
1451         __u64 ocd_maxbytes;      /* Maximum stripe size in bytes */
1452         /* Fields after ocd_maxbytes are only accessible by the receiver
1453          * if the corresponding flag in ocd_connect_flags is set. Accessing
1454          * any field after ocd_maxbytes on the receiver without a valid flag
1455          * may result in out-of-bound memory access and kernel oops. */
1456         __u64 padding1;          /* added 2.1.0. also fix lustre_swab_connect */
1457         __u64 padding2;          /* added 2.1.0. also fix lustre_swab_connect */
1458         __u64 padding3;          /* added 2.1.0. also fix lustre_swab_connect */
1459         __u64 padding4;          /* added 2.1.0. also fix lustre_swab_connect */
1460         __u64 padding5;          /* added 2.1.0. also fix lustre_swab_connect */
1461         __u64 padding6;          /* added 2.1.0. also fix lustre_swab_connect */
1462         __u64 padding7;          /* added 2.1.0. also fix lustre_swab_connect */
1463         __u64 padding8;          /* added 2.1.0. also fix lustre_swab_connect */
1464         __u64 padding9;          /* added 2.1.0. also fix lustre_swab_connect */
1465         __u64 paddingA;          /* added 2.1.0. also fix lustre_swab_connect */
1466         __u64 paddingB;          /* added 2.1.0. also fix lustre_swab_connect */
1467         __u64 paddingC;          /* added 2.1.0. also fix lustre_swab_connect */
1468         __u64 paddingD;          /* added 2.1.0. also fix lustre_swab_connect */
1469         __u64 paddingE;          /* added 2.1.0. also fix lustre_swab_connect */
1470         __u64 paddingF;          /* added 2.1.0. also fix lustre_swab_connect */
1471 };
1472 /* XXX README XXX:
1473  * Please DO NOT use any fields here before first ensuring that this same
1474  * field is not in use on some other branch.  Please clear any such changes
1475  * with senior engineers before starting to use a new field.  Then, submit
1476  * a small patch against EVERY branch that ONLY adds the new field along with
1477  * the matching OBD_CONNECT flag, so that can be approved and landed easily to
1478  * reserve the flag for future use. */
1479
1480
1481 extern void lustre_swab_connect(struct obd_connect_data *ocd);
1482
1483 /*
1484  * Supported checksum algorithms. Up to 32 checksum types are supported.
1485  * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
1486  * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
1487  * algorithm and also the OBD_FL_CKSUM* flags.
1488  */
1489 typedef enum {
1490         OBD_CKSUM_CRC32 = 0x00000001,
1491         OBD_CKSUM_ADLER = 0x00000002,
1492         OBD_CKSUM_CRC32C= 0x00000004,
1493 } cksum_type_t;
1494
1495 /*
1496  *   OST requests: OBDO & OBD request records
1497  */
1498
1499 /* opcodes */
1500 typedef enum {
1501         OST_REPLY      =  0,       /* reply ? */
1502         OST_GETATTR    =  1,
1503         OST_SETATTR    =  2,
1504         OST_READ       =  3,
1505         OST_WRITE      =  4,
1506         OST_CREATE     =  5,
1507         OST_DESTROY    =  6,
1508         OST_GET_INFO   =  7,
1509         OST_CONNECT    =  8,
1510         OST_DISCONNECT =  9,
1511         OST_PUNCH      = 10,
1512         OST_OPEN       = 11,
1513         OST_CLOSE      = 12,
1514         OST_STATFS     = 13,
1515         OST_SYNC       = 16,
1516         OST_SET_INFO   = 17,
1517         OST_QUOTACHECK = 18,
1518         OST_QUOTACTL   = 19,
1519         OST_QUOTA_ADJUST_QUNIT = 20, /* not used since 2.4 */
1520         OST_LAST_OPC
1521 } ost_cmd_t;
1522 #define OST_FIRST_OPC  OST_REPLY
1523
1524 enum obdo_flags {
1525         OBD_FL_INLINEDATA   = 0x00000001,
1526         OBD_FL_OBDMDEXISTS  = 0x00000002,
1527         OBD_FL_DELORPHAN    = 0x00000004, /* if set in o_flags delete orphans */
1528         OBD_FL_NORPC        = 0x00000008, /* set in o_flags do in OSC not OST */
1529         OBD_FL_IDONLY       = 0x00000010, /* set in o_flags only adjust obj id*/
1530         OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
1531         OBD_FL_DEBUG_CHECK  = 0x00000040, /* echo client/server debug check */
1532         OBD_FL_NO_USRQUOTA  = 0x00000100, /* the object's owner is over quota */
1533         OBD_FL_NO_GRPQUOTA  = 0x00000200, /* the object's group is over quota */
1534         OBD_FL_CREATE_CROW  = 0x00000400, /* object should be create on write */
1535         OBD_FL_SRVLOCK      = 0x00000800, /* delegate DLM locking to server */
1536         OBD_FL_CKSUM_CRC32  = 0x00001000, /* CRC32 checksum type */
1537         OBD_FL_CKSUM_ADLER  = 0x00002000, /* ADLER checksum type */
1538         OBD_FL_CKSUM_CRC32C = 0x00004000, /* CRC32C checksum type */
1539         OBD_FL_CKSUM_RSVD2  = 0x00008000, /* for future cksum types */
1540         OBD_FL_CKSUM_RSVD3  = 0x00010000, /* for future cksum types */
1541         OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
1542         OBD_FL_MMAP         = 0x00040000, /* object is mmapped on the client.
1543                                            * XXX: obsoleted - reserved for old
1544                                            * clients prior than 2.2 */
1545         OBD_FL_RECOV_RESEND = 0x00080000, /* recoverable resent */
1546         OBD_FL_NOSPC_BLK    = 0x00100000, /* no more block space on OST */
1547         OBD_FL_FLUSH        = 0x00200000, /* flush pages on the OST */
1548         OBD_FL_SHORT_IO     = 0x00400000, /* short io request */
1549
1550         /* Note that while these checksum values are currently separate bits,
1551          * in 2.x we can actually allow all values from 1-31 if we wanted. */
1552         OBD_FL_CKSUM_ALL    = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER |
1553                               OBD_FL_CKSUM_CRC32C,
1554
1555         /* mask for local-only flag, which won't be sent over network */
1556         OBD_FL_LOCAL_MASK   = 0xF0000000,
1557 };
1558
1559 /*
1560  * All LOV EA magics should have the same postfix, if some new version
1561  * Lustre instroduces new LOV EA magic, then when down-grade to an old
1562  * Lustre, even though the old version system does not recognizes such
1563  * new magic, it still can distinguish the corrupted cases by checking
1564  * the magic's postfix.
1565  */
1566 #define LOV_MAGIC_MAGIC 0x0BD0
1567 #define LOV_MAGIC_MASK  0xFFFF
1568
1569 #define LOV_MAGIC_V1            (0x0BD10000 | LOV_MAGIC_MAGIC)
1570 #define LOV_MAGIC_JOIN_V1       (0x0BD20000 | LOV_MAGIC_MAGIC)
1571 #define LOV_MAGIC_V3            (0x0BD30000 | LOV_MAGIC_MAGIC)
1572 #define LOV_MAGIC_MIGRATE       (0x0BD40000 | LOV_MAGIC_MAGIC)
1573 /* reserved for specifying OSTs */
1574 #define LOV_MAGIC_SPECIFIC      (0x0BD50000 | LOV_MAGIC_MAGIC)
1575 #define LOV_MAGIC               LOV_MAGIC_V1
1576
1577 /*
1578  * magic for fully defined striping
1579  * the idea is that we should have different magics for striping "hints"
1580  * (struct lov_user_md_v[13]) and defined ready-to-use striping (struct
1581  * lov_mds_md_v[13]). at the moment the magics are used in wire protocol,
1582  * we can't just change it w/o long way preparation, but we still need a
1583  * mechanism to allow LOD to differentiate hint versus ready striping.
1584  * so, at the moment we do a trick: MDT knows what to expect from request
1585  * depending on the case (replay uses ready striping, non-replay req uses
1586  * hints), so MDT replaces magic with appropriate one and now LOD can
1587  * easily understand what's inside -bzzz
1588  */
1589 #define LOV_MAGIC_V1_DEF  0x0CD10BD0
1590 #define LOV_MAGIC_V3_DEF  0x0CD30BD0
1591
1592 #define lov_pattern(pattern)            (pattern & ~LOV_PATTERN_F_MASK)
1593 #define lov_pattern_flags(pattern)      (pattern & LOV_PATTERN_F_MASK)
1594
1595 #define lov_ost_data lov_ost_data_v1
1596 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
1597         struct ost_id l_ost_oi;   /* OST object ID */
1598         __u32 l_ost_gen;          /* generation of this l_ost_idx */
1599         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
1600 };
1601
1602 #define lov_mds_md lov_mds_md_v1
1603 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
1604         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
1605         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1606         struct ost_id   lmm_oi;   /* LOV object ID */
1607         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1608         /* lmm_stripe_count used to be __u32 */
1609         __u16 lmm_stripe_count;   /* num stripes in use for this object */
1610         __u16 lmm_layout_gen;     /* layout generation number */
1611         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1612 };
1613
1614 /**
1615  * Sigh, because pre-2.4 uses
1616  * struct lov_mds_md_v1 {
1617  *      ........
1618  *      __u64 lmm_object_id;
1619  *      __u64 lmm_object_seq;
1620  *      ......
1621  *      }
1622  * to identify the LOV(MDT) object, and lmm_object_seq will
1623  * be normal_fid, which make it hard to combine these conversion
1624  * to ostid_to FID. so we will do lmm_oi/fid conversion separately
1625  *
1626  * We can tell the lmm_oi by this way,
1627  * 1.8: lmm_object_id = {inode}, lmm_object_gr = 0
1628  * 2.1: lmm_object_id = {oid < 128k}, lmm_object_seq = FID_SEQ_NORMAL
1629  * 2.4: lmm_oi.f_seq = FID_SEQ_NORMAL, lmm_oi.f_oid = {oid < 128k},
1630  *      lmm_oi.f_ver = 0
1631  *
1632  * But currently lmm_oi/lsm_oi does not have any "real" usages,
1633  * except for printing some information, and the user can always
1634  * get the real FID from LMA, besides this multiple case check might
1635  * make swab more complicate. So we will keep using id/seq for lmm_oi.
1636  */
1637
1638 static inline void fid_to_lmm_oi(const struct lu_fid *fid,
1639                                  struct ost_id *oi)
1640 {
1641         oi->oi.oi_id = fid_oid(fid);
1642         oi->oi.oi_seq = fid_seq(fid);
1643 }
1644
1645 static inline void lmm_oi_set_seq(struct ost_id *oi, __u64 seq)
1646 {
1647         oi->oi.oi_seq = seq;
1648 }
1649
1650 static inline void lmm_oi_set_id(struct ost_id *oi, __u64 oid)
1651 {
1652         oi->oi.oi_id = oid;
1653 }
1654
1655 static inline __u64 lmm_oi_id(const struct ost_id *oi)
1656 {
1657         return oi->oi.oi_id;
1658 }
1659
1660 static inline __u64 lmm_oi_seq(const struct ost_id *oi)
1661 {
1662         return oi->oi.oi_seq;
1663 }
1664
1665 static inline void lmm_oi_le_to_cpu(struct ost_id *dst_oi,
1666                                     const struct ost_id *src_oi)
1667 {
1668         dst_oi->oi.oi_id = le64_to_cpu(src_oi->oi.oi_id);
1669         dst_oi->oi.oi_seq = le64_to_cpu(src_oi->oi.oi_seq);
1670 }
1671
1672 static inline void lmm_oi_cpu_to_le(struct ost_id *dst_oi,
1673                                     const struct ost_id *src_oi)
1674 {
1675         dst_oi->oi.oi_id = cpu_to_le64(src_oi->oi.oi_id);
1676         dst_oi->oi.oi_seq = cpu_to_le64(src_oi->oi.oi_seq);
1677 }
1678
1679 /* extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm); */
1680
1681 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
1682 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
1683
1684 /* This is the default MDT reply size allocated, should the striping be bigger,
1685  * it will be reallocated in mdt_fix_reply.
1686  * 100 stripes is a bit less than 2.5k of data */
1687 #define DEF_REP_MD_SIZE (sizeof(struct lov_mds_md) + \
1688                          100 * sizeof(struct lov_ost_data))
1689
1690 #define XATTR_NAME_ACL_ACCESS   "system.posix_acl_access"
1691 #define XATTR_NAME_ACL_DEFAULT  "system.posix_acl_default"
1692 #define XATTR_USER_PREFIX       "user."
1693 #define XATTR_TRUSTED_PREFIX    "trusted."
1694 #define XATTR_SECURITY_PREFIX   "security."
1695
1696 #define XATTR_NAME_LOV          "trusted.lov"
1697 #define XATTR_NAME_LMA          "trusted.lma"
1698 #define XATTR_NAME_LMV          "trusted.lmv"
1699 #define XATTR_NAME_DEFAULT_LMV  "trusted.dmv"
1700 #define XATTR_NAME_LINK         "trusted.link"
1701 #define XATTR_NAME_FID          "trusted.fid"
1702 #define XATTR_NAME_VERSION      "trusted.version"
1703 #define XATTR_NAME_SOM          "trusted.som"
1704 #define XATTR_NAME_HSM          "trusted.hsm"
1705 #define XATTR_NAME_LFSCK_NAMESPACE "trusted.lfsck_namespace"
1706 #define XATTR_NAME_LFSCK_BITMAP "trusted.lfsck_bitmap"
1707 #define XATTR_NAME_MAX_LEN      32 /* increase this, if there is longer name. */
1708
1709 struct lov_mds_md_v3 {            /* LOV EA mds/wire data (little-endian) */
1710         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V3 */
1711         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1712         struct ost_id   lmm_oi;   /* LOV object ID */
1713         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1714         /* lmm_stripe_count used to be __u32 */
1715         __u16 lmm_stripe_count;   /* num stripes in use for this object */
1716         __u16 lmm_layout_gen;     /* layout generation number */
1717         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* must be 32bit aligned */
1718         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1719 };
1720
1721 static inline __u32 lov_mds_md_size(__u16 stripes, __u32 lmm_magic)
1722 {
1723         if (lmm_magic == LOV_MAGIC_V3)
1724                 return sizeof(struct lov_mds_md_v3) +
1725                                 stripes * sizeof(struct lov_ost_data_v1);
1726         else
1727                 return sizeof(struct lov_mds_md_v1) +
1728                                 stripes * sizeof(struct lov_ost_data_v1);
1729 }
1730
1731 static inline __u32
1732 lov_mds_md_max_stripe_count(size_t buf_size, __u32 lmm_magic)
1733 {
1734         switch (lmm_magic) {
1735         case LOV_MAGIC_V1: {
1736                 struct lov_mds_md_v1 lmm;
1737
1738                 if (buf_size < sizeof(lmm))
1739                         return 0;
1740
1741                 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1742         }
1743         case LOV_MAGIC_V3: {
1744                 struct lov_mds_md_v3 lmm;
1745
1746                 if (buf_size < sizeof(lmm))
1747                         return 0;
1748
1749                 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1750         }
1751         default:
1752                 return 0;
1753         }
1754 }
1755
1756 #define OBD_MD_FLID        (0x00000001ULL) /* object ID */
1757 #define OBD_MD_FLATIME     (0x00000002ULL) /* access time */
1758 #define OBD_MD_FLMTIME     (0x00000004ULL) /* data modification time */
1759 #define OBD_MD_FLCTIME     (0x00000008ULL) /* change time */
1760 #define OBD_MD_FLSIZE      (0x00000010ULL) /* size */
1761 #define OBD_MD_FLBLOCKS    (0x00000020ULL) /* allocated blocks count */
1762 #define OBD_MD_FLBLKSZ     (0x00000040ULL) /* block size */
1763 #define OBD_MD_FLMODE      (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1764 #define OBD_MD_FLTYPE      (0x00000100ULL) /* object type (mode & S_IFMT) */
1765 #define OBD_MD_FLUID       (0x00000200ULL) /* user ID */
1766 #define OBD_MD_FLGID       (0x00000400ULL) /* group ID */
1767 #define OBD_MD_FLFLAGS     (0x00000800ULL) /* flags word */
1768 #define OBD_MD_FLNLINK     (0x00002000ULL) /* link count */
1769 #define OBD_MD_FLGENER     (0x00004000ULL) /* generation number */
1770 /*#define OBD_MD_FLINLINE    (0x00008000ULL)  inline data. used until 1.6.5 */
1771 #define OBD_MD_FLRDEV      (0x00010000ULL) /* device number */
1772 #define OBD_MD_FLEASIZE    (0x00020000ULL) /* extended attribute data */
1773 #define OBD_MD_LINKNAME    (0x00040000ULL) /* symbolic link target */
1774 #define OBD_MD_FLHANDLE    (0x00080000ULL) /* file/lock handle */
1775 #define OBD_MD_FLCKSUM     (0x00100000ULL) /* bulk data checksum */
1776 #define OBD_MD_FLQOS       (0x00200000ULL) /* quality of service stats */
1777 /*#define OBD_MD_FLOSCOPQ    (0x00400000ULL) osc opaque data, never used */
1778 #define OBD_MD_FLCOOKIE    (0x00800000ULL) /* log cancellation cookie */
1779 #define OBD_MD_FLGROUP     (0x01000000ULL) /* group */
1780 #define OBD_MD_FLFID       (0x02000000ULL) /* ->ost write inline fid */
1781 #define OBD_MD_FLEPOCH     (0x04000000ULL) /* ->ost write with ioepoch */
1782                                            /* ->mds if epoch opens or closes */
1783 #define OBD_MD_FLGRANT     (0x08000000ULL) /* ost preallocation space grant */
1784 #define OBD_MD_FLDIREA     (0x10000000ULL) /* dir's extended attribute data */
1785 #define OBD_MD_FLUSRQUOTA  (0x20000000ULL) /* over quota flags sent from ost */
1786 #define OBD_MD_FLGRPQUOTA  (0x40000000ULL) /* over quota flags sent from ost */
1787 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1788
1789 #define OBD_MD_MDS         (0x0000000100000000ULL) /* where an inode lives on */
1790 #define OBD_MD_REINT       (0x0000000200000000ULL) /* reintegrate oa */
1791 #define OBD_MD_MEA         (0x0000000400000000ULL) /* CMD split EA  */
1792 #define OBD_MD_TSTATE      (0x0000000800000000ULL) /* transient state field */
1793
1794 #define OBD_MD_FLXATTR       (0x0000001000000000ULL) /* xattr */
1795 #define OBD_MD_FLXATTRLS     (0x0000002000000000ULL) /* xattr list */
1796 #define OBD_MD_FLXATTRRM     (0x0000004000000000ULL) /* xattr remove */
1797 #define OBD_MD_FLACL         (0x0000008000000000ULL) /* ACL */
1798 #define OBD_MD_FLRMTPERM     (0x0000010000000000ULL) /* remote permission */
1799 #define OBD_MD_FLMDSCAPA     (0x0000020000000000ULL) /* MDS capability */
1800 #define OBD_MD_FLOSSCAPA     (0x0000040000000000ULL) /* OSS capability */
1801 #define OBD_MD_FLCKSPLIT     (0x0000080000000000ULL) /* Check split on server */
1802 #define OBD_MD_FLCROSSREF    (0x0000100000000000ULL) /* Cross-ref case */
1803 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1804                                                       * under lock; for xattr
1805                                                       * requests means the
1806                                                       * client holds the lock */
1807 #define OBD_MD_FLOBJCOUNT    (0x0000400000000000ULL) /* for multiple destroy */
1808
1809 #define OBD_MD_FLRMTLSETFACL (0x0001000000000000ULL) /* lfs lsetfacl case */
1810 #define OBD_MD_FLRMTLGETFACL (0x0002000000000000ULL) /* lfs lgetfacl case */
1811 #define OBD_MD_FLRMTRSETFACL (0x0004000000000000ULL) /* lfs rsetfacl case */
1812 #define OBD_MD_FLRMTRGETFACL (0x0008000000000000ULL) /* lfs rgetfacl case */
1813
1814 #define OBD_MD_FLDATAVERSION (0x0010000000000000ULL) /* iversion sum */
1815 #define OBD_MD_FLRELEASED    (0x0020000000000000ULL) /* file released */
1816
1817 #define OBD_MD_DEFAULT_MEA   (0x0040000000000000ULL) /* default MEA */
1818
1819 #define OBD_MD_FLGETATTR (OBD_MD_FLID    | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1820                           OBD_MD_FLCTIME | OBD_MD_FLSIZE  | OBD_MD_FLBLKSZ | \
1821                           OBD_MD_FLMODE  | OBD_MD_FLTYPE  | OBD_MD_FLUID   | \
1822                           OBD_MD_FLGID   | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1823                           OBD_MD_FLGENER | OBD_MD_FLRDEV  | OBD_MD_FLGROUP)
1824
1825 #define OBD_MD_FLXATTRALL (OBD_MD_FLXATTR | OBD_MD_FLXATTRLS)
1826
1827 /* don't forget obdo_fid which is way down at the bottom so it can
1828  * come after the definition of llog_cookie */
1829
1830 enum hss_valid {
1831         HSS_SETMASK     = 0x01,
1832         HSS_CLEARMASK   = 0x02,
1833         HSS_ARCHIVE_ID  = 0x04,
1834 };
1835
1836 struct hsm_state_set {
1837         __u32   hss_valid;
1838         __u32   hss_archive_id;
1839         __u64   hss_setmask;
1840         __u64   hss_clearmask;
1841 };
1842
1843 extern void lustre_swab_hsm_user_state(struct hsm_user_state *hus);
1844 extern void lustre_swab_hsm_state_set(struct hsm_state_set *hss);
1845
1846 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
1847
1848 /* ost_body.data values for OST_BRW */
1849
1850 #define OBD_BRW_READ            0x01
1851 #define OBD_BRW_WRITE           0x02
1852 #define OBD_BRW_RWMASK          (OBD_BRW_READ | OBD_BRW_WRITE)
1853 #define OBD_BRW_SYNC            0x08 /* this page is a part of synchronous
1854                                       * transfer and is not accounted in
1855                                       * the grant. */
1856 #define OBD_BRW_CHECK           0x10
1857 #define OBD_BRW_FROM_GRANT      0x20 /* the osc manages this under llite */
1858 #define OBD_BRW_GRANTED         0x40 /* the ost manages this */
1859 #define OBD_BRW_NOCACHE         0x80 /* this page is a part of non-cached IO */
1860 #define OBD_BRW_NOQUOTA        0x100
1861 #define OBD_BRW_SRVLOCK        0x200 /* Client holds no lock over this page */
1862 #define OBD_BRW_ASYNC          0x400 /* Server may delay commit to disk */
1863 #define OBD_BRW_MEMALLOC       0x800 /* Client runs in the "kswapd" context */
1864 #define OBD_BRW_OVER_USRQUOTA 0x1000 /* Running out of user quota */
1865 #define OBD_BRW_OVER_GRPQUOTA 0x2000 /* Running out of group quota */
1866 #define OBD_BRW_SOFT_SYNC     0x4000 /* This flag notifies the server
1867                                       * that the client is running low on
1868                                       * space for unstable pages; asking
1869                                       * it to sync quickly */
1870
1871 #define OBD_OBJECT_EOF LUSTRE_EOF
1872
1873 #define OST_MIN_PRECREATE 32
1874 #define OST_MAX_PRECREATE 20000
1875
1876 struct obd_ioobj {
1877         struct ost_id   ioo_oid;        /* object ID, if multi-obj BRW */
1878         __u32           ioo_max_brw;    /* low 16 bits were o_mode before 2.4,
1879                                          * now (PTLRPC_BULK_OPS_COUNT - 1) in
1880                                          * high 16 bits in 2.4 and later */
1881         __u32           ioo_bufcnt;     /* number of niobufs for this object */
1882 };
1883
1884 #define IOOBJ_MAX_BRW_BITS      16
1885 #define IOOBJ_TYPE_MASK         ((1U << IOOBJ_MAX_BRW_BITS) - 1)
1886 #define ioobj_max_brw_get(ioo)  (((ioo)->ioo_max_brw >> IOOBJ_MAX_BRW_BITS) + 1)
1887 #define ioobj_max_brw_set(ioo, num)                                     \
1888 do { (ioo)->ioo_max_brw = ((num) - 1) << IOOBJ_MAX_BRW_BITS; } while (0)
1889
1890 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
1891
1892 /* multiple of 8 bytes => can array */
1893 struct niobuf_remote {
1894         __u64   rnb_offset;
1895         __u32   rnb_len;
1896         __u32   rnb_flags;
1897 };
1898
1899 void lustre_swab_niobuf_remote(struct niobuf_remote *nbr);
1900
1901 /* lock value block communicated between the filter and llite */
1902
1903 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1904  * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1905 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1906 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1907 #define OST_LVB_IS_ERR(blocks)                                          \
1908         ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1909 #define OST_LVB_SET_ERR(blocks, rc)                                     \
1910         do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1911 #define OST_LVB_GET_ERR(blocks)    (int)(blocks - OST_LVB_ERR_INIT)
1912
1913 struct ost_lvb_v1 {
1914         __u64           lvb_size;
1915         obd_time        lvb_mtime;
1916         obd_time        lvb_atime;
1917         obd_time        lvb_ctime;
1918         __u64           lvb_blocks;
1919 };
1920
1921 extern void lustre_swab_ost_lvb_v1(struct ost_lvb_v1 *lvb);
1922
1923 struct ost_lvb {
1924         __u64           lvb_size;
1925         obd_time        lvb_mtime;
1926         obd_time        lvb_atime;
1927         obd_time        lvb_ctime;
1928         __u64           lvb_blocks;
1929         __u32           lvb_mtime_ns;
1930         __u32           lvb_atime_ns;
1931         __u32           lvb_ctime_ns;
1932         __u32           lvb_padding;
1933 };
1934
1935 extern void lustre_swab_ost_lvb(struct ost_lvb *lvb);
1936
1937 /*
1938  *   lquota data structures
1939  */
1940
1941 #ifndef QUOTABLOCK_BITS
1942 # define QUOTABLOCK_BITS LUSTRE_QUOTABLOCK_BITS
1943 #endif
1944
1945 #ifndef QUOTABLOCK_SIZE
1946 # define QUOTABLOCK_SIZE LUSTRE_QUOTABLOCK_SIZE
1947 #endif
1948
1949 #ifndef toqb
1950 # define toqb lustre_stoqb
1951 #endif
1952
1953 /* The lquota_id structure is an union of all the possible identifier types that
1954  * can be used with quota, this includes:
1955  * - 64-bit user ID
1956  * - 64-bit group ID
1957  * - a FID which can be used for per-directory quota in the future */
1958 union lquota_id {
1959         struct lu_fid   qid_fid; /* FID for per-directory quota */
1960         __u64           qid_uid; /* user identifier */
1961         __u64           qid_gid; /* group identifier */
1962 };
1963
1964 /* quotactl management */
1965 struct obd_quotactl {
1966         __u32                   qc_cmd;
1967         __u32                   qc_type; /* see Q_* flag below */
1968         __u32                   qc_id;
1969         __u32                   qc_stat;
1970         struct obd_dqinfo       qc_dqinfo;
1971         struct obd_dqblk        qc_dqblk;
1972 };
1973
1974 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1975
1976 #define Q_COPY(out, in, member) (out)->member = (in)->member
1977
1978 #define QCTL_COPY(out, in)              \
1979 do {                                    \
1980         Q_COPY(out, in, qc_cmd);        \
1981         Q_COPY(out, in, qc_type);       \
1982         Q_COPY(out, in, qc_id);         \
1983         Q_COPY(out, in, qc_stat);       \
1984         Q_COPY(out, in, qc_dqinfo);     \
1985         Q_COPY(out, in, qc_dqblk);      \
1986 } while (0)
1987
1988 /* Body of quota request used for quota acquire/release RPCs between quota
1989  * master (aka QMT) and slaves (ak QSD). */
1990 struct quota_body {
1991         struct lu_fid   qb_fid;     /* FID of global index packing the pool ID
1992                                       * and type (data or metadata) as well as
1993                                       * the quota type (user or group). */
1994         union lquota_id qb_id;      /* uid or gid or directory FID */
1995         __u32           qb_flags;   /* see below */
1996         __u32           qb_padding;
1997         __u64           qb_count;   /* acquire/release count (kbytes/inodes) */
1998         __u64           qb_usage;   /* current slave usage (kbytes/inodes) */
1999         __u64           qb_slv_ver; /* slave index file version */
2000         struct lustre_handle    qb_lockh;     /* per-ID lock handle */
2001         struct lustre_handle    qb_glb_lockh; /* global lock handle */
2002         __u64           qb_padding1[4];
2003 };
2004
2005 /* When the quota_body is used in the reply of quota global intent
2006  * lock (IT_QUOTA_CONN) reply, qb_fid contains slave index file FID. */
2007 #define qb_slv_fid      qb_fid
2008 /* qb_usage is the current qunit (in kbytes/inodes) when quota_body is used in
2009  * quota reply */
2010 #define qb_qunit        qb_usage
2011
2012 #define QUOTA_DQACQ_FL_ACQ      0x1  /* acquire quota */
2013 #define QUOTA_DQACQ_FL_PREACQ   0x2  /* pre-acquire */
2014 #define QUOTA_DQACQ_FL_REL      0x4  /* release quota */
2015 #define QUOTA_DQACQ_FL_REPORT   0x8  /* report usage */
2016
2017 extern void lustre_swab_quota_body(struct quota_body *b);
2018
2019 /* Quota types currently supported */
2020 enum {
2021         LQUOTA_TYPE_USR = 0x00, /* maps to USRQUOTA */
2022         LQUOTA_TYPE_GRP = 0x01, /* maps to GRPQUOTA */
2023         LQUOTA_TYPE_MAX
2024 };
2025
2026 /* There are 2 different resource types on which a quota limit can be enforced:
2027  * - inodes on the MDTs
2028  * - blocks on the OSTs */
2029 enum {
2030         LQUOTA_RES_MD           = 0x01, /* skip 0 to avoid null oid in FID */
2031         LQUOTA_RES_DT           = 0x02,
2032         LQUOTA_LAST_RES,
2033         LQUOTA_FIRST_RES        = LQUOTA_RES_MD
2034 };
2035 #define LQUOTA_NR_RES (LQUOTA_LAST_RES - LQUOTA_FIRST_RES + 1)
2036
2037 /*
2038  * Space accounting support
2039  * Format of an accounting record, providing disk usage information for a given
2040  * user or group
2041  */
2042 struct lquota_acct_rec { /* 16 bytes */
2043         __u64 bspace;  /* current space in use */
2044         __u64 ispace;  /* current # inodes in use */
2045 };
2046
2047 /*
2048  * Global quota index support
2049  * Format of a global record, providing global quota settings for a given quota
2050  * identifier
2051  */
2052 struct lquota_glb_rec { /* 32 bytes */
2053         __u64 qbr_hardlimit; /* quota hard limit, in #inodes or kbytes */
2054         __u64 qbr_softlimit; /* quota soft limit, in #inodes or kbytes */
2055         __u64 qbr_time;      /* grace time, in seconds */
2056         __u64 qbr_granted;   /* how much is granted to slaves, in #inodes or
2057                               * kbytes */
2058 };
2059
2060 /*
2061  * Slave index support
2062  * Format of a slave record, recording how much space is granted to a given
2063  * slave
2064  */
2065 struct lquota_slv_rec { /* 8 bytes */
2066         __u64 qsr_granted; /* space granted to the slave for the key=ID,
2067                             * in #inodes or kbytes */
2068 };
2069
2070 /* Data structures associated with the quota locks */
2071
2072 /* Glimpse descriptor used for the index & per-ID quota locks */
2073 struct ldlm_gl_lquota_desc {
2074         union lquota_id gl_id;    /* quota ID subject to the glimpse */
2075         __u64           gl_flags; /* see LQUOTA_FL* below */
2076         __u64           gl_ver;   /* new index version */
2077         __u64           gl_hardlimit; /* new hardlimit or qunit value */
2078         __u64           gl_softlimit; /* new softlimit */
2079         __u64           gl_time;
2080         __u64           gl_pad2;
2081 };
2082 #define gl_qunit        gl_hardlimit /* current qunit value used when
2083                                       * glimpsing per-ID quota locks */
2084
2085 /* quota glimpse flags */
2086 #define LQUOTA_FL_EDQUOT 0x1 /* user/group out of quota space on QMT */
2087
2088 /* LVB used with quota (global and per-ID) locks */
2089 struct lquota_lvb {
2090         __u64   lvb_flags;      /* see LQUOTA_FL* above */
2091         __u64   lvb_id_may_rel; /* space that might be released later */
2092         __u64   lvb_id_rel;     /* space released by the slave for this ID */
2093         __u64   lvb_id_qunit;   /* current qunit value */
2094         __u64   lvb_pad1;
2095 };
2096
2097 extern void lustre_swab_lquota_lvb(struct lquota_lvb *lvb);
2098
2099 /* LVB used with global quota lock */
2100 #define lvb_glb_ver  lvb_id_may_rel /* current version of the global index */
2101
2102 /* op codes */
2103 typedef enum {
2104         QUOTA_DQACQ     = 601,
2105         QUOTA_DQREL     = 602,
2106         QUOTA_LAST_OPC
2107 } quota_cmd_t;
2108 #define QUOTA_FIRST_OPC QUOTA_DQACQ
2109
2110 /*
2111  *   MDS REQ RECORDS
2112  */
2113
2114 /* opcodes */
2115 typedef enum {
2116         MDS_GETATTR             = 33,
2117         MDS_GETATTR_NAME        = 34,
2118         MDS_CLOSE               = 35,
2119         MDS_REINT               = 36,
2120         MDS_READPAGE            = 37,
2121         MDS_CONNECT             = 38,
2122         MDS_DISCONNECT          = 39,
2123         MDS_GETSTATUS           = 40,
2124         MDS_STATFS              = 41,
2125         MDS_PIN                 = 42, /* obsolete, never used in a release */
2126         MDS_UNPIN               = 43, /* obsolete, never used in a release */
2127         MDS_SYNC                = 44,
2128         MDS_DONE_WRITING        = 45,
2129         MDS_SET_INFO            = 46,
2130         MDS_QUOTACHECK          = 47,
2131         MDS_QUOTACTL            = 48,
2132         MDS_GETXATTR            = 49,
2133         MDS_SETXATTR            = 50, /* obsolete, now it's MDS_REINT op */
2134         MDS_WRITEPAGE           = 51,
2135         MDS_IS_SUBDIR           = 52, /* obsolete, never used in a release */
2136         MDS_GET_INFO            = 53,
2137         MDS_HSM_STATE_GET       = 54,
2138         MDS_HSM_STATE_SET       = 55,
2139         MDS_HSM_ACTION          = 56,
2140         MDS_HSM_PROGRESS        = 57,
2141         MDS_HSM_REQUEST         = 58,
2142         MDS_HSM_CT_REGISTER     = 59,
2143         MDS_HSM_CT_UNREGISTER   = 60,
2144         MDS_SWAP_LAYOUTS        = 61,
2145         MDS_LAST_OPC
2146 } mds_cmd_t;
2147
2148 #define MDS_FIRST_OPC    MDS_GETATTR
2149
2150
2151 /* opcodes for object update */
2152 typedef enum {
2153         OUT_UPDATE      = 1000,
2154         OUT_UPDATE_LAST_OPC
2155 } update_cmd_t;
2156
2157 #define OUT_UPDATE_FIRST_OPC    OUT_UPDATE
2158
2159 /*
2160  * Do not exceed 63
2161  */
2162
2163 typedef enum {
2164         REINT_SETATTR  = 1,
2165         REINT_CREATE   = 2,
2166         REINT_LINK     = 3,
2167         REINT_UNLINK   = 4,
2168         REINT_RENAME   = 5,
2169         REINT_OPEN     = 6,
2170         REINT_SETXATTR = 7,
2171         REINT_RMENTRY  = 8,
2172         REINT_MIGRATE  = 9,
2173         REINT_MAX
2174 } mds_reint_t, mdt_reint_t;
2175
2176 extern void lustre_swab_generic_32s (__u32 *val);
2177
2178 /* the disposition of the intent outlines what was executed */
2179 #define DISP_IT_EXECD        0x00000001
2180 #define DISP_LOOKUP_EXECD    0x00000002
2181 #define DISP_LOOKUP_NEG      0x00000004
2182 #define DISP_LOOKUP_POS      0x00000008
2183 #define DISP_OPEN_CREATE     0x00000010
2184 #define DISP_OPEN_OPEN       0x00000020
2185 #define DISP_ENQ_COMPLETE    0x00400000         /* obsolete and unused */
2186 #define DISP_ENQ_OPEN_REF    0x00800000
2187 #define DISP_ENQ_CREATE_REF  0x01000000
2188 #define DISP_OPEN_LOCK       0x02000000
2189 #define DISP_OPEN_LEASE      0x04000000
2190 #define DISP_OPEN_STRIPE     0x08000000
2191
2192 /* INODE LOCK PARTS */
2193 #define MDS_INODELOCK_LOOKUP 0x000001   /* For namespace, dentry etc, and also
2194                                          * was used to protect permission (mode,
2195                                          * owner, group etc) before 2.4. */
2196 #define MDS_INODELOCK_UPDATE 0x000002   /* size, links, timestamps */
2197 #define MDS_INODELOCK_OPEN   0x000004   /* For opened files */
2198 #define MDS_INODELOCK_LAYOUT 0x000008   /* for layout */
2199
2200 /* The PERM bit is added int 2.4, and it is used to protect permission(mode,
2201  * owner, group, acl etc), so to separate the permission from LOOKUP lock.
2202  * Because for remote directories(in DNE), these locks will be granted by
2203  * different MDTs(different ldlm namespace).
2204  *
2205  * For local directory, MDT will always grant UPDATE_LOCK|PERM_LOCK together.
2206  * For Remote directory, the master MDT, where the remote directory is, will
2207  * grant UPDATE_LOCK|PERM_LOCK, and the remote MDT, where the name entry is,
2208  * will grant LOOKUP_LOCK. */
2209 #define MDS_INODELOCK_PERM   0x000010
2210 #define MDS_INODELOCK_XATTR  0x000020   /* extended attributes */
2211
2212 #define MDS_INODELOCK_MAXSHIFT 5
2213 /* This FULL lock is useful to take on unlink sort of operations */
2214 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
2215
2216 extern void lustre_swab_ll_fid (struct ll_fid *fid);
2217
2218 /* NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
2219  * but was moved into name[1] along with the OID to avoid consuming the
2220  * name[2,3] fields that need to be used for the quota id (also a FID). */
2221 enum {
2222         LUSTRE_RES_ID_SEQ_OFF = 0,
2223         LUSTRE_RES_ID_VER_OID_OFF = 1,
2224         LUSTRE_RES_ID_WAS_VER_OFF = 2, /* see note above */
2225         LUSTRE_RES_ID_QUOTA_SEQ_OFF = 2,
2226         LUSTRE_RES_ID_QUOTA_VER_OID_OFF = 3,
2227         LUSTRE_RES_ID_HSH_OFF = 3
2228 };
2229
2230 #define MDS_STATUS_CONN 1
2231 #define MDS_STATUS_LOV 2
2232
2233 /* mdt_thread_info.mti_flags. */
2234 enum md_op_flags {
2235         /* The flag indicates Size-on-MDS attributes are changed. */
2236         MF_SOM_CHANGE           = (1 << 0),
2237         /* Flags indicates an epoch opens or closes. */
2238         MF_EPOCH_OPEN           = (1 << 1),
2239         MF_EPOCH_CLOSE          = (1 << 2),
2240         MF_MDC_CANCEL_FID1      = (1 << 3),
2241         MF_MDC_CANCEL_FID2      = (1 << 4),
2242         MF_MDC_CANCEL_FID3      = (1 << 5),
2243         MF_MDC_CANCEL_FID4      = (1 << 6),
2244         /* There is a pending attribute update. */
2245         MF_SOM_AU               = (1 << 7),
2246         /* Cancel OST locks while getattr OST attributes. */
2247         MF_GETATTR_LOCK         = (1 << 8),
2248         MF_GET_MDT_IDX          = (1 << 9),
2249 };
2250
2251 #define MF_SOM_LOCAL_FLAGS (MF_SOM_CHANGE | MF_EPOCH_OPEN | MF_EPOCH_CLOSE)
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         obd_time mbo_mtime;
2305         obd_time mbo_atime;
2306         obd_time 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         obd_time        sa_mtime;
2390         obd_time        sa_atime;
2391         obd_time        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         obd_time        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         obd_time        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         obd_time        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         obd_time        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         obd_time        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         obd_time        rr_mtime;
2685         obd_time        rr_atime;
2686         obd_time        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 #define LDLM_GID_ANY  ((__u64) -1)
2966
2967 static inline int ldlm_extent_overlap(const struct ldlm_extent *ex1,
2968                                       const struct ldlm_extent *ex2)
2969 {
2970         return ex1->start <= ex2->end && ex2->start <= ex1->end;
2971 }
2972
2973 /* check if @ex1 contains @ex2 */
2974 static inline int ldlm_extent_contain(const struct ldlm_extent *ex1,
2975                                       const struct ldlm_extent *ex2)
2976 {
2977         return ex1->start <= ex2->start && ex1->end >= ex2->end;
2978 }
2979
2980 struct ldlm_inodebits {
2981         __u64 bits;
2982 };
2983
2984 struct ldlm_flock_wire {
2985         __u64 lfw_start;
2986         __u64 lfw_end;
2987         __u64 lfw_owner;
2988         __u32 lfw_padding;
2989         __u32 lfw_pid;
2990 };
2991
2992 /* it's important that the fields of the ldlm_extent structure match
2993  * the first fields of the ldlm_flock structure because there is only
2994  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
2995  * this ever changes we will need to swab the union differently based
2996  * on the resource type. */
2997
2998 typedef union {
2999         struct ldlm_extent l_extent;
3000         struct ldlm_flock_wire l_flock;
3001         struct ldlm_inodebits l_inodebits;
3002 } ldlm_wire_policy_data_t;
3003
3004 extern void lustre_swab_ldlm_policy_data (ldlm_wire_policy_data_t *d);
3005
3006 union ldlm_gl_desc {
3007         struct ldlm_gl_lquota_desc      lquota_desc;
3008 };
3009
3010 extern void lustre_swab_gl_desc(union ldlm_gl_desc *);
3011
3012 struct ldlm_intent {
3013         __u64 opc;
3014 };
3015
3016 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
3017
3018 struct ldlm_resource_desc {
3019         ldlm_type_t lr_type;
3020         __u32 lr_padding;       /* also fix lustre_swab_ldlm_resource_desc */
3021         struct ldlm_res_id lr_name;
3022 };
3023
3024 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
3025
3026 struct ldlm_lock_desc {
3027         struct ldlm_resource_desc l_resource;
3028         ldlm_mode_t l_req_mode;
3029         ldlm_mode_t l_granted_mode;
3030         ldlm_wire_policy_data_t l_policy_data;
3031 };
3032
3033 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
3034
3035 #define LDLM_LOCKREQ_HANDLES 2
3036 #define LDLM_ENQUEUE_CANCEL_OFF 1
3037
3038 struct ldlm_request {
3039         __u32 lock_flags;
3040         __u32 lock_count;
3041         struct ldlm_lock_desc lock_desc;
3042         struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
3043 };
3044
3045 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
3046
3047 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
3048  * Otherwise, 2 are available. */
3049 #define ldlm_request_bufsize(count,type)                                \
3050 ({                                                                      \
3051         int _avail = LDLM_LOCKREQ_HANDLES;                              \
3052         _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
3053         sizeof(struct ldlm_request) +                                   \
3054         (count > _avail ? count - _avail : 0) *                         \
3055         sizeof(struct lustre_handle);                                   \
3056 })
3057
3058 struct ldlm_reply {
3059         __u32 lock_flags;
3060         __u32 lock_padding;     /* also fix lustre_swab_ldlm_reply */
3061         struct ldlm_lock_desc lock_desc;
3062         struct lustre_handle lock_handle;
3063         __u64  lock_policy_res1;
3064         __u64  lock_policy_res2;
3065 };
3066
3067 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
3068
3069 #define ldlm_flags_to_wire(flags)    ((__u32)(flags))
3070 #define ldlm_flags_from_wire(flags)  ((__u64)(flags))
3071
3072 /*
3073  * Opcodes for mountconf (mgs and mgc)
3074  */
3075 typedef enum {
3076         MGS_CONNECT = 250,
3077         MGS_DISCONNECT,
3078         MGS_EXCEPTION,         /* node died, etc. */
3079         MGS_TARGET_REG,        /* whenever target starts up */
3080         MGS_TARGET_DEL,
3081         MGS_SET_INFO,
3082         MGS_CONFIG_READ,
3083         MGS_LAST_OPC
3084 } mgs_cmd_t;
3085 #define MGS_FIRST_OPC MGS_CONNECT
3086
3087 #define MGS_PARAM_MAXLEN 1024
3088 #define KEY_SET_INFO "set_info"
3089
3090 struct mgs_send_param {
3091         char             mgs_param[MGS_PARAM_MAXLEN];
3092 };
3093
3094 /* We pass this info to the MGS so it can write config logs */
3095 #define MTI_NAME_MAXLEN  64
3096 #define MTI_PARAM_MAXLEN 4096
3097 #define MTI_NIDS_MAX     32
3098 struct mgs_target_info {
3099         __u32            mti_lustre_ver;
3100         __u32            mti_stripe_index;
3101         __u32            mti_config_ver;
3102         __u32            mti_flags;
3103         __u32            mti_nid_count;
3104         __u32            mti_instance; /* Running instance of target */
3105         char             mti_fsname[MTI_NAME_MAXLEN];
3106         char             mti_svname[MTI_NAME_MAXLEN];
3107         char             mti_uuid[sizeof(struct obd_uuid)];
3108         __u64            mti_nids[MTI_NIDS_MAX];     /* host nids (lnet_nid_t)*/
3109         char             mti_params[MTI_PARAM_MAXLEN];
3110 };
3111 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
3112
3113 struct mgs_nidtbl_entry {
3114         __u64           mne_version;    /* table version of this entry */
3115         __u32           mne_instance;   /* target instance # */
3116         __u32           mne_index;      /* target index */
3117         __u32           mne_length;     /* length of this entry - by bytes */
3118         __u8            mne_type;       /* target type LDD_F_SV_TYPE_OST/MDT */
3119         __u8            mne_nid_type;   /* type of nid(mbz). for ipv6. */
3120         __u8            mne_nid_size;   /* size of each NID, by bytes */
3121         __u8            mne_nid_count;  /* # of NIDs in buffer */
3122         union {
3123                 lnet_nid_t nids[0];     /* variable size buffer for NIDs. */
3124         } u;
3125 };
3126 extern void lustre_swab_mgs_nidtbl_entry(struct mgs_nidtbl_entry *oinfo);
3127
3128 struct mgs_config_body {
3129         char     mcb_name[MTI_NAME_MAXLEN]; /* logname */
3130         __u64    mcb_offset;    /* next index of config log to request */
3131         __u16    mcb_type;      /* type of log: CONFIG_T_[CONFIG|RECOVER] */
3132         __u8     mcb_reserved;
3133         __u8     mcb_bits;      /* bits unit size of config log */
3134         __u32    mcb_units;     /* # of units for bulk transfer */
3135 };
3136 extern void lustre_swab_mgs_config_body(struct mgs_config_body *body);
3137
3138 struct mgs_config_res {
3139         __u64    mcr_offset;    /* index of last config log */
3140         __u64    mcr_size;      /* size of the log */
3141 };
3142 extern void lustre_swab_mgs_config_res(struct mgs_config_res *body);
3143
3144 /* Config marker flags (in config log) */
3145 #define CM_START       0x01
3146 #define CM_END         0x02
3147 #define CM_SKIP        0x04
3148 #define CM_UPGRADE146  0x08
3149 #define CM_EXCLUDE     0x10
3150 #define CM_START_SKIP (CM_START | CM_SKIP)
3151
3152 struct cfg_marker {
3153         __u32             cm_step;       /* aka config version */
3154         __u32             cm_flags;
3155         __u32             cm_vers;       /* lustre release version number */
3156         __u32             cm_padding;    /* 64 bit align */
3157         obd_time          cm_createtime; /*when this record was first created */
3158         obd_time          cm_canceltime; /*when this record is no longer valid*/
3159         char              cm_tgtname[MTI_NAME_MAXLEN];
3160         char              cm_comment[MTI_NAME_MAXLEN];
3161 };
3162
3163 extern void lustre_swab_cfg_marker(struct cfg_marker *marker,
3164                                    int swab, int size);
3165
3166 /*
3167  * Opcodes for multiple servers.
3168  */
3169
3170 typedef enum {
3171         OBD_PING = 400,
3172         OBD_LOG_CANCEL,
3173         OBD_QC_CALLBACK,
3174         OBD_IDX_READ,
3175         OBD_LAST_OPC
3176 } obd_cmd_t;
3177 #define OBD_FIRST_OPC OBD_PING
3178
3179 /**
3180  * llog contexts indices.
3181  *
3182  * There is compatibility problem with indexes below, they are not
3183  * continuous and must keep their numbers for compatibility needs.
3184  * See LU-5218 for details.
3185  */
3186 enum llog_ctxt_id {
3187         LLOG_CONFIG_ORIG_CTXT  =  0,
3188         LLOG_CONFIG_REPL_CTXT = 1,
3189         LLOG_MDS_OST_ORIG_CTXT = 2,
3190         LLOG_MDS_OST_REPL_CTXT = 3, /* kept just to avoid re-assignment */
3191         LLOG_SIZE_ORIG_CTXT = 4,
3192         LLOG_SIZE_REPL_CTXT = 5,
3193         LLOG_TEST_ORIG_CTXT = 8,
3194         LLOG_TEST_REPL_CTXT = 9, /* kept just to avoid re-assignment */
3195         LLOG_CHANGELOG_ORIG_CTXT = 12, /**< changelog generation on mdd */
3196         LLOG_CHANGELOG_REPL_CTXT = 13, /**< changelog access on clients */
3197         /* for multiple changelog consumers */
3198         LLOG_CHANGELOG_USER_ORIG_CTXT = 14,
3199         LLOG_AGENT_ORIG_CTXT = 15, /**< agent requests generation on cdt */
3200         LLOG_MAX_CTXTS
3201 };
3202
3203 /** Identifier for a single log object */
3204 struct llog_logid {
3205         struct ost_id           lgl_oi;
3206         __u32                   lgl_ogen;
3207 } __attribute__((packed));
3208
3209 /** Records written to the CATALOGS list */
3210 #define CATLIST "CATALOGS"
3211 struct llog_catid {
3212         struct llog_logid       lci_logid;
3213         __u32                   lci_padding1;
3214         __u32                   lci_padding2;
3215         __u32                   lci_padding3;
3216 } __attribute__((packed));
3217
3218 /* Log data record types - there is no specific reason that these need to
3219  * be related to the RPC opcodes, but no reason not to (may be handy later?)
3220  */
3221 #define LLOG_OP_MAGIC 0x10600000
3222 #define LLOG_OP_MASK  0xfff00000
3223
3224 typedef enum {
3225         LLOG_PAD_MAGIC          = LLOG_OP_MAGIC | 0x00000,
3226         OST_SZ_REC              = LLOG_OP_MAGIC | 0x00f00,
3227         /* OST_RAID1_REC        = LLOG_OP_MAGIC | 0x01000, never used */
3228         MDS_UNLINK_REC          = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) |
3229                                   REINT_UNLINK, /* obsolete after 2.5.0 */
3230         MDS_UNLINK64_REC        = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
3231                                   REINT_UNLINK,
3232         /* MDS_SETATTR_REC      = LLOG_OP_MAGIC | 0x12401, obsolete 1.8.0 */
3233         MDS_SETATTR64_REC       = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
3234                                   REINT_SETATTR,
3235         OBD_CFG_REC             = LLOG_OP_MAGIC | 0x20000,
3236         /* PTL_CFG_REC          = LLOG_OP_MAGIC | 0x30000, obsolete 1.4.0 */
3237         LLOG_GEN_REC            = LLOG_OP_MAGIC | 0x40000,
3238         /* LLOG_JOIN_REC        = LLOG_OP_MAGIC | 0x50000, obsolete  1.8.0 */
3239         CHANGELOG_REC           = LLOG_OP_MAGIC | 0x60000,
3240         CHANGELOG_USER_REC      = LLOG_OP_MAGIC | 0x70000,
3241         HSM_AGENT_REC           = LLOG_OP_MAGIC | 0x80000,
3242         LLOG_HDR_MAGIC          = LLOG_OP_MAGIC | 0x45539,
3243         LLOG_LOGID_MAGIC        = LLOG_OP_MAGIC | 0x4553b,
3244 } llog_op_type;
3245
3246 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
3247         (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == __swab32(LLOG_OP_MAGIC))
3248
3249 /** Log record header - stored in little endian order.
3250  * Each record must start with this struct, end with a llog_rec_tail,
3251  * and be a multiple of 256 bits in size.
3252  */
3253 struct llog_rec_hdr {
3254         __u32   lrh_len;
3255         __u32   lrh_index;
3256         __u32   lrh_type;
3257         __u32   lrh_id;
3258 };
3259
3260 struct llog_rec_tail {
3261         __u32   lrt_len;
3262         __u32   lrt_index;
3263 };
3264
3265 /* Where data follow just after header */
3266 #define REC_DATA(ptr)                                           \
3267         ((void *)((char *)ptr + sizeof(struct llog_rec_hdr)))
3268
3269 #define REC_DATA_LEN(rec)                                       \
3270         (rec->lrh_len - sizeof(struct llog_rec_hdr) -           \
3271          sizeof(struct llog_rec_tail))
3272
3273 static inline void *rec_tail(struct llog_rec_hdr *rec)
3274 {
3275         return (void *)((char *)rec + rec->lrh_len -
3276                         sizeof(struct llog_rec_tail));
3277 }
3278
3279 struct llog_logid_rec {
3280         struct llog_rec_hdr     lid_hdr;
3281         struct llog_logid       lid_id;
3282         __u32                   lid_padding1;
3283         __u64                   lid_padding2;
3284         __u64                   lid_padding3;
3285         struct llog_rec_tail    lid_tail;
3286 } __attribute__((packed));
3287
3288 struct llog_unlink_rec {
3289         struct llog_rec_hdr     lur_hdr;
3290         obd_id                  lur_oid;
3291         obd_count               lur_oseq;
3292         obd_count               lur_count;
3293         struct llog_rec_tail    lur_tail;
3294 } __attribute__((packed));
3295
3296 struct llog_unlink64_rec {
3297         struct llog_rec_hdr     lur_hdr;
3298         struct lu_fid           lur_fid;
3299         obd_count               lur_count; /* to destroy the lost precreated */
3300         __u32                   lur_padding1;
3301         __u64                   lur_padding2;
3302         __u64                   lur_padding3;
3303         struct llog_rec_tail    lur_tail;
3304 } __attribute__((packed));
3305
3306 struct llog_setattr64_rec {
3307         struct llog_rec_hdr     lsr_hdr;
3308         struct ost_id           lsr_oi;
3309         __u32                   lsr_uid;
3310         __u32                   lsr_uid_h;
3311         __u32                   lsr_gid;
3312         __u32                   lsr_gid_h;
3313         __u64                   lsr_valid;
3314         struct llog_rec_tail    lsr_tail;
3315 } __attribute__((packed));
3316
3317 struct llog_size_change_rec {
3318         struct llog_rec_hdr     lsc_hdr;
3319         struct ll_fid           lsc_fid;
3320         __u32                   lsc_ioepoch;
3321         __u32                   lsc_padding1;
3322         __u64                   lsc_padding2;
3323         __u64                   lsc_padding3;
3324         struct llog_rec_tail    lsc_tail;
3325 } __attribute__((packed));
3326
3327 #define CHANGELOG_MAGIC 0xca103000
3328
3329 /** \a changelog_rec_type's that can't be masked */
3330 #define CHANGELOG_MINMASK (1 << CL_MARK)
3331 /** bits covering all \a changelog_rec_type's */
3332 #define CHANGELOG_ALLMASK 0XFFFFFFFF
3333 /** default \a changelog_rec_type mask */
3334 #define CHANGELOG_DEFMASK CHANGELOG_ALLMASK & ~(1 << CL_ATIME | 1 << CL_CLOSE)
3335
3336 /* changelog llog name, needed by client replicators */
3337 #define CHANGELOG_CATALOG "changelog_catalog"
3338
3339 struct changelog_setinfo {
3340         __u64 cs_recno;
3341         __u32 cs_id;
3342 } __attribute__((packed));
3343
3344 /** changelog record */
3345 struct llog_changelog_rec {
3346         struct llog_rec_hdr  cr_hdr;
3347         struct changelog_rec cr; /**< Variable length field */
3348         struct llog_rec_tail cr_do_not_use; /**< for_sizeof_only */
3349 } __attribute__((packed));
3350
3351 #define CHANGELOG_USER_PREFIX "cl"
3352
3353 struct llog_changelog_user_rec {
3354         struct llog_rec_hdr   cur_hdr;
3355         __u32                 cur_id;
3356         __u32                 cur_padding;
3357         __u64                 cur_endrec;
3358         struct llog_rec_tail  cur_tail;
3359 } __attribute__((packed));
3360
3361 enum agent_req_status {
3362         ARS_WAITING,
3363         ARS_STARTED,
3364         ARS_FAILED,
3365         ARS_CANCELED,
3366         ARS_SUCCEED,
3367 };
3368
3369 static inline const char *agent_req_status2name(enum agent_req_status ars)
3370 {
3371         switch (ars) {
3372         case ARS_WAITING:
3373                 return "WAITING";
3374         case ARS_STARTED:
3375                 return "STARTED";
3376         case ARS_FAILED:
3377                 return "FAILED";
3378         case ARS_CANCELED:
3379                 return "CANCELED";
3380         case ARS_SUCCEED:
3381                 return "SUCCEED";
3382         default:
3383                 return "UNKNOWN";
3384         }
3385 }
3386
3387 static inline bool agent_req_in_final_state(enum agent_req_status ars)
3388 {
3389         return ((ars == ARS_SUCCEED) || (ars == ARS_FAILED) ||
3390                 (ars == ARS_CANCELED));
3391 }
3392
3393 struct llog_agent_req_rec {
3394         struct llog_rec_hdr     arr_hdr;        /**< record header */
3395         __u32                   arr_status;     /**< status of the request */
3396                                                 /* must match enum
3397                                                  * agent_req_status */
3398         __u32                   arr_archive_id; /**< backend archive number */
3399         __u64                   arr_flags;      /**< req flags */
3400         __u64                   arr_compound_id;        /**< compound cookie */
3401         __u64                   arr_req_create; /**< req. creation time */
3402         __u64                   arr_req_change; /**< req. status change time */
3403         struct hsm_action_item  arr_hai;        /**< req. to the agent */
3404         struct llog_rec_tail    arr_tail; /**< record tail for_sizezof_only */
3405 } __attribute__((packed));
3406
3407 /* Old llog gen for compatibility */
3408 struct llog_gen {
3409         __u64 mnt_cnt;
3410         __u64 conn_cnt;
3411 } __attribute__((packed));
3412
3413 struct llog_gen_rec {
3414         struct llog_rec_hdr     lgr_hdr;
3415         struct llog_gen         lgr_gen;
3416         __u64                   padding1;
3417         __u64                   padding2;
3418         __u64                   padding3;
3419         struct llog_rec_tail    lgr_tail;
3420 };
3421
3422 /* On-disk header structure of each log object, stored in little endian order */
3423 #define LLOG_CHUNK_SIZE         8192
3424 #define LLOG_HEADER_SIZE        (96)
3425 #define LLOG_BITMAP_BYTES       (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
3426
3427 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
3428
3429 /* flags for the logs */
3430 enum llog_flag {
3431         LLOG_F_ZAP_WHEN_EMPTY   = 0x1,
3432         LLOG_F_IS_CAT           = 0x2,
3433         LLOG_F_IS_PLAIN         = 0x4,
3434         LLOG_F_EXT_JOBID        = 0x8,
3435
3436         LLOG_F_EXT_MASK = LLOG_F_EXT_JOBID,
3437 };
3438
3439 struct llog_log_hdr {
3440         struct llog_rec_hdr     llh_hdr;
3441         obd_time                llh_timestamp;
3442         __u32                   llh_count;
3443         __u32                   llh_bitmap_offset;
3444         __u32                   llh_size;
3445         __u32                   llh_flags;
3446         __u32                   llh_cat_idx;
3447         /* for a catalog the first plain slot is next to it */
3448         struct obd_uuid         llh_tgtuuid;
3449         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
3450         __u32                   llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
3451         struct llog_rec_tail    llh_tail;
3452 } __attribute__((packed));
3453
3454 #define LLOG_BITMAP_SIZE(llh)  (__u32)((llh->llh_hdr.lrh_len -          \
3455                                         llh->llh_bitmap_offset -        \
3456                                         sizeof(llh->llh_tail)) * 8)
3457
3458 /** log cookies are used to reference a specific log file and a record therein */
3459 struct llog_cookie {
3460         struct llog_logid       lgc_lgl;
3461         __u32                   lgc_subsys;
3462         __u32                   lgc_index;
3463         __u32                   lgc_padding;
3464 } __attribute__((packed));
3465
3466 /** llog protocol */
3467 enum llogd_rpc_ops {
3468         LLOG_ORIGIN_HANDLE_CREATE       = 501,
3469         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
3470         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
3471         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
3472         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
3473         LLOG_ORIGIN_CONNECT             = 506,
3474         LLOG_CATINFO                    = 507,  /* deprecated */
3475         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
3476         LLOG_ORIGIN_HANDLE_DESTROY      = 509,  /* for destroy llog object*/
3477         LLOG_LAST_OPC,
3478         LLOG_FIRST_OPC                  = LLOG_ORIGIN_HANDLE_CREATE
3479 };
3480
3481 struct llogd_body {
3482         struct llog_logid  lgd_logid;
3483         __u32 lgd_ctxt_idx;
3484         __u32 lgd_llh_flags;
3485         __u32 lgd_index;
3486         __u32 lgd_saved_index;
3487         __u32 lgd_len;
3488         __u64 lgd_cur_offset;
3489 } __attribute__((packed));
3490
3491 struct llogd_conn_body {
3492         struct llog_gen         lgdc_gen;
3493         struct llog_logid       lgdc_logid;
3494         __u32                   lgdc_ctxt_idx;
3495 } __attribute__((packed));
3496
3497 /* Note: 64-bit types are 64-bit aligned in structure */
3498 struct obdo {
3499         obd_valid               o_valid;        /* hot fields in this obdo */
3500         struct ost_id           o_oi;
3501         obd_id                  o_parent_seq;
3502         obd_size                o_size;         /* o_size-o_blocks == ost_lvb */
3503         obd_time                o_mtime;
3504         obd_time                o_atime;
3505         obd_time                o_ctime;
3506         obd_blocks              o_blocks;       /* brw: cli sent cached bytes */
3507         obd_size                o_grant;
3508
3509         /* 32-bit fields start here: keep an even number of them via padding */
3510         obd_blksize             o_blksize;      /* optimal IO blocksize */
3511         obd_mode                o_mode;         /* brw: cli sent cache remain */
3512         obd_uid                 o_uid;
3513         obd_gid                 o_gid;
3514         obd_flag                o_flags;
3515         obd_count               o_nlink;        /* brw: checksum */
3516         obd_count               o_parent_oid;
3517         obd_count               o_misc;         /* brw: o_dropped */
3518
3519         __u64                   o_ioepoch;      /* epoch in ost writes */
3520         __u32                   o_stripe_idx;   /* holds stripe idx */
3521         __u32                   o_parent_ver;
3522         struct lustre_handle    o_handle;       /* brw: lock handle to prolong
3523                                                  * locks */
3524         struct llog_cookie      o_lcookie;      /* destroy: unlink cookie from
3525                                                  * MDS */
3526         __u32                   o_uid_h;
3527         __u32                   o_gid_h;
3528
3529         __u64                   o_data_version; /* getattr: sum of iversion for
3530                                                  * each stripe.
3531                                                  * brw: grant space consumed on
3532                                                  * the client for the write */
3533         __u64                   o_padding_4;
3534         __u64                   o_padding_5;
3535         __u64                   o_padding_6;
3536 };
3537
3538 #define o_dirty   o_blocks
3539 #define o_undirty o_mode
3540 #define o_dropped o_misc
3541 #define o_cksum   o_nlink
3542 #define o_grant_used o_data_version
3543
3544 struct lfsck_request {
3545         __u32           lr_event;
3546         __u32           lr_index;
3547         __u32           lr_flags;
3548         __u32           lr_valid;
3549         union {
3550                 __u32   lr_speed;
3551                 __u32   lr_status;
3552                 __u32   lr_type;
3553         };
3554         __u16           lr_version;
3555         __u16           lr_active;
3556         __u16           lr_param;
3557         __u16           lr_async_windows;
3558         union {
3559                 __u32   lr_flags2;
3560                 __u32   lr_layout_version;
3561         };
3562         struct lu_fid   lr_fid;
3563         struct lu_fid   lr_fid2;
3564         union {
3565                 struct lu_fid   lr_fid3;
3566                 char            lr_pool_name[LOV_MAXPOOLNAME + 1];
3567         };
3568         __u32           lr_stripe_count;
3569         __u32           lr_hash_type;
3570         __u64           lr_padding_3;
3571 };
3572
3573 void lustre_swab_lfsck_request(struct lfsck_request *lr);
3574
3575 struct lfsck_reply {
3576         __u32           lr_status;
3577         __u32           lr_padding_1;
3578         __u64           lr_padding_2;
3579 };
3580
3581 void lustre_swab_lfsck_reply(struct lfsck_reply *lr);
3582
3583 enum lfsck_events {
3584         LE_LASTID_REBUILDING    = 1,
3585         LE_LASTID_REBUILT       = 2,
3586         LE_PHASE1_DONE          = 3,
3587         LE_PHASE2_DONE          = 4,
3588         LE_START                = 5,
3589         LE_STOP                 = 6,
3590         LE_QUERY                = 7,
3591         LE_FID_ACCESSED         = 8,
3592         LE_PEER_EXIT            = 9,
3593         LE_CONDITIONAL_DESTROY  = 10,
3594         LE_PAIRS_VERIFY         = 11,
3595         LE_CREATE_ORPHAN        = 12,
3596         LE_SKIP_NLINK_DECLARE   = 13,
3597         LE_SKIP_NLINK           = 14,
3598         LE_SET_LMV_MASTER       = 15,
3599         LE_SET_LMV_SLAVE        = 16,
3600 };
3601
3602 enum lfsck_event_flags {
3603         LEF_TO_OST              = 0x00000001,
3604         LEF_FROM_OST            = 0x00000002,
3605         LEF_SET_LMV_HASH        = 0x00000004,
3606         LEF_SET_LMV_ALL         = 0x00000008,
3607         LEF_RECHECK_NAME_HASH   = 0x00000010,
3608 };
3609
3610 static inline void lustre_set_wire_obdo(const struct obd_connect_data *ocd,
3611                                         struct obdo *wobdo,
3612                                         const struct obdo *lobdo)
3613 {
3614         *wobdo = *lobdo;
3615         wobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
3616         if (ocd == NULL)
3617                 return;
3618
3619         if (unlikely(!(ocd->ocd_connect_flags & OBD_CONNECT_FID)) &&
3620             fid_seq_is_echo(ostid_seq(&lobdo->o_oi))) {
3621                 /* Currently OBD_FL_OSTID will only be used when 2.4 echo
3622                  * client communicate with pre-2.4 server */
3623                 wobdo->o_oi.oi.oi_id = fid_oid(&lobdo->o_oi.oi_fid);
3624                 wobdo->o_oi.oi.oi_seq = fid_seq(&lobdo->o_oi.oi_fid);
3625         }
3626 }
3627
3628 static inline void lustre_get_wire_obdo(const struct obd_connect_data *ocd,
3629                                         struct obdo *lobdo,
3630                                         const struct obdo *wobdo)
3631 {
3632         obd_flag local_flags = 0;
3633
3634         if (lobdo->o_valid & OBD_MD_FLFLAGS)
3635                  local_flags = lobdo->o_flags & OBD_FL_LOCAL_MASK;
3636
3637         *lobdo = *wobdo;
3638         if (local_flags != 0) {
3639                 lobdo->o_valid |= OBD_MD_FLFLAGS;
3640                 lobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
3641                 lobdo->o_flags |= local_flags;
3642         }
3643         if (ocd == NULL)
3644                 return;
3645
3646         if (unlikely(!(ocd->ocd_connect_flags & OBD_CONNECT_FID)) &&
3647             fid_seq_is_echo(wobdo->o_oi.oi.oi_seq)) {
3648                 /* see above */
3649                 lobdo->o_oi.oi_fid.f_seq = wobdo->o_oi.oi.oi_seq;
3650                 lobdo->o_oi.oi_fid.f_oid = wobdo->o_oi.oi.oi_id;
3651                 lobdo->o_oi.oi_fid.f_ver = 0;
3652         }
3653 }
3654
3655 extern void lustre_swab_obdo (struct obdo *o);
3656
3657 /* request structure for OST's */
3658 struct ost_body {
3659         struct  obdo oa;
3660 };
3661
3662 /* Key for FIEMAP to be used in get_info calls */
3663 struct ll_fiemap_info_key {
3664         char    name[8];
3665         struct  obdo oa;
3666         struct  ll_user_fiemap fiemap;
3667 };
3668
3669 extern void lustre_swab_ost_body (struct ost_body *b);
3670 extern void lustre_swab_ost_last_id(obd_id *id);
3671 extern void lustre_swab_fiemap(struct ll_user_fiemap *fiemap);
3672
3673 extern void lustre_swab_lov_user_md_v1(struct lov_user_md_v1 *lum);
3674 extern void lustre_swab_lov_user_md_v3(struct lov_user_md_v3 *lum);
3675 extern void lustre_swab_lov_user_md_objects(struct lov_user_ost_data *lod,
3676                                             int stripe_count);
3677 extern void lustre_swab_lov_mds_md(struct lov_mds_md *lmm);
3678 void lustre_print_user_md(unsigned int level, struct lov_user_md *lum,
3679                           const char *msg);
3680
3681 /* llog_swab.c */
3682 extern void lustre_swab_llogd_body (struct llogd_body *d);
3683 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
3684 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
3685 extern void lustre_swab_llog_rec(struct llog_rec_hdr *rec);
3686 extern void lustre_swab_llog_id(struct llog_logid *lid);
3687
3688 struct lustre_cfg;
3689 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
3690
3691 /* Functions for dumping PTLRPC fields */
3692 void dump_rniobuf(struct niobuf_remote *rnb);
3693 void dump_ioo(struct obd_ioobj *nb);
3694 void dump_obdo(struct obdo *oa);
3695 void dump_ost_body(struct ost_body *ob);
3696 void dump_rcs(__u32 *rc);
3697
3698 #define IDX_INFO_MAGIC 0x3D37CC37
3699
3700 /* Index file transfer through the network. The server serializes the index into
3701  * a byte stream which is sent to the client via a bulk transfer */
3702 struct idx_info {
3703         __u32           ii_magic;
3704
3705         /* reply: see idx_info_flags below */
3706         __u32           ii_flags;
3707
3708         /* request & reply: number of lu_idxpage (to be) transferred */
3709         __u16           ii_count;
3710         __u16           ii_pad0;
3711
3712         /* request: requested attributes passed down to the iterator API */
3713         __u32           ii_attrs;
3714
3715         /* request & reply: index file identifier (FID) */
3716         struct lu_fid   ii_fid;
3717
3718         /* reply: version of the index file before starting to walk the index.
3719          * Please note that the version can be modified at any time during the
3720          * transfer */
3721         __u64           ii_version;
3722
3723         /* request: hash to start with:
3724          * reply: hash of the first entry of the first lu_idxpage and hash
3725          *        of the entry to read next if any */
3726         __u64           ii_hash_start;
3727         __u64           ii_hash_end;
3728
3729         /* reply: size of keys in lu_idxpages, minimal one if II_FL_VARKEY is
3730          * set */
3731         __u16           ii_keysize;
3732
3733         /* reply: size of records in lu_idxpages, minimal one if II_FL_VARREC
3734          * is set */
3735         __u16           ii_recsize;
3736
3737         __u32           ii_pad1;
3738         __u64           ii_pad2;
3739         __u64           ii_pad3;
3740 };
3741 extern void lustre_swab_idx_info(struct idx_info *ii);
3742
3743