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