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