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