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