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