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