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