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