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