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