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