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