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