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