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