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