Whamcloud - gitweb
LU-4017 quota: add project inherit attributes
[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         LUSTRE_PROJINHERIT_FL = 0x20000000, /* Create with parents projid */
1625
1626         /* These flags will not be identical to any EXT4_*_FL counterparts,
1627          * and only reserved for lustre purpose. Note: these flags might
1628          * be conflict with some of EXT4 flags, so
1629          * 1. these conflict flags needs to be removed when the flag is
1630          * wired by la_flags see osd_attr_get().
1631          * 2. If these flags needs to be stored into inode, they will be
1632          * stored in LMA. see LMAI_XXXX */
1633         LUSTRE_ORPHAN_FL = 0x00002000,
1634
1635         LUSTRE_LMA_FL_MASKS = LUSTRE_ORPHAN_FL,
1636 };
1637
1638 #ifndef FS_XFLAG_PROJINHERIT
1639 #define FS_XFLAG_PROJINHERIT    0x00000200      /* create with parents projid */
1640 #endif
1641
1642 #ifdef __KERNEL__
1643 /* Convert wire LUSTRE_*_FL to corresponding client local VFS S_* values
1644  * for the client inode i_flags.  The LUSTRE_*_FL are the Lustre wire
1645  * protocol equivalents of LDISKFS_*_FL values stored on disk, while
1646  * the S_* flags are kernel-internal values that change between kernel
1647  * versions.  These flags are set/cleared via FSFILT_IOC_{GET,SET}_FLAGS.
1648  * See b=16526 for a full history. */
1649 static inline int ll_ext_to_inode_flags(int flags)
1650 {
1651         return (((flags & LUSTRE_SYNC_FL)      ? S_SYNC      : 0) |
1652                 ((flags & LUSTRE_NOATIME_FL)   ? S_NOATIME   : 0) |
1653                 ((flags & LUSTRE_APPEND_FL)    ? S_APPEND    : 0) |
1654 #if defined(S_DIRSYNC)
1655                 ((flags & LUSTRE_DIRSYNC_FL)   ? S_DIRSYNC   : 0) |
1656 #endif
1657                 ((flags & LUSTRE_IMMUTABLE_FL) ? S_IMMUTABLE : 0) |
1658                 ((flags & LUSTRE_PROJINHERIT_FL) ? FS_XFLAG_PROJINHERIT : 0));
1659 }
1660
1661 static inline int ll_inode_to_ext_flags(int iflags)
1662 {
1663         return (((iflags & S_SYNC)      ? LUSTRE_SYNC_FL      : 0) |
1664                 ((iflags & S_NOATIME)   ? LUSTRE_NOATIME_FL   : 0) |
1665                 ((iflags & S_APPEND)    ? LUSTRE_APPEND_FL    : 0) |
1666 #if defined(S_DIRSYNC)
1667                 ((iflags & S_DIRSYNC)   ? LUSTRE_DIRSYNC_FL   : 0) |
1668 #endif
1669                 ((iflags & S_IMMUTABLE) ? LUSTRE_IMMUTABLE_FL : 0) |
1670                 ((iflags & FS_XFLAG_PROJINHERIT) ? LUSTRE_PROJINHERIT_FL : 0));
1671 }
1672 #endif
1673
1674 /* 64 possible states */
1675 enum md_transient_state {
1676         MS_RESTORE      = (1 << 0),     /* restore is running */
1677 };
1678
1679 struct mdt_body {
1680         struct lu_fid mbo_fid1;
1681         struct lu_fid mbo_fid2;
1682         struct lustre_handle mbo_handle;
1683         __u64   mbo_valid;
1684         __u64   mbo_size; /* Offset, in the case of MDS_READPAGE */
1685         __s64   mbo_mtime;
1686         __s64   mbo_atime;
1687         __s64   mbo_ctime;
1688         __u64   mbo_blocks; /* XID, in the case of MDS_READPAGE */
1689         __u64   mbo_ioepoch;
1690         __u64   mbo_t_state; /* transient file state defined in
1691                               * enum md_transient_state
1692                               * was "ino" until 2.4.0 */
1693         __u32   mbo_fsuid;
1694         __u32   mbo_fsgid;
1695         __u32   mbo_capability;
1696         __u32   mbo_mode;
1697         __u32   mbo_uid;
1698         __u32   mbo_gid;
1699         __u32   mbo_flags;   /* LUSTRE_*_FL file attributes */
1700         __u32   mbo_rdev;
1701         __u32   mbo_nlink; /* #bytes to read in the case of MDS_READPAGE */
1702         __u32   mbo_unused2; /* was "generation" until 2.4.0 */
1703         __u32   mbo_suppgid;
1704         __u32   mbo_eadatasize;
1705         __u32   mbo_aclsize;
1706         __u32   mbo_max_mdsize;
1707         __u32   mbo_unused3; /* was max_cookiesize until 2.8 */
1708         __u32   mbo_uid_h; /* high 32-bits of uid, for FUID */
1709         __u32   mbo_gid_h; /* high 32-bits of gid, for FUID */
1710         __u32   mbo_projid;
1711         __u64   mbo_padding_6; /* also fix lustre_swab_mdt_body */
1712         __u64   mbo_padding_7;
1713         __u64   mbo_padding_8;
1714         __u64   mbo_padding_9;
1715         __u64   mbo_padding_10;
1716 }; /* 216 */
1717
1718 struct mdt_ioepoch {
1719         struct lustre_handle mio_handle;
1720         __u64 mio_unused1; /* was ioepoch */
1721         __u32 mio_unused2; /* was flags */
1722         __u32 mio_padding;
1723 };
1724
1725 /* permissions for md_perm.mp_perm */
1726 enum {
1727         CFS_SETUID_PERM = 0x01,
1728         CFS_SETGID_PERM = 0x02,
1729         CFS_SETGRP_PERM = 0x04,
1730 };
1731
1732 struct mdt_rec_setattr {
1733         __u32           sa_opcode;
1734         __u32           sa_cap;
1735         __u32           sa_fsuid;
1736         __u32           sa_fsuid_h;
1737         __u32           sa_fsgid;
1738         __u32           sa_fsgid_h;
1739         __u32           sa_suppgid;
1740         __u32           sa_suppgid_h;
1741         __u32           sa_padding_1;
1742         __u32           sa_padding_1_h;
1743         struct lu_fid   sa_fid;
1744         __u64           sa_valid;
1745         __u32           sa_uid;
1746         __u32           sa_gid;
1747         __u64           sa_size;
1748         __u64           sa_blocks;
1749         __s64           sa_mtime;
1750         __s64           sa_atime;
1751         __s64           sa_ctime;
1752         __u32           sa_attr_flags;
1753         __u32           sa_mode;
1754         __u32           sa_bias;      /* some operation flags */
1755         __u32           sa_projid;
1756         __u32           sa_padding_4;
1757         __u32           sa_padding_5;
1758 };
1759
1760 /*
1761  * Attribute flags used in mdt_rec_setattr::sa_valid.
1762  * The kernel's #defines for ATTR_* should not be used over the network
1763  * since the client and MDS may run different kernels (see bug 13828)
1764  * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1765  */
1766 #define MDS_ATTR_MODE          0x1ULL /* = 1 */
1767 #define MDS_ATTR_UID           0x2ULL /* = 2 */
1768 #define MDS_ATTR_GID           0x4ULL /* = 4 */
1769 #define MDS_ATTR_SIZE          0x8ULL /* = 8 */
1770 #define MDS_ATTR_ATIME        0x10ULL /* = 16 */
1771 #define MDS_ATTR_MTIME        0x20ULL /* = 32 */
1772 #define MDS_ATTR_CTIME        0x40ULL /* = 64 */
1773 #define MDS_ATTR_ATIME_SET    0x80ULL /* = 128 */
1774 #define MDS_ATTR_MTIME_SET   0x100ULL /* = 256 */
1775 #define MDS_ATTR_FORCE       0x200ULL /* = 512, Not a change, but a change it */
1776 #define MDS_ATTR_ATTR_FLAG   0x400ULL /* = 1024 */
1777 #define MDS_ATTR_KILL_SUID   0x800ULL /* = 2048 */
1778 #define MDS_ATTR_KILL_SGID  0x1000ULL /* = 4096 */
1779 #define MDS_ATTR_CTIME_SET  0x2000ULL /* = 8192 */
1780 #define MDS_ATTR_FROM_OPEN  0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
1781 #define MDS_ATTR_BLOCKS     0x8000ULL /* = 32768 */
1782 #define MDS_ATTR_PROJID     0x10000ULL  /* = 65536 */
1783
1784 #ifndef FMODE_READ
1785 #define FMODE_READ               00000001
1786 #define FMODE_WRITE              00000002
1787 #endif
1788
1789 #define MDS_FMODE_CLOSED         00000000
1790 #define MDS_FMODE_EXEC           00000004
1791 /*      MDS_FMODE_EPOCH          01000000 obsolete since 2.8.0 */
1792 /*      MDS_FMODE_TRUNC          02000000 obsolete since 2.8.0 */
1793 /*      MDS_FMODE_SOM            04000000 obsolete since 2.8.0 */
1794
1795 #define MDS_OPEN_CREATED         00000010
1796 #define MDS_OPEN_CROSS           00000020
1797
1798 #define MDS_OPEN_CREAT           00000100
1799 #define MDS_OPEN_EXCL            00000200
1800 #define MDS_OPEN_TRUNC           00001000
1801 #define MDS_OPEN_APPEND          00002000
1802 #define MDS_OPEN_SYNC            00010000
1803 #define MDS_OPEN_DIRECTORY       00200000
1804
1805 #define MDS_OPEN_BY_FID         040000000 /* open_by_fid for known object */
1806 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
1807 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1808 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file.
1809                                            * We do not support JOIN FILE
1810                                            * anymore, reserve this flags
1811                                            * just for preventing such bit
1812                                            * to be reused. */
1813
1814 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
1815 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
1816 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
1817 #define MDS_OPEN_NORESTORE  0100000000000ULL /* Do not restore file at open */
1818 #define MDS_OPEN_NEWSTRIPE  0200000000000ULL /* New stripe needed (restripe or
1819                                               * hsm restore) */
1820 #define MDS_OPEN_VOLATILE   0400000000000ULL /* File is volatile = created
1821                                                 unlinked */
1822 #define MDS_OPEN_LEASE     01000000000000ULL /* Open the file and grant lease
1823                                               * delegation, succeed if it's not
1824                                               * being opened with conflict mode.
1825                                               */
1826 #define MDS_OPEN_RELEASE   02000000000000ULL /* Open the file for HSM release */
1827
1828 /* lustre internal open flags, which should not be set from user space */
1829 #define MDS_OPEN_FL_INTERNAL (MDS_OPEN_HAS_EA | MDS_OPEN_HAS_OBJS |     \
1830                               MDS_OPEN_OWNEROVERRIDE | MDS_OPEN_LOCK |  \
1831                               MDS_OPEN_BY_FID | MDS_OPEN_LEASE |        \
1832                               MDS_OPEN_RELEASE)
1833
1834 enum mds_op_bias {
1835         MDS_CHECK_SPLIT         = 1 << 0,
1836         MDS_CROSS_REF           = 1 << 1,
1837         MDS_VTX_BYPASS          = 1 << 2,
1838         MDS_PERM_BYPASS         = 1 << 3,
1839 /*      MDS_SOM                 = 1 << 4, obsolete since 2.8.0 */
1840         MDS_QUOTA_IGNORE        = 1 << 5,
1841         /* Was MDS_CLOSE_CLEANUP (1 << 6), No more used */
1842         MDS_KEEP_ORPHAN         = 1 << 7,
1843         MDS_RECOV_OPEN          = 1 << 8,
1844         MDS_DATA_MODIFIED       = 1 << 9,
1845         MDS_CREATE_VOLATILE     = 1 << 10,
1846         MDS_OWNEROVERRIDE       = 1 << 11,
1847         MDS_HSM_RELEASE         = 1 << 12,
1848         MDS_RENAME_MIGRATE      = 1 << 13,
1849         MDS_CLOSE_LAYOUT_SWAP   = 1 << 14,
1850 };
1851
1852 /* instance of mdt_reint_rec */
1853 struct mdt_rec_create {
1854         __u32           cr_opcode;
1855         __u32           cr_cap;
1856         __u32           cr_fsuid;
1857         __u32           cr_fsuid_h;
1858         __u32           cr_fsgid;
1859         __u32           cr_fsgid_h;
1860         __u32           cr_suppgid1;
1861         __u32           cr_suppgid1_h;
1862         __u32           cr_suppgid2;
1863         __u32           cr_suppgid2_h;
1864         struct lu_fid   cr_fid1;
1865         struct lu_fid   cr_fid2;
1866         struct lustre_handle cr_old_handle; /* handle in case of open replay */
1867         __s64           cr_time;
1868         __u64           cr_rdev;
1869         __u64           cr_ioepoch;
1870         __u64           cr_padding_1;   /* rr_blocks */
1871         __u32           cr_mode;
1872         __u32           cr_bias;
1873         /* use of helpers set/get_mrc_cr_flags() is needed to access
1874          * 64 bits cr_flags [cr_flags_l, cr_flags_h], this is done to
1875          * extend cr_flags size without breaking 1.8 compat */
1876         __u32           cr_flags_l;     /* for use with open, low  32 bits  */
1877         __u32           cr_flags_h;     /* for use with open, high 32 bits */
1878         __u32           cr_umask;       /* umask for create */
1879         __u32           cr_padding_4;   /* rr_padding_4 */
1880 };
1881
1882 /* instance of mdt_reint_rec */
1883 struct mdt_rec_link {
1884         __u32           lk_opcode;
1885         __u32           lk_cap;
1886         __u32           lk_fsuid;
1887         __u32           lk_fsuid_h;
1888         __u32           lk_fsgid;
1889         __u32           lk_fsgid_h;
1890         __u32           lk_suppgid1;
1891         __u32           lk_suppgid1_h;
1892         __u32           lk_suppgid2;
1893         __u32           lk_suppgid2_h;
1894         struct lu_fid   lk_fid1;
1895         struct lu_fid   lk_fid2;
1896         __s64           lk_time;
1897         __u64           lk_padding_1;   /* rr_atime */
1898         __u64           lk_padding_2;   /* rr_ctime */
1899         __u64           lk_padding_3;   /* rr_size */
1900         __u64           lk_padding_4;   /* rr_blocks */
1901         __u32           lk_bias;
1902         __u32           lk_padding_5;   /* rr_mode */
1903         __u32           lk_padding_6;   /* rr_flags */
1904         __u32           lk_padding_7;   /* rr_padding_2 */
1905         __u32           lk_padding_8;   /* rr_padding_3 */
1906         __u32           lk_padding_9;   /* rr_padding_4 */
1907 };
1908
1909 /* instance of mdt_reint_rec */
1910 struct mdt_rec_unlink {
1911         __u32           ul_opcode;
1912         __u32           ul_cap;
1913         __u32           ul_fsuid;
1914         __u32           ul_fsuid_h;
1915         __u32           ul_fsgid;
1916         __u32           ul_fsgid_h;
1917         __u32           ul_suppgid1;
1918         __u32           ul_suppgid1_h;
1919         __u32           ul_suppgid2;
1920         __u32           ul_suppgid2_h;
1921         struct lu_fid   ul_fid1;
1922         struct lu_fid   ul_fid2;
1923         __s64           ul_time;
1924         __u64           ul_padding_2;   /* rr_atime */
1925         __u64           ul_padding_3;   /* rr_ctime */
1926         __u64           ul_padding_4;   /* rr_size */
1927         __u64           ul_padding_5;   /* rr_blocks */
1928         __u32           ul_bias;
1929         __u32           ul_mode;
1930         __u32           ul_padding_6;   /* rr_flags */
1931         __u32           ul_padding_7;   /* rr_padding_2 */
1932         __u32           ul_padding_8;   /* rr_padding_3 */
1933         __u32           ul_padding_9;   /* rr_padding_4 */
1934 };
1935
1936 /* instance of mdt_reint_rec */
1937 struct mdt_rec_rename {
1938         __u32           rn_opcode;
1939         __u32           rn_cap;
1940         __u32           rn_fsuid;
1941         __u32           rn_fsuid_h;
1942         __u32           rn_fsgid;
1943         __u32           rn_fsgid_h;
1944         __u32           rn_suppgid1;
1945         __u32           rn_suppgid1_h;
1946         __u32           rn_suppgid2;
1947         __u32           rn_suppgid2_h;
1948         struct lu_fid   rn_fid1;
1949         struct lu_fid   rn_fid2;
1950         __s64           rn_time;
1951         __u64           rn_padding_1;   /* rr_atime */
1952         __u64           rn_padding_2;   /* rr_ctime */
1953         __u64           rn_padding_3;   /* rr_size */
1954         __u64           rn_padding_4;   /* rr_blocks */
1955         __u32           rn_bias;        /* some operation flags */
1956         __u32           rn_mode;        /* cross-ref rename has mode */
1957         __u32           rn_padding_5;   /* rr_flags */
1958         __u32           rn_padding_6;   /* rr_padding_2 */
1959         __u32           rn_padding_7;   /* rr_padding_3 */
1960         __u32           rn_padding_8;   /* rr_padding_4 */
1961 };
1962
1963 /* instance of mdt_reint_rec */
1964 struct mdt_rec_setxattr {
1965         __u32           sx_opcode;
1966         __u32           sx_cap;
1967         __u32           sx_fsuid;
1968         __u32           sx_fsuid_h;
1969         __u32           sx_fsgid;
1970         __u32           sx_fsgid_h;
1971         __u32           sx_suppgid1;
1972         __u32           sx_suppgid1_h;
1973         __u32           sx_suppgid2;
1974         __u32           sx_suppgid2_h;
1975         struct lu_fid   sx_fid;
1976         __u64           sx_padding_1;   /* These three are rr_fid2 */
1977         __u32           sx_padding_2;
1978         __u32           sx_padding_3;
1979         __u64           sx_valid;
1980         __s64           sx_time;
1981         __u64           sx_padding_5;   /* rr_ctime */
1982         __u64           sx_padding_6;   /* rr_size */
1983         __u64           sx_padding_7;   /* rr_blocks */
1984         __u32           sx_size;
1985         __u32           sx_flags;
1986         __u32           sx_padding_8;   /* rr_flags */
1987         __u32           sx_padding_9;   /* rr_padding_2 */
1988         __u32           sx_padding_10;  /* rr_padding_3 */
1989         __u32           sx_padding_11;  /* rr_padding_4 */
1990 };
1991
1992 /*
1993  * mdt_rec_reint is the template for all mdt_reint_xxx structures.
1994  * Do NOT change the size of various members, otherwise the value
1995  * will be broken in lustre_swab_mdt_rec_reint().
1996  *
1997  * If you add new members in other mdt_reint_xxx structres and need to use the
1998  * rr_padding_x fields, then update lustre_swab_mdt_rec_reint() also.
1999  */
2000 struct mdt_rec_reint {
2001         __u32           rr_opcode;
2002         __u32           rr_cap;
2003         __u32           rr_fsuid;
2004         __u32           rr_fsuid_h;
2005         __u32           rr_fsgid;
2006         __u32           rr_fsgid_h;
2007         __u32           rr_suppgid1;
2008         __u32           rr_suppgid1_h;
2009         __u32           rr_suppgid2;
2010         __u32           rr_suppgid2_h;
2011         struct lu_fid   rr_fid1;
2012         struct lu_fid   rr_fid2;
2013         __s64           rr_mtime;
2014         __s64           rr_atime;
2015         __s64           rr_ctime;
2016         __u64           rr_size;
2017         __u64           rr_blocks;
2018         __u32           rr_bias;
2019         __u32           rr_mode;
2020         __u32           rr_flags;
2021         __u32           rr_flags_h;
2022         __u32           rr_umask;
2023         __u32           rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
2024 };
2025
2026 /* lmv structures */
2027 struct lmv_desc {
2028         __u32 ld_tgt_count;                /* how many MDS's */
2029         __u32 ld_active_tgt_count;         /* how many active */
2030         __u32 ld_default_stripe_count;     /* how many objects are used */
2031         __u32 ld_pattern;                  /* default hash pattern */
2032         __u64 ld_default_hash_size;
2033         __u64 ld_padding_1;                /* also fix lustre_swab_lmv_desc */
2034         __u32 ld_padding_2;                /* also fix lustre_swab_lmv_desc */
2035         __u32 ld_qos_maxage;               /* in second */
2036         __u32 ld_padding_3;                /* also fix lustre_swab_lmv_desc */
2037         __u32 ld_padding_4;                /* also fix lustre_swab_lmv_desc */
2038         struct obd_uuid ld_uuid;
2039 };
2040
2041 /* LMV layout EA, and it will be stored both in master and slave object */
2042 struct lmv_mds_md_v1 {
2043         __u32 lmv_magic;
2044         __u32 lmv_stripe_count;
2045         __u32 lmv_master_mdt_index;     /* On master object, it is master
2046                                          * MDT index, on slave object, it
2047                                          * is stripe index of the slave obj */
2048         __u32 lmv_hash_type;            /* dir stripe policy, i.e. indicate
2049                                          * which hash function to be used,
2050                                          * Note: only lower 16 bits is being
2051                                          * used for now. Higher 16 bits will
2052                                          * be used to mark the object status,
2053                                          * for example migrating or dead. */
2054         __u32 lmv_layout_version;       /* Used for directory restriping */
2055         __u32 lmv_padding1;
2056         __u64 lmv_padding2;
2057         __u64 lmv_padding3;
2058         char lmv_pool_name[LOV_MAXPOOLNAME + 1];        /* pool name */
2059         struct lu_fid lmv_stripe_fids[0];       /* FIDs for each stripe */
2060 };
2061
2062 #define LMV_MAGIC_V1    0x0CD20CD0    /* normal stripe lmv magic */
2063 #define LMV_MAGIC       LMV_MAGIC_V1
2064
2065 /* #define LMV_USER_MAGIC 0x0CD30CD0 */
2066 #define LMV_MAGIC_STRIPE 0x0CD40CD0 /* magic for dir sub_stripe */
2067
2068 /* Right now only the lower part(0-16bits) of lmv_hash_type is being used,
2069  * and the higher part will be the flag to indicate the status of object,
2070  * for example the object is being migrated. And the hash function
2071  * might be interpreted differently with different flags. */
2072 #define LMV_HASH_TYPE_MASK 0x0000ffff
2073
2074 #define LMV_HASH_FLAG_MIGRATION 0x80000000
2075
2076 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 10, 53, 0)
2077 /* Since lustre 2.8, this flag will not be needed, instead this DEAD
2078  * and orphan flags will be stored in LMA (see LMAI_ORPHAN)
2079  * Keep this flag just for LFSCK, because it still might meet such
2080  * flag when it checks the old FS */
2081 #define LMV_HASH_FLAG_DEAD      0x40000000
2082 #endif
2083 #define LMV_HASH_FLAG_BAD_TYPE  0x20000000
2084
2085 /* The striped directory has ever lost its master LMV EA, then LFSCK
2086  * re-generated it. This flag is used to indicate such case. It is an
2087  * on-disk flag. */
2088 #define LMV_HASH_FLAG_LOST_LMV  0x10000000
2089
2090 /**
2091  * The FNV-1a hash algorithm is as follows:
2092  *      hash = FNV_offset_basis
2093  *      for each octet_of_data to be hashed
2094  *              hash = hash XOR octet_of_data
2095  *              hash = hash × FNV_prime
2096  *      return hash
2097  * http://en.wikipedia.org/wiki/Fowler–Noll–Vo_hash_function#FNV-1a_hash
2098  *
2099  * http://www.isthe.com/chongo/tech/comp/fnv/index.html#FNV-reference-source
2100  * FNV_prime is 2^40 + 2^8 + 0xb3 = 0x100000001b3ULL
2101  **/
2102 #define LUSTRE_FNV_1A_64_PRIME  0x100000001b3ULL
2103 #define LUSTRE_FNV_1A_64_OFFSET_BIAS 0xcbf29ce484222325ULL
2104 static inline __u64 lustre_hash_fnv_1a_64(const void *buf, size_t size)
2105 {
2106         __u64 hash = LUSTRE_FNV_1A_64_OFFSET_BIAS;
2107         const unsigned char *p = buf;
2108         size_t i;
2109
2110         for (i = 0; i < size; i++) {
2111                 hash ^= p[i];
2112                 hash *= LUSTRE_FNV_1A_64_PRIME;
2113         }
2114
2115         return hash;
2116 }
2117
2118 union lmv_mds_md {
2119         __u32                    lmv_magic;
2120         struct lmv_mds_md_v1     lmv_md_v1;
2121         struct lmv_user_md       lmv_user_md;
2122 };
2123
2124 static inline int lmv_mds_md_size(int stripe_count, unsigned int lmm_magic)
2125 {
2126         switch (lmm_magic) {
2127         case LMV_MAGIC_V1:{
2128                 struct lmv_mds_md_v1 *lmm1;
2129
2130                 return sizeof(*lmm1) + stripe_count *
2131                                        sizeof(lmm1->lmv_stripe_fids[0]);
2132         }
2133         default:
2134                 return -EINVAL;
2135         }
2136 }
2137
2138 static inline int lmv_mds_md_stripe_count_get(const union lmv_mds_md *lmm)
2139 {
2140         switch (__le32_to_cpu(lmm->lmv_magic)) {
2141         case LMV_MAGIC_V1:
2142                 return __le32_to_cpu(lmm->lmv_md_v1.lmv_stripe_count);
2143         case LMV_USER_MAGIC:
2144                 return __le32_to_cpu(lmm->lmv_user_md.lum_stripe_count);
2145         default:
2146                 return -EINVAL;
2147         }
2148 }
2149
2150 static inline int lmv_mds_md_hash_type_get(const union lmv_mds_md *lmm)
2151 {
2152         switch (__le32_to_cpu(lmm->lmv_magic)) {
2153         case LMV_MAGIC_V1:
2154                 return __le32_to_cpu(lmm->lmv_md_v1.lmv_hash_type);
2155         case LMV_USER_MAGIC:
2156                 return __le32_to_cpu(lmm->lmv_user_md.lum_hash_type);
2157         default:
2158                 return -EINVAL;
2159         }
2160 }
2161
2162 enum fld_rpc_opc {
2163         FLD_QUERY       = 900,
2164         FLD_READ        = 901,
2165         FLD_LAST_OPC,
2166         FLD_FIRST_OPC   = FLD_QUERY
2167 };
2168
2169 enum seq_rpc_opc {
2170         SEQ_QUERY                       = 700,
2171         SEQ_LAST_OPC,
2172         SEQ_FIRST_OPC                   = SEQ_QUERY
2173 };
2174
2175 enum seq_op {
2176         SEQ_ALLOC_SUPER = 0,
2177         SEQ_ALLOC_META = 1
2178 };
2179
2180 enum fld_op {
2181         FLD_CREATE = 0,
2182         FLD_DELETE = 1,
2183         FLD_LOOKUP = 2,
2184 };
2185
2186 /* LFSCK opcodes */
2187 typedef enum {
2188         LFSCK_NOTIFY            = 1101,
2189         LFSCK_QUERY             = 1102,
2190         LFSCK_LAST_OPC,
2191         LFSCK_FIRST_OPC         = LFSCK_NOTIFY
2192 } lfsck_cmd_t;
2193
2194 /*
2195  *  LOV data structures
2196  */
2197
2198 #define LOV_MAX_UUID_BUFFER_SIZE  8192
2199 /* The size of the buffer the lov/mdc reserves for the
2200  * array of UUIDs returned by the MDS.  With the current
2201  * protocol, this will limit the max number of OSTs per LOV */
2202
2203 #define LOV_DESC_MAGIC 0xB0CCDE5C
2204 #define LOV_DESC_QOS_MAXAGE_DEFAULT 5  /* Seconds */
2205 #define LOV_DESC_STRIPE_SIZE_DEFAULT (1 << LNET_MTU_BITS)
2206
2207 /* LOV settings descriptor (should only contain static info) */
2208 struct lov_desc {
2209         __u32 ld_tgt_count;                /* how many OBD's */
2210         __u32 ld_active_tgt_count;         /* how many active */
2211         __u32 ld_default_stripe_count;     /* how many objects are used */
2212         __u32 ld_pattern;                  /* default PATTERN_RAID0 */
2213         __u64 ld_default_stripe_size;      /* in bytes */
2214         __u64 ld_default_stripe_offset;    /* in bytes */
2215         __u32 ld_padding_0;                /* unused */
2216         __u32 ld_qos_maxage;               /* in second */
2217         __u32 ld_padding_1;                /* also fix lustre_swab_lov_desc */
2218         __u32 ld_padding_2;                /* also fix lustre_swab_lov_desc */
2219         struct obd_uuid ld_uuid;
2220 };
2221
2222 #define ld_magic ld_active_tgt_count       /* for swabbing from llogs */
2223
2224 /*
2225  *   LDLM requests:
2226  */
2227 /* opcodes -- MUST be distinct from OST/MDS opcodes */
2228 typedef enum {
2229         LDLM_ENQUEUE     = 101,
2230         LDLM_CONVERT     = 102,
2231         LDLM_CANCEL      = 103,
2232         LDLM_BL_CALLBACK = 104,
2233         LDLM_CP_CALLBACK = 105,
2234         LDLM_GL_CALLBACK = 106,
2235         LDLM_SET_INFO    = 107,
2236         LDLM_LAST_OPC
2237 } ldlm_cmd_t;
2238 #define LDLM_FIRST_OPC LDLM_ENQUEUE
2239
2240 #define RES_NAME_SIZE 4
2241 struct ldlm_res_id {
2242         __u64 name[RES_NAME_SIZE];
2243 };
2244
2245 #define DLDLMRES        "[%#llx:%#llx:%#llx].%#llx"
2246 #define PLDLMRES(res)   (unsigned long long)(res)->lr_name.name[0],     \
2247                         (unsigned long long)(res)->lr_name.name[1],     \
2248                         (unsigned long long)(res)->lr_name.name[2],     \
2249                         (unsigned long long)(res)->lr_name.name[3]
2250
2251 /* lock types */
2252 typedef enum ldlm_mode {
2253         LCK_MINMODE     = 0,
2254         LCK_EX          = 1,
2255         LCK_PW          = 2,
2256         LCK_PR          = 4,
2257         LCK_CW          = 8,
2258         LCK_CR          = 16,
2259         LCK_NL          = 32,
2260         LCK_GROUP       = 64,
2261         LCK_COS         = 128,
2262         LCK_MAXMODE
2263 } ldlm_mode_t;
2264
2265 #define LCK_MODE_NUM    8
2266
2267 typedef enum ldlm_type {
2268         LDLM_PLAIN      = 10,
2269         LDLM_EXTENT     = 11,
2270         LDLM_FLOCK      = 12,
2271         LDLM_IBITS      = 13,
2272         LDLM_MAX_TYPE
2273 } ldlm_type_t;
2274
2275 #define LDLM_MIN_TYPE LDLM_PLAIN
2276
2277 struct ldlm_extent {
2278         __u64 start;
2279         __u64 end;
2280         __u64 gid;
2281 };
2282
2283 struct ldlm_inodebits {
2284         __u64 bits;
2285 };
2286
2287 struct ldlm_flock_wire {
2288         __u64 lfw_start;
2289         __u64 lfw_end;
2290         __u64 lfw_owner;
2291         __u32 lfw_padding;
2292         __u32 lfw_pid;
2293 };
2294
2295 /* it's important that the fields of the ldlm_extent structure match
2296  * the first fields of the ldlm_flock structure because there is only
2297  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
2298  * this ever changes we will need to swab the union differently based
2299  * on the resource type. */
2300
2301 typedef union ldlm_wire_policy_data {
2302         struct ldlm_extent      l_extent;
2303         struct ldlm_flock_wire  l_flock;
2304         struct ldlm_inodebits   l_inodebits;
2305 } ldlm_wire_policy_data_t;
2306
2307 struct barrier_lvb {
2308         __u32   lvb_status;
2309         __u32   lvb_index;
2310         __u64   lvb_padding;
2311 };
2312
2313 struct ldlm_gl_barrier_desc {
2314         __u32   lgbd_status;
2315         __u32   lgbd_timeout;
2316         __u64   lgbd_padding;
2317 };
2318
2319 union ldlm_gl_desc {
2320         struct ldlm_gl_lquota_desc      lquota_desc;
2321         struct ldlm_gl_barrier_desc     barrier_desc;
2322 };
2323
2324 enum ldlm_intent_flags {
2325         IT_OPEN        = 0x00000001,
2326         IT_CREAT       = 0x00000002,
2327         IT_OPEN_CREAT  = 0x00000003,
2328         IT_READDIR     = 0x00000004,
2329         IT_GETATTR     = 0x00000008,
2330         IT_LOOKUP      = 0x00000010,
2331         IT_UNLINK      = 0x00000020,
2332         IT_TRUNC       = 0x00000040,
2333         IT_GETXATTR    = 0x00000080,
2334         IT_EXEC        = 0x00000100,
2335         IT_PIN         = 0x00000200,
2336         IT_LAYOUT      = 0x00000400,
2337         IT_QUOTA_DQACQ = 0x00000800,
2338         IT_QUOTA_CONN  = 0x00001000,
2339         IT_SETXATTR    = 0x00002000,
2340 };
2341
2342 struct ldlm_intent {
2343         __u64 opc;
2344 };
2345
2346 struct ldlm_resource_desc {
2347         enum ldlm_type     lr_type;
2348         __u32              lr_pad; /* also fix lustre_swab_ldlm_resource_desc */
2349         struct ldlm_res_id lr_name;
2350 };
2351
2352 struct ldlm_lock_desc {
2353         struct ldlm_resource_desc l_resource;
2354         enum ldlm_mode l_req_mode;
2355         enum ldlm_mode l_granted_mode;
2356         union ldlm_wire_policy_data l_policy_data;
2357 };
2358
2359 #define LDLM_LOCKREQ_HANDLES 2
2360 #define LDLM_ENQUEUE_CANCEL_OFF 1
2361
2362 struct ldlm_request {
2363         __u32 lock_flags;
2364         __u32 lock_count;
2365         struct ldlm_lock_desc lock_desc;
2366         struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
2367 };
2368
2369 struct ldlm_reply {
2370         __u32 lock_flags;
2371         __u32 lock_padding;     /* also fix lustre_swab_ldlm_reply */
2372         struct ldlm_lock_desc lock_desc;
2373         struct lustre_handle lock_handle;
2374         __u64  lock_policy_res1;
2375         __u64  lock_policy_res2;
2376 };
2377
2378 #define ldlm_flags_to_wire(flags)    ((__u32)(flags))
2379 #define ldlm_flags_from_wire(flags)  ((__u64)(flags))
2380
2381 /*
2382  * Opcodes for mountconf (mgs and mgc)
2383  */
2384 typedef enum {
2385         MGS_CONNECT = 250,
2386         MGS_DISCONNECT,
2387         MGS_EXCEPTION,         /* node died, etc. */
2388         MGS_TARGET_REG,        /* whenever target starts up */
2389         MGS_TARGET_DEL,
2390         MGS_SET_INFO,
2391         MGS_CONFIG_READ,
2392         MGS_LAST_OPC
2393 } mgs_cmd_t;
2394 #define MGS_FIRST_OPC MGS_CONNECT
2395
2396 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
2397 #define MGS_PARAM_MAXLEN 1024
2398 #define KEY_SET_INFO "set_info"
2399
2400 struct mgs_send_param {
2401         char             mgs_param[MGS_PARAM_MAXLEN];
2402 };
2403 #endif
2404
2405 /* We pass this info to the MGS so it can write config logs */
2406 #define MTI_NAME_MAXLEN  64
2407 #define MTI_PARAM_MAXLEN 4096
2408 #define MTI_NIDS_MAX     32
2409 struct mgs_target_info {
2410         __u32            mti_lustre_ver;
2411         __u32            mti_stripe_index;
2412         __u32            mti_config_ver;
2413         __u32            mti_flags;
2414         __u32            mti_nid_count;
2415         __u32            mti_instance; /* Running instance of target */
2416         char             mti_fsname[MTI_NAME_MAXLEN];
2417         char             mti_svname[MTI_NAME_MAXLEN];
2418         char             mti_uuid[sizeof(struct obd_uuid)];
2419         __u64            mti_nids[MTI_NIDS_MAX];     /* host nids (lnet_nid_t)*/
2420         char             mti_params[MTI_PARAM_MAXLEN];
2421 };
2422
2423 struct mgs_nidtbl_entry {
2424         __u64           mne_version;    /* table version of this entry */
2425         __u32           mne_instance;   /* target instance # */
2426         __u32           mne_index;      /* target index */
2427         __u32           mne_length;     /* length of this entry - by bytes */
2428         __u8            mne_type;       /* target type LDD_F_SV_TYPE_OST/MDT */
2429         __u8            mne_nid_type;   /* type of nid(mbz). for ipv6. */
2430         __u8            mne_nid_size;   /* size of each NID, by bytes */
2431         __u8            mne_nid_count;  /* # of NIDs in buffer */
2432         union {
2433                 lnet_nid_t nids[0];     /* variable size buffer for NIDs. */
2434         } u;
2435 };
2436
2437 enum {
2438         CONFIG_T_CONFIG  = 0,
2439         CONFIG_T_SPTLRPC = 1,
2440         CONFIG_T_RECOVER = 2,
2441         CONFIG_T_PARAMS  = 3,
2442         CONFIG_T_NODEMAP = 4,
2443         CONFIG_T_BARRIER = 5,
2444         CONFIG_T_MAX
2445 };
2446
2447 struct mgs_config_body {
2448         char     mcb_name[MTI_NAME_MAXLEN]; /* logname */
2449         __u64    mcb_offset;    /* next index of config log to request */
2450         __u16    mcb_type;      /* type of log: CONFIG_T_[CONFIG|RECOVER] */
2451         __u8     mcb_nm_cur_pass;
2452         __u8     mcb_bits;      /* bits unit size of config log */
2453         __u32    mcb_units;     /* # of units for bulk transfer */
2454 };
2455
2456 struct mgs_config_res {
2457         __u64    mcr_offset;    /* index of last config log */
2458         union {
2459                 __u64    mcr_size;              /* size of the log */
2460                 __u64    mcr_nm_cur_pass;       /* current nodemap config pass */
2461         };
2462 };
2463
2464 /* Config marker flags (in config log) */
2465 #define CM_START       0x01
2466 #define CM_END         0x02
2467 #define CM_SKIP        0x04
2468 #define CM_UPGRADE146  0x08
2469 #define CM_EXCLUDE     0x10
2470 #define CM_START_SKIP (CM_START | CM_SKIP)
2471
2472 struct cfg_marker {
2473         __u32   cm_step;       /* aka config version */
2474         __u32   cm_flags;
2475         __u32   cm_vers;       /* lustre release version number */
2476         __u32   cm_padding;    /* 64 bit align */
2477         __s64   cm_createtime; /*when this record was first created */
2478         __s64   cm_canceltime; /*when this record is no longer valid*/
2479         char    cm_tgtname[MTI_NAME_MAXLEN];
2480         char    cm_comment[MTI_NAME_MAXLEN];
2481 };
2482
2483 /*
2484  * Opcodes for multiple servers.
2485  */
2486
2487 typedef enum {
2488         OBD_PING = 400,
2489         OBD_LOG_CANCEL,
2490         OBD_QC_CALLBACK, /* not used since 2.4 */
2491         OBD_IDX_READ,
2492         OBD_LAST_OPC
2493 } obd_cmd_t;
2494 #define OBD_FIRST_OPC OBD_PING
2495
2496 /**
2497  * llog contexts indices.
2498  *
2499  * There is compatibility problem with indexes below, they are not
2500  * continuous and must keep their numbers for compatibility needs.
2501  * See LU-5218 for details.
2502  */
2503 enum llog_ctxt_id {
2504         LLOG_CONFIG_ORIG_CTXT  =  0,
2505         LLOG_CONFIG_REPL_CTXT = 1,
2506         LLOG_MDS_OST_ORIG_CTXT = 2,
2507         LLOG_MDS_OST_REPL_CTXT = 3, /* kept just to avoid re-assignment */
2508         LLOG_SIZE_ORIG_CTXT = 4,
2509         LLOG_SIZE_REPL_CTXT = 5,
2510         LLOG_TEST_ORIG_CTXT = 8,
2511         LLOG_TEST_REPL_CTXT = 9, /* kept just to avoid re-assignment */
2512         LLOG_CHANGELOG_ORIG_CTXT = 12, /**< changelog generation on mdd */
2513         LLOG_CHANGELOG_REPL_CTXT = 13, /**< changelog access on clients */
2514         /* for multiple changelog consumers */
2515         LLOG_CHANGELOG_USER_ORIG_CTXT = 14,
2516         LLOG_AGENT_ORIG_CTXT = 15, /**< agent requests generation on cdt */
2517         LLOG_UPDATELOG_ORIG_CTXT = 16, /* update log */
2518         LLOG_UPDATELOG_REPL_CTXT = 17, /* update log */
2519         LLOG_MAX_CTXTS
2520 };
2521
2522 /** Identifier for a single log object */
2523 struct llog_logid {
2524         struct ost_id           lgl_oi;
2525         __u32                   lgl_ogen;
2526 } __attribute__((packed));
2527
2528 /** Records written to the CATALOGS list */
2529 #define CATLIST "CATALOGS"
2530 struct llog_catid {
2531         struct llog_logid       lci_logid;
2532         __u32                   lci_padding1;
2533         __u32                   lci_padding2;
2534         __u32                   lci_padding3;
2535 } __attribute__((packed));
2536
2537 /* Log data record types - there is no specific reason that these need to
2538  * be related to the RPC opcodes, but no reason not to (may be handy later?)
2539  */
2540 #define LLOG_OP_MAGIC 0x10600000
2541 #define LLOG_OP_MASK  0xfff00000
2542
2543 typedef enum {
2544         LLOG_PAD_MAGIC          = LLOG_OP_MAGIC | 0x00000,
2545         OST_SZ_REC              = LLOG_OP_MAGIC | 0x00f00,
2546         /* OST_RAID1_REC        = LLOG_OP_MAGIC | 0x01000, never used */
2547         MDS_UNLINK_REC          = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) |
2548                                   REINT_UNLINK, /* obsolete after 2.5.0 */
2549         MDS_UNLINK64_REC        = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2550                                   REINT_UNLINK,
2551         /* MDS_SETATTR_REC      = LLOG_OP_MAGIC | 0x12401, obsolete 1.8.0 */
2552         MDS_SETATTR64_REC       = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2553                                   REINT_SETATTR,
2554         OBD_CFG_REC             = LLOG_OP_MAGIC | 0x20000,
2555         /* PTL_CFG_REC          = LLOG_OP_MAGIC | 0x30000, obsolete 1.4.0 */
2556         LLOG_GEN_REC            = LLOG_OP_MAGIC | 0x40000,
2557         /* LLOG_JOIN_REC        = LLOG_OP_MAGIC | 0x50000, obsolete  1.8.0 */
2558         CHANGELOG_REC           = LLOG_OP_MAGIC | 0x60000,
2559         CHANGELOG_USER_REC      = LLOG_OP_MAGIC | 0x70000,
2560         HSM_AGENT_REC           = LLOG_OP_MAGIC | 0x80000,
2561         UPDATE_REC              = LLOG_OP_MAGIC | 0xa0000,
2562         LLOG_HDR_MAGIC          = LLOG_OP_MAGIC | 0x45539,
2563         LLOG_LOGID_MAGIC        = LLOG_OP_MAGIC | 0x4553b,
2564 } llog_op_type;
2565
2566 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
2567         (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == __swab32(LLOG_OP_MAGIC))
2568
2569 /** Log record header - stored in little endian order.
2570  * Each record must start with this struct, end with a llog_rec_tail,
2571  * and be a multiple of 256 bits in size.
2572  */
2573 struct llog_rec_hdr {
2574         __u32   lrh_len;
2575         __u32   lrh_index;
2576         __u32   lrh_type;
2577         __u32   lrh_id;
2578 };
2579
2580 struct llog_rec_tail {
2581         __u32   lrt_len;
2582         __u32   lrt_index;
2583 };
2584
2585 /* Where data follow just after header */
2586 #define REC_DATA(ptr)                                           \
2587         ((void *)((char *)ptr + sizeof(struct llog_rec_hdr)))
2588
2589 #define REC_DATA_LEN(rec)                                       \
2590         (rec->lrh_len - sizeof(struct llog_rec_hdr) -           \
2591          sizeof(struct llog_rec_tail))
2592
2593 struct llog_logid_rec {
2594         struct llog_rec_hdr     lid_hdr;
2595         struct llog_logid       lid_id;
2596         __u32                   lid_padding1;
2597         __u64                   lid_padding2;
2598         __u64                   lid_padding3;
2599         struct llog_rec_tail    lid_tail;
2600 } __attribute__((packed));
2601
2602 struct llog_unlink_rec {
2603         struct llog_rec_hdr     lur_hdr;
2604         __u64                   lur_oid;
2605         __u32                   lur_oseq;
2606         __u32                   lur_count;
2607         struct llog_rec_tail    lur_tail;
2608 } __attribute__((packed));
2609
2610 struct llog_unlink64_rec {
2611         struct llog_rec_hdr     lur_hdr;
2612         struct lu_fid           lur_fid;
2613         __u32                   lur_count; /* to destroy the lost precreated */
2614         __u32                   lur_padding1;
2615         __u64                   lur_padding2;
2616         __u64                   lur_padding3;
2617         struct llog_rec_tail    lur_tail;
2618 } __attribute__((packed));
2619
2620 struct llog_setattr64_rec {
2621         struct llog_rec_hdr     lsr_hdr;
2622         struct ost_id           lsr_oi;
2623         __u32                   lsr_uid;
2624         __u32                   lsr_uid_h;
2625         __u32                   lsr_gid;
2626         __u32                   lsr_gid_h;
2627         __u64                   lsr_valid;
2628         struct llog_rec_tail    lsr_tail;
2629 } __attribute__((packed));
2630
2631 /* Extended to support project quota */
2632 struct llog_setattr64_rec_v2 {
2633         struct llog_rec_hdr     lsr_hdr;
2634         struct ost_id           lsr_oi;
2635         __u32                   lsr_uid;
2636         __u32                   lsr_uid_h;
2637         __u32                   lsr_gid;
2638         __u32                   lsr_gid_h;
2639         __u64                   lsr_valid;
2640         __u32                   lsr_projid;
2641         __u32                   lsr_padding1;
2642         __u64                   lsr_padding2;
2643         __u64                   lsr_padding3;
2644         struct llog_rec_tail    lsr_tail;
2645 } __attribute__((packed));
2646
2647 struct llog_size_change_rec {
2648         struct llog_rec_hdr     lsc_hdr;
2649         struct ll_fid           lsc_fid;
2650         __u32                   lsc_ioepoch;
2651         __u32                   lsc_padding1;
2652         __u64                   lsc_padding2;
2653         __u64                   lsc_padding3;
2654         struct llog_rec_tail    lsc_tail;
2655 } __attribute__((packed));
2656
2657 #define CHANGELOG_MAGIC 0xca103000
2658
2659 /** \a changelog_rec_type's that can't be masked */
2660 #define CHANGELOG_MINMASK (1 << CL_MARK)
2661 /** bits covering all \a changelog_rec_type's */
2662 #define CHANGELOG_ALLMASK 0XFFFFFFFF
2663 /** default \a changelog_rec_type mask. Allow all of them, except
2664  * CL_ATIME since it can really be time consuming, and not necessary
2665  * under normal use. */
2666 #define CHANGELOG_DEFMASK (CHANGELOG_ALLMASK & ~(1 << CL_ATIME))
2667
2668 /* changelog llog name, needed by client replicators */
2669 #define CHANGELOG_CATALOG "changelog_catalog"
2670
2671 struct changelog_setinfo {
2672         __u64 cs_recno;
2673         __u32 cs_id;
2674 } __attribute__((packed));
2675
2676 /** changelog record */
2677 struct llog_changelog_rec {
2678         struct llog_rec_hdr  cr_hdr;
2679         struct changelog_rec cr; /**< Variable length field */
2680         struct llog_rec_tail cr_do_not_use; /**< for_sizeof_only */
2681 } __attribute__((packed));
2682
2683 #define CHANGELOG_USER_PREFIX "cl"
2684
2685 struct llog_changelog_user_rec {
2686         struct llog_rec_hdr   cur_hdr;
2687         __u32                 cur_id;
2688         __u32                 cur_padding;
2689         __u64                 cur_endrec;
2690         struct llog_rec_tail  cur_tail;
2691 } __attribute__((packed));
2692
2693 enum agent_req_status {
2694         ARS_WAITING,
2695         ARS_STARTED,
2696         ARS_FAILED,
2697         ARS_CANCELED,
2698         ARS_SUCCEED,
2699 };
2700
2701 static inline const char *agent_req_status2name(enum agent_req_status ars)
2702 {
2703         switch (ars) {
2704         case ARS_WAITING:
2705                 return "WAITING";
2706         case ARS_STARTED:
2707                 return "STARTED";
2708         case ARS_FAILED:
2709                 return "FAILED";
2710         case ARS_CANCELED:
2711                 return "CANCELED";
2712         case ARS_SUCCEED:
2713                 return "SUCCEED";
2714         default:
2715                 return "UNKNOWN";
2716         }
2717 }
2718
2719 struct llog_agent_req_rec {
2720         struct llog_rec_hdr     arr_hdr;        /**< record header */
2721         __u32                   arr_status;     /**< status of the request */
2722                                                 /* must match enum
2723                                                  * agent_req_status */
2724         __u32                   arr_archive_id; /**< backend archive number */
2725         __u64                   arr_flags;      /**< req flags */
2726         __u64                   arr_compound_id;        /**< compound cookie */
2727         __u64                   arr_req_create; /**< req. creation time */
2728         __u64                   arr_req_change; /**< req. status change time */
2729         struct hsm_action_item  arr_hai;        /**< req. to the agent */
2730         struct llog_rec_tail    arr_tail; /**< record tail for_sizezof_only */
2731 } __attribute__((packed));
2732
2733 /* Old llog gen for compatibility */
2734 struct llog_gen {
2735         __u64 mnt_cnt;
2736         __u64 conn_cnt;
2737 } __attribute__((packed));
2738
2739 struct llog_gen_rec {
2740         struct llog_rec_hdr     lgr_hdr;
2741         struct llog_gen         lgr_gen;
2742         __u64                   padding1;
2743         __u64                   padding2;
2744         __u64                   padding3;
2745         struct llog_rec_tail    lgr_tail;
2746 };
2747
2748 /* flags for the logs */
2749 enum llog_flag {
2750         LLOG_F_ZAP_WHEN_EMPTY   = 0x1,
2751         LLOG_F_IS_CAT           = 0x2,
2752         LLOG_F_IS_PLAIN         = 0x4,
2753         LLOG_F_EXT_JOBID        = 0x8,
2754         LLOG_F_IS_FIXSIZE       = 0x10,
2755
2756         /* Note: Flags covered by LLOG_F_EXT_MASK will be inherited from
2757          * catlog to plain log, so do not add LLOG_F_IS_FIXSIZE here,
2758          * because the catlog record is usually fixed size, but its plain
2759          * log record can be variable */
2760         LLOG_F_EXT_MASK = LLOG_F_EXT_JOBID,
2761 };
2762
2763 /* On-disk header structure of each log object, stored in little endian order */
2764 #define LLOG_MIN_CHUNK_SIZE     8192
2765 #define LLOG_HEADER_SIZE        (96) /* sizeof (llog_log_hdr) + sizeof(llh_tail)
2766                                       * - sizeof(llh_bitmap) */
2767 #define LLOG_BITMAP_BYTES       (LLOG_MIN_CHUNK_SIZE - LLOG_HEADER_SIZE)
2768 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
2769
2770 struct llog_log_hdr {
2771         struct llog_rec_hdr     llh_hdr;
2772         __s64                   llh_timestamp;
2773         __u32                   llh_count;
2774         __u32                   llh_bitmap_offset;
2775         __u32                   llh_size;
2776         __u32                   llh_flags;
2777         /* for a catalog the first/oldest and still in-use plain slot is just
2778          * next to it. It will serve as the upper limit after Catalog has
2779          * wrapped around */
2780         __u32                   llh_cat_idx;
2781         struct obd_uuid         llh_tgtuuid;
2782         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32)-23];
2783         /* These fields must always be at the end of the llog_log_hdr.
2784          * Note: llh_bitmap size is variable because llog chunk size could be
2785          * bigger than LLOG_MIN_CHUNK_SIZE, i.e. sizeof(llog_log_hdr) > 8192
2786          * bytes, and the real size is stored in llh_hdr.lrh_len, which means
2787          * llh_tail should only be refered by LLOG_HDR_TAIL().
2788          * But this structure is also used by client/server llog interface
2789          * (see llog_client.c), it will be kept in its original way to avoid
2790          * compatiblity issue. */
2791         __u32                   llh_bitmap[LLOG_BITMAP_BYTES / sizeof(__u32)];
2792         struct llog_rec_tail    llh_tail;
2793 } __attribute__((packed));
2794 #undef LLOG_HEADER_SIZE
2795 #undef LLOG_BITMAP_BYTES
2796
2797 #define LLOG_HDR_BITMAP_SIZE(llh)       (__u32)((llh->llh_hdr.lrh_len - \
2798                                          llh->llh_bitmap_offset -       \
2799                                          sizeof(llh->llh_tail)) * 8)
2800 #define LLOG_HDR_BITMAP(llh)    (__u32 *)((char *)(llh) +               \
2801                                           (llh)->llh_bitmap_offset)
2802 #define LLOG_HDR_TAIL(llh)      ((struct llog_rec_tail *)((char *)llh + \
2803                                                  llh->llh_hdr.lrh_len - \
2804                                                  sizeof(llh->llh_tail)))
2805
2806 /** log cookies are used to reference a specific log file and a record therein */
2807 struct llog_cookie {
2808         struct llog_logid       lgc_lgl;
2809         __u32                   lgc_subsys;
2810         __u32                   lgc_index;
2811         __u32                   lgc_padding;
2812 } __attribute__((packed));
2813
2814 /** llog protocol */
2815 enum llogd_rpc_ops {
2816         LLOG_ORIGIN_HANDLE_CREATE       = 501,
2817         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
2818         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
2819         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
2820         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
2821         LLOG_ORIGIN_CONNECT             = 506,
2822         LLOG_CATINFO                    = 507,  /* deprecated */
2823         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
2824         LLOG_ORIGIN_HANDLE_DESTROY      = 509,  /* for destroy llog object*/
2825         LLOG_LAST_OPC,
2826         LLOG_FIRST_OPC                  = LLOG_ORIGIN_HANDLE_CREATE
2827 };
2828
2829 struct llogd_body {
2830         struct llog_logid  lgd_logid;
2831         __u32 lgd_ctxt_idx;
2832         __u32 lgd_llh_flags;
2833         __u32 lgd_index;
2834         __u32 lgd_saved_index;
2835         __u32 lgd_len;
2836         __u64 lgd_cur_offset;
2837 } __attribute__((packed));
2838
2839 struct llogd_conn_body {
2840         struct llog_gen         lgdc_gen;
2841         struct llog_logid       lgdc_logid;
2842         __u32                   lgdc_ctxt_idx;
2843 } __attribute__((packed));
2844
2845 /* Note: 64-bit types are 64-bit aligned in structure */
2846 struct obdo {
2847         __u64                   o_valid;        /* hot fields in this obdo */
2848         struct ost_id           o_oi;
2849         __u64                   o_parent_seq;
2850         __u64                   o_size;         /* o_size-o_blocks == ost_lvb */
2851         __s64                   o_mtime;
2852         __s64                   o_atime;
2853         __s64                   o_ctime;
2854         __u64                   o_blocks;       /* brw: cli sent cached bytes */
2855         __u64                   o_grant;
2856
2857         /* 32-bit fields start here: keep an even number of them via padding */
2858         __u32                   o_blksize;      /* optimal IO blocksize */
2859         __u32                   o_mode;         /* brw: cli sent cache remain */
2860         __u32                   o_uid;
2861         __u32                   o_gid;
2862         __u32                   o_flags;
2863         __u32                   o_nlink;        /* brw: checksum */
2864         __u32                   o_parent_oid;
2865         __u32                   o_misc;         /* brw: o_dropped */
2866
2867         __u64                   o_ioepoch;      /* epoch in ost writes */
2868         __u32                   o_stripe_idx;   /* holds stripe idx */
2869         __u32                   o_parent_ver;
2870         struct lustre_handle    o_handle;       /* brw: lock handle to prolong
2871                                                  * locks */
2872         /* Originally, the field is llog_cookie for destroy with unlink cookie
2873          * from MDS, it is obsolete in 2.8. Then reuse it by client to transfer
2874          * layout and PFL information in IO, setattr RPCs. Since llog_cookie is
2875          * not used on wire any longer, remove it from the obdo, then it can be
2876          * enlarged freely in the further without affect related RPCs.
2877          *
2878          * sizeof(ost_layout) + sieof(__u32) == sizeof(llog_cookie). */
2879         struct ost_layout       o_layout;
2880         __u32                   o_padding_3;
2881         __u32                   o_uid_h;
2882         __u32                   o_gid_h;
2883
2884         __u64                   o_data_version; /* getattr: sum of iversion for
2885                                                  * each stripe.
2886                                                  * brw: grant space consumed on
2887                                                  * the client for the write */
2888         __u32                   o_projid;
2889         __u32                   o_padding_4;
2890         __u64                   o_padding_5;
2891         __u64                   o_padding_6;
2892 };
2893
2894 #define o_dirty   o_blocks
2895 #define o_undirty o_mode
2896 #define o_dropped o_misc
2897 #define o_cksum   o_nlink
2898 #define o_grant_used o_data_version
2899
2900 struct lfsck_request {
2901         __u32           lr_event;
2902         __u32           lr_index;
2903         __u32           lr_flags;
2904         __u32           lr_valid;
2905         union {
2906                 __u32   lr_speed;
2907                 __u32   lr_status;
2908         };
2909         __u16           lr_version;
2910         __u16           lr_active;
2911         __u16           lr_param;
2912         __u16           lr_async_windows;
2913         __u32           lr_flags2;
2914         struct lu_fid   lr_fid;
2915         struct lu_fid   lr_fid2;
2916         __u32           lr_comp_id;
2917         __u32           lr_padding_0;
2918         __u64           lr_padding_1;
2919         __u64           lr_padding_2;
2920         __u64           lr_padding_3;
2921 };
2922
2923 struct lfsck_reply {
2924         __u32           lr_status;
2925         __u32           lr_padding_1;
2926         __u64           lr_repaired;
2927 };
2928
2929 enum lfsck_events {
2930         LE_LASTID_REBUILDING    = 1,
2931         LE_LASTID_REBUILT       = 2,
2932         LE_PHASE1_DONE          = 3,
2933         LE_PHASE2_DONE          = 4,
2934         LE_START                = 5,
2935         LE_STOP                 = 6,
2936         LE_QUERY                = 7,
2937         /* LE_FID_ACCESSED      = 8, moved to lfsck_events_local */
2938         LE_PEER_EXIT            = 9,
2939         LE_CONDITIONAL_DESTROY  = 10,
2940         LE_PAIRS_VERIFY         = 11,
2941         LE_SET_LMV_MASTER       = 15,
2942         LE_SET_LMV_SLAVE        = 16,
2943 };
2944
2945 enum lfsck_event_flags {
2946         LEF_TO_OST              = 0x00000001,
2947         LEF_FROM_OST            = 0x00000002,
2948         LEF_SET_LMV_HASH        = 0x00000004,
2949         LEF_SET_LMV_ALL         = 0x00000008,
2950         LEF_RECHECK_NAME_HASH   = 0x00000010,
2951         LEF_QUERY_ALL           = 0x00000020,
2952 };
2953
2954 /* request structure for OST's */
2955 struct ost_body {
2956         struct obdo oa;
2957 };
2958
2959 /* Key for FIEMAP to be used in get_info calls */
2960 struct ll_fiemap_info_key {
2961         char            lfik_name[8];
2962         struct obdo     lfik_oa;
2963         struct fiemap   lfik_fiemap;
2964 };
2965
2966 #define IDX_INFO_MAGIC 0x3D37CC37
2967
2968 /* Index file transfer through the network. The server serializes the index into
2969  * a byte stream which is sent to the client via a bulk transfer */
2970 struct idx_info {
2971         __u32           ii_magic;
2972
2973         /* reply: see idx_info_flags below */
2974         __u32           ii_flags;
2975
2976         /* request & reply: number of lu_idxpage (to be) transferred */
2977         __u16           ii_count;
2978         __u16           ii_pad0;
2979
2980         /* request: requested attributes passed down to the iterator API */
2981         __u32           ii_attrs;
2982
2983         /* request & reply: index file identifier (FID) */
2984         struct lu_fid   ii_fid;
2985
2986         /* reply: version of the index file before starting to walk the index.
2987          * Please note that the version can be modified at any time during the
2988          * transfer */
2989         __u64           ii_version;
2990
2991         /* request: hash to start with:
2992          * reply: hash of the first entry of the first lu_idxpage and hash
2993          *        of the entry to read next if any */
2994         __u64           ii_hash_start;
2995         __u64           ii_hash_end;
2996
2997         /* reply: size of keys in lu_idxpages, minimal one if II_FL_VARKEY is
2998          * set */
2999         __u16           ii_keysize;
3000
3001         /* reply: size of records in lu_idxpages, minimal one if II_FL_VARREC
3002          * is set */
3003         __u16           ii_recsize;
3004
3005         __u32           ii_pad1;
3006         __u64           ii_pad2;
3007         __u64           ii_pad3;
3008 };
3009
3010 #define II_END_OFF      MDS_DIR_END_OFF /* all entries have been read */
3011
3012 /* List of flags used in idx_info::ii_flags */
3013 enum idx_info_flags {
3014         II_FL_NOHASH    = 1 << 0, /* client doesn't care about hash value */
3015         II_FL_VARKEY    = 1 << 1, /* keys can be of variable size */
3016         II_FL_VARREC    = 1 << 2, /* records can be of variable size */
3017         II_FL_NONUNQ    = 1 << 3, /* index supports non-unique keys */
3018         II_FL_NOKEY     = 1 << 4, /* client doesn't care about key */
3019 };
3020
3021 #define LIP_MAGIC 0x8A6D6B6C
3022
3023 /* 4KB (= LU_PAGE_SIZE) container gathering key/record pairs */
3024 struct lu_idxpage {
3025         /* 16-byte header */
3026         __u32   lip_magic;
3027         __u16   lip_flags;
3028         __u16   lip_nr;   /* number of entries in the container */
3029         __u64   lip_pad0; /* additional padding for future use */
3030
3031         /* key/record pairs are stored in the remaining 4080 bytes.
3032          * depending upon the flags in idx_info::ii_flags, each key/record
3033          * pair might be preceded by:
3034          * - a hash value
3035          * - the key size (II_FL_VARKEY is set)
3036          * - the record size (II_FL_VARREC is set)
3037          *
3038          * For the time being, we only support fixed-size key & record. */
3039         char    lip_entries[0];
3040 };
3041
3042 #define LIP_HDR_SIZE (offsetof(struct lu_idxpage, lip_entries))
3043
3044 /* Gather all possible type associated with a 4KB container */
3045 union lu_page {
3046         struct lu_dirpage       lp_dir; /* for MDS_READPAGE */
3047         struct lu_idxpage       lp_idx; /* for OBD_IDX_READ */
3048         char                    lp_array[LU_PAGE_SIZE];
3049 };
3050
3051 /* security opcodes */
3052 typedef enum {
3053         SEC_CTX_INIT            = 801,
3054         SEC_CTX_INIT_CONT       = 802,
3055         SEC_CTX_FINI            = 803,
3056         SEC_LAST_OPC,
3057         SEC_FIRST_OPC           = SEC_CTX_INIT
3058 } sec_cmd_t;
3059
3060 /*
3061  * capa related definitions
3062  */
3063 #define CAPA_HMAC_MAX_LEN       64
3064 #define CAPA_HMAC_KEY_MAX_LEN   56
3065
3066 /* NB take care when changing the sequence of elements this struct,
3067  * because the offset info is used in find_capa() */
3068 struct lustre_capa {
3069         struct lu_fid   lc_fid;         /** fid */
3070         __u64           lc_opc;         /** operations allowed */
3071         __u64           lc_uid;         /** file owner */
3072         __u64           lc_gid;         /** file group */
3073         __u32           lc_flags;       /** HMAC algorithm & flags */
3074         __u32           lc_keyid;       /** key# used for the capability */
3075         __u32           lc_timeout;     /** capa timeout value (sec) */
3076         __u32           lc_expiry;      /** expiry time (sec) */
3077         __u8            lc_hmac[CAPA_HMAC_MAX_LEN];   /** HMAC */
3078 } __attribute__((packed));
3079
3080 /** lustre_capa::lc_opc */
3081 enum {
3082         CAPA_OPC_BODY_WRITE   = 1<<0,  /**< write object data */
3083         CAPA_OPC_BODY_READ    = 1<<1,  /**< read object data */
3084         CAPA_OPC_INDEX_LOOKUP = 1<<2,  /**< lookup object fid */
3085         CAPA_OPC_INDEX_INSERT = 1<<3,  /**< insert object fid */
3086         CAPA_OPC_INDEX_DELETE = 1<<4,  /**< delete object fid */
3087         CAPA_OPC_OSS_WRITE    = 1<<5,  /**< write oss object data */
3088         CAPA_OPC_OSS_READ     = 1<<6,  /**< read oss object data */
3089         CAPA_OPC_OSS_TRUNC    = 1<<7,  /**< truncate oss object */
3090         CAPA_OPC_OSS_DESTROY  = 1<<8,  /**< destroy oss object */
3091         CAPA_OPC_META_WRITE   = 1<<9,  /**< write object meta data */
3092         CAPA_OPC_META_READ    = 1<<10, /**< read object meta data */
3093 };
3094
3095 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
3096 #define CAPA_OPC_MDS_ONLY                                                   \
3097         (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
3098          CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
3099 #define CAPA_OPC_OSS_ONLY                                                   \
3100         (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC |      \
3101          CAPA_OPC_OSS_DESTROY)
3102 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
3103 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
3104
3105 /* lustre_capa::lc_hmac_alg */
3106 enum {
3107         CAPA_HMAC_ALG_SHA1 = 1, /**< sha1 algorithm */
3108         CAPA_HMAC_ALG_MAX,
3109 };
3110
3111 #define CAPA_FL_MASK            0x00ffffff
3112 #define CAPA_HMAC_ALG_MASK      0xff000000
3113
3114 struct lustre_capa_key {
3115         __u64   lk_seq;       /**< mds# */
3116         __u32   lk_keyid;     /**< key# */
3117         __u32   lk_padding;
3118         __u8    lk_key[CAPA_HMAC_KEY_MAX_LEN];    /**< key */
3119 } __attribute__((packed));
3120
3121 /** The link ea holds 1 \a link_ea_entry for each hardlink */
3122 #define LINK_EA_MAGIC 0x11EAF1DFUL
3123 struct link_ea_header {
3124         __u32 leh_magic;
3125         __u32 leh_reccount;
3126         __u64 leh_len;  /* total size */
3127         __u32 leh_overflow_time;
3128         __u32 leh_padding;
3129 };
3130
3131 /** Hardlink data is name and parent fid.
3132  * Stored in this crazy struct for maximum packing and endian-neutrality
3133  */
3134 struct link_ea_entry {
3135         /** __u16 stored big-endian, unaligned */
3136         unsigned char      lee_reclen[2];
3137         unsigned char      lee_parent_fid[sizeof(struct lu_fid)];
3138         char               lee_name[0];
3139 }__attribute__((packed));
3140
3141 /** fid2path request/reply structure */
3142 struct getinfo_fid2path {
3143         struct lu_fid   gf_fid;
3144         __u64           gf_recno;
3145         __u32           gf_linkno;
3146         __u32           gf_pathlen;
3147         union {
3148                 char            gf_path[0];
3149                 struct lu_fid   gf_root_fid[0];
3150         } gf_u;
3151 } __attribute__((packed));
3152
3153 /** path2parent request/reply