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