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