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