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