Whamcloud - gitweb
89b632c93d87290e014193febbc7e0d777fc62b9
[fs/lustre-release.git] / lustre / include / lustre / lustre_idl.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2016, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lustre/include/lustre/lustre_idl.h
33  *
34  * Lustre wire protocol definitions.
35  */
36
37 /** \defgroup lustreidl lustreidl
38  *
39  * Lustre wire protocol definitions.
40  *
41  * ALL structs passing over the wire should be declared here.  Structs
42  * that are used in interfaces with userspace should go in lustre_user.h.
43  *
44  * All structs being declared here should be built from simple fixed-size
45  * types (__u8, __u16, __u32, __u64) or be built from other types or
46  * structs also declared in this file.  Similarly, all flags and magic
47  * values in those structs should also be declared here.  This ensures
48  * that the Lustre wire protocol is not influenced by external dependencies.
49  *
50  * The only other acceptable items in this file are VERY SIMPLE accessor
51  * functions to avoid callers grubbing inside the structures. Nothing that
52  * depends on external functions or definitions should be in here.
53  *
54  * Structs must be properly aligned to put 64-bit values on an 8-byte
55  * boundary.  Any structs being added here must also be added to
56  * utils/wirecheck.c and "make newwiretest" run to regenerate the
57  * utils/wiretest.c sources.  This allows us to verify that wire structs
58  * have the proper alignment/size on all architectures.
59  *
60  * DO NOT CHANGE any of the structs, flags, values declared here and used
61  * in released Lustre versions.  Some structs may have padding fields that
62  * can be used.  Some structs might allow addition at the end (verify this
63  * in the code to ensure that new/old clients that see this larger struct
64  * do not fail, otherwise you need to implement protocol compatibility).
65  *
66  * @{
67  */
68
69 #ifndef _LUSTRE_IDL_H_
70 #define _LUSTRE_IDL_H_
71
72 #include <asm/byteorder.h>
73 #include <linux/types.h>
74
75 #include <lnet/types.h>
76 #include <lustre/lustre_user.h> /* Defn's shared with user-space. */
77 #include <lustre_ver.h>
78
79 /*
80  *  GENERAL STUFF
81  */
82 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
83  * FOO_REPLY_PORTAL   is for incoming replies on the FOO
84  * FOO_BULK_PORTAL    is for incoming bulk on the FOO
85  */
86
87 #define CONNMGR_REQUEST_PORTAL          1
88 #define CONNMGR_REPLY_PORTAL            2
89 //#define OSC_REQUEST_PORTAL            3
90 #define OSC_REPLY_PORTAL                4
91 //#define OSC_BULK_PORTAL               5
92 #define OST_IO_PORTAL                   6
93 #define OST_CREATE_PORTAL               7
94 #define OST_BULK_PORTAL                 8
95 //#define MDC_REQUEST_PORTAL            9
96 #define MDC_REPLY_PORTAL               10
97 //#define MDC_BULK_PORTAL              11
98 #define MDS_REQUEST_PORTAL             12
99 //#define MDS_REPLY_PORTAL             13
100 #define MDS_BULK_PORTAL                14
101 #define LDLM_CB_REQUEST_PORTAL         15
102 #define LDLM_CB_REPLY_PORTAL           16
103 #define LDLM_CANCEL_REQUEST_PORTAL     17
104 #define LDLM_CANCEL_REPLY_PORTAL       18
105 //#define PTLBD_REQUEST_PORTAL           19
106 //#define PTLBD_REPLY_PORTAL             20
107 //#define PTLBD_BULK_PORTAL              21
108 #define MDS_SETATTR_PORTAL             22
109 #define MDS_READPAGE_PORTAL            23
110 #define OUT_PORTAL                      24
111 #define MGC_REPLY_PORTAL               25
112 #define MGS_REQUEST_PORTAL             26
113 #define MGS_REPLY_PORTAL               27
114 #define OST_REQUEST_PORTAL             28
115 #define FLD_REQUEST_PORTAL             29
116 #define SEQ_METADATA_PORTAL            30
117 #define SEQ_DATA_PORTAL                31
118 #define SEQ_CONTROLLER_PORTAL          32
119 #define MGS_BULK_PORTAL                33
120
121 /* Portal 63 is reserved for the Cray Inc DVS - nic@cray.com, roe@cray.com, n8851@cray.com */
122
123 /* packet types */
124 #define PTL_RPC_MSG_REQUEST 4711
125 #define PTL_RPC_MSG_ERR     4712
126 #define PTL_RPC_MSG_REPLY   4713
127
128 /* DON'T use swabbed values of MAGIC as magic! */
129 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
130 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
131
132 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
133
134 #define PTLRPC_MSG_VERSION  0x00000003
135 #define LUSTRE_VERSION_MASK 0xffff0000
136 #define LUSTRE_OBD_VERSION  0x00010000
137 #define LUSTRE_MDS_VERSION  0x00020000
138 #define LUSTRE_OST_VERSION  0x00030000
139 #define LUSTRE_DLM_VERSION  0x00040000
140 #define LUSTRE_LOG_VERSION  0x00050000
141 #define LUSTRE_MGS_VERSION  0x00060000
142
143 /**
144  * Describes a range of sequence, lsr_start is included but lsr_end is
145  * not in the range.
146  * Same structure is used in fld module where lsr_index field holds mdt id
147  * of the home mdt.
148  */
149 struct lu_seq_range {
150         __u64 lsr_start;
151         __u64 lsr_end;
152         __u32 lsr_index;
153         __u32 lsr_flags;
154 };
155
156 struct lu_seq_range_array {
157         __u32 lsra_count;
158         __u32 lsra_padding;
159         struct lu_seq_range lsra_lsr[0];
160 };
161
162 #define LU_SEQ_RANGE_MDT        0x0
163 #define LU_SEQ_RANGE_OST        0x1
164 #define LU_SEQ_RANGE_ANY        0x3
165
166 #define LU_SEQ_RANGE_MASK       0x3
167
168 /** \defgroup lu_fid lu_fid
169  * @{ */
170
171 extern void lustre_lma_swab(struct lustre_mdt_attrs *lma);
172 extern void lustre_lma_init(struct lustre_mdt_attrs *lma,
173                             const struct lu_fid *fid,
174                             __u32 compat, __u32 incompat);
175 extern void lustre_loa_swab(struct lustre_ost_attrs *loa,
176                             bool to_cpu);
177 extern void lustre_loa_init(struct lustre_ost_attrs *loa,
178                             const struct lu_fid *fid,
179                             __u32 compat, __u32 incompat);
180
181 /* copytool uses a 32b bitmask field to encode archive-Ids during register
182  * with MDT thru kuc.
183  * archive num = 0 => all
184  * archive num from 1 to 32
185  */
186 #define LL_HSM_MAX_ARCHIVE (sizeof(__u32) * 8)
187
188 /**
189  * HSM on-disk attributes stored in a separate xattr.
190  */
191 struct hsm_attrs {
192         /** Bitfield for supported data in this structure. For future use. */
193         __u32   hsm_compat;
194
195         /** HSM flags, see hsm_flags enum below */
196         __u32   hsm_flags;
197         /** backend archive id associated with the file */
198         __u64   hsm_arch_id;
199         /** version associated with the last archiving, if any */
200         __u64   hsm_arch_ver;
201 };
202 extern void lustre_hsm_swab(struct hsm_attrs *attrs);
203
204 /**
205  * fid constants
206  */
207 enum {
208         /** LASTID file has zero OID */
209         LUSTRE_FID_LASTID_OID = 0UL,
210         /** initial fid id value */
211         LUSTRE_FID_INIT_OID  = 1UL
212 };
213
214 /**
215  * Different FID Format
216  * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs#NEW.0
217  *
218  * FID:
219  * File IDentifier generated by client from range allocated by the seq service.
220  * First 0x400 sequences [2^33, 2^33 + 0x400] are reserved for system use. Note
221  * that on ldiskfs MDTs that IGIF FIDs can use inode numbers starting at 12,
222  * but this is in the IGIF SEQ rangeand does not conflict with assigned FIDs.
223  *
224  * IGIF:
225  * Inode and Generation In FID, a surrogate FID used to globally identify an
226  * existing object on OLD formatted MDT file system. This would only be used on
227  * MDT0 in a DNE filesystem, because there are not expected to be any OLD
228  * formatted DNE filesystems. Belongs to a sequence in [12, 2^32 - 1] range,
229  * where sequence number is inode number, and inode generation is used as OID.
230  * NOTE: This assumes no more than 2^32-1 inodes exist in the MDT filesystem,
231  * which is the maximum possible for an ldiskfs backend. NOTE: This assumes
232  * that the reserved ext3/ext4/ldiskfs inode numbers [0-11] are never visible
233  * to clients, which has always been true.
234  *
235  * IDIF:
236  * Object ID in FID, a surrogate FID used to globally identify an existing
237  * object on OLD formatted OST file system. Belongs to a sequence in
238  * [2^32, 2^33 - 1]. Sequence number is calculated as:
239  *      1 << 32 | (ost_index << 16) | ((objid >> 32) & 0xffff)
240  * that is, SEQ consists of 16-bit OST index, and higher 16 bits of object ID.
241  * The generation of unique SEQ values per OST allows the IDIF FIDs to be
242  * identified in the FLD correctly. The OID field is calculated as:
243  *      objid & 0xffffffff
244  * that is, it consists of lower 32 bits of object ID. NOTE This assumes that
245  * no more than 2^48-1 objects have ever been created on an OST, and that no
246  * more than 65535 OSTs are in use. Both are very reasonable assumptions (can
247  * uniquely map all objects on an OST that created 1M objects per second for 9
248  * years, or combinations thereof).
249  *
250  * OST_MDT0:
251  * Surrogate FID used to identify an existing object on OLD formatted OST
252  * filesystem. Belongs to the reserved sequence 0, and is used internally prior
253  * to the introduction of FID-on-OST, at which point IDIF will be used to
254  * identify objects as residing on a specific OST.
255  *
256  * LLOG:
257  * For Lustre Log objects the object sequence 1 is used. This is compatible with
258  * both OLD and NEW.1 namespaces, as this SEQ number is in the ext3/ldiskfs
259  * reserved inode range and does not conflict with IGIF sequence numbers.
260  *
261  * ECHO:
262  * For testing OST IO performance the object sequence 2 is used. This is
263  * compatible with both OLD and NEW.1 namespaces, as this SEQ number is in the
264  * ext3/ldiskfs reserved inode range and does not conflict with IGIF sequence
265  * numbers.
266  *
267  * OST_MDT1 .. OST_MAX:
268  * For testing with multiple MDTs the object sequence 3 through 9 is used,
269  * allowing direct mapping of MDTs 1 through 7 respectively, for a total of 8
270  * MDTs including OST_MDT0. This matches the legacy CMD project "group"
271  * mappings. However, this SEQ range is only for testing prior to any production
272  * DNE release, as the objects in this range conflict across all OSTs, as the
273  * OST index is not part of the FID.
274  *
275  *
276  * For compatibility with existing OLD OST network protocol structures, the FID
277  * must map onto the o_id and o_gr in a manner that ensures existing objects are
278  * identified consistently for IO, as well as onto the lock namespace to ensure
279  * both IDIFs map onto the same objects for IO as well as resources in the DLM.
280  *
281  * DLM OLD OBIF/IDIF:
282  * resource[] = {o_id, o_seq, 0, 0};  // o_seq == 0 for production releases
283  *
284  * DLM NEW.1 FID (this is the same for both the MDT and OST):
285  * resource[] = {SEQ, OID, VER, HASH};
286  *
287  * Note that for mapping IDIF values to DLM resource names the o_id may be
288  * larger than the 2^33 reserved sequence numbers for IDIF, so it is possible
289  * for the o_id numbers to overlap FID SEQ numbers in the resource. However, in
290  * all production releases the OLD o_seq field is always zero, and all valid FID
291  * OID values are non-zero, so the lock resources will not collide.
292  *
293  * For objects within the IDIF range, group extraction (non-CMD) will be:
294  * o_id = (fid->f_seq & 0x7fff) << 16 | fid->f_oid;
295  * o_seq = 0;  // formerly group number
296  */
297
298 /**
299  * Note that reserved SEQ numbers below 12 will conflict with ldiskfs
300  * inodes in the IGIF namespace, so these reserved SEQ numbers can be
301  * used for other purposes and not risk collisions with existing inodes.
302  */
303 enum fid_seq {
304         FID_SEQ_OST_MDT0        = 0,
305         FID_SEQ_LLOG            = 1, /* unnamed llogs */
306         FID_SEQ_ECHO            = 2,
307         FID_SEQ_UNUSED_START    = 3,
308         FID_SEQ_UNUSED_END      = 9,
309         FID_SEQ_LLOG_NAME       = 10, /* named llogs */
310         FID_SEQ_RSVD            = 11,
311         FID_SEQ_IGIF            = 12,
312         FID_SEQ_IGIF_MAX        = 0x0ffffffffULL,
313         FID_SEQ_IDIF            = 0x100000000ULL,
314         FID_SEQ_IDIF_MAX        = 0x1ffffffffULL,
315         /* Normal FID sequence starts from this value, i.e. 1<<33 */
316         FID_SEQ_START           = 0x200000000ULL,
317         /* sequence for local pre-defined FIDs listed in local_oid */
318         FID_SEQ_LOCAL_FILE      = 0x200000001ULL,
319         FID_SEQ_DOT_LUSTRE      = 0x200000002ULL,
320         /* sequence is used for local named objects FIDs generated
321          * by local_object_storage library */
322         FID_SEQ_LOCAL_NAME      = 0x200000003ULL,
323         /* Because current FLD will only cache the fid sequence, instead
324          * of oid on the client side, if the FID needs to be exposed to
325          * clients sides, it needs to make sure all of fids under one
326          * sequence will be located in one MDT. */
327         FID_SEQ_SPECIAL         = 0x200000004ULL,
328         FID_SEQ_QUOTA           = 0x200000005ULL,
329         FID_SEQ_QUOTA_GLB       = 0x200000006ULL,
330         FID_SEQ_ROOT            = 0x200000007ULL,  /* Located on MDT0 */
331         FID_SEQ_LAYOUT_RBTREE   = 0x200000008ULL,
332         /* sequence is used for update logs of cross-MDT operation */
333         FID_SEQ_UPDATE_LOG      = 0x200000009ULL,
334         /* Sequence is used for the directory under which update logs
335          * are created. */
336         FID_SEQ_UPDATE_LOG_DIR  = 0x20000000aULL,
337         FID_SEQ_NORMAL          = 0x200000400ULL,
338         FID_SEQ_LOV_DEFAULT     = 0xffffffffffffffffULL
339 };
340
341 #define OBIF_OID_MAX_BITS           32
342 #define OBIF_MAX_OID                (1ULL << OBIF_OID_MAX_BITS)
343 #define OBIF_OID_MASK               ((1ULL << OBIF_OID_MAX_BITS) - 1)
344 #define IDIF_OID_MAX_BITS           48
345 #define IDIF_MAX_OID                (1ULL << IDIF_OID_MAX_BITS)
346 #define IDIF_OID_MASK               ((1ULL << IDIF_OID_MAX_BITS) - 1)
347
348 /** OID for FID_SEQ_SPECIAL */
349 enum special_oid {
350         /* Big Filesystem Lock to serialize rename operations */
351         FID_OID_SPECIAL_BFL     = 1UL,
352 };
353
354 /** OID for FID_SEQ_DOT_LUSTRE */
355 enum dot_lustre_oid {
356         FID_OID_DOT_LUSTRE      = 1UL,
357         FID_OID_DOT_LUSTRE_OBF  = 2UL,
358         FID_OID_DOT_LUSTRE_LPF  = 3UL,
359 };
360
361 /** OID for FID_SEQ_ROOT */
362 enum root_oid {
363         FID_OID_ROOT            = 1UL,
364         FID_OID_ECHO_ROOT       = 2UL,
365 };
366
367 struct lu_orphan_rec {
368         /* The MDT-object's FID referenced by the orphan OST-object */
369         struct lu_fid   lor_fid;
370         __u32           lor_uid;
371         __u32           lor_gid;
372 };
373
374 struct lu_orphan_ent {
375         /* The orphan OST-object's FID */
376         struct lu_fid           loe_key;
377         struct lu_orphan_rec    loe_rec;
378 };
379
380 struct lu_orphan_rec_v2 {
381         struct lu_orphan_rec    lor_rec;
382         struct ost_layout       lor_layout;
383         __u32                   lor_padding;
384 };
385
386 struct lu_orphan_ent_v2 {
387         /* The orphan OST-object's FID */
388         struct lu_fid           loe_key;
389         struct lu_orphan_rec_v2 loe_rec;
390 };
391
392 /** @} lu_fid */
393
394 /** \defgroup lu_dir lu_dir
395  * @{ */
396
397 /**
398  * Enumeration of possible directory entry attributes.
399  *
400  * Attributes follow directory entry header in the order they appear in this
401  * enumeration.
402  */
403 enum lu_dirent_attrs {
404         LUDA_FID                = 0x0001,
405         LUDA_TYPE               = 0x0002,
406         LUDA_64BITHASH          = 0x0004,
407
408         /* The following attrs are used for MDT internal only,
409          * not visible to client */
410
411         /* Something in the record is unknown, to be verified in further. */
412         LUDA_UNKNOWN            = 0x0400,
413         /* Ignore this record, go to next directly. */
414         LUDA_IGNORE             = 0x0800,
415         /* The system is upgraded, has beed or to be repaired (dryrun). */
416         LUDA_UPGRADE            = 0x1000,
417         /* The dirent has been repaired, or to be repaired (dryrun). */
418         LUDA_REPAIR             = 0x2000,
419         /* Only check but not repair the dirent inconsistency */
420         LUDA_VERIFY_DRYRUN      = 0x4000,
421         /* Verify the dirent consistency */
422         LUDA_VERIFY             = 0x8000,
423 };
424
425 #define LU_DIRENT_ATTRS_MASK    0xff00
426
427 /**
428  * Layout of readdir pages, as transmitted on wire.
429  */
430 struct lu_dirent {
431         /** valid if LUDA_FID is set. */
432         struct lu_fid lde_fid;
433         /** a unique entry identifier: a hash or an offset. */
434         __u64         lde_hash;
435         /** total record length, including all attributes. */
436         __u16         lde_reclen;
437         /** name length */
438         __u16         lde_namelen;
439         /** optional variable size attributes following this entry.
440          *  taken from enum lu_dirent_attrs.
441          */
442         __u32         lde_attrs;
443         /** name is followed by the attributes indicated in ->ldp_attrs, in
444          *  their natural order. After the last attribute, padding bytes are
445          *  added to make ->lde_reclen a multiple of 8.
446          */
447         char          lde_name[0];
448 };
449
450 /*
451  * Definitions of optional directory entry attributes formats.
452  *
453  * Individual attributes do not have their length encoded in a generic way. It
454  * is assumed that consumer of an attribute knows its format. This means that
455  * it is impossible to skip over an unknown attribute, except by skipping over all
456  * remaining attributes (by using ->lde_reclen), which is not too
457  * constraining, because new server versions will append new attributes at
458  * the end of an entry.
459  */
460
461 /**
462  * Fid directory attribute: a fid of an object referenced by the entry. This
463  * will be almost always requested by the client and supplied by the server.
464  *
465  * Aligned to 8 bytes.
466  */
467 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
468
469 /**
470  * File type.
471  *
472  * Aligned to 2 bytes.
473  */
474 struct luda_type {
475         __u16 lt_type;
476 };
477
478 struct lu_dirpage {
479         __u64            ldp_hash_start;
480         __u64            ldp_hash_end;
481         __u32            ldp_flags;
482         __u32            ldp_pad0;
483         struct lu_dirent ldp_entries[0];
484 };
485
486 enum lu_dirpage_flags {
487         /**
488          * dirpage contains no entry.
489          */
490         LDF_EMPTY   = 1 << 0,
491         /**
492          * last entry's lde_hash equals ldp_hash_end.
493          */
494         LDF_COLLIDE = 1 << 1
495 };
496
497 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
498 {
499         if (__le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
500                 return NULL;
501         else
502                 return dp->ldp_entries;
503 }
504
505 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
506 {
507         struct lu_dirent *next;
508
509         if (__le16_to_cpu(ent->lde_reclen) != 0)
510                 next = ((void *)ent) + __le16_to_cpu(ent->lde_reclen);
511         else
512                 next = NULL;
513
514         return next;
515 }
516
517 static inline size_t lu_dirent_calc_size(size_t namelen, __u16 attr)
518 {
519         size_t size;
520
521         if (attr & LUDA_TYPE) {
522                 const size_t align = sizeof(struct luda_type) - 1;
523                 size = (sizeof(struct lu_dirent) + namelen + align) & ~align;
524                 size += sizeof(struct luda_type);
525         } else
526                 size = sizeof(struct lu_dirent) + namelen;
527
528         return (size + 7) & ~7;
529 }
530
531 #define MDS_DIR_END_OFF 0xfffffffffffffffeULL
532
533 /**
534  * MDS_READPAGE page size
535  *
536  * This is the directory page size packed in MDS_READPAGE RPC.
537  * It's different than PAGE_SIZE because the client needs to
538  * access the struct lu_dirpage header packed at the beginning of
539  * the "page" and without this there isn't any way to know find the
540  * lu_dirpage header is if client and server PAGE_SIZE differ.
541  */
542 #define LU_PAGE_SHIFT 12
543 #define LU_PAGE_SIZE  (1UL << LU_PAGE_SHIFT)
544 #define LU_PAGE_MASK  (~(LU_PAGE_SIZE - 1))
545
546 #define LU_PAGE_COUNT (1 << (PAGE_SHIFT - LU_PAGE_SHIFT))
547
548 /** @} lu_dir */
549
550 struct lustre_handle {
551         __u64 cookie;
552 };
553 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
554
555 static inline bool lustre_handle_is_used(const struct lustre_handle *lh)
556 {
557         return lh->cookie != 0;
558 }
559
560 static inline bool lustre_handle_equal(const struct lustre_handle *lh1,
561                                        const 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                                       const struct lustre_handle *src)
568 {
569         tgt->cookie = src->cookie;
570 }
571
572 struct lustre_handle_array {
573         unsigned int            count;
574         struct lustre_handle    handles[0];
575 };
576
577 /* flags for lm_flags */
578 #define MSGHDR_AT_SUPPORT               0x1
579 #define MSGHDR_CKSUM_INCOMPAT18         0x2
580
581 #define lustre_msg lustre_msg_v2
582 /* we depend on this structure to be 8-byte aligned */
583 /* this type is only endian-adjusted in lustre_unpack_msg() */
584 struct lustre_msg_v2 {
585         __u32 lm_bufcount;
586         __u32 lm_secflvr;
587         __u32 lm_magic;
588         __u32 lm_repsize;
589         __u32 lm_cksum;
590         __u32 lm_flags;
591         __u32 lm_padding_2;
592         __u32 lm_padding_3;
593         __u32 lm_buflens[0];
594 };
595
596 /* without gss, ptlrpc_body is put at the first buffer. */
597 #define PTLRPC_NUM_VERSIONS     4
598 struct ptlrpc_body_v3 {
599         struct lustre_handle pb_handle;
600         __u32 pb_type;
601         __u32 pb_version;
602         __u32 pb_opc;
603         __u32 pb_status;
604         __u64 pb_last_xid; /* highest replied XID without lower unreplied XID */
605         __u16 pb_tag;      /* virtual slot idx for multiple modifying RPCs */
606         __u16 pb_padding0;
607         __u32 pb_padding1;
608         __u64 pb_last_committed;
609         __u64 pb_transno;
610         __u32 pb_flags;
611         __u32 pb_op_flags;
612         __u32 pb_conn_cnt;
613         __u32 pb_timeout;  /* for req, the deadline, for rep, the service est */
614         __u32 pb_service_time; /* for rep, actual service time */
615         __u32 pb_limit;
616         __u64 pb_slv;
617         /* VBR: pre-versions */
618         __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
619         __u64 pb_mbits; /**< match bits for bulk request */
620         /* padding for future needs */
621         __u64 pb_padding64_0;
622         __u64 pb_padding64_1;
623         __u64 pb_padding64_2;
624         char  pb_jobid[LUSTRE_JOBID_SIZE];
625 };
626 #define ptlrpc_body     ptlrpc_body_v3
627
628 struct ptlrpc_body_v2 {
629         struct lustre_handle pb_handle;
630         __u32 pb_type;
631         __u32 pb_version;
632         __u32 pb_opc;
633         __u32 pb_status;
634         __u64 pb_last_xid; /* highest replied XID without lower unreplied XID */
635         __u16 pb_tag;      /* virtual slot idx for multiple modifying RPCs */
636         __u16 pb_padding0;
637         __u32 pb_padding1;
638         __u64 pb_last_committed;
639         __u64 pb_transno;
640         __u32 pb_flags;
641         __u32 pb_op_flags;
642         __u32 pb_conn_cnt;
643         __u32 pb_timeout;  /* for req, the deadline, for rep, the service est */
644         __u32 pb_service_time; /* for rep, actual service time, also used for
645                                   net_latency of req */
646         __u32 pb_limit;
647         __u64 pb_slv;
648         /* VBR: pre-versions */
649         __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
650         __u64 pb_mbits; /**< unused in V2 */
651         /* padding for future needs */
652         __u64 pb_padding64_0;
653         __u64 pb_padding64_1;
654         __u64 pb_padding64_2;
655 };
656
657 /* message body offset for lustre_msg_v2 */
658 /* ptlrpc body offset in all request/reply messages */
659 #define MSG_PTLRPC_BODY_OFF             0
660
661 /* normal request/reply message record offset */
662 #define REQ_REC_OFF                     1
663 #define REPLY_REC_OFF                   1
664
665 /* ldlm request message body offset */
666 #define DLM_LOCKREQ_OFF                 1 /* lockreq offset */
667 #define DLM_REQ_REC_OFF                 2 /* normal dlm request record offset */
668
669 /* ldlm intent lock message body offset */
670 #define DLM_INTENT_IT_OFF               2 /* intent lock it offset */
671 #define DLM_INTENT_REC_OFF              3 /* intent lock record offset */
672
673 /* ldlm reply message body offset */
674 #define DLM_LOCKREPLY_OFF               1 /* lockrep offset */
675 #define DLM_REPLY_REC_OFF               2 /* reply record offset */
676
677 /** only use in req->rq_{req,rep}_swab_mask */
678 #define MSG_PTLRPC_HEADER_OFF           31
679
680 /* Flags that are operation-specific go in the top 16 bits. */
681 #define MSG_OP_FLAG_MASK   0xffff0000
682 #define MSG_OP_FLAG_SHIFT  16
683
684 /* Flags that apply to all requests are in the bottom 16 bits */
685 #define MSG_GEN_FLAG_MASK     0x0000ffff
686 #define MSG_LAST_REPLAY           0x0001
687 #define MSG_RESENT                0x0002
688 #define MSG_REPLAY                0x0004
689 /* #define MSG_AT_SUPPORT         0x0008
690  * This was used in early prototypes of adaptive timeouts, and while there
691  * shouldn't be any users of that code there also isn't a need for using this
692  * bits. Defer usage until at least 1.10 to avoid potential conflict. */
693 #define MSG_DELAY_REPLAY          0x0010
694 #define MSG_VERSION_REPLAY        0x0020
695 #define MSG_REQ_REPLAY_DONE       0x0040
696 #define MSG_LOCK_REPLAY_DONE      0x0080
697
698 /*
699  * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
700  */
701
702 #define MSG_CONNECT_RECOVERING  0x00000001
703 #define MSG_CONNECT_RECONNECT   0x00000002
704 #define MSG_CONNECT_REPLAYABLE  0x00000004
705 //#define MSG_CONNECT_PEER        0x8
706 #define MSG_CONNECT_LIBCLIENT   0x00000010
707 #define MSG_CONNECT_INITIAL     0x00000020
708 #define MSG_CONNECT_ASYNC       0x00000040
709 #define MSG_CONNECT_NEXT_VER    0x00000080 /* use next version of lustre_msg */
710 #define MSG_CONNECT_TRANSNO     0x00000100 /* report transno */
711
712 /* Connect flags */
713 #define OBD_CONNECT_RDONLY                0x1ULL /*client has read-only access*/
714 #define OBD_CONNECT_INDEX                 0x2ULL /*connect specific LOV idx */
715 #define OBD_CONNECT_MDS                   0x4ULL /*connect from MDT to OST */
716 #define OBD_CONNECT_GRANT                 0x8ULL /*OSC gets grant at connect */
717 #define OBD_CONNECT_SRVLOCK              0x10ULL /*server takes locks for cli */
718 #define OBD_CONNECT_VERSION              0x20ULL /*Lustre versions in ocd */
719 #define OBD_CONNECT_REQPORTAL            0x40ULL /*Separate non-IO req portal */
720 #define OBD_CONNECT_ACL                  0x80ULL /*access control lists */
721 #define OBD_CONNECT_XATTR               0x100ULL /*client use extended attr */
722 #define OBD_CONNECT_CROW                0x200ULL /*MDS+OST create obj on write*/
723 #define OBD_CONNECT_TRUNCLOCK           0x400ULL /*locks on server for punch */
724 #define OBD_CONNECT_TRANSNO             0x800ULL /*replay sends init transno */
725 #define OBD_CONNECT_IBITS              0x1000ULL /*support for inodebits locks*/
726 #define OBD_CONNECT_BARRIER            0x2000ULL /* write barrier */
727 #define OBD_CONNECT_ATTRFID            0x4000ULL /*Server can GetAttr By Fid*/
728 #define OBD_CONNECT_NODEVOH            0x8000ULL /*No open hndl on specl nodes*/
729 #define OBD_CONNECT_RMT_CLIENT        0x10000ULL /* Remote client, never used
730                                                   * in production. Removed in
731                                                   * 2.9. Keep this flag to
732                                                   * avoid reusing.
733                                                   */
734 #define OBD_CONNECT_RMT_CLIENT_FORCE  0x20000ULL /* Remote client by force,
735                                                   * never used in production.
736                                                   * Removed in 2.9. Keep this
737                                                   * flag to avoid reusing.
738                                                   */
739 #define OBD_CONNECT_BRW_SIZE          0x40000ULL /*Max bytes per rpc */
740 #define OBD_CONNECT_QUOTA64           0x80000ULL /*Not used since 2.4 */
741 #define OBD_CONNECT_MDS_CAPA         0x100000ULL /*MDS capability */
742 #define OBD_CONNECT_OSS_CAPA         0x200000ULL /*OSS capability */
743 #define OBD_CONNECT_CANCELSET        0x400000ULL /*Early batched cancels. */
744 #define OBD_CONNECT_SOM              0x800000ULL /*Size on MDS */
745 #define OBD_CONNECT_AT              0x1000000ULL /*client uses AT */
746 #define OBD_CONNECT_LRU_RESIZE      0x2000000ULL /*LRU resize feature. */
747 #define OBD_CONNECT_MDS_MDS         0x4000000ULL /*MDS-MDS connection */
748 #define OBD_CONNECT_REAL            0x8000000ULL /* obsolete since 2.8 */
749 #define OBD_CONNECT_CHANGE_QS      0x10000000ULL /*Not used since 2.4 */
750 #define OBD_CONNECT_CKSUM          0x20000000ULL /*support several cksum algos*/
751 #define OBD_CONNECT_FID            0x40000000ULL /*FID is supported by server */
752 #define OBD_CONNECT_VBR            0x80000000ULL /*version based recovery */
753 #define OBD_CONNECT_LOV_V3        0x100000000ULL /*client supports LOV v3 EA */
754 #define OBD_CONNECT_GRANT_SHRINK  0x200000000ULL /* support grant shrink */
755 #define OBD_CONNECT_SKIP_ORPHAN   0x400000000ULL /* don't reuse orphan objids */
756 #define OBD_CONNECT_MAX_EASIZE    0x800000000ULL /* preserved for large EA */
757 #define OBD_CONNECT_FULL20       0x1000000000ULL /* it is 2.0 client */
758 #define OBD_CONNECT_LAYOUTLOCK   0x2000000000ULL /* client uses layout lock */
759 #define OBD_CONNECT_64BITHASH    0x4000000000ULL /* client supports 64-bits
760                                                   * directory hash */
761 #define OBD_CONNECT_MAXBYTES     0x8000000000ULL /* max stripe size */
762 #define OBD_CONNECT_IMP_RECOV   0x10000000000ULL /* imp recovery support */
763 #define OBD_CONNECT_JOBSTATS    0x20000000000ULL /* jobid in ptlrpc_body */
764 #define OBD_CONNECT_UMASK       0x40000000000ULL /* create uses client umask */
765 #define OBD_CONNECT_EINPROGRESS 0x80000000000ULL /* client handles -EINPROGRESS
766                                                   * RPC error properly */
767 #define OBD_CONNECT_GRANT_PARAM 0x100000000000ULL/* extra grant params used for
768                                                   * finer space reservation */
769 #define OBD_CONNECT_FLOCK_OWNER 0x200000000000ULL /* for the fixed 1.8
770                                                    * policy and 2.x server */
771 #define OBD_CONNECT_LVB_TYPE    0x400000000000ULL /* variable type of LVB */
772 #define OBD_CONNECT_NANOSEC_TIME 0x800000000000ULL /* nanosecond timestamps */
773 #define OBD_CONNECT_LIGHTWEIGHT 0x1000000000000ULL/* lightweight connection */
774 #define OBD_CONNECT_SHORTIO     0x2000000000000ULL/* short io */
775 #define OBD_CONNECT_PINGLESS    0x4000000000000ULL/* pings not required */
776 #define OBD_CONNECT_FLOCK_DEAD  0x8000000000000ULL/* improved flock deadlock detection */
777 #define OBD_CONNECT_DISP_STRIPE 0x10000000000000ULL/* create stripe disposition*/
778 #define OBD_CONNECT_OPEN_BY_FID 0x20000000000000ULL /* open by fid won't pack
779                                                        name in request */
780 #define OBD_CONNECT_LFSCK      0x40000000000000ULL/* support online LFSCK */
781 #define OBD_CONNECT_UNLINK_CLOSE 0x100000000000000ULL/* close file in unlink */
782 #define OBD_CONNECT_MULTIMODRPCS 0x200000000000000ULL /* support multiple modify
783                                                          RPCs in parallel */
784 #define OBD_CONNECT_DIR_STRIPE   0x400000000000000ULL /* striped DNE dir */
785 #define OBD_CONNECT_SUBTREE     0x800000000000000ULL /* fileset mount */
786 #define OBD_CONNECT_LOCK_AHEAD   0x1000000000000000ULL /* lock ahead */
787 /** bulk matchbits is sent within ptlrpc_body */
788 #define OBD_CONNECT_BULK_MBITS   0x2000000000000000ULL
789 #define OBD_CONNECT_OBDOPACK     0x4000000000000000ULL /* compact OUT obdo */
790 #define OBD_CONNECT_FLAGS2       0x8000000000000000ULL /* second flags word */
791 /* ocd_connect_flags2 flags */
792 #define OBD_CONNECT2_FILE_SECCTX        0x1ULL /* set file security context at create */
793
794 /* XXX README XXX:
795  * Please DO NOT add flag values here before first ensuring that this same
796  * flag value is not in use on some other branch.  Please clear any such
797  * changes with senior engineers before starting to use a new flag.  Then,
798  * submit a small patch against EVERY branch that ONLY adds the new flag,
799  * updates obd_connect_names[] for lprocfs_rd_connect_flags(), adds the
800  * flag to check_obd_connect_data(), and updates wiretests accordingly, so it
801  * can be approved and landed easily to reserve the flag for future use. */
802
803 /* The MNE_SWAB flag is overloading the MDS_MDS bit only for the MGS
804  * connection.  It is a temporary bug fix for Imperative Recovery interop
805  * between 2.2 and 2.3 x86/ppc nodes, and can be removed when interop for
806  * 2.2 clients/servers is no longer needed.  LU-1252/LU-1644. */
807 #define OBD_CONNECT_MNE_SWAB             OBD_CONNECT_MDS_MDS
808
809 #define OCD_HAS_FLAG(ocd, flg)  \
810         (!!((ocd)->ocd_connect_flags & OBD_CONNECT_##flg))
811
812
813 #ifdef HAVE_LRU_RESIZE_SUPPORT
814 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
815 #else
816 #define LRU_RESIZE_CONNECT_FLAG 0
817 #endif
818
819 #define MDT_CONNECT_SUPPORTED  (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
820                                 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
821                                 OBD_CONNECT_IBITS | OBD_CONNECT_NODEVOH | \
822                                 OBD_CONNECT_ATTRFID | OBD_CONNECT_CANCELSET | \
823                                 OBD_CONNECT_AT | OBD_CONNECT_BRW_SIZE | \
824                                 OBD_CONNECT_MDS_MDS | OBD_CONNECT_FID | \
825                                 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_VBR | \
826                                 OBD_CONNECT_LOV_V3 | OBD_CONNECT_FULL20 | \
827                                 OBD_CONNECT_64BITHASH | OBD_CONNECT_JOBSTATS | \
828                                 OBD_CONNECT_EINPROGRESS | \
829                                 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_UMASK | \
830                                 OBD_CONNECT_LVB_TYPE | OBD_CONNECT_LAYOUTLOCK |\
831                                 OBD_CONNECT_PINGLESS | OBD_CONNECT_MAX_EASIZE |\
832                                 OBD_CONNECT_FLOCK_DEAD | \
833                                 OBD_CONNECT_DISP_STRIPE | OBD_CONNECT_LFSCK | \
834                                 OBD_CONNECT_OPEN_BY_FID | \
835                                 OBD_CONNECT_DIR_STRIPE | \
836                                 OBD_CONNECT_BULK_MBITS | \
837                                 OBD_CONNECT_MULTIMODRPCS | \
838                                 OBD_CONNECT_SUBTREE | \
839                                 OBD_CONNECT_FLAGS2)
840
841 #define MDT_CONNECT_SUPPORTED2 OBD_CONNECT2_FILE_SECCTX
842
843 #define OST_CONNECT_SUPPORTED  (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
844                                 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
845                                 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
846                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_CANCELSET | \
847                                 OBD_CONNECT_AT | LRU_RESIZE_CONNECT_FLAG | \
848                                 OBD_CONNECT_CKSUM | OBD_CONNECT_VBR | \
849                                 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
850                                 OBD_CONNECT_GRANT_SHRINK | OBD_CONNECT_FULL20 |\
851                                 OBD_CONNECT_64BITHASH | OBD_CONNECT_MAXBYTES | \
852                                 OBD_CONNECT_MAX_EASIZE | \
853                                 OBD_CONNECT_EINPROGRESS | \
854                                 OBD_CONNECT_JOBSTATS | \
855                                 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_LVB_TYPE|\
856                                 OBD_CONNECT_LAYOUTLOCK | OBD_CONNECT_FID | \
857                                 OBD_CONNECT_PINGLESS | OBD_CONNECT_LFSCK | \
858                                 OBD_CONNECT_BULK_MBITS | \
859                                 OBD_CONNECT_GRANT_PARAM)
860 #define OST_CONNECT_SUPPORTED2 0
861
862 #define ECHO_CONNECT_SUPPORTED 0
863 #define ECHO_CONNECT_SUPPORTED2 0
864
865 #define MGS_CONNECT_SUPPORTED  (OBD_CONNECT_VERSION | OBD_CONNECT_AT | \
866                                 OBD_CONNECT_FULL20 | OBD_CONNECT_IMP_RECOV | \
867                                 OBD_CONNECT_MNE_SWAB | OBD_CONNECT_PINGLESS |\
868                                 OBD_CONNECT_BULK_MBITS | OBD_CONNECT_BARRIER)
869
870 #define MGS_CONNECT_SUPPORTED2 0
871
872 /* Features required for this version of the client to work with server */
873 #define CLIENT_CONNECT_MDT_REQD (OBD_CONNECT_IBITS | OBD_CONNECT_FID | \
874                                  OBD_CONNECT_FULL20)
875
876 /* This structure is used for both request and reply.
877  *
878  * If we eventually have separate connect data for different types, which we
879  * almost certainly will, then perhaps we stick a union in here. */
880 struct obd_connect_data {
881         __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
882         __u32 ocd_version;       /* lustre release version number */
883         __u32 ocd_grant;         /* initial cache grant amount (bytes) */
884         __u32 ocd_index;         /* LOV index to connect to */
885         __u32 ocd_brw_size;      /* Maximum BRW size in bytes */
886         __u64 ocd_ibits_known;   /* inode bits this client understands */
887         __u8  ocd_grant_blkbits; /* log2 of the backend filesystem blocksize */
888         __u8  ocd_grant_inobits; /* log2 of the per-inode space consumption */
889         __u16 ocd_grant_tax_kb;  /* extent insertion overhead, in 1K blocks */
890         __u32 ocd_grant_max_blks;/* maximum number of blocks per extent */
891         __u64 ocd_transno;       /* first transno from client to be replayed */
892         __u32 ocd_group;         /* MDS group on OST */
893         __u32 ocd_cksum_types;   /* supported checksum algorithms */
894         __u32 ocd_max_easize;    /* How big LOV EA can be on MDS */
895         __u32 ocd_instance;      /* instance # of this target */
896         __u64 ocd_maxbytes;      /* Maximum stripe size in bytes */
897         /* Fields after ocd_maxbytes are only accessible by the receiver
898          * if the corresponding flag in ocd_connect_flags is set. Accessing
899          * any field after ocd_maxbytes on the receiver without a valid flag
900          * may result in out-of-bound memory access and kernel oops. */
901         __u16 ocd_maxmodrpcs;    /* Maximum modify RPCs in parallel */
902         __u16 padding0;          /* added 2.1.0. also fix lustre_swab_connect */
903         __u32 padding1;          /* added 2.1.0. also fix lustre_swab_connect */
904         __u64 ocd_connect_flags2;
905         __u64 padding3;          /* added 2.1.0. also fix lustre_swab_connect */
906         __u64 padding4;          /* added 2.1.0. also fix lustre_swab_connect */
907         __u64 padding5;          /* added 2.1.0. also fix lustre_swab_connect */
908         __u64 padding6;          /* added 2.1.0. also fix lustre_swab_connect */
909         __u64 padding7;          /* added 2.1.0. also fix lustre_swab_connect */
910         __u64 padding8;          /* added 2.1.0. also fix lustre_swab_connect */
911         __u64 padding9;          /* added 2.1.0. also fix lustre_swab_connect */
912         __u64 paddingA;          /* added 2.1.0. also fix lustre_swab_connect */
913         __u64 paddingB;          /* added 2.1.0. also fix lustre_swab_connect */
914         __u64 paddingC;          /* added 2.1.0. also fix lustre_swab_connect */
915         __u64 paddingD;          /* added 2.1.0. also fix lustre_swab_connect */
916         __u64 paddingE;          /* added 2.1.0. also fix lustre_swab_connect */
917         __u64 paddingF;          /* added 2.1.0. also fix lustre_swab_connect */
918 };
919 /* XXX README XXX:
920  * Please DO NOT use any fields here before first ensuring that this same
921  * field is not in use on some other branch.  Please clear any such changes
922  * with senior engineers before starting to use a new field.  Then, submit
923  * a small patch against EVERY branch that ONLY adds the new field along with
924  * the matching OBD_CONNECT flag, so that can be approved and landed easily to
925  * reserve the flag for future use. */
926
927 /*
928  * Supported checksum algorithms. Up to 32 checksum types are supported.
929  * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
930  * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
931  * algorithm and also the OBD_FL_CKSUM* flags.
932  */
933 typedef enum cksum_types {
934         OBD_CKSUM_CRC32 = 0x00000001,
935         OBD_CKSUM_ADLER = 0x00000002,
936         OBD_CKSUM_CRC32C= 0x00000004,
937 } cksum_type_t;
938
939 /*
940  *   OST requests: OBDO & OBD request records
941  */
942
943 /* opcodes */
944 typedef enum {
945         OST_REPLY      =  0,       /* reply ? */
946         OST_GETATTR    =  1,
947         OST_SETATTR    =  2,
948         OST_READ       =  3,
949         OST_WRITE      =  4,
950         OST_CREATE     =  5,
951         OST_DESTROY    =  6,
952         OST_GET_INFO   =  7,
953         OST_CONNECT    =  8,
954         OST_DISCONNECT =  9,
955         OST_PUNCH      = 10,
956         OST_OPEN       = 11,
957         OST_CLOSE      = 12,
958         OST_STATFS     = 13,
959         OST_SYNC       = 16,
960         OST_SET_INFO   = 17,
961         OST_QUOTACHECK = 18, /* not used since 2.4 */
962         OST_QUOTACTL   = 19,
963         OST_QUOTA_ADJUST_QUNIT = 20, /* not used since 2.4 */
964         OST_LADVISE    = 21,
965         OST_LAST_OPC /* must be < 33 to avoid MDS_GETATTR */
966 } ost_cmd_t;
967 #define OST_FIRST_OPC  OST_REPLY
968
969 enum obdo_flags {
970         OBD_FL_INLINEDATA   = 0x00000001,
971         OBD_FL_OBDMDEXISTS  = 0x00000002,
972         OBD_FL_DELORPHAN    = 0x00000004, /* if set in o_flags delete orphans */
973         OBD_FL_NORPC        = 0x00000008, /* set in o_flags do in OSC not OST */
974         OBD_FL_IDONLY       = 0x00000010, /* set in o_flags only adjust obj id*/
975         OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
976         OBD_FL_DEBUG_CHECK  = 0x00000040, /* echo client/server debug check */
977         OBD_FL_NO_PRJQUOTA  = 0x00000080, /* the object's project is over
978                                            * quota */
979         OBD_FL_NO_USRQUOTA  = 0x00000100, /* the object's owner is over quota */
980         OBD_FL_NO_GRPQUOTA  = 0x00000200, /* the object's group is over quota */
981         OBD_FL_CREATE_CROW  = 0x00000400, /* object should be create on write */
982         OBD_FL_SRVLOCK      = 0x00000800, /* delegate DLM locking to server */
983         OBD_FL_CKSUM_CRC32  = 0x00001000, /* CRC32 checksum type */
984         OBD_FL_CKSUM_ADLER  = 0x00002000, /* ADLER checksum type */
985         OBD_FL_CKSUM_CRC32C = 0x00004000, /* CRC32C checksum type */
986         OBD_FL_CKSUM_RSVD2  = 0x00008000, /* for future cksum types */
987         OBD_FL_CKSUM_RSVD3  = 0x00010000, /* for future cksum types */
988         OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
989         OBD_FL_MMAP         = 0x00040000, /* object is mmapped on the client.
990                                            * XXX: obsoleted - reserved for old
991                                            * clients prior than 2.2 */
992         OBD_FL_RECOV_RESEND = 0x00080000, /* recoverable resent */
993         OBD_FL_NOSPC_BLK    = 0x00100000, /* no more block space on OST */
994         OBD_FL_FLUSH        = 0x00200000, /* flush pages on the OST */
995         OBD_FL_SHORT_IO     = 0x00400000, /* short io request */
996         /* OBD_FL_LOCAL_MASK = 0xF0000000, was local-only flags until 2.10 */
997
998         /* Note that while these checksum values are currently separate bits,
999          * in 2.x we can actually allow all values from 1-31 if we wanted. */
1000         OBD_FL_CKSUM_ALL    = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER |
1001                               OBD_FL_CKSUM_CRC32C,
1002 };
1003
1004 /*
1005  * All LOV EA magics should have the same postfix, if some new version
1006  * Lustre instroduces new LOV EA magic, then when down-grade to an old
1007  * Lustre, even though the old version system does not recognizes such
1008  * new magic, it still can distinguish the corrupted cases by checking
1009  * the magic's postfix.
1010  */
1011 #define LOV_MAGIC_MAGIC 0x0BD0
1012 #define LOV_MAGIC_MASK  0xFFFF
1013
1014 #define LOV_MAGIC_V1            (0x0BD10000 | LOV_MAGIC_MAGIC)
1015 #define LOV_MAGIC_JOIN_V1       (0x0BD20000 | LOV_MAGIC_MAGIC)
1016 #define LOV_MAGIC_V3            (0x0BD30000 | LOV_MAGIC_MAGIC)
1017 #define LOV_MAGIC_MIGRATE       (0x0BD40000 | LOV_MAGIC_MAGIC)
1018 /* reserved for specifying OSTs */
1019 #define LOV_MAGIC_SPECIFIC      (0x0BD50000 | LOV_MAGIC_MAGIC)
1020 #define LOV_MAGIC               LOV_MAGIC_V1
1021 #define LOV_MAGIC_COMP_V1       (0x0BD60000 | LOV_MAGIC_MAGIC)
1022
1023 /*
1024  * magic for fully defined striping
1025  * the idea is that we should have different magics for striping "hints"
1026  * (struct lov_user_md_v[13]) and defined ready-to-use striping (struct
1027  * lov_mds_md_v[13]). at the moment the magics are used in wire protocol,
1028  * we can't just change it w/o long way preparation, but we still need a
1029  * mechanism to allow LOD to differentiate hint versus ready striping.
1030  * so, at the moment we do a trick: MDT knows what to expect from request
1031  * depending on the case (replay uses ready striping, non-replay req uses
1032  * hints), so MDT replaces magic with appropriate one and now LOD can
1033  * easily understand what's inside -bzzz
1034  *
1035  * those *_DEF magics are only used on server side internally, they
1036  * won't be put on wire or disk.
1037  */
1038 #define LOV_MAGIC_DEF           0x10000000
1039 #define LOV_MAGIC_V1_DEF        (LOV_MAGIC_DEF | LOV_MAGIC_V1)
1040 #define LOV_MAGIC_V3_DEF        (LOV_MAGIC_DEF | LOV_MAGIC_V3)
1041 #define LOV_MAGIC_COMP_V1_DEF   (LOV_MAGIC_DEF | LOV_MAGIC_COMP_V1)
1042
1043 #define lov_pattern(pattern)            (pattern & ~LOV_PATTERN_F_MASK)
1044 #define lov_pattern_flags(pattern)      (pattern & LOV_PATTERN_F_MASK)
1045
1046 #define lov_ost_data lov_ost_data_v1
1047 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
1048         struct ost_id l_ost_oi;   /* OST object ID */
1049         __u32 l_ost_gen;          /* generation of this l_ost_idx */
1050         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
1051 };
1052
1053 #define lov_mds_md lov_mds_md_v1
1054 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
1055         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
1056         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1057         struct ost_id   lmm_oi;   /* LOV object ID */
1058         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1059         /* lmm_stripe_count used to be __u32 */
1060         __u16 lmm_stripe_count;   /* num stripes in use for this object */
1061         __u16 lmm_layout_gen;     /* layout generation number */
1062         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1063 };
1064
1065 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
1066 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
1067
1068 /* This is the default MDT reply size allocated, should the striping be bigger,
1069  * it will be reallocated in mdt_fix_reply.
1070  * 100 stripes is a bit less than 2.5k of data */
1071 #define DEF_REP_MD_SIZE (sizeof(struct lov_mds_md) + \
1072                          100 * sizeof(struct lov_ost_data))
1073
1074 #define XATTR_NAME_ACL_ACCESS   "system.posix_acl_access"
1075 #define XATTR_NAME_ACL_DEFAULT  "system.posix_acl_default"
1076 #define XATTR_USER_PREFIX       "user."
1077 #define XATTR_TRUSTED_PREFIX    "trusted."
1078 #define XATTR_SECURITY_PREFIX   "security."
1079
1080 #define XATTR_NAME_LOV          "trusted.lov"
1081 #define XATTR_NAME_LMA          "trusted.lma"
1082 #define XATTR_NAME_LMV          "trusted.lmv"
1083 #define XATTR_NAME_DEFAULT_LMV  "trusted.dmv"
1084 #define XATTR_NAME_LINK         "trusted.link"
1085 #define XATTR_NAME_FID          "trusted.fid"
1086 #define XATTR_NAME_VERSION      "trusted.version"
1087 #define XATTR_NAME_SOM          "trusted.som"
1088 #define XATTR_NAME_HSM          "trusted.hsm"
1089 #define XATTR_NAME_LFSCK_BITMAP "trusted.lfsck_bitmap"
1090 #define XATTR_NAME_DUMMY        "trusted.dummy"
1091
1092 #define XATTR_NAME_LFSCK_NAMESPACE "trusted.lfsck_ns"
1093 #define XATTR_NAME_MAX_LEN      32 /* increase this, if there is longer name. */
1094
1095 struct lov_mds_md_v3 {            /* LOV EA mds/wire data (little-endian) */
1096         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V3 */
1097         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1098         struct ost_id   lmm_oi;   /* LOV object ID */
1099         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1100         /* lmm_stripe_count used to be __u32 */
1101         __u16 lmm_stripe_count;   /* num stripes in use for this object */
1102         __u16 lmm_layout_gen;     /* layout generation number */
1103         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* must be 32bit aligned */
1104         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1105 };
1106
1107 static inline __u32 lov_mds_md_size(__u16 stripes, __u32 lmm_magic)
1108 {
1109         if (stripes == (__u16)-1)
1110                 stripes = 0;
1111
1112         if (lmm_magic == LOV_MAGIC_V3)
1113                 return sizeof(struct lov_mds_md_v3) +
1114                                 stripes * sizeof(struct lov_ost_data_v1);
1115         else
1116                 return sizeof(struct lov_mds_md_v1) +
1117                                 stripes * sizeof(struct lov_ost_data_v1);
1118 }
1119
1120 static inline __u32
1121 lov_mds_md_max_stripe_count(size_t buf_size, __u32 lmm_magic)
1122 {
1123         switch (lmm_magic) {
1124         case LOV_MAGIC_V1: {
1125                 struct lov_mds_md_v1 lmm;
1126
1127                 if (buf_size < sizeof(lmm))
1128                         return 0;
1129
1130                 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1131         }
1132         case LOV_MAGIC_V3: {
1133                 struct lov_mds_md_v3 lmm;
1134
1135                 if (buf_size < sizeof(lmm))
1136                         return 0;
1137
1138                 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1139         }
1140         default:
1141                 return 0;
1142         }
1143 }
1144
1145 #define OBD_MD_FLID        (0x00000001ULL) /* object ID */
1146 #define OBD_MD_FLATIME     (0x00000002ULL) /* access time */
1147 #define OBD_MD_FLMTIME     (0x00000004ULL) /* data modification time */
1148 #define OBD_MD_FLCTIME     (0x00000008ULL) /* change time */
1149 #define OBD_MD_FLSIZE      (0x00000010ULL) /* size */
1150 #define OBD_MD_FLBLOCKS    (0x00000020ULL) /* allocated blocks count */
1151 #define OBD_MD_FLBLKSZ     (0x00000040ULL) /* block size */
1152 #define OBD_MD_FLMODE      (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1153 #define OBD_MD_FLTYPE      (0x00000100ULL) /* object type (mode & S_IFMT) */
1154 #define OBD_MD_FLUID       (0x00000200ULL) /* user ID */
1155 #define OBD_MD_FLGID       (0x00000400ULL) /* group ID */
1156 #define OBD_MD_FLFLAGS     (0x00000800ULL) /* flags word */
1157 #define OBD_MD_FLNLINK     (0x00002000ULL) /* link count */
1158 #define OBD_MD_FLGENER     (0x00004000ULL) /* generation number */
1159 /*#define OBD_MD_FLINLINE    (0x00008000ULL)  inline data. used until 1.6.5 */
1160 #define OBD_MD_FLRDEV      (0x00010000ULL) /* device number */
1161 #define OBD_MD_FLEASIZE    (0x00020000ULL) /* extended attribute data */
1162 #define OBD_MD_LINKNAME    (0x00040000ULL) /* symbolic link target */
1163 #define OBD_MD_FLHANDLE    (0x00080000ULL) /* file/lock handle */
1164 #define OBD_MD_FLCKSUM     (0x00100000ULL) /* bulk data checksum */
1165 #define OBD_MD_FLQOS       (0x00200000ULL) /* quality of service stats */
1166 /*      OBD_MD_FLCOOKIE    (0x00800000ULL)    obsolete in 2.8 */
1167 #define OBD_MD_FLPRJQUOTA  (0x00400000ULL) /* over quota flags sent from ost */
1168 #define OBD_MD_FLGROUP     (0x01000000ULL) /* group */
1169 #define OBD_MD_FLFID       (0x02000000ULL) /* ->ost write inline fid */
1170 #define OBD_MD_FLEPOCH     (0x04000000ULL) /* ->ost write with ioepoch */
1171                                            /* ->mds if epoch opens or closes */
1172 #define OBD_MD_FLGRANT     (0x08000000ULL) /* ost preallocation space grant */
1173 #define OBD_MD_FLDIREA     (0x10000000ULL) /* dir's extended attribute data */
1174 #define OBD_MD_FLUSRQUOTA  (0x20000000ULL) /* over quota flags sent from ost */
1175 #define OBD_MD_FLGRPQUOTA  (0x40000000ULL) /* over quota flags sent from ost */
1176 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1177
1178 #define OBD_MD_MDS         (0x0000000100000000ULL) /* where an inode lives on */
1179 #define OBD_MD_REINT       (0x0000000200000000ULL) /* reintegrate oa */
1180 #define OBD_MD_MEA         (0x0000000400000000ULL) /* CMD split EA  */
1181 #define OBD_MD_TSTATE      (0x0000000800000000ULL) /* transient state field */
1182
1183 #define OBD_MD_FLXATTR       (0x0000001000000000ULL) /* xattr */
1184 #define OBD_MD_FLXATTRLS     (0x0000002000000000ULL) /* xattr list */
1185 #define OBD_MD_FLXATTRRM     (0x0000004000000000ULL) /* xattr remove */
1186 #define OBD_MD_FLACL         (0x0000008000000000ULL) /* ACL */
1187 /*      OBD_MD_FLRMTPERM     (0x0000010000000000ULL) remote perm, obsolete */
1188 #define OBD_MD_FLMDSCAPA     (0x0000020000000000ULL) /* MDS capability */
1189 #define OBD_MD_FLOSSCAPA     (0x0000040000000000ULL) /* OSS capability */
1190 #define OBD_MD_FLCKSPLIT     (0x0000080000000000ULL) /* Check split on server */
1191 #define OBD_MD_FLCROSSREF    (0x0000100000000000ULL) /* Cross-ref case */
1192 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1193                                                       * under lock; for xattr
1194                                                       * requests means the
1195                                                       * client holds the lock */
1196 #define OBD_MD_FLOBJCOUNT    (0x0000400000000000ULL) /* for multiple destroy */
1197
1198 #define OBD_MD_FLDATAVERSION (0x0010000000000000ULL) /* iversion sum */
1199 #define OBD_MD_CLOSE_INTENT_EXECED (0x0020000000000000ULL) /* close intent
1200                                                               executed */
1201
1202 #define OBD_MD_DEFAULT_MEA   (0x0040000000000000ULL) /* default MEA */
1203 #define OBD_MD_FLOSTLAYOUT   (0x0080000000000000ULL) /* contain ost_layout */
1204 #define OBD_MD_FLPROJID      (0x0100000000000000ULL) /* project ID */
1205
1206 #define OBD_MD_FLALLQUOTA (OBD_MD_FLUSRQUOTA | \
1207                            OBD_MD_FLGRPQUOTA | \
1208                            OBD_MD_FLPRJQUOTA)
1209
1210 #define OBD_MD_FLGETATTR (OBD_MD_FLID    | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1211                           OBD_MD_FLCTIME | OBD_MD_FLSIZE  | OBD_MD_FLBLKSZ | \
1212                           OBD_MD_FLMODE  | OBD_MD_FLTYPE  | OBD_MD_FLUID   | \
1213                           OBD_MD_FLGID   | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1214                           OBD_MD_FLGENER | OBD_MD_FLRDEV  | OBD_MD_FLGROUP | \
1215                           OBD_MD_FLPROJID)
1216
1217 #define OBD_MD_FLXATTRALL (OBD_MD_FLXATTR | OBD_MD_FLXATTRLS)
1218
1219 /* don't forget obdo_fid which is way down at the bottom so it can
1220  * come after the definition of llog_cookie */
1221
1222 enum hss_valid {
1223         HSS_SETMASK     = 0x01,
1224         HSS_CLEARMASK   = 0x02,
1225         HSS_ARCHIVE_ID  = 0x04,
1226 };
1227
1228 struct hsm_state_set {
1229         __u32   hss_valid;
1230         __u32   hss_archive_id;
1231         __u64   hss_setmask;
1232         __u64   hss_clearmask;
1233 };
1234
1235 /* ost_body.data values for OST_BRW */
1236
1237 #define OBD_BRW_READ            0x01
1238 #define OBD_BRW_WRITE           0x02
1239 #define OBD_BRW_RWMASK          (OBD_BRW_READ | OBD_BRW_WRITE)
1240 #define OBD_BRW_SYNC            0x08 /* this page is a part of synchronous
1241                                       * transfer and is not accounted in
1242                                       * the grant. */
1243 #define OBD_BRW_CHECK           0x10
1244 #define OBD_BRW_FROM_GRANT      0x20 /* the osc manages this under llite */
1245 #define OBD_BRW_GRANTED         0x40 /* the ost manages this */
1246 #define OBD_BRW_NOCACHE         0x80 /* this page is a part of non-cached IO */
1247 #define OBD_BRW_NOQUOTA        0x100
1248 #define OBD_BRW_SRVLOCK        0x200 /* Client holds no lock over this page */
1249 #define OBD_BRW_ASYNC          0x400 /* Server may delay commit to disk */
1250 #define OBD_BRW_MEMALLOC       0x800 /* Client runs in the "kswapd" context */
1251 #define OBD_BRW_OVER_USRQUOTA 0x1000 /* Running out of user quota */
1252 #define OBD_BRW_OVER_GRPQUOTA 0x2000 /* Running out of group quota */
1253 #define OBD_BRW_SOFT_SYNC     0x4000 /* This flag notifies the server
1254                                       * that the client is running low on
1255                                       * space for unstable pages; asking
1256                                       * it to sync quickly */
1257 #define OBD_BRW_OVER_PRJQUOTA 0x8000 /* Running out of project quota */
1258
1259 #define OBD_BRW_OVER_ALLQUOTA (OBD_BRW_OVER_USRQUOTA | \
1260                                OBD_BRW_OVER_GRPQUOTA | \
1261                                OBD_BRW_OVER_PRJQUOTA)
1262
1263 #define OBD_OBJECT_EOF LUSTRE_EOF
1264
1265 #define OST_MIN_PRECREATE 32
1266 #define OST_MAX_PRECREATE 20000
1267
1268 struct obd_ioobj {
1269         struct ost_id   ioo_oid;        /* object ID, if multi-obj BRW */
1270         __u32           ioo_max_brw;    /* low 16 bits were o_mode before 2.4,
1271                                          * now (PTLRPC_BULK_OPS_COUNT - 1) in
1272                                          * high 16 bits in 2.4 and later */
1273         __u32           ioo_bufcnt;     /* number of niobufs for this object */
1274 };
1275
1276 /* NOTE: IOOBJ_MAX_BRW_BITS defines the _offset_ of the max_brw field in
1277  * ioo_max_brw, NOT the maximum number of bits in PTLRPC_BULK_OPS_BITS.
1278  * That said, ioo_max_brw is a 32-bit field so the limit is also 16 bits. */
1279 #define IOOBJ_MAX_BRW_BITS      16
1280 #define ioobj_max_brw_get(ioo)  (((ioo)->ioo_max_brw >> IOOBJ_MAX_BRW_BITS) + 1)
1281 #define ioobj_max_brw_set(ioo, num)                                     \
1282 do { (ioo)->ioo_max_brw = ((num) - 1) << IOOBJ_MAX_BRW_BITS; } while (0)
1283
1284 /* multiple of 8 bytes => can array */
1285 struct niobuf_remote {
1286         __u64   rnb_offset;
1287         __u32   rnb_len;
1288         __u32   rnb_flags;
1289 };
1290
1291 /* lock value block communicated between the filter and llite */
1292
1293 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1294  * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1295 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1296 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1297 #define OST_LVB_IS_ERR(blocks)                                          \
1298         ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1299 #define OST_LVB_SET_ERR(blocks, rc)                                     \
1300         do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1301 #define OST_LVB_GET_ERR(blocks)    (int)(blocks - OST_LVB_ERR_INIT)
1302
1303 struct ost_lvb_v1 {
1304         __u64   lvb_size;
1305         __s64   lvb_mtime;
1306         __s64   lvb_atime;
1307         __s64   lvb_ctime;
1308         __u64   lvb_blocks;
1309 };
1310
1311 struct ost_lvb {
1312         __u64   lvb_size;
1313         __s64   lvb_mtime;
1314         __s64   lvb_atime;
1315         __s64   lvb_ctime;
1316         __u64   lvb_blocks;
1317         __u32   lvb_mtime_ns;
1318         __u32   lvb_atime_ns;
1319         __u32   lvb_ctime_ns;
1320         __u32   lvb_padding;
1321 };
1322
1323 /*
1324  *   lquota data structures
1325  */
1326
1327 #ifndef QUOTABLOCK_BITS
1328 # define QUOTABLOCK_BITS LUSTRE_QUOTABLOCK_BITS
1329 #endif
1330
1331 #ifndef QUOTABLOCK_SIZE
1332 # define QUOTABLOCK_SIZE LUSTRE_QUOTABLOCK_SIZE
1333 #endif
1334
1335 #ifndef toqb
1336 # define toqb lustre_stoqb
1337 #endif
1338
1339 /* The lquota_id structure is an union of all the possible identifier types that
1340  * can be used with quota, this includes:
1341  * - 64-bit user ID
1342  * - 64-bit group ID
1343  * - a FID which can be used for per-directory quota in the future */
1344 union lquota_id {
1345         struct lu_fid   qid_fid; /* FID for per-directory quota */
1346         __u64           qid_uid; /* user identifier */
1347         __u64           qid_gid; /* group identifier */
1348 };
1349
1350 /* quotactl management */
1351 struct obd_quotactl {
1352         __u32                   qc_cmd;
1353         __u32                   qc_type; /* see Q_* flag below */
1354         __u32                   qc_id;
1355         __u32                   qc_stat;
1356         struct obd_dqinfo       qc_dqinfo;
1357         struct obd_dqblk        qc_dqblk;
1358 };
1359
1360 #define Q_COPY(out, in, member) (out)->member = (in)->member
1361
1362 #define QCTL_COPY(out, in)              \
1363 do {                                    \
1364         Q_COPY(out, in, qc_cmd);        \
1365         Q_COPY(out, in, qc_type);       \
1366         Q_COPY(out, in, qc_id);         \
1367         Q_COPY(out, in, qc_stat);       \
1368         Q_COPY(out, in, qc_dqinfo);     \
1369         Q_COPY(out, in, qc_dqblk);      \
1370 } while (0)
1371
1372 /* Body of quota request used for quota acquire/release RPCs between quota
1373  * master (aka QMT) and slaves (ak QSD). */
1374 struct quota_body {
1375         struct lu_fid   qb_fid;     /* FID of global index packing the pool ID
1376                                       * and type (data or metadata) as well as
1377                                       * the quota type (user or group). */
1378         union lquota_id qb_id;      /* uid or gid or directory FID */
1379         __u32           qb_flags;   /* see below */
1380         __u32           qb_padding;
1381         __u64           qb_count;   /* acquire/release count (kbytes/inodes) */
1382         __u64           qb_usage;   /* current slave usage (kbytes/inodes) */
1383         __u64           qb_slv_ver; /* slave index file version */
1384         struct lustre_handle    qb_lockh;     /* per-ID lock handle */
1385         struct lustre_handle    qb_glb_lockh; /* global lock handle */
1386         __u64           qb_padding1[4];
1387 };
1388
1389 /* When the quota_body is used in the reply of quota global intent
1390  * lock (IT_QUOTA_CONN) reply, qb_fid contains slave index file FID. */
1391 #define qb_slv_fid      qb_fid
1392 /* qb_usage is the current qunit (in kbytes/inodes) when quota_body is used in
1393  * quota reply */
1394 #define qb_qunit        qb_usage
1395
1396 #define QUOTA_DQACQ_FL_ACQ      0x1  /* acquire quota */
1397 #define QUOTA_DQACQ_FL_PREACQ   0x2  /* pre-acquire */
1398 #define QUOTA_DQACQ_FL_REL      0x4  /* release quota */
1399 #define QUOTA_DQACQ_FL_REPORT   0x8  /* report usage */
1400
1401 /* Quota types currently supported */
1402 enum {
1403         LQUOTA_TYPE_USR = 0x00, /* maps to USRQUOTA */
1404         LQUOTA_TYPE_GRP = 0x01, /* maps to GRPQUOTA */
1405         LQUOTA_TYPE_PRJ = 0x02, /* maps to PRJQUOTA */
1406         LQUOTA_TYPE_MAX
1407 };
1408
1409 /* There are 2 different resource types on which a quota limit can be enforced:
1410  * - inodes on the MDTs
1411  * - blocks on the OSTs */
1412 enum {
1413         LQUOTA_RES_MD           = 0x01, /* skip 0 to avoid null oid in FID */
1414         LQUOTA_RES_DT           = 0x02,
1415         LQUOTA_LAST_RES,
1416         LQUOTA_FIRST_RES        = LQUOTA_RES_MD
1417 };
1418 #define LQUOTA_NR_RES (LQUOTA_LAST_RES - LQUOTA_FIRST_RES + 1)
1419
1420 /*
1421  * Space accounting support
1422  * Format of an accounting record, providing disk usage information for a given
1423  * user or group
1424  */
1425 struct lquota_acct_rec { /* 16 bytes */
1426         __u64 bspace;  /* current space in use */
1427         __u64 ispace;  /* current # inodes in use */
1428 };
1429
1430 /*
1431  * Global quota index support
1432  * Format of a global record, providing global quota settings for a given quota
1433  * identifier
1434  */
1435 struct lquota_glb_rec { /* 32 bytes */
1436         __u64 qbr_hardlimit; /* quota hard limit, in #inodes or kbytes */
1437         __u64 qbr_softlimit; /* quota soft limit, in #inodes or kbytes */
1438         __u64 qbr_time;      /* grace time, in seconds */
1439         __u64 qbr_granted;   /* how much is granted to slaves, in #inodes or
1440                               * kbytes */
1441 };
1442
1443 /*
1444  * Slave index support
1445  * Format of a slave record, recording how much space is granted to a given
1446  * slave
1447  */
1448 struct lquota_slv_rec { /* 8 bytes */
1449         __u64 qsr_granted; /* space granted to the slave for the key=ID,
1450                             * in #inodes or kbytes */
1451 };
1452
1453 /* Data structures associated with the quota locks */
1454
1455 /* Glimpse descriptor used for the index & per-ID quota locks */
1456 struct ldlm_gl_lquota_desc {
1457         union lquota_id gl_id;    /* quota ID subject to the glimpse */
1458         __u64           gl_flags; /* see LQUOTA_FL* below */
1459         __u64           gl_ver;   /* new index version */
1460         __u64           gl_hardlimit; /* new hardlimit or qunit value */
1461         __u64           gl_softlimit; /* new softlimit */
1462         __u64           gl_time;
1463         __u64           gl_pad2;
1464 };
1465 #define gl_qunit        gl_hardlimit /* current qunit value used when
1466                                       * glimpsing per-ID quota locks */
1467
1468 /* quota glimpse flags */
1469 #define LQUOTA_FL_EDQUOT 0x1 /* user/group out of quota space on QMT */
1470
1471 /* LVB used with quota (global and per-ID) locks */
1472 struct lquota_lvb {
1473         __u64   lvb_flags;      /* see LQUOTA_FL* above */
1474         __u64   lvb_id_may_rel; /* space that might be released later */
1475         __u64   lvb_id_rel;     /* space released by the slave for this ID */
1476         __u64   lvb_id_qunit;   /* current qunit value */
1477         __u64   lvb_pad1;
1478 };
1479
1480 /* LVB used with global quota lock */
1481 #define lvb_glb_ver  lvb_id_may_rel /* current version of the global index */
1482
1483 /* op codes */
1484 typedef enum {
1485         QUOTA_DQACQ     = 601,
1486         QUOTA_DQREL     = 602,
1487         QUOTA_LAST_OPC
1488 } quota_cmd_t;
1489 #define QUOTA_FIRST_OPC QUOTA_DQACQ
1490
1491 /*
1492  *   MDS REQ RECORDS
1493  */
1494
1495 /* opcodes */
1496 typedef enum {
1497         MDS_GETATTR             = 33,
1498         MDS_GETATTR_NAME        = 34,
1499         MDS_CLOSE               = 35,
1500         MDS_REINT               = 36,
1501         MDS_READPAGE            = 37,
1502         MDS_CONNECT             = 38,
1503         MDS_DISCONNECT          = 39,
1504         MDS_GET_ROOT            = 40,
1505         MDS_STATFS              = 41,
1506         MDS_PIN                 = 42, /* obsolete, never used in a release */
1507         MDS_UNPIN               = 43, /* obsolete, never used in a release */
1508         MDS_SYNC                = 44,
1509         MDS_DONE_WRITING        = 45, /* obsolete since 2.8.0 */
1510         MDS_SET_INFO            = 46,
1511         MDS_QUOTACHECK          = 47, /* not used since 2.4 */
1512         MDS_QUOTACTL            = 48,
1513         MDS_GETXATTR            = 49,
1514         MDS_SETXATTR            = 50, /* obsolete, now it's MDS_REINT op */
1515         MDS_WRITEPAGE           = 51,
1516         MDS_IS_SUBDIR           = 52, /* obsolete, never used in a release */
1517         MDS_GET_INFO            = 53,
1518         MDS_HSM_STATE_GET       = 54,
1519         MDS_HSM_STATE_SET       = 55,
1520         MDS_HSM_ACTION          = 56,
1521         MDS_HSM_PROGRESS        = 57,
1522         MDS_HSM_REQUEST         = 58,
1523         MDS_HSM_CT_REGISTER     = 59,
1524         MDS_HSM_CT_UNREGISTER   = 60,
1525         MDS_SWAP_LAYOUTS        = 61,
1526         MDS_LAST_OPC
1527 } mds_cmd_t;
1528
1529 #define MDS_FIRST_OPC    MDS_GETATTR
1530
1531
1532 /* opcodes for object update */
1533 typedef enum {
1534         OUT_UPDATE      = 1000,
1535         OUT_UPDATE_LAST_OPC
1536 } update_cmd_t;
1537
1538 #define OUT_UPDATE_FIRST_OPC    OUT_UPDATE
1539
1540 /*
1541  * Do not exceed 63
1542  */
1543
1544 typedef enum {
1545         REINT_SETATTR  = 1,
1546         REINT_CREATE   = 2,
1547         REINT_LINK     = 3,
1548         REINT_UNLINK   = 4,
1549         REINT_RENAME   = 5,
1550         REINT_OPEN     = 6,
1551         REINT_SETXATTR = 7,
1552         REINT_RMENTRY  = 8,
1553         REINT_MIGRATE  = 9,
1554         REINT_MAX
1555 } mds_reint_t, mdt_reint_t;
1556
1557 /* the disposition of the intent outlines what was executed */
1558 #define DISP_IT_EXECD        0x00000001
1559 #define DISP_LOOKUP_EXECD    0x00000002
1560 #define DISP_LOOKUP_NEG      0x00000004
1561 #define DISP_LOOKUP_POS      0x00000008
1562 #define DISP_OPEN_CREATE     0x00000010
1563 #define DISP_OPEN_OPEN       0x00000020
1564 #define DISP_ENQ_COMPLETE    0x00400000         /* obsolete and unused */
1565 #define DISP_ENQ_OPEN_REF    0x00800000
1566 #define DISP_ENQ_CREATE_REF  0x01000000
1567 #define DISP_OPEN_LOCK       0x02000000
1568 #define DISP_OPEN_LEASE      0x04000000
1569 #define DISP_OPEN_STRIPE     0x08000000
1570 #define DISP_OPEN_DENY       0x10000000
1571
1572 /* INODE LOCK PARTS */
1573 #define MDS_INODELOCK_LOOKUP 0x000001   /* For namespace, dentry etc, and also
1574                                          * was used to protect permission (mode,
1575                                          * owner, group etc) before 2.4. */
1576 #define MDS_INODELOCK_UPDATE 0x000002   /* size, links, timestamps */
1577 #define MDS_INODELOCK_OPEN   0x000004   /* For opened files */
1578 #define MDS_INODELOCK_LAYOUT 0x000008   /* for layout */
1579
1580 /* The PERM bit is added int 2.4, and it is used to protect permission(mode,
1581  * owner, group, acl etc), so to separate the permission from LOOKUP lock.
1582  * Because for remote directories(in DNE), these locks will be granted by
1583  * different MDTs(different ldlm namespace).
1584  *
1585  * For local directory, MDT will always grant UPDATE_LOCK|PERM_LOCK together.
1586  * For Remote directory, the master MDT, where the remote directory is, will
1587  * grant UPDATE_LOCK|PERM_LOCK, and the remote MDT, where the name entry is,
1588  * will grant LOOKUP_LOCK. */
1589 #define MDS_INODELOCK_PERM   0x000010
1590 #define MDS_INODELOCK_XATTR  0x000020   /* extended attributes */
1591
1592 #define MDS_INODELOCK_MAXSHIFT 5
1593 /* This FULL lock is useful to take on unlink sort of operations */
1594 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
1595
1596 /* NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
1597  * but was moved into name[1] along with the OID to avoid consuming the
1598  * name[2,3] fields that need to be used for the quota id (also a FID). */
1599 enum {
1600         LUSTRE_RES_ID_SEQ_OFF = 0,
1601         LUSTRE_RES_ID_VER_OID_OFF = 1,
1602         LUSTRE_RES_ID_WAS_VER_OFF = 2, /* see note above */
1603         LUSTRE_RES_ID_QUOTA_SEQ_OFF = 2,
1604         LUSTRE_RES_ID_QUOTA_VER_OID_OFF = 3,
1605         LUSTRE_RES_ID_HSH_OFF = 3
1606 };
1607
1608 #define MDS_STATUS_CONN 1
1609 #define MDS_STATUS_LOV 2
1610
1611 enum {
1612         /* these should be identical to their EXT4_*_FL counterparts, they are
1613          * redefined here only to avoid dragging in fs/ext4/ext4.h */
1614         LUSTRE_SYNC_FL = 0x00000008, /* Synchronous updates */
1615         LUSTRE_IMMUTABLE_FL = 0x00000010, /* Immutable file */
1616         LUSTRE_APPEND_FL = 0x00000020, /* writes to file may only append */
1617         LUSTRE_NODUMP_FL = 0x00000040, /* do not dump file */
1618         LUSTRE_NOATIME_FL = 0x00000080, /* do not update atime */
1619         LUSTRE_INDEX_FL = 0x00001000, /* hash-indexed directory */
1620         LUSTRE_DIRSYNC_FL = 0x00010000, /* dirsync behaviour (dir only) */
1621         LUSTRE_TOPDIR_FL = 0x00020000, /* Top of directory hierarchies*/
1622         LUSTRE_DIRECTIO_FL = 0x00100000, /* Use direct i/o */
1623         LUSTRE_INLINE_DATA_FL = 0x10000000, /* Inode has inline data. */
1624
1625         /* These flags will not be identical to any EXT4_*_FL counterparts,
1626          * and only reserved for lustre purpose. Note: these flags might
1627          * be conflict with some of EXT4 flags, so
1628          * 1. these conflict flags needs to be removed when the flag is
1629          * wired by la_flags see osd_attr_get().
1630          * 2. If these flags needs to be stored into inode, they will be
1631          * stored in LMA. see LMAI_XXXX */
1632         LUSTRE_ORPHAN_FL = 0x00002000,
1633
1634         LUSTRE_LMA_FL_MASKS = LUSTRE_ORPHAN_FL,
1635 };
1636
1637 #ifdef __KERNEL__
1638 /* Convert wire LUSTRE_*_FL to corresponding client local VFS S_* values
1639  * for the client inode i_flags.  The LUSTRE_*_FL are the Lustre wire
1640  * protocol equivalents of LDISKFS_*_FL values stored on disk, while
1641  * the S_* flags are kernel-internal values that change between kernel
1642  * versions.  These flags are set/cleared via FSFILT_IOC_{GET,SET}_FLAGS.
1643  * See b=16526 for a full history. */
1644 static inline int ll_ext_to_inode_flags(int flags)
1645 {
1646         return (((flags & LUSTRE_SYNC_FL)      ? S_SYNC      : 0) |
1647                 ((flags & LUSTRE_NOATIME_FL)   ? S_NOATIME   : 0) |
1648                 ((flags & LUSTRE_APPEND_FL)    ? S_APPEND    : 0) |
1649 #if defined(S_DIRSYNC)
1650                 ((flags & LUSTRE_DIRSYNC_FL)   ? S_DIRSYNC   : 0) |
1651 #endif
1652                 ((flags & LUSTRE_IMMUTABLE_FL) ? S_IMMUTABLE : 0));
1653 }
1654
1655 static inline int ll_inode_to_ext_flags(int iflags)
1656 {
1657         return (((iflags & S_SYNC)      ? LUSTRE_SYNC_FL      : 0) |
1658                 ((iflags & S_NOATIME)   ? LUSTRE_NOATIME_FL   : 0) |
1659                 ((iflags & S_APPEND)    ? LUSTRE_APPEND_FL    : 0) |
1660 #if defined(S_DIRSYNC)
1661                 ((iflags & S_DIRSYNC)   ? LUSTRE_DIRSYNC_FL   : 0) |
1662 #endif
1663                 ((iflags & S_IMMUTABLE) ? LUSTRE_IMMUTABLE_FL : 0));
1664 }
1665 #endif
1666
1667 /* 64 possible states */
1668 enum md_transient_state {
1669         MS_RESTORE      = (1 << 0),     /* restore is running */
1670 };
1671
1672 struct mdt_body {
1673         struct lu_fid mbo_fid1;
1674         struct lu_fid mbo_fid2;
1675         struct lustre_handle mbo_handle;
1676         __u64   mbo_valid;
1677         __u64   mbo_size; /* Offset, in the case of MDS_READPAGE */
1678         __s64   mbo_mtime;
1679         __s64   mbo_atime;
1680         __s64   mbo_ctime;
1681         __u64   mbo_blocks; /* XID, in the case of MDS_READPAGE */
1682         __u64   mbo_ioepoch;
1683         __u64   mbo_t_state; /* transient file state defined in
1684                               * enum md_transient_state
1685                               * was "ino" until 2.4.0 */
1686         __u32   mbo_fsuid;
1687         __u32   mbo_fsgid;
1688         __u32   mbo_capability;
1689         __u32   mbo_mode;
1690         __u32   mbo_uid;
1691         __u32   mbo_gid;
1692         __u32   mbo_flags;   /* LUSTRE_*_FL file attributes */
1693         __u32   mbo_rdev;
1694         __u32   mbo_nlink; /* #bytes to read in the case of MDS_READPAGE */
1695         __u32   mbo_unused2; /* was "generation" until 2.4.0 */
1696         __u32   mbo_suppgid;
1697         __u32   mbo_eadatasize;
1698         __u32   mbo_aclsize;
1699         __u32   mbo_max_mdsize;
1700         __u32   mbo_unused3; /* was max_cookiesize until 2.8 */
1701         __u32   mbo_uid_h; /* high 32-bits of uid, for FUID */
1702         __u32   mbo_gid_h; /* high 32-bits of gid, for FUID */
1703         __u32   mbo_projid;
1704         __u64   mbo_padding_6; /* also fix lustre_swab_mdt_body */
1705         __u64   mbo_padding_7;
1706         __u64   mbo_padding_8;
1707         __u64   mbo_padding_9;
1708         __u64   mbo_padding_10;
1709 }; /* 216 */
1710
1711 struct mdt_ioepoch {
1712         struct lustre_handle mio_handle;
1713         __u64 mio_unused1; /* was ioepoch */
1714         __u32 mio_unused2; /* was flags */
1715         __u32 mio_padding;
1716 };
1717
1718 /* permissions for md_perm.mp_perm */
1719 enum {
1720         CFS_SETUID_PERM = 0x01,
1721         CFS_SETGID_PERM = 0x02,
1722         CFS_SETGRP_PERM = 0x04,
1723 };
1724
1725 struct mdt_rec_setattr {
1726         __u32           sa_opcode;
1727         __u32           sa_cap;
1728         __u32           sa_fsuid;
1729         __u32           sa_fsuid_h;
1730         __u32           sa_fsgid;
1731         __u32           sa_fsgid_h;
1732         __u32           sa_suppgid;
1733         __u32           sa_suppgid_h;
1734         __u32           sa_padding_1;
1735         __u32           sa_padding_1_h;
1736         struct lu_fid   sa_fid;
1737         __u64           sa_valid;
1738         __u32           sa_uid;
1739         __u32           sa_gid;
1740         __u64           sa_size;
1741         __u64           sa_blocks;
1742         __s64           sa_mtime;
1743         __s64           sa_atime;
1744         __s64           sa_ctime;
1745         __u32           sa_attr_flags;
1746         __u32           sa_mode;
1747         __u32           sa_bias;      /* some operation flags */
1748         __u32           sa_projid;
1749         __u32           sa_padding_4;
1750         __u32           sa_padding_5;
1751 };
1752
1753 /*
1754  * Attribute flags used in mdt_rec_setattr::sa_valid.
1755  * The kernel's #defines for ATTR_* should not be used over the network
1756  * since the client and MDS may run different kernels (see bug 13828)
1757  * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1758  */
1759 #define MDS_ATTR_MODE          0x1ULL /* = 1 */
1760 #define MDS_ATTR_UID           0x2ULL /* = 2 */
1761 #define MDS_ATTR_GID           0x4ULL /* = 4 */
1762 #define MDS_ATTR_SIZE          0x8ULL /* = 8 */
1763 #define MDS_ATTR_ATIME        0x10ULL /* = 16 */
1764 #define MDS_ATTR_MTIME        0x20ULL /* = 32 */
1765 #define MDS_ATTR_CTIME        0x40ULL /* = 64 */
1766 #define MDS_ATTR_ATIME_SET    0x80ULL /* = 128 */
1767 #define MDS_ATTR_MTIME_SET   0x100ULL /* = 256 */
1768 #define MDS_ATTR_FORCE       0x200ULL /* = 512, Not a change, but a change it */
1769 #define MDS_ATTR_ATTR_FLAG   0x400ULL /* = 1024 */
1770 #define MDS_ATTR_KILL_SUID   0x800ULL /* = 2048 */
1771 #define MDS_ATTR_KILL_SGID  0x1000ULL /* = 4096 */
1772 #define MDS_ATTR_CTIME_SET  0x2000ULL /* = 8192 */
1773 #define MDS_ATTR_FROM_OPEN  0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
1774 #define MDS_ATTR_BLOCKS     0x8000ULL /* = 32768 */
1775 #define MDS_ATTR_PROJID     0x10000ULL  /* = 65536 */
1776
1777 #ifndef FMODE_READ
1778 #define FMODE_READ               00000001
1779 #define FMODE_WRITE              00000002
1780 #endif
1781
1782 #define MDS_FMODE_CLOSED         00000000
1783 #define MDS_FMODE_EXEC           00000004
1784 /*      MDS_FMODE_EPOCH          01000000 obsolete since 2.8.0 */
1785 /*      MDS_FMODE_TRUNC          02000000 obsolete since 2.8.0 */
1786 /*      MDS_FMODE_SOM            04000000 obsolete since 2.8.0 */
1787
1788 #define MDS_OPEN_CREATED         00000010
1789 #define MDS_OPEN_CROSS           00000020
1790
1791 #define MDS_OPEN_CREAT           00000100
1792 #define MDS_OPEN_EXCL            00000200
1793 #define MDS_OPEN_TRUNC           00001000
1794 #define MDS_OPEN_APPEND          00002000
1795 #define MDS_OPEN_SYNC            00010000
1796 #define MDS_OPEN_DIRECTORY       00200000
1797
1798 #define MDS_OPEN_BY_FID         040000000 /* open_by_fid for known object */
1799 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
1800 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1801 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file.
1802                                            * We do not support JOIN FILE
1803                                            * anymore, reserve this flags
1804                                            * just for preventing such bit
1805                                            * to be reused. */
1806
1807 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
1808 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
1809 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
1810 #define MDS_OPEN_NORESTORE  0100000000000ULL /* Do not restore file at open */
1811 #define MDS_OPEN_NEWSTRIPE  0200000000000ULL /* New stripe needed (restripe or
1812                                               * hsm restore) */
1813 #define MDS_OPEN_VOLATILE   0400000000000ULL /* File is volatile = created
1814                                                 unlinked */
1815 #define MDS_OPEN_LEASE     01000000000000ULL /* Open the file and grant lease
1816                                               * delegation, succeed if it's not
1817                                               * being opened with conflict mode.
1818                                               */
1819 #define MDS_OPEN_RELEASE   02000000000000ULL /* Open the file for HSM release */
1820
1821 /* lustre internal open flags, which should not be set from user space */
1822 #define MDS_OPEN_FL_INTERNAL (MDS_OPEN_HAS_EA | MDS_OPEN_HAS_OBJS |     \
1823                               MDS_OPEN_OWNEROVERRIDE | MDS_OPEN_LOCK |  \
1824                               MDS_OPEN_BY_FID | MDS_OPEN_LEASE |        \
1825                               MDS_OPEN_RELEASE)
1826
1827 enum mds_op_bias {
1828         MDS_CHECK_SPLIT         = 1 << 0,
1829         MDS_CROSS_REF           = 1 << 1,
1830         MDS_VTX_BYPASS          = 1 << 2,
1831         MDS_PERM_BYPASS         = 1 << 3,
1832 /*      MDS_SOM                 = 1 << 4, obsolete since 2.8.0 */
1833         MDS_QUOTA_IGNORE        = 1 << 5,
1834         /* Was MDS_CLOSE_CLEANUP (1 << 6), No more used */
1835         MDS_KEEP_ORPHAN         = 1 << 7,
1836         MDS_RECOV_OPEN          = 1 << 8,
1837         MDS_DATA_MODIFIED       = 1 << 9,
1838         MDS_CREATE_VOLATILE     = 1 << 10,
1839         MDS_OWNEROVERRIDE       = 1 << 11,
1840         MDS_HSM_RELEASE         = 1 << 12,
1841         MDS_RENAME_MIGRATE      = 1 << 13,
1842         MDS_CLOSE_LAYOUT_SWAP   = 1 << 14,
1843 };
1844
1845 /* instance of mdt_reint_rec */
1846 struct mdt_rec_create {
1847         __u32           cr_opcode;
1848         __u32           cr_cap;
1849         __u32           cr_fsuid;
1850         __u32           cr_fsuid_h;
1851         __u32           cr_fsgid;
1852         __u32           cr_fsgid_h;
1853         __u32           cr_suppgid1;
1854         __u32           cr_suppgid1_h;
1855         __u32           cr_suppgid2;
1856         __u32           cr_suppgid2_h;
1857         struct lu_fid   cr_fid1;
1858         struct lu_fid   cr_fid2;
1859         struct lustre_handle cr_old_handle; /* handle in case of open replay */
1860         __s64           cr_time;
1861         __u64           cr_rdev;
1862         __u64           cr_ioepoch;
1863         __u64           cr_padding_1;   /* rr_blocks */
1864         __u32           cr_mode;
1865         __u32           cr_bias;
1866         /* use of helpers set/get_mrc_cr_flags() is needed to access
1867          * 64 bits cr_flags [cr_flags_l, cr_flags_h], this is done to
1868          * extend cr_flags size without breaking 1.8 compat */
1869         __u32           cr_flags_l;     /* for use with open, low  32 bits  */
1870         __u32           cr_flags_h;     /* for use with open, high 32 bits */
1871         __u32           cr_umask;       /* umask for create */
1872         __u32           cr_padding_4;   /* rr_padding_4 */
1873 };
1874
1875 /* instance of mdt_reint_rec */
1876 struct mdt_rec_link {
1877         __u32           lk_opcode;
1878         __u32           lk_cap;
1879         __u32           lk_fsuid;
1880         __u32           lk_fsuid_h;
1881         __u32           lk_fsgid;
1882         __u32           lk_fsgid_h;
1883         __u32           lk_suppgid1;
1884         __u32           lk_suppgid1_h;
1885         __u32           lk_suppgid2;
1886         __u32           lk_suppgid2_h;
1887         struct lu_fid   lk_fid1;
1888         struct lu_fid   lk_fid2;
1889         __s64           lk_time;
1890         __u64           lk_padding_1;   /* rr_atime */
1891         __u64           lk_padding_2;   /* rr_ctime */
1892         __u64           lk_padding_3;   /* rr_size */
1893         __u64           lk_padding_4;   /* rr_blocks */
1894         __u32           lk_bias;
1895         __u32           lk_padding_5;   /* rr_mode */
1896         __u32           lk_padding_6;   /* rr_flags */
1897         __u32           lk_padding_7;   /* rr_padding_2 */
1898         __u32           lk_padding_8;   /* rr_padding_3 */
1899         __u32           lk_padding_9;   /* rr_padding_4 */
1900 };
1901
1902 /* instance of mdt_reint_rec */
1903 struct mdt_rec_unlink {
1904         __u32           ul_opcode;
1905         __u32           ul_cap;
1906         __u32           ul_fsuid;
1907         __u32           ul_fsuid_h;
1908         __u32           ul_fsgid;
1909         __u32           ul_fsgid_h;
1910         __u32           ul_suppgid1;
1911         __u32           ul_suppgid1_h;
1912         __u32           ul_suppgid2;
1913         __u32           ul_suppgid2_h;
1914         struct lu_fid   ul_fid1;
1915         struct lu_fid   ul_fid2;
1916         __s64           ul_time;
1917         __u64           ul_padding_2;   /* rr_atime */
1918         __u64           ul_padding_3;   /* rr_ctime */
1919         __u64           ul_padding_4;   /* rr_size */
1920         __u64           ul_padding_5;   /* rr_blocks */
1921         __u32           ul_bias;
1922         __u32           ul_mode;
1923         __u32           ul_padding_6;   /* rr_flags */
1924         __u32           ul_padding_7;   /* rr_padding_2 */
1925         __u32           ul_padding_8;   /* rr_padding_3 */
1926         __u32           ul_padding_9;   /* rr_padding_4 */
1927 };
1928
1929 /* instance of mdt_reint_rec */
1930 struct mdt_rec_rename {
1931         __u32           rn_opcode;
1932         __u32           rn_cap;
1933         __u32           rn_fsuid;
1934         __u32           rn_fsuid_h;
1935         __u32           rn_fsgid;
1936         __u32           rn_fsgid_h;
1937         __u32           rn_suppgid1;
1938         __u32           rn_suppgid1_h;
1939         __u32           rn_suppgid2;
1940         __u32           rn_suppgid2_h;
1941         struct lu_fid   rn_fid1;
1942         struct lu_fid   rn_fid2;
1943         __s64           rn_time;
1944         __u64           rn_padding_1;   /* rr_atime */
1945         __u64           rn_padding_2;   /* rr_ctime */
1946         __u64           rn_padding_3;   /* rr_size */
1947         __u64           rn_padding_4;   /* rr_blocks */
1948         __u32           rn_bias;        /* some operation flags */
1949         __u32           rn_mode;        /* cross-ref rename has mode */
1950         __u32           rn_padding_5;   /* rr_flags */
1951         __u32           rn_padding_6;   /* rr_padding_2 */
1952         __u32           rn_padding_7;   /* rr_padding_3 */
1953         __u32           rn_padding_8;   /* rr_padding_4 */
1954 };
1955
1956 /* instance of mdt_reint_rec */
1957 struct mdt_rec_setxattr {
1958         __u32           sx_opcode;
1959         __u32           sx_cap;
1960         __u32           sx_fsuid;
1961         __u32           sx_fsuid_h;
1962         __u32           sx_fsgid;
1963         __u32           sx_fsgid_h;
1964         __u32           sx_suppgid1;
1965         __u32           sx_suppgid1_h;
1966         __u32           sx_suppgid2;
1967         __u32           sx_suppgid2_h;
1968         struct lu_fid   sx_fid;
1969         __u64           sx_padding_1;   /* These three are rr_fid2 */
1970         __u32           sx_padding_2;
1971         __u32           sx_padding_3;
1972         __u64           sx_valid;
1973         __s64           sx_time;
1974         __u64           sx_padding_5;   /* rr_ctime */
1975         __u64           sx_padding_6;   /* rr_size */
1976         __u64           sx_padding_7;   /* rr_blocks */
1977         __u32           sx_size;
1978         __u32           sx_flags;
1979         __u32           sx_padding_8;   /* rr_flags */
1980         __u32           sx_padding_9;   /* rr_padding_2 */
1981         __u32           sx_padding_10;  /* rr_padding_3 */
1982         __u32           sx_padding_11;  /* rr_padding_4 */
1983 };
1984
1985 /*
1986  * mdt_rec_reint is the template for all mdt_reint_xxx structures.
1987  * Do NOT change the size of various members, otherwise the value
1988  * will be broken in lustre_swab_mdt_rec_reint().
1989  *
1990  * If you add new members in other mdt_reint_xxx structres and need to use the
1991  * rr_padding_x fields, then update lustre_swab_mdt_rec_reint() also.
1992  */
1993 struct mdt_rec_reint {
1994         __u32           rr_opcode;
1995         __u32           rr_cap;
1996         __u32           rr_fsuid;
1997         __u32           rr_fsuid_h;
1998         __u32           rr_fsgid;
1999         __u32           rr_fsgid_h;
2000         __u32           rr_suppgid1;
2001         __u32           rr_suppgid1_h;
2002         __u32           rr_suppgid2;
2003         __u32           rr_suppgid2_h;
2004         struct lu_fid   rr_fid1;
2005         struct lu_fid   rr_fid2;
2006         __s64           rr_mtime;
2007         __s64           rr_atime;
2008         __s64           rr_ctime;
2009         __u64           rr_size;
2010         __u64           rr_blocks;
2011         __u32           rr_bias;
2012         __u32           rr_mode;
2013         __u32           rr_flags;
2014         __u32           rr_flags_h;
2015         __u32           rr_umask;
2016         __u32           rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
2017 };
2018
2019 /* lmv structures */
2020 struct lmv_desc {
2021         __u32 ld_tgt_count;                /* how many MDS's */
2022         __u32 ld_active_tgt_count;         /* how many active */
2023         __u32 ld_default_stripe_count;     /* how many objects are used */
2024         __u32 ld_pattern;                  /* default hash pattern */
2025         __u64 ld_default_hash_size;
2026         __u64 ld_padding_1;                /* also fix lustre_swab_lmv_desc */
2027         __u32 ld_padding_2;                /* also fix lustre_swab_lmv_desc */
2028         __u32 ld_qos_maxage;               /* in second */
2029         __u32 ld_padding_3;                /* also fix lustre_swab_lmv_desc */
2030         __u32 ld_padding_4;                /* also fix lustre_swab_lmv_desc */
2031         struct obd_uuid ld_uuid;
2032 };
2033
2034 /* LMV layout EA, and it will be stored both in master and slave object */
2035 struct lmv_mds_md_v1 {
2036         __u32 lmv_magic;
2037         __u32 lmv_stripe_count;
2038         __u32 lmv_master_mdt_index;     /* On master object, it is master
2039                                          * MDT index, on slave object, it
2040                                          * is stripe index of the slave obj */
2041         __u32 lmv_hash_type;            /* dir stripe policy, i.e. indicate
2042                                          * which hash function to be used,
2043                                          * Note: only lower 16 bits is being
2044                                          * used for now. Higher 16 bits will
2045                                          * be used to mark the object status,
2046                                          * for example migrating or dead. */
2047         __u32 lmv_layout_version;       /* Used for directory restriping */
2048         __u32 lmv_padding1;
2049         __u64 lmv_padding2;
2050         __u64 lmv_padding3;
2051         char lmv_pool_name[LOV_MAXPOOLNAME + 1];        /* pool name */
2052         struct lu_fid lmv_stripe_fids[0];       /* FIDs for each stripe */
2053 };
2054
2055 #define LMV_MAGIC_V1    0x0CD20CD0    /* normal stripe lmv magic */
2056 #define LMV_MAGIC       LMV_MAGIC_V1
2057
2058 /* #define LMV_USER_MAGIC 0x0CD30CD0 */
2059 #define LMV_MAGIC_STRIPE 0x0CD40CD0 /* magic for dir sub_stripe */
2060
2061 /* Right now only the lower part(0-16bits) of lmv_hash_type is being used,
2062  * and the higher part will be the flag to indicate the status of object,
2063  * for example the object is being migrated. And the hash function
2064  * might be interpreted differently with different flags. */
2065 #define LMV_HASH_TYPE_MASK 0x0000ffff
2066
2067 #define LMV_HASH_FLAG_MIGRATION 0x80000000
2068
2069 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 10, 53, 0)
2070 /* Since lustre 2.8, this flag will not be needed, instead this DEAD
2071  * and orphan flags will be stored in LMA (see LMAI_ORPHAN)
2072  * Keep this flag just for LFSCK, because it still might meet such
2073  * flag when it checks the old FS */
2074 #define LMV_HASH_FLAG_DEAD      0x40000000
2075 #endif
2076 #define LMV_HASH_FLAG_BAD_TYPE  0x20000000
2077
2078 /* The striped directory has ever lost its master LMV EA, then LFSCK
2079  * re-generated it. This flag is used to indicate such case. It is an
2080  * on-disk flag. */
2081 #define LMV_HASH_FLAG_LOST_LMV  0x10000000
2082
2083 /**
2084  * The FNV-1a hash algorithm is as follows:
2085  *      hash = FNV_offset_basis
2086  *      for each octet_of_data to be hashed
2087  *              hash = hash XOR octet_of_data
2088  *              hash = hash × FNV_prime
2089  *      return hash
2090  * http://en.wikipedia.org/wiki/Fowler–Noll–Vo_hash_function#FNV-1a_hash
2091  *
2092  * http://www.isthe.com/chongo/tech/comp/fnv/index.html#FNV-reference-source
2093  * FNV_prime is 2^40 + 2^8 + 0xb3 = 0x100000001b3ULL
2094  **/
2095 #define LUSTRE_FNV_1A_64_PRIME  0x100000001b3ULL
2096 #define LUSTRE_FNV_1A_64_OFFSET_BIAS 0xcbf29ce484222325ULL
2097 static inline __u64 lustre_hash_fnv_1a_64(const void *buf, size_t size)
2098 {
2099         __u64 hash = LUSTRE_FNV_1A_64_OFFSET_BIAS;
2100         const unsigned char *p = buf;
2101         size_t i;
2102
2103         for (i = 0; i < size; i++) {
2104                 hash ^= p[i];
2105                 hash *= LUSTRE_FNV_1A_64_PRIME;
2106         }
2107
2108         return hash;
2109 }
2110
2111 union lmv_mds_md {
2112         __u32                    lmv_magic;
2113         struct lmv_mds_md_v1     lmv_md_v1;
2114         struct lmv_user_md       lmv_user_md;
2115 };
2116
2117 static inline int lmv_mds_md_size(int stripe_count, unsigned int lmm_magic)
2118 {
2119         switch (lmm_magic) {
2120         case LMV_MAGIC_V1:{
2121                 struct lmv_mds_md_v1 *lmm1;
2122
2123                 return sizeof(*lmm1) + stripe_count *
2124                                        sizeof(lmm1->lmv_stripe_fids[0]);
2125         }
2126         default:
2127                 return -EINVAL;
2128         }
2129 }
2130
2131 static inline int lmv_mds_md_stripe_count_get(const union lmv_mds_md *lmm)
2132 {
2133         switch (__le32_to_cpu(lmm->lmv_magic)) {
2134         case LMV_MAGIC_V1:
2135                 return __le32_to_cpu(lmm->lmv_md_v1.lmv_stripe_count);
2136         case LMV_USER_MAGIC:
2137                 return __le32_to_cpu(lmm->lmv_user_md.lum_stripe_count);
2138         default:
2139                 return -EINVAL;
2140         }
2141 }
2142
2143 static inline int lmv_mds_md_hash_type_get(const union lmv_mds_md *lmm)
2144 {
2145         switch (__le32_to_cpu(lmm->lmv_magic)) {
2146         case LMV_MAGIC_V1:
2147                 return __le32_to_cpu(lmm->lmv_md_v1.lmv_hash_type);
2148         case LMV_USER_MAGIC:
2149                 return __le32_to_cpu(lmm->lmv_user_md.lum_hash_type);
2150         default:
2151                 return -EINVAL;
2152         }
2153 }
2154
2155 enum fld_rpc_opc {
2156         FLD_QUERY       = 900,
2157         FLD_READ        = 901,
2158         FLD_LAST_OPC,
2159         FLD_FIRST_OPC   = FLD_QUERY
2160 };
2161
2162 enum seq_rpc_opc {
2163         SEQ_QUERY                       = 700,
2164         SEQ_LAST_OPC,
2165         SEQ_FIRST_OPC                   = SEQ_QUERY
2166 };
2167
2168 enum seq_op {
2169         SEQ_ALLOC_SUPER = 0,
2170         SEQ_ALLOC_META = 1
2171 };
2172
2173 enum fld_op {
2174         FLD_CREATE = 0,
2175         FLD_DELETE = 1,
2176         FLD_LOOKUP = 2,
2177 };
2178
2179 /* LFSCK opcodes */
2180 typedef enum {
2181         LFSCK_NOTIFY            = 1101,
2182         LFSCK_QUERY             = 1102,
2183         LFSCK_LAST_OPC,
2184         LFSCK_FIRST_OPC         = LFSCK_NOTIFY
2185 } lfsck_cmd_t;
2186
2187 /*
2188  *  LOV data structures
2189  */
2190
2191 #define LOV_MAX_UUID_BUFFER_SIZE  8192
2192 /* The size of the buffer the lov/mdc reserves for the
2193  * array of UUIDs returned by the MDS.  With the current
2194  * protocol, this will limit the max number of OSTs per LOV */
2195
2196 #define LOV_DESC_MAGIC 0xB0CCDE5C
2197 #define LOV_DESC_QOS_MAXAGE_DEFAULT 5  /* Seconds */
2198 #define LOV_DESC_STRIPE_SIZE_DEFAULT (1 << LNET_MTU_BITS)
2199
2200 /* LOV settings descriptor (should only contain static info) */
2201 struct lov_desc {
2202         __u32 ld_tgt_count;                /* how many OBD's */
2203         __u32 ld_active_tgt_count;         /* how many active */
2204         __u32 ld_default_stripe_count;     /* how many objects are used */
2205         __u32 ld_pattern;                  /* default PATTERN_RAID0 */
2206         __u64 ld_default_stripe_size;      /* in bytes */
2207         __u64 ld_default_stripe_offset;    /* in bytes */
2208         __u32 ld_padding_0;                /* unused */
2209         __u32 ld_qos_maxage;               /* in second */
2210         __u32 ld_padding_1;                /* also fix lustre_swab_lov_desc */
2211         __u32 ld_padding_2;                /* also fix lustre_swab_lov_desc */
2212         struct obd_uuid ld_uuid;
2213 };
2214
2215 #define ld_magic ld_active_tgt_count       /* for swabbing from llogs */
2216
2217 /*
2218  *   LDLM requests:
2219  */
2220 /* opcodes -- MUST be distinct from OST/MDS opcodes */
2221 typedef enum {
2222         LDLM_ENQUEUE     = 101,
2223         LDLM_CONVERT     = 102,
2224         LDLM_CANCEL      = 103,
2225         LDLM_BL_CALLBACK = 104,
2226         LDLM_CP_CALLBACK = 105,
2227         LDLM_GL_CALLBACK = 106,
2228         LDLM_SET_INFO    = 107,
2229         LDLM_LAST_OPC
2230 } ldlm_cmd_t;
2231 #define LDLM_FIRST_OPC LDLM_ENQUEUE
2232
2233 #define RES_NAME_SIZE 4
2234 struct ldlm_res_id {
2235         __u64 name[RES_NAME_SIZE];
2236 };
2237
2238 #define DLDLMRES        "[%#llx:%#llx:%#llx].%#llx"
2239 #define PLDLMRES(res)   (unsigned long long)(res)->lr_name.name[0],     \
2240                         (unsigned long long)(res)->lr_name.name[1],     \
2241                         (unsigned long long)(res)->lr_name.name[2],     \
2242                         (unsigned long long)(res)->lr_name.name[3]
2243
2244 /* lock types */
2245 typedef enum ldlm_mode {
2246         LCK_MINMODE     = 0,
2247         LCK_EX          = 1,
2248         LCK_PW          = 2,
2249         LCK_PR          = 4,
2250         LCK_CW          = 8,
2251         LCK_CR          = 16,
2252         LCK_NL          = 32,
2253         LCK_GROUP       = 64,
2254         LCK_COS         = 128,
2255         LCK_MAXMODE
2256 } ldlm_mode_t;
2257
2258 #define LCK_MODE_NUM    8
2259
2260 typedef enum ldlm_type {
2261         LDLM_PLAIN      = 10,
2262         LDLM_EXTENT     = 11,
2263         LDLM_FLOCK      = 12,
2264         LDLM_IBITS      = 13,
2265         LDLM_MAX_TYPE
2266 } ldlm_type_t;
2267
2268 #define LDLM_MIN_TYPE LDLM_PLAIN
2269
2270 struct ldlm_extent {
2271         __u64 start;
2272         __u64 end;
2273         __u64 gid;
2274 };
2275
2276 struct ldlm_inodebits {
2277         __u64 bits;
2278 };
2279
2280 struct ldlm_flock_wire {
2281         __u64 lfw_start;
2282         __u64 lfw_end;
2283         __u64 lfw_owner;
2284         __u32 lfw_padding;
2285         __u32 lfw_pid;
2286 };
2287
2288 /* it's important that the fields of the ldlm_extent structure match
2289  * the first fields of the ldlm_flock structure because there is only
2290  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
2291  * this ever changes we will need to swab the union differently based
2292  * on the resource type. */
2293
2294 typedef union ldlm_wire_policy_data {
2295         struct ldlm_extent      l_extent;
2296         struct ldlm_flock_wire  l_flock;
2297         struct ldlm_inodebits   l_inodebits;
2298 } ldlm_wire_policy_data_t;
2299
2300 struct barrier_lvb {
2301         __u32   lvb_status;
2302         __u32   lvb_index;
2303         __u64   lvb_padding;
2304 };
2305
2306 struct ldlm_gl_barrier_desc {
2307         __u32   lgbd_status;
2308         __u32   lgbd_timeout;
2309         __u64   lgbd_padding;
2310 };
2311
2312 union ldlm_gl_desc {
2313         struct ldlm_gl_lquota_desc      lquota_desc;
2314         struct ldlm_gl_barrier_desc     barrier_desc;
2315 };
2316
2317 enum ldlm_intent_flags {
2318         IT_OPEN        = 0x00000001,
2319         IT_CREAT       = 0x00000002,
2320         IT_OPEN_CREAT  = 0x00000003,
2321         IT_READDIR     = 0x00000004,
2322         IT_GETATTR     = 0x00000008,
2323         IT_LOOKUP      = 0x00000010,
2324         IT_UNLINK      = 0x00000020,
2325         IT_TRUNC       = 0x00000040,
2326         IT_GETXATTR    = 0x00000080,
2327         IT_EXEC        = 0x00000100,
2328         IT_PIN         = 0x00000200,
2329         IT_LAYOUT      = 0x00000400,
2330         IT_QUOTA_DQACQ = 0x00000800,
2331         IT_QUOTA_CONN  = 0x00001000,
2332         IT_SETXATTR    = 0x00002000,
2333 };
2334
2335 struct ldlm_intent {
2336         __u64 opc;
2337 };
2338
2339 struct ldlm_resource_desc {
2340         enum ldlm_type     lr_type;
2341         __u32              lr_pad; /* also fix lustre_swab_ldlm_resource_desc */
2342         struct ldlm_res_id lr_name;
2343 };
2344
2345 struct ldlm_lock_desc {
2346         struct ldlm_resource_desc l_resource;
2347         enum ldlm_mode l_req_mode;
2348         enum ldlm_mode l_granted_mode;
2349         union ldlm_wire_policy_data l_policy_data;
2350 };
2351
2352 #define LDLM_LOCKREQ_HANDLES 2
2353 #define LDLM_ENQUEUE_CANCEL_OFF 1
2354
2355 struct ldlm_request {
2356         __u32 lock_flags;
2357         __u32 lock_count;
2358         struct ldlm_lock_desc lock_desc;
2359         struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
2360 };
2361
2362 struct ldlm_reply {
2363         __u32 lock_flags;
2364         __u32 lock_padding;     /* also fix lustre_swab_ldlm_reply */
2365         struct ldlm_lock_desc lock_desc;
2366         struct lustre_handle lock_handle;
2367         __u64  lock_policy_res1;
2368         __u64  lock_policy_res2;
2369 };
2370
2371 #define ldlm_flags_to_wire(flags)    ((__u32)(flags))
2372 #define ldlm_flags_from_wire(flags)  ((__u64)(flags))
2373
2374 /*
2375  * Opcodes for mountconf (mgs and mgc)
2376  */
2377 typedef enum {
2378         MGS_CONNECT = 250,
2379         MGS_DISCONNECT,
2380         MGS_EXCEPTION,         /* node died, etc. */
2381         MGS_TARGET_REG,        /* whenever target starts up */
2382         MGS_TARGET_DEL,
2383         MGS_SET_INFO,
2384         MGS_CONFIG_READ,
2385         MGS_LAST_OPC
2386 } mgs_cmd_t;
2387 #define MGS_FIRST_OPC MGS_CONNECT
2388
2389 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
2390 #define MGS_PARAM_MAXLEN 1024
2391 #define KEY_SET_INFO "set_info"
2392
2393 struct mgs_send_param {
2394         char             mgs_param[MGS_PARAM_MAXLEN];
2395 };
2396 #endif
2397
2398 /* We pass this info to the MGS so it can write config logs */
2399 #define MTI_NAME_MAXLEN  64
2400 #define MTI_PARAM_MAXLEN 4096
2401 #define MTI_NIDS_MAX     32
2402 struct mgs_target_info {
2403         __u32            mti_lustre_ver;
2404         __u32            mti_stripe_index;
2405         __u32            mti_config_ver;
2406         __u32            mti_flags;
2407         __u32            mti_nid_count;
2408         __u32            mti_instance; /* Running instance of target */
2409         char             mti_fsname[MTI_NAME_MAXLEN];
2410         char             mti_svname[MTI_NAME_MAXLEN];
2411         char             mti_uuid[sizeof(struct obd_uuid)];
2412         __u64            mti_nids[MTI_NIDS_MAX];     /* host nids (lnet_nid_t)*/
2413         char             mti_params[MTI_PARAM_MAXLEN];
2414 };
2415
2416 struct mgs_nidtbl_entry {
2417         __u64           mne_version;    /* table version of this entry */
2418         __u32           mne_instance;   /* target instance # */
2419         __u32           mne_index;      /* target index */
2420         __u32           mne_length;     /* length of this entry - by bytes */
2421         __u8            mne_type;       /* target type LDD_F_SV_TYPE_OST/MDT */
2422         __u8            mne_nid_type;   /* type of nid(mbz). for ipv6. */
2423         __u8            mne_nid_size;   /* size of each NID, by bytes */
2424         __u8            mne_nid_count;  /* # of NIDs in buffer */
2425         union {
2426                 lnet_nid_t nids[0];     /* variable size buffer for NIDs. */
2427         } u;
2428 };
2429
2430 enum {
2431         CONFIG_T_CONFIG  = 0,
2432         CONFIG_T_SPTLRPC = 1,
2433         CONFIG_T_RECOVER = 2,
2434         CONFIG_T_PARAMS  = 3,
2435         CONFIG_T_NODEMAP = 4,
2436         CONFIG_T_BARRIER = 5,
2437         CONFIG_T_MAX
2438 };
2439
2440 struct mgs_config_body {
2441         char     mcb_name[MTI_NAME_MAXLEN]; /* logname */
2442         __u64    mcb_offset;    /* next index of config log to request */
2443         __u16    mcb_type;      /* type of log: CONFIG_T_[CONFIG|RECOVER] */
2444         __u8     mcb_nm_cur_pass;
2445         __u8     mcb_bits;      /* bits unit size of config log */
2446         __u32    mcb_units;     /* # of units for bulk transfer */
2447 };
2448
2449 struct mgs_config_res {
2450         __u64    mcr_offset;    /* index of last config log */
2451         union {
2452                 __u64    mcr_size;              /* size of the log */
2453                 __u64    mcr_nm_cur_pass;       /* current nodemap config pass */
2454         };
2455 };
2456
2457 /* Config marker flags (in config log) */
2458 #define CM_START       0x01
2459 #define CM_END         0x02
2460 #define CM_SKIP        0x04
2461 #define CM_UPGRADE146  0x08
2462 #define CM_EXCLUDE     0x10
2463 #define CM_START_SKIP (CM_START | CM_SKIP)
2464
2465 struct cfg_marker {
2466         __u32   cm_step;       /* aka config version */
2467         __u32   cm_flags;
2468         __u32   cm_vers;       /* lustre release version number */
2469         __u32   cm_padding;    /* 64 bit align */
2470         __s64   cm_createtime; /*when this record was first created */
2471         __s64   cm_canceltime; /*when this record is no longer valid*/
2472         char    cm_tgtname[MTI_NAME_MAXLEN];
2473         char    cm_comment[MTI_NAME_MAXLEN];
2474 };
2475
2476 /*
2477  * Opcodes for multiple servers.
2478  */
2479
2480 typedef enum {
2481         OBD_PING = 400,
2482         OBD_LOG_CANCEL,
2483         OBD_QC_CALLBACK, /* not used since 2.4 */
2484         OBD_IDX_READ,
2485         OBD_LAST_OPC
2486 } obd_cmd_t;
2487 #define OBD_FIRST_OPC OBD_PING
2488
2489 /**
2490  * llog contexts indices.
2491  *
2492  * There is compatibility problem with indexes below, they are not
2493  * continuous and must keep their numbers for compatibility needs.
2494  * See LU-5218 for details.
2495  */
2496 enum llog_ctxt_id {
2497         LLOG_CONFIG_ORIG_CTXT  =  0,
2498         LLOG_CONFIG_REPL_CTXT = 1,
2499         LLOG_MDS_OST_ORIG_CTXT = 2,
2500         LLOG_MDS_OST_REPL_CTXT = 3, /* kept just to avoid re-assignment */
2501         LLOG_SIZE_ORIG_CTXT = 4,
2502         LLOG_SIZE_REPL_CTXT = 5,
2503         LLOG_TEST_ORIG_CTXT = 8,
2504         LLOG_TEST_REPL_CTXT = 9, /* kept just to avoid re-assignment */
2505         LLOG_CHANGELOG_ORIG_CTXT = 12, /**< changelog generation on mdd */
2506         LLOG_CHANGELOG_REPL_CTXT = 13, /**< changelog access on clients */
2507         /* for multiple changelog consumers */
2508         LLOG_CHANGELOG_USER_ORIG_CTXT = 14,
2509         LLOG_AGENT_ORIG_CTXT = 15, /**< agent requests generation on cdt */
2510         LLOG_UPDATELOG_ORIG_CTXT = 16, /* update log */
2511         LLOG_UPDATELOG_REPL_CTXT = 17, /* update log */
2512         LLOG_MAX_CTXTS
2513 };
2514
2515 /** Identifier for a single log object */
2516 struct llog_logid {
2517         struct ost_id           lgl_oi;
2518         __u32                   lgl_ogen;
2519 } __attribute__((packed));
2520
2521 /** Records written to the CATALOGS list */
2522 #define CATLIST "CATALOGS"
2523 struct llog_catid {
2524         struct llog_logid       lci_logid;
2525         __u32                   lci_padding1;
2526         __u32                   lci_padding2;
2527         __u32                   lci_padding3;
2528 } __attribute__((packed));
2529
2530 /* Log data record types - there is no specific reason that these need to
2531  * be related to the RPC opcodes, but no reason not to (may be handy later?)
2532  */
2533 #define LLOG_OP_MAGIC 0x10600000
2534 #define LLOG_OP_MASK  0xfff00000
2535
2536 typedef enum {
2537         LLOG_PAD_MAGIC          = LLOG_OP_MAGIC | 0x00000,
2538         OST_SZ_REC              = LLOG_OP_MAGIC | 0x00f00,
2539         /* OST_RAID1_REC        = LLOG_OP_MAGIC | 0x01000, never used */
2540         MDS_UNLINK_REC          = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) |
2541                                   REINT_UNLINK, /* obsolete after 2.5.0 */
2542         MDS_UNLINK64_REC        = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2543                                   REINT_UNLINK,
2544         /* MDS_SETATTR_REC      = LLOG_OP_MAGIC | 0x12401, obsolete 1.8.0 */
2545         MDS_SETATTR64_REC       = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2546                                   REINT_SETATTR,
2547         OBD_CFG_REC             = LLOG_OP_MAGIC | 0x20000,
2548         /* PTL_CFG_REC          = LLOG_OP_MAGIC | 0x30000, obsolete 1.4.0 */
2549         LLOG_GEN_REC            = LLOG_OP_MAGIC | 0x40000,
2550         /* LLOG_JOIN_REC        = LLOG_OP_MAGIC | 0x50000, obsolete  1.8.0 */
2551         CHANGELOG_REC           = LLOG_OP_MAGIC | 0x60000,
2552         CHANGELOG_USER_REC      = LLOG_OP_MAGIC | 0x70000,
2553         HSM_AGENT_REC           = LLOG_OP_MAGIC | 0x80000,
2554         UPDATE_REC              = LLOG_OP_MAGIC | 0xa0000,
2555         LLOG_HDR_MAGIC          = LLOG_OP_MAGIC | 0x45539,
2556         LLOG_LOGID_MAGIC        = LLOG_OP_MAGIC | 0x4553b,
2557 } llog_op_type;
2558
2559 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
2560         (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == __swab32(LLOG_OP_MAGIC))
2561
2562 /** Log record header - stored in little endian order.
2563  * Each record must start with this struct, end with a llog_rec_tail,
2564  * and be a multiple of 256 bits in size.
2565  */
2566 struct llog_rec_hdr {
2567         __u32   lrh_len;
2568         __u32   lrh_index;
2569         __u32   lrh_type;
2570         __u32   lrh_id;
2571 };
2572
2573 struct llog_rec_tail {
2574         __u32   lrt_len;
2575         __u32   lrt_index;
2576 };
2577
2578 /* Where data follow just after header */
2579 #define REC_DATA(ptr)                                           \
2580         ((void *)((char *)ptr + sizeof(struct llog_rec_hdr)))
2581
2582 #define REC_DATA_LEN(rec)                                       \
2583         (rec->lrh_len - sizeof(struct llog_rec_hdr) -           \
2584          sizeof(struct llog_rec_tail))
2585
2586 struct llog_logid_rec {
2587         struct llog_rec_hdr     lid_hdr;
2588         struct llog_logid       lid_id;
2589         __u32                   lid_padding1;
2590         __u64                   lid_padding2;
2591         __u64                   lid_padding3;
2592         struct llog_rec_tail    lid_tail;
2593 } __attribute__((packed));
2594
2595 struct llog_unlink_rec {
2596         struct llog_rec_hdr     lur_hdr;
2597         __u64                   lur_oid;
2598         __u32                   lur_oseq;
2599         __u32                   lur_count;
2600         struct llog_rec_tail    lur_tail;
2601 } __attribute__((packed));
2602
2603 struct llog_unlink64_rec {
2604         struct llog_rec_hdr     lur_hdr;
2605         struct lu_fid           lur_fid;
2606         __u32                   lur_count; /* to destroy the lost precreated */
2607         __u32                   lur_padding1;
2608         __u64                   lur_padding2;
2609         __u64                   lur_padding3;
2610         struct llog_rec_tail    lur_tail;
2611 } __attribute__((packed));
2612
2613 struct llog_setattr64_rec {
2614         struct llog_rec_hdr     lsr_hdr;
2615         struct ost_id           lsr_oi;
2616         __u32                   lsr_uid;
2617         __u32                   lsr_uid_h;
2618         __u32                   lsr_gid;
2619         __u32                   lsr_gid_h;
2620         __u64                   lsr_valid;
2621         struct llog_rec_tail    lsr_tail;
2622 } __attribute__((packed));
2623
2624 /* Extended to support project quota */
2625 struct llog_setattr64_rec_v2 {
2626         struct llog_rec_hdr     lsr_hdr;
2627         struct ost_id           lsr_oi;
2628         __u32                   lsr_uid;
2629         __u32                   lsr_uid_h;
2630         __u32                   lsr_gid;
2631         __u32                   lsr_gid_h;
2632         __u64                   lsr_valid;
2633         __u32                   lsr_projid;
2634         __u32                   lsr_padding1;
2635         __u64                   lsr_padding2;
2636         __u64                   lsr_padding3;
2637         struct llog_rec_tail    lsr_tail;
2638 } __attribute__((packed));
2639
2640 struct llog_size_change_rec {
2641         struct llog_rec_hdr     lsc_hdr;
2642         struct ll_fid           lsc_fid;
2643         __u32                   lsc_ioepoch;
2644         __u32                   lsc_padding1;
2645         __u64                   lsc_padding2;
2646         __u64                   lsc_padding3;
2647         struct llog_rec_tail    lsc_tail;
2648 } __attribute__((packed));
2649
2650 #define CHANGELOG_MAGIC 0xca103000
2651
2652 /** \a changelog_rec_type's that can't be masked */
2653 #define CHANGELOG_MINMASK (1 << CL_MARK)
2654 /** bits covering all \a changelog_rec_type's */
2655 #define CHANGELOG_ALLMASK 0XFFFFFFFF
2656 /** default \a changelog_rec_type mask. Allow all of them, except
2657  * CL_ATIME since it can really be time consuming, and not necessary
2658  * under normal use. */
2659 #define CHANGELOG_DEFMASK (CHANGELOG_ALLMASK & ~(1 << CL_ATIME))
2660
2661 /* changelog llog name, needed by client replicators */
2662 #define CHANGELOG_CATALOG "changelog_catalog"
2663
2664 struct changelog_setinfo {
2665         __u64 cs_recno;
2666         __u32 cs_id;
2667 } __attribute__((packed));
2668
2669 /** changelog record */
2670 struct llog_changelog_rec {
2671         struct llog_rec_hdr  cr_hdr;
2672         struct changelog_rec cr; /**< Variable length field */
2673         struct llog_rec_tail cr_do_not_use; /**< for_sizeof_only */
2674 } __attribute__((packed));
2675
2676 #define CHANGELOG_USER_PREFIX "cl"
2677
2678 struct llog_changelog_user_rec {
2679         struct llog_rec_hdr   cur_hdr;
2680         __u32                 cur_id;
2681         __u32                 cur_padding;
2682         __u64                 cur_endrec;
2683         struct llog_rec_tail  cur_tail;
2684 } __attribute__((packed));
2685
2686 enum agent_req_status {
2687         ARS_WAITING,
2688         ARS_STARTED,
2689         ARS_FAILED,
2690         ARS_CANCELED,
2691         ARS_SUCCEED,
2692 };
2693
2694 static inline const char *agent_req_status2name(enum agent_req_status ars)
2695 {
2696         switch (ars) {
2697         case ARS_WAITING:
2698                 return "WAITING";
2699         case ARS_STARTED:
2700                 return "STARTED";
2701         case ARS_FAILED:
2702                 return "FAILED";
2703         case ARS_CANCELED:
2704                 return "CANCELED";
2705         case ARS_SUCCEED:
2706                 return "SUCCEED";
2707         default:
2708                 return "UNKNOWN";
2709         }
2710 }
2711
2712 struct llog_agent_req_rec {
2713         struct llog_rec_hdr     arr_hdr;        /**< record header */
2714         __u32                   arr_status;     /**< status of the request */
2715                                                 /* must match enum
2716                                                  * agent_req_status */
2717         __u32                   arr_archive_id; /**< backend archive number */
2718         __u64                   arr_flags;      /**< req flags */
2719         __u64                   arr_compound_id;        /**< compound cookie */
2720         __u64                   arr_req_create; /**< req. creation time */
2721         __u64                   arr_req_change; /**< req. status change time */
2722         struct hsm_action_item  arr_hai;        /**< req. to the agent */
2723         struct llog_rec_tail    arr_tail; /**< record tail for_sizezof_only */
2724 } __attribute__((packed));
2725
2726 /* Old llog gen for compatibility */
2727 struct llog_gen {
2728         __u64 mnt_cnt;
2729         __u64 conn_cnt;
2730 } __attribute__((packed));
2731
2732 struct llog_gen_rec {
2733         struct llog_rec_hdr     lgr_hdr;
2734         struct llog_gen         lgr_gen;
2735         __u64                   padding1;
2736         __u64                   padding2;
2737         __u64                   padding3;
2738         struct llog_rec_tail    lgr_tail;
2739 };
2740
2741 /* flags for the logs */
2742 enum llog_flag {
2743         LLOG_F_ZAP_WHEN_EMPTY   = 0x1,
2744         LLOG_F_IS_CAT           = 0x2,
2745         LLOG_F_IS_PLAIN         = 0x4,
2746         LLOG_F_EXT_JOBID        = 0x8,
2747         LLOG_F_IS_FIXSIZE       = 0x10,
2748
2749         /* Note: Flags covered by LLOG_F_EXT_MASK will be inherited from
2750          * catlog to plain log, so do not add LLOG_F_IS_FIXSIZE here,
2751          * because the catlog record is usually fixed size, but its plain
2752          * log record can be variable */
2753         LLOG_F_EXT_MASK = LLOG_F_EXT_JOBID,
2754 };
2755
2756 /* On-disk header structure of each log object, stored in little endian order */
2757 #define LLOG_MIN_CHUNK_SIZE     8192
2758 #define LLOG_HEADER_SIZE        (96) /* sizeof (llog_log_hdr) + sizeof(llh_tail)
2759                                       * - sizeof(llh_bitmap) */
2760 #define LLOG_BITMAP_BYTES       (LLOG_MIN_CHUNK_SIZE - LLOG_HEADER_SIZE)
2761 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
2762
2763 struct llog_log_hdr {
2764         struct llog_rec_hdr     llh_hdr;
2765         __s64                   llh_timestamp;
2766         __u32                   llh_count;
2767         __u32                   llh_bitmap_offset;
2768         __u32                   llh_size;
2769         __u32                   llh_flags;
2770         /* for a catalog the first/oldest and still in-use plain slot is just
2771          * next to it. It will serve as the upper limit after Catalog has
2772          * wrapped around */
2773         __u32                   llh_cat_idx;
2774         struct obd_uuid         llh_tgtuuid;
2775         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32)-23];
2776         /* These fields must always be at the end of the llog_log_hdr.
2777          * Note: llh_bitmap size is variable because llog chunk size could be
2778          * bigger than LLOG_MIN_CHUNK_SIZE, i.e. sizeof(llog_log_hdr) > 8192
2779          * bytes, and the real size is stored in llh_hdr.lrh_len, which means
2780          * llh_tail should only be refered by LLOG_HDR_TAIL().
2781          * But this structure is also used by client/server llog interface
2782          * (see llog_client.c), it will be kept in its original way to avoid
2783          * compatiblity issue. */
2784         __u32                   llh_bitmap[LLOG_BITMAP_BYTES / sizeof(__u32)];
2785         struct llog_rec_tail    llh_tail;
2786 } __attribute__((packed));
2787 #undef LLOG_HEADER_SIZE
2788 #undef LLOG_BITMAP_BYTES
2789
2790 #define LLOG_HDR_BITMAP_SIZE(llh)       (__u32)((llh->llh_hdr.lrh_len - \
2791                                          llh->llh_bitmap_offset -       \
2792                                          sizeof(llh->llh_tail)) * 8)
2793 #define LLOG_HDR_BITMAP(llh)    (__u32 *)((char *)(llh) +               \
2794                                           (llh)->llh_bitmap_offset)
2795 #define LLOG_HDR_TAIL(llh)      ((struct llog_rec_tail *)((char *)llh + \
2796                                                  llh->llh_hdr.lrh_len - \
2797                                                  sizeof(llh->llh_tail)))
2798
2799 /** log cookies are used to reference a specific log file and a record therein */
2800 struct llog_cookie {
2801         struct llog_logid       lgc_lgl;
2802         __u32                   lgc_subsys;
2803         __u32                   lgc_index;
2804         __u32                   lgc_padding;
2805 } __attribute__((packed));
2806
2807 /** llog protocol */
2808 enum llogd_rpc_ops {
2809         LLOG_ORIGIN_HANDLE_CREATE       = 501,
2810         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
2811         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
2812         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
2813         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
2814         LLOG_ORIGIN_CONNECT             = 506,
2815         LLOG_CATINFO                    = 507,  /* deprecated */
2816         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
2817         LLOG_ORIGIN_HANDLE_DESTROY      = 509,  /* for destroy llog object*/
2818         LLOG_LAST_OPC,
2819         LLOG_FIRST_OPC                  = LLOG_ORIGIN_HANDLE_CREATE
2820 };
2821
2822 struct llogd_body {
2823         struct llog_logid  lgd_logid;
2824         __u32 lgd_ctxt_idx;
2825         __u32 lgd_llh_flags;
2826         __u32 lgd_index;
2827         __u32 lgd_saved_index;
2828         __u32 lgd_len;
2829         __u64 lgd_cur_offset;
2830 } __attribute__((packed));
2831
2832 struct llogd_conn_body {
2833         struct llog_gen         lgdc_gen;
2834         struct llog_logid       lgdc_logid;
2835         __u32                   lgdc_ctxt_idx;
2836 } __attribute__((packed));
2837
2838 /* Note: 64-bit types are 64-bit aligned in structure */
2839 struct obdo {
2840         __u64                   o_valid;        /* hot fields in this obdo */
2841         struct ost_id           o_oi;
2842         __u64                   o_parent_seq;
2843         __u64                   o_size;         /* o_size-o_blocks == ost_lvb */
2844         __s64                   o_mtime;
2845         __s64                   o_atime;
2846         __s64                   o_ctime;
2847         __u64                   o_blocks;       /* brw: cli sent cached bytes */
2848         __u64                   o_grant;
2849
2850         /* 32-bit fields start here: keep an even number of them via padding */
2851         __u32                   o_blksize;      /* optimal IO blocksize */
2852         __u32                   o_mode;         /* brw: cli sent cache remain */
2853         __u32                   o_uid;
2854         __u32                   o_gid;
2855         __u32                   o_flags;
2856         __u32                   o_nlink;        /* brw: checksum */
2857         __u32                   o_parent_oid;
2858         __u32                   o_misc;         /* brw: o_dropped */
2859
2860         __u64                   o_ioepoch;      /* epoch in ost writes */
2861         __u32                   o_stripe_idx;   /* holds stripe idx */
2862         __u32                   o_parent_ver;
2863         struct lustre_handle    o_handle;       /* brw: lock handle to prolong
2864                                                  * locks */
2865         /* Originally, the field is llog_cookie for destroy with unlink cookie
2866          * from MDS, it is obsolete in 2.8. Then reuse it by client to transfer
2867          * layout and PFL information in IO, setattr RPCs. Since llog_cookie is
2868          * not used on wire any longer, remove it from the obdo, then it can be
2869          * enlarged freely in the further without affect related RPCs.
2870          *
2871          * sizeof(ost_layout) + sieof(__u32) == sizeof(llog_cookie). */
2872         struct ost_layout       o_layout;
2873         __u32                   o_padding_3;
2874         __u32                   o_uid_h;
2875         __u32                   o_gid_h;
2876
2877         __u64                   o_data_version; /* getattr: sum of iversion for
2878                                                  * each stripe.
2879                                                  * brw: grant space consumed on
2880                                                  * the client for the write */
2881         __u32                   o_projid;
2882         __u32                   o_padding_4;
2883         __u64                   o_padding_5;
2884         __u64                   o_padding_6;
2885 };
2886
2887 #define o_dirty   o_blocks
2888 #define o_undirty o_mode
2889 #define o_dropped o_misc
2890 #define o_cksum   o_nlink
2891 #define o_grant_used o_data_version
2892
2893 struct lfsck_request {
2894         __u32           lr_event;
2895         __u32           lr_index;
2896         __u32           lr_flags;
2897         __u32           lr_valid;
2898         union {
2899                 __u32   lr_speed;
2900                 __u32   lr_status;
2901         };
2902         __u16           lr_version;
2903         __u16           lr_active;
2904         __u16           lr_param;
2905         __u16           lr_async_windows;
2906         __u32           lr_flags2;
2907         struct lu_fid   lr_fid;
2908         struct lu_fid   lr_fid2;
2909         __u32           lr_comp_id;
2910         __u32           lr_padding_0;
2911         __u64           lr_padding_1;
2912         __u64           lr_padding_2;
2913         __u64           lr_padding_3;
2914 };
2915
2916 struct lfsck_reply {
2917         __u32           lr_status;
2918         __u32           lr_padding_1;
2919         __u64           lr_repaired;
2920 };
2921
2922 enum lfsck_events {
2923         LE_LASTID_REBUILDING    = 1,
2924         LE_LASTID_REBUILT       = 2,
2925         LE_PHASE1_DONE          = 3,
2926         LE_PHASE2_DONE          = 4,
2927         LE_START                = 5,
2928         LE_STOP                 = 6,
2929         LE_QUERY                = 7,
2930         /* LE_FID_ACCESSED      = 8, moved to lfsck_events_local */
2931         LE_PEER_EXIT            = 9,
2932         LE_CONDITIONAL_DESTROY  = 10,
2933         LE_PAIRS_VERIFY         = 11,
2934         LE_SET_LMV_MASTER       = 15,
2935         LE_SET_LMV_SLAVE        = 16,
2936 };
2937
2938 enum lfsck_event_flags {
2939         LEF_TO_OST              = 0x00000001,
2940         LEF_FROM_OST            = 0x00000002,
2941         LEF_SET_LMV_HASH        = 0x00000004,
2942         LEF_SET_LMV_ALL         = 0x00000008,
2943         LEF_RECHECK_NAME_HASH   = 0x00000010,
2944         LEF_QUERY_ALL           = 0x00000020,
2945 };
2946
2947 /* request structure for OST's */
2948 struct ost_body {
2949         struct obdo oa;
2950 };
2951
2952 /* Key for FIEMAP to be used in get_info calls */
2953 struct ll_fiemap_info_key {
2954         char            lfik_name[8];
2955         struct obdo     lfik_oa;
2956         struct fiemap   lfik_fiemap;
2957 };
2958
2959 #define IDX_INFO_MAGIC 0x3D37CC37
2960
2961 /* Index file transfer through the network. The server serializes the index into
2962  * a byte stream which is sent to the client via a bulk transfer */
2963 struct idx_info {
2964         __u32           ii_magic;
2965
2966         /* reply: see idx_info_flags below */
2967         __u32           ii_flags;
2968
2969         /* request & reply: number of lu_idxpage (to be) transferred */
2970         __u16           ii_count;
2971         __u16           ii_pad0;
2972
2973         /* request: requested attributes passed down to the iterator API */
2974         __u32           ii_attrs;
2975
2976         /* request & reply: index file identifier (FID) */
2977         struct lu_fid   ii_fid;
2978
2979         /* reply: version of the index file before starting to walk the index.
2980          * Please note that the version can be modified at any time during the
2981          * transfer */
2982         __u64           ii_version;
2983
2984         /* request: hash to start with:
2985          * reply: hash of the first entry of the first lu_idxpage and hash
2986          *        of the entry to read next if any */
2987         __u64           ii_hash_start;
2988         __u64           ii_hash_end;
2989
2990         /* reply: size of keys in lu_idxpages, minimal one if II_FL_VARKEY is
2991          * set */
2992         __u16           ii_keysize;
2993
2994         /* reply: size of records in lu_idxpages, minimal one if II_FL_VARREC
2995          * is set */
2996         __u16           ii_recsize;
2997
2998         __u32           ii_pad1;
2999         __u64           ii_pad2;
3000         __u64           ii_pad3;
3001 };
3002
3003 #define II_END_OFF      MDS_DIR_END_OFF /* all entries have been read */
3004
3005 /* List of flags used in idx_info::ii_flags */
3006 enum idx_info_flags {
3007         II_FL_NOHASH    = 1 << 0, /* client doesn't care about hash value */
3008         II_FL_VARKEY    = 1 << 1, /* keys can be of variable size */
3009         II_FL_VARREC    = 1 << 2, /* records can be of variable size */
3010         II_FL_NONUNQ    = 1 << 3, /* index supports non-unique keys */
3011         II_FL_NOKEY     = 1 << 4, /* client doesn't care about key */
3012 };
3013
3014 #define LIP_MAGIC 0x8A6D6B6C
3015
3016 /* 4KB (= LU_PAGE_SIZE) container gathering key/record pairs */
3017 struct lu_idxpage {
3018         /* 16-byte header */
3019         __u32   lip_magic;
3020         __u16   lip_flags;
3021         __u16   lip_nr;   /* number of entries in the container */
3022         __u64   lip_pad0; /* additional padding for future use */
3023
3024         /* key/record pairs are stored in the remaining 4080 bytes.
3025          * depending upon the flags in idx_info::ii_flags, each key/record
3026          * pair might be preceded by:
3027          * - a hash value
3028          * - the key size (II_FL_VARKEY is set)
3029          * - the record size (II_FL_VARREC is set)
3030          *
3031          * For the time being, we only support fixed-size key & record. */
3032         char    lip_entries[0];
3033 };
3034
3035 #define LIP_HDR_SIZE (offsetof(struct lu_idxpage, lip_entries))
3036
3037 /* Gather all possible type associated with a 4KB container */
3038 union lu_page {
3039         struct lu_dirpage       lp_dir; /* for MDS_READPAGE */
3040         struct lu_idxpage       lp_idx; /* for OBD_IDX_READ */
3041         char                    lp_array[LU_PAGE_SIZE];
3042 };
3043
3044 /* security opcodes */
3045 typedef enum {
3046         SEC_CTX_INIT            = 801,
3047         SEC_CTX_INIT_CONT       = 802,
3048         SEC_CTX_FINI            = 803,
3049         SEC_LAST_OPC,
3050         SEC_FIRST_OPC           = SEC_CTX_INIT
3051 } sec_cmd_t;
3052
3053 /*
3054  * capa related definitions
3055  */
3056 #define CAPA_HMAC_MAX_LEN       64
3057 #define CAPA_HMAC_KEY_MAX_LEN   56
3058
3059 /* NB take care when changing the sequence of elements this struct,
3060  * because the offset info is used in find_capa() */
3061 struct lustre_capa {
3062         struct lu_fid   lc_fid;         /** fid */
3063         __u64           lc_opc;         /** operations allowed */
3064         __u64           lc_uid;         /** file owner */
3065         __u64           lc_gid;         /** file group */
3066         __u32           lc_flags;       /** HMAC algorithm & flags */
3067         __u32           lc_keyid;       /** key# used for the capability */
3068         __u32           lc_timeout;     /** capa timeout value (sec) */
3069         __u32           lc_expiry;      /** expiry time (sec) */
3070         __u8            lc_hmac[CAPA_HMAC_MAX_LEN];   /** HMAC */
3071 } __attribute__((packed));
3072
3073 /** lustre_capa::lc_opc */
3074 enum {
3075         CAPA_OPC_BODY_WRITE   = 1<<0,  /**< write object data */
3076         CAPA_OPC_BODY_READ    = 1<<1,  /**< read object data */
3077         CAPA_OPC_INDEX_LOOKUP = 1<<2,  /**< lookup object fid */
3078         CAPA_OPC_INDEX_INSERT = 1<<3,  /**< insert object fid */
3079         CAPA_OPC_INDEX_DELETE = 1<<4,  /**< delete object fid */
3080         CAPA_OPC_OSS_WRITE    = 1<<5,  /**< write oss object data */
3081         CAPA_OPC_OSS_READ     = 1<<6,  /**< read oss object data */
3082         CAPA_OPC_OSS_TRUNC    = 1<<7,  /**< truncate oss object */
3083         CAPA_OPC_OSS_DESTROY  = 1<<8,  /**< destroy oss object */
3084         CAPA_OPC_META_WRITE   = 1<<9,  /**< write object meta data */
3085         CAPA_OPC_META_READ    = 1<<10, /**< read object meta data */
3086 };
3087
3088 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
3089 #define CAPA_OPC_MDS_ONLY                                                   \
3090         (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
3091          CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
3092 #define CAPA_OPC_OSS_ONLY                                                   \
3093         (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC |      \
3094          CAPA_OPC_OSS_DESTROY)
3095 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
3096 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
3097
3098 /* lustre_capa::lc_hmac_alg */
3099 enum {
3100         CAPA_HMAC_ALG_SHA1 = 1, /**< sha1 algorithm */
3101         CAPA_HMAC_ALG_MAX,
3102 };
3103
3104 #define CAPA_FL_MASK            0x00ffffff
3105 #define CAPA_HMAC_ALG_MASK      0xff000000
3106
3107 struct lustre_capa_key {
3108         __u64   lk_seq;       /**< mds# */
3109         __u32   lk_keyid;     /**< key# */
3110         __u32   lk_padding;
3111         __u8    lk_key[CAPA_HMAC_KEY_MAX_LEN];    /**< key */
3112 } __attribute__((packed));
3113
3114 /** The link ea holds 1 \a link_ea_entry for each hardlink */
3115 #define LINK_EA_MAGIC 0x11EAF1DFUL
3116 struct link_ea_header {
3117         __u32 leh_magic;
3118         __u32 leh_reccount;
3119         __u64 leh_len;  /* total size */
3120         __u32 leh_overflow_time;
3121         __u32 leh_padding;
3122 };
3123
3124 /** Hardlink data is name and parent fid.
3125  * Stored in this crazy struct for maximum packing and endian-neutrality
3126  */
3127 struct link_ea_entry {
3128         /** __u16 stored big-endian, unaligned */
3129         unsigned char      lee_reclen[2];
3130         unsigned char      lee_parent_fid[sizeof(struct lu_fid)];
3131         char               lee_name[0];
3132 }__attribute__((packed));
3133
3134 /** fid2path request/reply structure */
3135 struct getinfo_fid2path {
3136         struct lu_fid   gf_fid;
3137         __u64           gf_recno;
3138         __u32           gf_linkno;
3139         __u32           gf_pathlen;
3140         union {
3141                 char            gf_path[0];
3142                 struct lu_fid   gf_root_fid[0];
3143         } gf_u;
3144 } __attribute__((packed));
3145
3146 /** path2parent request/reply structures */
3147 struct getparent {
3148         struct lu_fid   gp_fid;         /**< parent FID */
3149         __u32           gp_linkno;      /**< hardlink number */
3150         __u32           gp_name_size;   /**< size of the name field */
3151         char            gp_name[0];     /**< zero-terminated link name */
3152 } __attribute__((packed));
3153
3154 enum {
3155         LAYOUT_INTENT_ACCESS    = 0,    /** generic access */
3156         LAYOUT_INTENT_READ      = 1,    /** not used */
3157         LAYOUT_INTENT_WRITE     = 2,    /** write file, for comp layout */
3158         LAYOUT_INTENT_GLIMPSE   = 3,    /** not used */
3159         LAYOUT_INTENT_TRUNC     = 4,    /** truncate file, for comp layout */
3160         LAYOUT_INTENT_RELEASE   = 5,    /** reserved for HSM release */
3161         LAYOUT_INTENT_RESTORE   = 6,    /** reserved for HSM restore */
3162 };
3163
3164 /* enqueue layout lock with intent */
3165 struct layout_intent {
3166         __u32 li_opc;   /* intent operation for enqueue, read, write etc */
3167         __u32 li_flags;
3168         __u64 li_start;
3169         __u64 li_end;
3170 } __attribute__((packed));
3171
3172 /**
3173  * On the wire version of hsm_progress structure.
3174  *
3175  * Contains the userspace hsm_progress and some internal fields.
3176  */
3177 struct hsm_progress_kernel {
3178         /* Field taken from struct hsm_progress */
3179         lustre_fid              hpk_fid;
3180         __u64                   hpk_cookie;
3181         struct hsm_extent       hpk_extent;
3182         __u16                   hpk_flags;
3183         __u16                   hpk_errval; /* positive val */
3184         __u32                   hpk_padding1;
3185         /* Additional fields */
3186         __u64                   hpk_data_version;
3187         __u64                   hpk_padding2;
3188 } __attribute__((packed));
3189
3190 /**
3191  * OUT_UPDATE RPC Format
3192  *
3193  * During the cross-ref operation, the Master MDT, which the client send the
3194  * request to, will disassembly the operation into object updates, then OSP
3195  * will send these updates to the remote MDT to be executed.
3196  *
3197  * An UPDATE_OBJ RPC does a list of updates.  Each update belongs to an
3198  * operation and does a type of modification to an object.
3199  *
3200  * Request Format
3201  *
3202  *   update_buf
3203  *   update (1st)
3204  *   update (2nd)
3205  *   ...
3206  *   update (ub_count-th)
3207  *
3208  * ub_count must be less than or equal to UPDATE_PER_RPC_MAX.
3209  *
3210  * Reply Format
3211  *
3212  *   update_reply
3213  *   rc [+ buffers] (1st)
3214  *   rc [+ buffers] (2st)
3215  *   ...
3216  *   rc [+ buffers] (nr_count-th)
3217  *
3218  * ur_count must be less than or equal to UPDATE_PER_RPC_MAX and should usually
3219  * be equal to ub_count.
3220  */
3221
3222 /**
3223  * Type of each update, if adding/deleting update, please also update
3224  * update_opcode in lustre/target/out_lib.c.
3225  */
3226 enum update_type {
3227         OUT_START               = 0,
3228         OUT_CREATE              = 1,
3229         OUT_DESTROY             = 2,
3230         OUT_REF_ADD             = 3,
3231         OUT_REF_DEL             = 4,
3232         OUT_ATTR_SET            = 5,
3233         OUT_ATTR_GET            = 6,
3234         OUT_XATTR_SET           = 7,
3235         OUT_XATTR_GET           = 8,
3236         OUT_INDEX_LOOKUP        = 9,
3237         OUT_INDEX_INSERT        = 10,
3238         OUT_INDEX_DELETE        = 11,
3239         OUT_WRITE               = 12,
3240         OUT_XATTR_DEL           = 13,
3241         OUT_PUNCH               = 14,
3242         OUT_READ                = 15,
3243         OUT_NOOP                = 16,
3244         OUT_LAST
3245 };
3246
3247 enum update_flag {
3248         UPDATE_FL_OST           = 0x00000001,   /* op from OST (not MDT) */
3249         UPDATE_FL_SYNC          = 0x00000002,   /* commit before replying */
3250         UPDATE_FL_COMMITTED     = 0x00000004,   /* op committed globally */
3251         UPDATE_FL_NOLOG         = 0x00000008    /* for idempotent updates */
3252 };
3253
3254 struct object_update_param {
3255         __u16   oup_len;        /* length of this parameter */
3256         __u16   oup_padding;
3257         __u32   oup_padding2;
3258         char    oup_buf[0];
3259 };
3260
3261 /* object update */
3262 struct object_update {
3263         __u16           ou_type;                /* enum update_type */
3264         __u16           ou_params_count;        /* update parameters count */
3265         __u32           ou_result_size;         /* how many bytes can return */
3266         __u32           ou_flags;               /* enum update_flag */
3267         __u32           ou_padding1;            /* padding 1 */
3268         __u64           ou_batchid;             /* op transno on master */
3269         struct lu_fid   ou_fid;                 /* object to be updated */
3270         struct object_update_param ou_params[0]; /* update params */
3271 };
3272
3273 #define UPDATE_REQUEST_MAGIC_V1 0xBDDE0001
3274 #define UPDATE_REQUEST_MAGIC_V2 0xBDDE0002
3275 #define UPDATE_REQUEST_MAGIC    UPDATE_REQUEST_MAGIC_V2
3276 /* Hold object_updates sending to the remote OUT in single RPC */
3277 struct object_update_request {
3278         __u32                   ourq_magic;
3279         __u16                   ourq_count;     /* number of ourq_updates[] */
3280         __u16                   ourq_padding;
3281         struct object_update    ourq_updates[0];
3282 };
3283
3284 #define OUT_UPDATE_HEADER_MAGIC         0xBDDF0001
3285 #define OUT_UPDATE_MAX_INLINE_SIZE      4096
3286 /* Header for updates request between MDTs */
3287 struct out_update_header {
3288         __u32           ouh_magic;
3289         __u32           ouh_count;
3290         __u32           ouh_inline_length;
3291         __u32           ouh_reply_size;
3292         __u32           ouh_inline_data[0];
3293 };
3294
3295 struct out_update_buffer {
3296         __u32   oub_size;
3297         __u32   oub_padding;
3298 };
3299
3300 /* the result of object update */
3301 struct object_update_result {
3302         __u32   our_rc;
3303         __u16   our_datalen;
3304         __u16   our_padding;
3305         __u32   our_data[0];
3306 };
3307
3308 #define UPDATE_REPLY_MAGIC_V1   0x00BD0001
3309 #define UPDATE_REPLY_MAGIC_V2   0x00BD0002
3310 #define UPDATE_REPLY_MAGIC      UPDATE_REPLY_MAGIC_V2
3311 /* Hold object_update_results being replied from the remote OUT. */
3312 struct object_update_reply {
3313         __u32   ourp_magic;
3314         __u16   ourp_count;
3315         __u16   ourp_padding;
3316         __u16   ourp_lens[0];
3317 };
3318
3319 /* read update result */
3320 struct out_read_reply {
3321         __u32   orr_size;
3322         __u32   orr_padding;
3323         __u64   orr_offset;
3324         char    orr_data[0];
3325 };
3326
3327 /** layout swap request structure
3328  * fid1 and fid2 are in mdt_body
3329  */
3330 struct mdc_swap_layouts {
3331         __u64           msl_flags;
3332 } __attribute__((packed));
3333
3334 struct close_data {
3335         struct lustre_handle    cd_handle;
3336         struct lu_fid           cd_fid;
3337         __u64                   cd_data_version;
3338         __u64                   cd_reserved[8];
3339 };
3340
3341 /* Update llog format */
3342 struct update_op {
3343         struct lu_fid   uop_fid;
3344         __u16           uop_type;
3345         __u16           uop_param_count;
3346         __u16           uop_params_off[0];
3347 };
3348
3349 struct update_ops {
3350         struct update_op        uops_op[0];
3351 };
3352
3353 struct update_params {
3354         struct object_update_param      up_params[0];
3355 };
3356
3357 enum update_records_flag {
3358         UPDATE_RECORD_CONTINUE = 1 >> 0,
3359 };
3360 /*
3361  * This is the update record format used to store the updates in
3362  * disk. All updates of the operation will be stored in ur_ops.
3363  * All of parameters for updates of the operation will be stored
3364  * in ur_params.
3365  * To save the space of the record, parameters in ur_ops will only
3366  * remember their offset in ur_params, so to avoid storing duplicate
3367  * parameters in ur_params, which can help us save a lot space for
3368  * operation like creating striped directory.
3369  */
3370 struct update_records {
3371         __u64                   ur_master_transno;
3372         __u64                   ur_batchid;
3373         __u32                   ur_flags;
3374         /* If the operation includes multiple updates, then ur_index
3375          * means the index of the update inside the whole updates. */
3376         __u32                   ur_index;
3377         __u32                   ur_update_count;
3378         __u32                   ur_param_count;
3379         struct update_ops       ur_ops;
3380          /* Note ur_ops has a variable size, so comment out
3381           * the following ur_params, in case some use it directly
3382           * update_records->ur_params
3383           *
3384           * struct update_params        ur_params;
3385           */
3386 };
3387
3388 struct llog_update_record {
3389         struct llog_rec_hdr     lur_hdr;
3390         struct update_records   lur_update_rec;
3391         /* Note ur_update_rec has a variable size, so comment out
3392         * the following ur_tail, in case someone use it directly
3393         *
3394         * struct llog_rec_tail lur_tail;
3395         */
3396 };
3397
3398 /* nodemap records, uses 32 byte record length */
3399 #define LUSTRE_NODEMAP_NAME_LENGTH 16
3400 struct nodemap_cluster_rec {
3401         char    ncr_name[LUSTRE_NODEMAP_NAME_LENGTH + 1];
3402         __u8    ncr_flags;
3403         __u16   ncr_padding1;
3404         __u32   ncr_padding2;
3405         __u32   ncr_squash_uid;
3406         __u32   ncr_squash_gid;
3407 };
3408
3409 /* lnet_nid_t is 8 bytes */
3410 struct nodemap_range_rec {
3411         lnet_nid_t      nrr_start_nid;
3412         lnet_nid_t      nrr_end_nid;
3413         __u64           nrr_padding1;
3414         __u64           nrr_padding2;
3415 };
3416
3417 struct nodemap_id_rec {
3418         __u32   nir_id_fs;
3419         __u32   nir_padding1;
3420         __u64   nir_padding2;
3421         __u64   nir_padding3;
3422         __u64   nir_padding4;
3423 };
3424
3425 struct nodemap_global_rec {
3426         __u8    ngr_is_active;
3427         __u8    ngr_padding1;
3428         __u16   ngr_padding2;
3429         __u32   ngr_padding3;
3430         __u64   ngr_padding4;
3431         __u64   ngr_padding5;
3432         __u64   ngr_padding6;
3433 };
3434
3435 union nodemap_rec {
3436         struct nodemap_cluster_rec ncr;
3437         struct nodemap_range_rec nrr;
3438         struct nodemap_id_rec nir;
3439         struct nodemap_global_rec ngr;
3440 };
3441
3442 /* This is the lu_ladvise struct which goes out on the wire.
3443  * Corresponds to the userspace arg llapi_lu_ladvise.
3444  * value[1-4] are unspecified fields, used differently by different advices */
3445 struct lu_ladvise {
3446         __u16 lla_advice;       /* advice type */
3447         __u16 lla_value1;       /* values for different advice types */
3448         __u32 lla_value2;
3449         __u64 lla_start;        /* first byte of extent for advice */
3450         __u64 lla_end;          /* last byte of extent for advice */
3451         __u32 lla_value3;
3452         __u32 lla_value4;
3453 };
3454
3455 /* This is the ladvise_hdr which goes on the wire, corresponds to the userspace
3456  * arg llapi_ladvise_hdr.
3457  * value[1-3] are unspecified fields, used differently by different advices */
3458 struct ladvise_hdr {
3459         __u32                   lah_magic;      /* LADVISE_MAGIC */
3460         __u32                   lah_count;      /* number of advices */
3461         __u64                   lah_flags;      /* from enum ladvise_flag */
3462         __u32                   lah_value1;     /* unused */
3463         __u32                   lah_value2;     /* unused */
3464         __u64                   lah_value3;     /* unused */
3465         struct lu_ladvise       lah_advise[0];  /* advices in this header */
3466 };
3467
3468 #endif
3469 /** @} lustreidl */