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