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