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