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