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