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