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