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