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