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