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