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