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