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