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