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