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