Whamcloud - gitweb
LU-7543 obd: reserve connection flag OBD_CONNECT_LOCK_AHEAD
[fs/lustre-release.git] / lustre / include / lustre / lustre_idl.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2015, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/include/lustre/lustre_idl.h
37  *
38  * Lustre wire protocol definitions.
39  */
40
41 /** \defgroup lustreidl lustreidl
42  *
43  * Lustre wire protocol definitions.
44  *
45  * ALL structs passing over the wire should be declared here.  Structs
46  * that are used in interfaces with userspace should go in lustre_user.h.
47  *
48  * All structs being declared here should be built from simple fixed-size
49  * types (__u8, __u16, __u32, __u64) or be built from other types or
50  * structs also declared in this file.  Similarly, all flags and magic
51  * values in those structs should also be declared here.  This ensures
52  * that the Lustre wire protocol is not influenced by external dependencies.
53  *
54  * The only other acceptable items in this file are VERY SIMPLE accessor
55  * functions to avoid callers grubbing inside the structures, 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>
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("Too large OID %#llx to set MDT0 "DOSTID"\n",
614                                (unsigned long long)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("Too large OID %#llx to set IDIF "DOSTID"\n",
621                                (unsigned long long)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("Too large oid %#llx to set REG "DOSTID"\n",
631                                (unsigned long long)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("Too large OID %#llx to set IDIF "DFID"\n",
648                                (unsigned long long)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("Too large OID %#llx to set REG "DFID"\n",
657                                (unsigned long long)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
706                  * across all OSTs, or a regular FID.  The IDIF namespace maps
707                  * legacy OST objects into the FID namespace.  In both cases,
708                  * we just 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         /* Something in the record is unknown, to be verified in further. */
898         LUDA_UNKNOWN            = 0x0400,
899         /* Ignore this record, go to next directly. */
900         LUDA_IGNORE             = 0x0800,
901         /* The system is upgraded, has beed or to be repaired (dryrun). */
902         LUDA_UPGRADE            = 0x1000,
903         /* The dirent has been repaired, or to be repaired (dryrun). */
904         LUDA_REPAIR             = 0x2000,
905         /* Only check but not repair the dirent inconsistency */
906         LUDA_VERIFY_DRYRUN      = 0x4000,
907         /* Verify the dirent consistency */
908         LUDA_VERIFY             = 0x8000,
909 };
910
911 #define LU_DIRENT_ATTRS_MASK    0xff00
912
913 /**
914  * Layout of readdir pages, as transmitted on wire.
915  */
916 struct lu_dirent {
917         /** valid if LUDA_FID is set. */
918         struct lu_fid lde_fid;
919         /** a unique entry identifier: a hash or an offset. */
920         __u64         lde_hash;
921         /** total record length, including all attributes. */
922         __u16         lde_reclen;
923         /** name length */
924         __u16         lde_namelen;
925         /** optional variable size attributes following this entry.
926          *  taken from enum lu_dirent_attrs.
927          */
928         __u32         lde_attrs;
929         /** name is followed by the attributes indicated in ->ldp_attrs, in
930          *  their natural order. After the last attribute, padding bytes are
931          *  added to make ->lde_reclen a multiple of 8.
932          */
933         char          lde_name[0];
934 };
935
936 /*
937  * Definitions of optional directory entry attributes formats.
938  *
939  * Individual attributes do not have their length encoded in a generic way. It
940  * is assumed that consumer of an attribute knows its format. This means that
941  * it is impossible to skip over an unknown attribute, except by skipping over all
942  * remaining attributes (by using ->lde_reclen), which is not too
943  * constraining, because new server versions will append new attributes at
944  * the end of an entry.
945  */
946
947 /**
948  * Fid directory attribute: a fid of an object referenced by the entry. This
949  * will be almost always requested by the client and supplied by the server.
950  *
951  * Aligned to 8 bytes.
952  */
953 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
954
955 /**
956  * File type.
957  *
958  * Aligned to 2 bytes.
959  */
960 struct luda_type {
961         __u16 lt_type;
962 };
963
964 struct lu_dirpage {
965         __u64            ldp_hash_start;
966         __u64            ldp_hash_end;
967         __u32            ldp_flags;
968         __u32            ldp_pad0;
969         struct lu_dirent ldp_entries[0];
970 };
971
972 enum lu_dirpage_flags {
973         /**
974          * dirpage contains no entry.
975          */
976         LDF_EMPTY   = 1 << 0,
977         /**
978          * last entry's lde_hash equals ldp_hash_end.
979          */
980         LDF_COLLIDE = 1 << 1
981 };
982
983 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
984 {
985         if (le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
986                 return NULL;
987         else
988                 return dp->ldp_entries;
989 }
990
991 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
992 {
993         struct lu_dirent *next;
994
995         if (le16_to_cpu(ent->lde_reclen) != 0)
996                 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
997         else
998                 next = NULL;
999
1000         return next;
1001 }
1002
1003 static inline size_t lu_dirent_calc_size(size_t namelen, __u16 attr)
1004 {
1005         size_t size;
1006
1007         if (attr & LUDA_TYPE) {
1008                 const size_t align = sizeof(struct luda_type) - 1;
1009                 size = (sizeof(struct lu_dirent) + namelen + align) & ~align;
1010                 size += sizeof(struct luda_type);
1011         } else
1012                 size = sizeof(struct lu_dirent) + namelen;
1013
1014         return (size + 7) & ~7;
1015 }
1016
1017 #define MDS_DIR_END_OFF 0xfffffffffffffffeULL
1018
1019 /**
1020  * MDS_READPAGE page size
1021  *
1022  * This is the directory page size packed in MDS_READPAGE RPC.
1023  * It's different than PAGE_CACHE_SIZE because the client needs to
1024  * access the struct lu_dirpage header packed at the beginning of
1025  * the "page" and without this there isn't any way to know find the
1026  * lu_dirpage header is if client and server PAGE_CACHE_SIZE differ.
1027  */
1028 #define LU_PAGE_SHIFT 12
1029 #define LU_PAGE_SIZE  (1UL << LU_PAGE_SHIFT)
1030 #define LU_PAGE_MASK  (~(LU_PAGE_SIZE - 1))
1031
1032 #define LU_PAGE_COUNT (1 << (PAGE_CACHE_SHIFT - LU_PAGE_SHIFT))
1033
1034 /** @} lu_dir */
1035
1036 struct lustre_handle {
1037         __u64 cookie;
1038 };
1039 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
1040
1041 static inline bool lustre_handle_is_used(const struct lustre_handle *lh)
1042 {
1043         return lh->cookie != 0;
1044 }
1045
1046 static inline bool lustre_handle_equal(const struct lustre_handle *lh1,
1047                                        const struct lustre_handle *lh2)
1048 {
1049         return lh1->cookie == lh2->cookie;
1050 }
1051
1052 static inline void lustre_handle_copy(struct lustre_handle *tgt,
1053                                       const struct lustre_handle *src)
1054 {
1055         tgt->cookie = src->cookie;
1056 }
1057
1058 /* flags for lm_flags */
1059 #define MSGHDR_AT_SUPPORT               0x1
1060 #define MSGHDR_CKSUM_INCOMPAT18         0x2
1061
1062 #define lustre_msg lustre_msg_v2
1063 /* we depend on this structure to be 8-byte aligned */
1064 /* this type is only endian-adjusted in lustre_unpack_msg() */
1065 struct lustre_msg_v2 {
1066         __u32 lm_bufcount;
1067         __u32 lm_secflvr;
1068         __u32 lm_magic;
1069         __u32 lm_repsize;
1070         __u32 lm_cksum;
1071         __u32 lm_flags;
1072         __u32 lm_padding_2;
1073         __u32 lm_padding_3;
1074         __u32 lm_buflens[0];
1075 };
1076
1077 /* without gss, ptlrpc_body is put at the first buffer. */
1078 #define PTLRPC_NUM_VERSIONS     4
1079 struct ptlrpc_body_v3 {
1080         struct lustre_handle pb_handle;
1081         __u32 pb_type;
1082         __u32 pb_version;
1083         __u32 pb_opc;
1084         __u32 pb_status;
1085         __u64 pb_last_xid; /* highest replied XID without lower unreplied XID */
1086         __u16 pb_tag;      /* virtual slot idx for multiple modifying RPCs */
1087         __u16 pb_padding0;
1088         __u32 pb_padding1;
1089         __u64 pb_last_committed;
1090         __u64 pb_transno;
1091         __u32 pb_flags;
1092         __u32 pb_op_flags;
1093         __u32 pb_conn_cnt;
1094         __u32 pb_timeout;  /* for req, the deadline, for rep, the service est */
1095         __u32 pb_service_time; /* for rep, actual service time */
1096         __u32 pb_limit;
1097         __u64 pb_slv;
1098         /* VBR: pre-versions */
1099         __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1100         __u64 pb_mbits; /**< match bits for bulk request */
1101         /* padding for future needs */
1102         __u64 pb_padding64_0;
1103         __u64 pb_padding64_1;
1104         __u64 pb_padding64_2;
1105         char  pb_jobid[LUSTRE_JOBID_SIZE];
1106 };
1107 #define ptlrpc_body     ptlrpc_body_v3
1108
1109 struct ptlrpc_body_v2 {
1110         struct lustre_handle pb_handle;
1111         __u32 pb_type;
1112         __u32 pb_version;
1113         __u32 pb_opc;
1114         __u32 pb_status;
1115         __u64 pb_last_xid; /* highest replied XID without lower unreplied XID */
1116         __u16 pb_tag;      /* virtual slot idx for multiple modifying RPCs */
1117         __u16 pb_padding0;
1118         __u32 pb_padding1;
1119         __u64 pb_last_committed;
1120         __u64 pb_transno;
1121         __u32 pb_flags;
1122         __u32 pb_op_flags;
1123         __u32 pb_conn_cnt;
1124         __u32 pb_timeout;  /* for req, the deadline, for rep, the service est */
1125         __u32 pb_service_time; /* for rep, actual service time, also used for
1126                                   net_latency of req */
1127         __u32 pb_limit;
1128         __u64 pb_slv;
1129         /* VBR: pre-versions */
1130         __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1131         __u64 pb_mbits; /**< unused in V2 */
1132         /* padding for future needs */
1133         __u64 pb_padding64_0;
1134         __u64 pb_padding64_1;
1135         __u64 pb_padding64_2;
1136 };
1137
1138 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
1139
1140 /* message body offset for lustre_msg_v2 */
1141 /* ptlrpc body offset in all request/reply messages */
1142 #define MSG_PTLRPC_BODY_OFF             0
1143
1144 /* normal request/reply message record offset */
1145 #define REQ_REC_OFF                     1
1146 #define REPLY_REC_OFF                   1
1147
1148 /* ldlm request message body offset */
1149 #define DLM_LOCKREQ_OFF                 1 /* lockreq offset */
1150 #define DLM_REQ_REC_OFF                 2 /* normal dlm request record offset */
1151
1152 /* ldlm intent lock message body offset */
1153 #define DLM_INTENT_IT_OFF               2 /* intent lock it offset */
1154 #define DLM_INTENT_REC_OFF              3 /* intent lock record offset */
1155
1156 /* ldlm reply message body offset */
1157 #define DLM_LOCKREPLY_OFF               1 /* lockrep offset */
1158 #define DLM_REPLY_REC_OFF               2 /* reply record offset */
1159
1160 /** only use in req->rq_{req,rep}_swab_mask */
1161 #define MSG_PTLRPC_HEADER_OFF           31
1162
1163 /* Flags that are operation-specific go in the top 16 bits. */
1164 #define MSG_OP_FLAG_MASK   0xffff0000
1165 #define MSG_OP_FLAG_SHIFT  16
1166
1167 /* Flags that apply to all requests are in the bottom 16 bits */
1168 #define MSG_GEN_FLAG_MASK     0x0000ffff
1169 #define MSG_LAST_REPLAY           0x0001
1170 #define MSG_RESENT                0x0002
1171 #define MSG_REPLAY                0x0004
1172 /* #define MSG_AT_SUPPORT         0x0008
1173  * This was used in early prototypes of adaptive timeouts, and while there
1174  * shouldn't be any users of that code there also isn't a need for using this
1175  * bits. Defer usage until at least 1.10 to avoid potential conflict. */
1176 #define MSG_DELAY_REPLAY          0x0010
1177 #define MSG_VERSION_REPLAY        0x0020
1178 #define MSG_REQ_REPLAY_DONE       0x0040
1179 #define MSG_LOCK_REPLAY_DONE      0x0080
1180
1181 /*
1182  * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
1183  */
1184
1185 #define MSG_CONNECT_RECOVERING  0x00000001
1186 #define MSG_CONNECT_RECONNECT   0x00000002
1187 #define MSG_CONNECT_REPLAYABLE  0x00000004
1188 //#define MSG_CONNECT_PEER        0x8
1189 #define MSG_CONNECT_LIBCLIENT   0x00000010
1190 #define MSG_CONNECT_INITIAL     0x00000020
1191 #define MSG_CONNECT_ASYNC       0x00000040
1192 #define MSG_CONNECT_NEXT_VER    0x00000080 /* use next version of lustre_msg */
1193 #define MSG_CONNECT_TRANSNO     0x00000100 /* report transno */
1194
1195 /* Connect flags */
1196 #define OBD_CONNECT_RDONLY                0x1ULL /*client has read-only access*/
1197 #define OBD_CONNECT_INDEX                 0x2ULL /*connect specific LOV idx */
1198 #define OBD_CONNECT_MDS                   0x4ULL /*connect from MDT to OST */
1199 #define OBD_CONNECT_GRANT                 0x8ULL /*OSC gets grant at connect */
1200 #define OBD_CONNECT_SRVLOCK              0x10ULL /*server takes locks for cli */
1201 #define OBD_CONNECT_VERSION              0x20ULL /*Lustre versions in ocd */
1202 #define OBD_CONNECT_REQPORTAL            0x40ULL /*Separate non-IO req portal */
1203 #define OBD_CONNECT_ACL                  0x80ULL /*access control lists */
1204 #define OBD_CONNECT_XATTR               0x100ULL /*client use extended attr */
1205 #define OBD_CONNECT_CROW                0x200ULL /*MDS+OST create obj on write*/
1206 #define OBD_CONNECT_TRUNCLOCK           0x400ULL /*locks on server for punch */
1207 #define OBD_CONNECT_TRANSNO             0x800ULL /*replay sends init transno */
1208 #define OBD_CONNECT_IBITS              0x1000ULL /*support for inodebits locks*/
1209 #define OBD_CONNECT_JOIN               0x2000ULL /*files can be concatenated.
1210                                                   *We do not support JOIN FILE
1211                                                   *anymore, reserve this flags
1212                                                   *just for preventing such bit
1213                                                   *to be reused.*/
1214 #define OBD_CONNECT_ATTRFID            0x4000ULL /*Server can GetAttr By Fid*/
1215 #define OBD_CONNECT_NODEVOH            0x8000ULL /*No open hndl on specl nodes*/
1216 #define OBD_CONNECT_RMT_CLIENT        0x10000ULL /*Remote client */
1217 #define OBD_CONNECT_RMT_CLIENT_FORCE  0x20000ULL /*Remote client by force */
1218 #define OBD_CONNECT_BRW_SIZE          0x40000ULL /*Max bytes per rpc */
1219 #define OBD_CONNECT_QUOTA64           0x80000ULL /*Not used since 2.4 */
1220 #define OBD_CONNECT_MDS_CAPA         0x100000ULL /*MDS capability */
1221 #define OBD_CONNECT_OSS_CAPA         0x200000ULL /*OSS capability */
1222 #define OBD_CONNECT_CANCELSET        0x400000ULL /*Early batched cancels. */
1223 #define OBD_CONNECT_SOM              0x800000ULL /*Size on MDS */
1224 #define OBD_CONNECT_AT              0x1000000ULL /*client uses AT */
1225 #define OBD_CONNECT_LRU_RESIZE      0x2000000ULL /*LRU resize feature. */
1226 #define OBD_CONNECT_MDS_MDS         0x4000000ULL /*MDS-MDS connection */
1227 #define OBD_CONNECT_REAL            0x8000000ULL /*real connection */
1228 #define OBD_CONNECT_CHANGE_QS      0x10000000ULL /*Not used since 2.4 */
1229 #define OBD_CONNECT_CKSUM          0x20000000ULL /*support several cksum algos*/
1230 #define OBD_CONNECT_FID            0x40000000ULL /*FID is supported by server */
1231 #define OBD_CONNECT_VBR            0x80000000ULL /*version based recovery */
1232 #define OBD_CONNECT_LOV_V3        0x100000000ULL /*client supports LOV v3 EA */
1233 #define OBD_CONNECT_GRANT_SHRINK  0x200000000ULL /* support grant shrink */
1234 #define OBD_CONNECT_SKIP_ORPHAN   0x400000000ULL /* don't reuse orphan objids */
1235 #define OBD_CONNECT_MAX_EASIZE    0x800000000ULL /* preserved for large EA */
1236 #define OBD_CONNECT_FULL20       0x1000000000ULL /* it is 2.0 client */
1237 #define OBD_CONNECT_LAYOUTLOCK   0x2000000000ULL /* client uses layout lock */
1238 #define OBD_CONNECT_64BITHASH    0x4000000000ULL /* client supports 64-bits
1239                                                   * directory hash */
1240 #define OBD_CONNECT_MAXBYTES     0x8000000000ULL /* max stripe size */
1241 #define OBD_CONNECT_IMP_RECOV   0x10000000000ULL /* imp recovery support */
1242 #define OBD_CONNECT_JOBSTATS    0x20000000000ULL /* jobid in ptlrpc_body */
1243 #define OBD_CONNECT_UMASK       0x40000000000ULL /* create uses client umask */
1244 #define OBD_CONNECT_EINPROGRESS 0x80000000000ULL /* client handles -EINPROGRESS
1245                                                   * RPC error properly */
1246 #define OBD_CONNECT_GRANT_PARAM 0x100000000000ULL/* extra grant params used for
1247                                                   * finer space reservation */
1248 #define OBD_CONNECT_FLOCK_OWNER 0x200000000000ULL /* for the fixed 1.8
1249                                                    * policy and 2.x server */
1250 #define OBD_CONNECT_LVB_TYPE    0x400000000000ULL /* variable type of LVB */
1251 #define OBD_CONNECT_NANOSEC_TIME 0x800000000000ULL /* nanosecond timestamps */
1252 #define OBD_CONNECT_LIGHTWEIGHT 0x1000000000000ULL/* lightweight connection */
1253 #define OBD_CONNECT_SHORTIO     0x2000000000000ULL/* short io */
1254 #define OBD_CONNECT_PINGLESS    0x4000000000000ULL/* pings not required */
1255 #define OBD_CONNECT_FLOCK_DEAD  0x8000000000000ULL/* improved flock deadlock detection */
1256 #define OBD_CONNECT_DISP_STRIPE 0x10000000000000ULL/* create stripe disposition*/
1257 #define OBD_CONNECT_OPEN_BY_FID 0x20000000000000ULL /* open by fid won't pack
1258                                                        name in request */
1259 #define OBD_CONNECT_LFSCK      0x40000000000000ULL/* support online LFSCK */
1260 #define OBD_CONNECT_UNLINK_CLOSE 0x100000000000000ULL/* close file in unlink */
1261 #define OBD_CONNECT_MULTIMODRPCS 0x200000000000000ULL /* support multiple modify
1262                                                          RPCs in parallel */
1263 #define OBD_CONNECT_DIR_STRIPE   0x400000000000000ULL /* striped DNE dir */
1264 #define OBD_CONNECT_SUBTREE     0x800000000000000ULL /* fileset mount */
1265 #define OBD_CONNECT_LOCK_AHEAD   0x1000000000000000ULL /* lock ahead */
1266 /** bulk matchbits is sent within ptlrpc_body */
1267 #define OBD_CONNECT_BULK_MBITS   0x2000000000000000ULL
1268 #define OBD_CONNECT_OBDOPACK     0x4000000000000000ULL /* compact OUT obdo */
1269 /* XXX README XXX:
1270  * Please DO NOT add flag values here before first ensuring that this same
1271  * flag value is not in use on some other branch.  Please clear any such
1272  * changes with senior engineers before starting to use a new flag.  Then,
1273  * submit a small patch against EVERY branch that ONLY adds the new flag,
1274  * updates obd_connect_names[] for lprocfs_rd_connect_flags(), adds the
1275  * flag to check_obd_connect_data(), and updates wiretests accordingly, so it
1276  * can be approved and landed easily to reserve the flag for future use. */
1277
1278 /* The MNE_SWAB flag is overloading the MDS_MDS bit only for the MGS
1279  * connection.  It is a temporary bug fix for Imperative Recovery interop
1280  * between 2.2 and 2.3 x86/ppc nodes, and can be removed when interop for
1281  * 2.2 clients/servers is no longer needed.  LU-1252/LU-1644. */
1282 #define OBD_CONNECT_MNE_SWAB             OBD_CONNECT_MDS_MDS
1283
1284 #define OCD_HAS_FLAG(ocd, flg)  \
1285         (!!((ocd)->ocd_connect_flags & OBD_CONNECT_##flg))
1286
1287
1288 #ifdef HAVE_LRU_RESIZE_SUPPORT
1289 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
1290 #else
1291 #define LRU_RESIZE_CONNECT_FLAG 0
1292 #endif
1293
1294 #define MDT_CONNECT_SUPPORTED  (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
1295                                 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
1296                                 OBD_CONNECT_IBITS | \
1297                                 OBD_CONNECT_NODEVOH | OBD_CONNECT_ATTRFID | \
1298                                 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1299                                 OBD_CONNECT_RMT_CLIENT | \
1300                                 OBD_CONNECT_RMT_CLIENT_FORCE | \
1301                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_MDS_MDS | \
1302                                 OBD_CONNECT_FID | LRU_RESIZE_CONNECT_FLAG | \
1303                                 OBD_CONNECT_VBR | OBD_CONNECT_LOV_V3 | \
1304                                 OBD_CONNECT_FULL20 | \
1305                                 OBD_CONNECT_64BITHASH | OBD_CONNECT_JOBSTATS | \
1306                                 OBD_CONNECT_EINPROGRESS | \
1307                                 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_UMASK | \
1308                                 OBD_CONNECT_LVB_TYPE | OBD_CONNECT_LAYOUTLOCK |\
1309                                 OBD_CONNECT_PINGLESS | OBD_CONNECT_MAX_EASIZE |\
1310                                 OBD_CONNECT_FLOCK_DEAD | \
1311                                 OBD_CONNECT_DISP_STRIPE | OBD_CONNECT_LFSCK | \
1312                                 OBD_CONNECT_OPEN_BY_FID | \
1313                                 OBD_CONNECT_DIR_STRIPE | \
1314                                 OBD_CONNECT_BULK_MBITS | \
1315                                 OBD_CONNECT_MULTIMODRPCS)
1316
1317 #define OST_CONNECT_SUPPORTED  (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
1318                                 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
1319                                 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
1320                                 OBD_CONNECT_BRW_SIZE | \
1321                                 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1322                                 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_CKSUM | \
1323                                 OBD_CONNECT_RMT_CLIENT | \
1324                                 OBD_CONNECT_RMT_CLIENT_FORCE | OBD_CONNECT_VBR | \
1325                                 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
1326                                 OBD_CONNECT_GRANT_SHRINK | OBD_CONNECT_FULL20 | \
1327                                 OBD_CONNECT_64BITHASH | OBD_CONNECT_MAXBYTES | \
1328                                 OBD_CONNECT_MAX_EASIZE | \
1329                                 OBD_CONNECT_EINPROGRESS | \
1330                                 OBD_CONNECT_JOBSTATS | \
1331                                 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_LVB_TYPE|\
1332                                 OBD_CONNECT_LAYOUTLOCK | OBD_CONNECT_FID | \
1333                                 OBD_CONNECT_PINGLESS | OBD_CONNECT_LFSCK | \
1334                                 OBD_CONNECT_BULK_MBITS)
1335 #define ECHO_CONNECT_SUPPORTED (0)
1336 #define MGS_CONNECT_SUPPORTED  (OBD_CONNECT_VERSION | OBD_CONNECT_AT | \
1337                                 OBD_CONNECT_FULL20 | OBD_CONNECT_IMP_RECOV | \
1338                                 OBD_CONNECT_MNE_SWAB | OBD_CONNECT_PINGLESS |\
1339                                 OBD_CONNECT_BULK_MBITS)
1340
1341 /* Features required for this version of the client to work with server */
1342 #define CLIENT_CONNECT_MDT_REQD (OBD_CONNECT_IBITS | OBD_CONNECT_FID | \
1343                                  OBD_CONNECT_FULL20)
1344
1345 /* This structure is used for both request and reply.
1346  *
1347  * If we eventually have separate connect data for different types, which we
1348  * almost certainly will, then perhaps we stick a union in here. */
1349 struct obd_connect_data {
1350         __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1351         __u32 ocd_version;       /* lustre release version number */
1352         __u32 ocd_grant;         /* initial cache grant amount (bytes) */
1353         __u32 ocd_index;         /* LOV index to connect to */
1354         __u32 ocd_brw_size;      /* Maximum BRW size in bytes */
1355         __u64 ocd_ibits_known;   /* inode bits this client understands */
1356         __u8  ocd_blocksize;     /* log2 of the backend filesystem blocksize */
1357         __u8  ocd_inodespace;    /* log2 of the per-inode space consumption */
1358         __u16 ocd_grant_extent;  /* per-extent grant overhead, in 1K blocks */
1359         __u32 ocd_unused;        /* also fix lustre_swab_connect */
1360         __u64 ocd_transno;       /* first transno from client to be replayed */
1361         __u32 ocd_group;         /* MDS group on OST */
1362         __u32 ocd_cksum_types;   /* supported checksum algorithms */
1363         __u32 ocd_max_easize;    /* How big LOV EA can be on MDS */
1364         __u32 ocd_instance;      /* instance # of this target */
1365         __u64 ocd_maxbytes;      /* Maximum stripe size in bytes */
1366         /* Fields after ocd_maxbytes are only accessible by the receiver
1367          * if the corresponding flag in ocd_connect_flags is set. Accessing
1368          * any field after ocd_maxbytes on the receiver without a valid flag
1369          * may result in out-of-bound memory access and kernel oops. */
1370         __u16 ocd_maxmodrpcs;    /* Maximum modify RPCs in parallel */
1371         __u16 padding0;          /* added 2.1.0. also fix lustre_swab_connect */
1372         __u32 padding1;          /* added 2.1.0. also fix lustre_swab_connect */
1373         __u64 padding2;          /* added 2.1.0. also fix lustre_swab_connect */
1374         __u64 padding3;          /* added 2.1.0. also fix lustre_swab_connect */
1375         __u64 padding4;          /* added 2.1.0. also fix lustre_swab_connect */
1376         __u64 padding5;          /* added 2.1.0. also fix lustre_swab_connect */
1377         __u64 padding6;          /* added 2.1.0. also fix lustre_swab_connect */
1378         __u64 padding7;          /* added 2.1.0. also fix lustre_swab_connect */
1379         __u64 padding8;          /* added 2.1.0. also fix lustre_swab_connect */
1380         __u64 padding9;          /* added 2.1.0. also fix lustre_swab_connect */
1381         __u64 paddingA;          /* added 2.1.0. also fix lustre_swab_connect */
1382         __u64 paddingB;          /* added 2.1.0. also fix lustre_swab_connect */
1383         __u64 paddingC;          /* added 2.1.0. also fix lustre_swab_connect */
1384         __u64 paddingD;          /* added 2.1.0. also fix lustre_swab_connect */
1385         __u64 paddingE;          /* added 2.1.0. also fix lustre_swab_connect */
1386         __u64 paddingF;          /* added 2.1.0. also fix lustre_swab_connect */
1387 };
1388 /* XXX README XXX:
1389  * Please DO NOT use any fields here before first ensuring that this same
1390  * field is not in use on some other branch.  Please clear any such changes
1391  * with senior engineers before starting to use a new field.  Then, submit
1392  * a small patch against EVERY branch that ONLY adds the new field along with
1393  * the matching OBD_CONNECT flag, so that can be approved and landed easily to
1394  * reserve the flag for future use. */
1395
1396
1397 extern void lustre_swab_connect(struct obd_connect_data *ocd);
1398
1399 /*
1400  * Supported checksum algorithms. Up to 32 checksum types are supported.
1401  * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
1402  * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
1403  * algorithm and also the OBD_FL_CKSUM* flags.
1404  */
1405 typedef enum {
1406         OBD_CKSUM_CRC32 = 0x00000001,
1407         OBD_CKSUM_ADLER = 0x00000002,
1408         OBD_CKSUM_CRC32C= 0x00000004,
1409 } cksum_type_t;
1410
1411 /*
1412  *   OST requests: OBDO & OBD request records
1413  */
1414
1415 /* opcodes */
1416 typedef enum {
1417         OST_REPLY      =  0,       /* reply ? */
1418         OST_GETATTR    =  1,
1419         OST_SETATTR    =  2,
1420         OST_READ       =  3,
1421         OST_WRITE      =  4,
1422         OST_CREATE     =  5,
1423         OST_DESTROY    =  6,
1424         OST_GET_INFO   =  7,
1425         OST_CONNECT    =  8,
1426         OST_DISCONNECT =  9,
1427         OST_PUNCH      = 10,
1428         OST_OPEN       = 11,
1429         OST_CLOSE      = 12,
1430         OST_STATFS     = 13,
1431         OST_SYNC       = 16,
1432         OST_SET_INFO   = 17,
1433         OST_QUOTACHECK = 18, /* not used since 2.4 */
1434         OST_QUOTACTL   = 19,
1435         OST_QUOTA_ADJUST_QUNIT = 20, /* not used since 2.4 */
1436         OST_LAST_OPC
1437 } ost_cmd_t;
1438 #define OST_FIRST_OPC  OST_REPLY
1439
1440 enum obdo_flags {
1441         OBD_FL_INLINEDATA   = 0x00000001,
1442         OBD_FL_OBDMDEXISTS  = 0x00000002,
1443         OBD_FL_DELORPHAN    = 0x00000004, /* if set in o_flags delete orphans */
1444         OBD_FL_NORPC        = 0x00000008, /* set in o_flags do in OSC not OST */
1445         OBD_FL_IDONLY       = 0x00000010, /* set in o_flags only adjust obj id*/
1446         OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
1447         OBD_FL_DEBUG_CHECK  = 0x00000040, /* echo client/server debug check */
1448         OBD_FL_NO_USRQUOTA  = 0x00000100, /* the object's owner is over quota */
1449         OBD_FL_NO_GRPQUOTA  = 0x00000200, /* the object's group is over quota */
1450         OBD_FL_CREATE_CROW  = 0x00000400, /* object should be create on write */
1451         OBD_FL_SRVLOCK      = 0x00000800, /* delegate DLM locking to server */
1452         OBD_FL_CKSUM_CRC32  = 0x00001000, /* CRC32 checksum type */
1453         OBD_FL_CKSUM_ADLER  = 0x00002000, /* ADLER checksum type */
1454         OBD_FL_CKSUM_CRC32C = 0x00004000, /* CRC32C checksum type */
1455         OBD_FL_CKSUM_RSVD2  = 0x00008000, /* for future cksum types */
1456         OBD_FL_CKSUM_RSVD3  = 0x00010000, /* for future cksum types */
1457         OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
1458         OBD_FL_MMAP         = 0x00040000, /* object is mmapped on the client.
1459                                            * XXX: obsoleted - reserved for old
1460                                            * clients prior than 2.2 */
1461         OBD_FL_RECOV_RESEND = 0x00080000, /* recoverable resent */
1462         OBD_FL_NOSPC_BLK    = 0x00100000, /* no more block space on OST */
1463         OBD_FL_FLUSH        = 0x00200000, /* flush pages on the OST */
1464         OBD_FL_SHORT_IO     = 0x00400000, /* short io request */
1465
1466         /* Note that while these checksum values are currently separate bits,
1467          * in 2.x we can actually allow all values from 1-31 if we wanted. */
1468         OBD_FL_CKSUM_ALL    = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER |
1469                               OBD_FL_CKSUM_CRC32C,
1470
1471         /* mask for local-only flag, which won't be sent over network */
1472         OBD_FL_LOCAL_MASK   = 0xF0000000,
1473 };
1474
1475 /*
1476  * All LOV EA magics should have the same postfix, if some new version
1477  * Lustre instroduces new LOV EA magic, then when down-grade to an old
1478  * Lustre, even though the old version system does not recognizes such
1479  * new magic, it still can distinguish the corrupted cases by checking
1480  * the magic's postfix.
1481  */
1482 #define LOV_MAGIC_MAGIC 0x0BD0
1483 #define LOV_MAGIC_MASK  0xFFFF
1484
1485 #define LOV_MAGIC_V1            (0x0BD10000 | LOV_MAGIC_MAGIC)
1486 #define LOV_MAGIC_JOIN_V1       (0x0BD20000 | LOV_MAGIC_MAGIC)
1487 #define LOV_MAGIC_V3            (0x0BD30000 | LOV_MAGIC_MAGIC)
1488 #define LOV_MAGIC_MIGRATE       (0x0BD40000 | LOV_MAGIC_MAGIC)
1489 /* reserved for specifying OSTs */
1490 #define LOV_MAGIC_SPECIFIC      (0x0BD50000 | LOV_MAGIC_MAGIC)
1491 #define LOV_MAGIC               LOV_MAGIC_V1
1492
1493 /*
1494  * magic for fully defined striping
1495  * the idea is that we should have different magics for striping "hints"
1496  * (struct lov_user_md_v[13]) and defined ready-to-use striping (struct
1497  * lov_mds_md_v[13]). at the moment the magics are used in wire protocol,
1498  * we can't just change it w/o long way preparation, but we still need a
1499  * mechanism to allow LOD to differentiate hint versus ready striping.
1500  * so, at the moment we do a trick: MDT knows what to expect from request
1501  * depending on the case (replay uses ready striping, non-replay req uses
1502  * hints), so MDT replaces magic with appropriate one and now LOD can
1503  * easily understand what's inside -bzzz
1504  */
1505 #define LOV_MAGIC_V1_DEF  0x0CD10BD0
1506 #define LOV_MAGIC_V3_DEF  0x0CD30BD0
1507
1508 #define lov_pattern(pattern)            (pattern & ~LOV_PATTERN_F_MASK)
1509 #define lov_pattern_flags(pattern)      (pattern & LOV_PATTERN_F_MASK)
1510
1511 #define lov_ost_data lov_ost_data_v1
1512 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
1513         struct ost_id l_ost_oi;   /* OST object ID */
1514         __u32 l_ost_gen;          /* generation of this l_ost_idx */
1515         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
1516 };
1517
1518 #define lov_mds_md lov_mds_md_v1
1519 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
1520         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
1521         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1522         struct ost_id   lmm_oi;   /* LOV object ID */
1523         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1524         /* lmm_stripe_count used to be __u32 */
1525         __u16 lmm_stripe_count;   /* num stripes in use for this object */
1526         __u16 lmm_layout_gen;     /* layout generation number */
1527         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1528 };
1529
1530 /**
1531  * Sigh, because pre-2.4 uses
1532  * struct lov_mds_md_v1 {
1533  *      ........
1534  *      __u64 lmm_object_id;
1535  *      __u64 lmm_object_seq;
1536  *      ......
1537  *      }
1538  * to identify the LOV(MDT) object, and lmm_object_seq will
1539  * be normal_fid, which make it hard to combine these conversion
1540  * to ostid_to FID. so we will do lmm_oi/fid conversion separately
1541  *
1542  * We can tell the lmm_oi by this way,
1543  * 1.8: lmm_object_id = {inode}, lmm_object_gr = 0
1544  * 2.1: lmm_object_id = {oid < 128k}, lmm_object_seq = FID_SEQ_NORMAL
1545  * 2.4: lmm_oi.f_seq = FID_SEQ_NORMAL, lmm_oi.f_oid = {oid < 128k},
1546  *      lmm_oi.f_ver = 0
1547  *
1548  * But currently lmm_oi/lsm_oi does not have any "real" usages,
1549  * except for printing some information, and the user can always
1550  * get the real FID from LMA, besides this multiple case check might
1551  * make swab more complicate. So we will keep using id/seq for lmm_oi.
1552  */
1553
1554 static inline void fid_to_lmm_oi(const struct lu_fid *fid,
1555                                  struct ost_id *oi)
1556 {
1557         oi->oi.oi_id = fid_oid(fid);
1558         oi->oi.oi_seq = fid_seq(fid);
1559 }
1560
1561 static inline void lmm_oi_set_seq(struct ost_id *oi, __u64 seq)
1562 {
1563         oi->oi.oi_seq = seq;
1564 }
1565
1566 static inline void lmm_oi_set_id(struct ost_id *oi, __u64 oid)
1567 {
1568         oi->oi.oi_id = oid;
1569 }
1570
1571 static inline __u64 lmm_oi_id(const struct ost_id *oi)
1572 {
1573         return oi->oi.oi_id;
1574 }
1575
1576 static inline __u64 lmm_oi_seq(const struct ost_id *oi)
1577 {
1578         return oi->oi.oi_seq;
1579 }
1580
1581 static inline void lmm_oi_le_to_cpu(struct ost_id *dst_oi,
1582                                     const struct ost_id *src_oi)
1583 {
1584         dst_oi->oi.oi_id = le64_to_cpu(src_oi->oi.oi_id);
1585         dst_oi->oi.oi_seq = le64_to_cpu(src_oi->oi.oi_seq);
1586 }
1587
1588 static inline void lmm_oi_cpu_to_le(struct ost_id *dst_oi,
1589                                     const struct ost_id *src_oi)
1590 {
1591         dst_oi->oi.oi_id = cpu_to_le64(src_oi->oi.oi_id);
1592         dst_oi->oi.oi_seq = cpu_to_le64(src_oi->oi.oi_seq);
1593 }
1594
1595 /* extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm); */
1596
1597 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
1598 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
1599
1600 /* This is the default MDT reply size allocated, should the striping be bigger,
1601  * it will be reallocated in mdt_fix_reply.
1602  * 100 stripes is a bit less than 2.5k of data */
1603 #define DEF_REP_MD_SIZE (sizeof(struct lov_mds_md) + \
1604                          100 * sizeof(struct lov_ost_data))
1605
1606 #define XATTR_NAME_ACL_ACCESS   "system.posix_acl_access"
1607 #define XATTR_NAME_ACL_DEFAULT  "system.posix_acl_default"
1608 #define XATTR_USER_PREFIX       "user."
1609 #define XATTR_TRUSTED_PREFIX    "trusted."
1610 #define XATTR_SECURITY_PREFIX   "security."
1611
1612 #define XATTR_NAME_LOV          "trusted.lov"
1613 #define XATTR_NAME_LMA          "trusted.lma"
1614 #define XATTR_NAME_LMV          "trusted.lmv"
1615 #define XATTR_NAME_DEFAULT_LMV  "trusted.dmv"
1616 #define XATTR_NAME_LINK         "trusted.link"
1617 #define XATTR_NAME_FID          "trusted.fid"
1618 #define XATTR_NAME_VERSION      "trusted.version"
1619 #define XATTR_NAME_SOM          "trusted.som"
1620 #define XATTR_NAME_HSM          "trusted.hsm"
1621 #define XATTR_NAME_LFSCK_BITMAP "trusted.lfsck_bitmap"
1622 #define XATTR_NAME_DUMMY        "trusted.dummy"
1623
1624 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 8, 53, 0)
1625 # define XATTR_NAME_LFSCK_NAMESPACE_OLD "trusted.lfsck_namespace"
1626 #endif
1627
1628 #define XATTR_NAME_LFSCK_NAMESPACE "trusted.lfsck_ns"
1629 #define XATTR_NAME_MAX_LEN      32 /* increase this, if there is longer name. */
1630
1631 struct lov_mds_md_v3 {            /* LOV EA mds/wire data (little-endian) */
1632         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V3 */
1633         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1634         struct ost_id   lmm_oi;   /* LOV object ID */
1635         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1636         /* lmm_stripe_count used to be __u32 */
1637         __u16 lmm_stripe_count;   /* num stripes in use for this object */
1638         __u16 lmm_layout_gen;     /* layout generation number */
1639         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* must be 32bit aligned */
1640         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1641 };
1642
1643 static inline __u32 lov_mds_md_size(__u16 stripes, __u32 lmm_magic)
1644 {
1645         if (lmm_magic == LOV_MAGIC_V3)
1646                 return sizeof(struct lov_mds_md_v3) +
1647                                 stripes * sizeof(struct lov_ost_data_v1);
1648         else
1649                 return sizeof(struct lov_mds_md_v1) +
1650                                 stripes * sizeof(struct lov_ost_data_v1);
1651 }
1652
1653 static inline __u32
1654 lov_mds_md_max_stripe_count(size_t buf_size, __u32 lmm_magic)
1655 {
1656         switch (lmm_magic) {
1657         case LOV_MAGIC_V1: {
1658                 struct lov_mds_md_v1 lmm;
1659
1660                 if (buf_size < sizeof(lmm))
1661                         return 0;
1662
1663                 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1664         }
1665         case LOV_MAGIC_V3: {
1666                 struct lov_mds_md_v3 lmm;
1667
1668                 if (buf_size < sizeof(lmm))
1669                         return 0;
1670
1671                 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1672         }
1673         default:
1674                 return 0;
1675         }
1676 }
1677
1678 #define OBD_MD_FLID        (0x00000001ULL) /* object ID */
1679 #define OBD_MD_FLATIME     (0x00000002ULL) /* access time */
1680 #define OBD_MD_FLMTIME     (0x00000004ULL) /* data modification time */
1681 #define OBD_MD_FLCTIME     (0x00000008ULL) /* change time */
1682 #define OBD_MD_FLSIZE      (0x00000010ULL) /* size */
1683 #define OBD_MD_FLBLOCKS    (0x00000020ULL) /* allocated blocks count */
1684 #define OBD_MD_FLBLKSZ     (0x00000040ULL) /* block size */
1685 #define OBD_MD_FLMODE      (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1686 #define OBD_MD_FLTYPE      (0x00000100ULL) /* object type (mode & S_IFMT) */
1687 #define OBD_MD_FLUID       (0x00000200ULL) /* user ID */
1688 #define OBD_MD_FLGID       (0x00000400ULL) /* group ID */
1689 #define OBD_MD_FLFLAGS     (0x00000800ULL) /* flags word */
1690 #define OBD_MD_FLNLINK     (0x00002000ULL) /* link count */
1691 #define OBD_MD_FLGENER     (0x00004000ULL) /* generation number */
1692 /*#define OBD_MD_FLINLINE    (0x00008000ULL)  inline data. used until 1.6.5 */
1693 #define OBD_MD_FLRDEV      (0x00010000ULL) /* device number */
1694 #define OBD_MD_FLEASIZE    (0x00020000ULL) /* extended attribute data */
1695 #define OBD_MD_LINKNAME    (0x00040000ULL) /* symbolic link target */
1696 #define OBD_MD_FLHANDLE    (0x00080000ULL) /* file/lock handle */
1697 #define OBD_MD_FLCKSUM     (0x00100000ULL) /* bulk data checksum */
1698 #define OBD_MD_FLQOS       (0x00200000ULL) /* quality of service stats */
1699 /*#define OBD_MD_FLOSCOPQ    (0x00400000ULL) osc opaque data, never used */
1700 /*      OBD_MD_FLCOOKIE    (0x00800000ULL)    obsolete in 2.8 */
1701 #define OBD_MD_FLGROUP     (0x01000000ULL) /* group */
1702 #define OBD_MD_FLFID       (0x02000000ULL) /* ->ost write inline fid */
1703 #define OBD_MD_FLEPOCH     (0x04000000ULL) /* ->ost write with ioepoch */
1704                                            /* ->mds if epoch opens or closes */
1705 #define OBD_MD_FLGRANT     (0x08000000ULL) /* ost preallocation space grant */
1706 #define OBD_MD_FLDIREA     (0x10000000ULL) /* dir's extended attribute data */
1707 #define OBD_MD_FLUSRQUOTA  (0x20000000ULL) /* over quota flags sent from ost */
1708 #define OBD_MD_FLGRPQUOTA  (0x40000000ULL) /* over quota flags sent from ost */
1709 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1710
1711 #define OBD_MD_MDS         (0x0000000100000000ULL) /* where an inode lives on */
1712 #define OBD_MD_REINT       (0x0000000200000000ULL) /* reintegrate oa */
1713 #define OBD_MD_MEA         (0x0000000400000000ULL) /* CMD split EA  */
1714 #define OBD_MD_TSTATE      (0x0000000800000000ULL) /* transient state field */
1715
1716 #define OBD_MD_FLXATTR       (0x0000001000000000ULL) /* xattr */
1717 #define OBD_MD_FLXATTRLS     (0x0000002000000000ULL) /* xattr list */
1718 #define OBD_MD_FLXATTRRM     (0x0000004000000000ULL) /* xattr remove */
1719 #define OBD_MD_FLACL         (0x0000008000000000ULL) /* ACL */
1720 #define OBD_MD_FLRMTPERM     (0x0000010000000000ULL) /* remote permission */
1721 #define OBD_MD_FLMDSCAPA     (0x0000020000000000ULL) /* MDS capability */
1722 #define OBD_MD_FLOSSCAPA     (0x0000040000000000ULL) /* OSS capability */
1723 #define OBD_MD_FLCKSPLIT     (0x0000080000000000ULL) /* Check split on server */
1724 #define OBD_MD_FLCROSSREF    (0x0000100000000000ULL) /* Cross-ref case */
1725 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1726                                                       * under lock; for xattr
1727                                                       * requests means the
1728                                                       * client holds the lock */
1729 #define OBD_MD_FLOBJCOUNT    (0x0000400000000000ULL) /* for multiple destroy */
1730
1731 #define OBD_MD_FLRMTLSETFACL (0x0001000000000000ULL) /* lfs lsetfacl case */
1732 #define OBD_MD_FLRMTLGETFACL (0x0002000000000000ULL) /* lfs lgetfacl case */
1733 #define OBD_MD_FLRMTRSETFACL (0x0004000000000000ULL) /* lfs rsetfacl case */
1734 #define OBD_MD_FLRMTRGETFACL (0x0008000000000000ULL) /* lfs rgetfacl case */
1735
1736 #define OBD_MD_FLDATAVERSION (0x0010000000000000ULL) /* iversion sum */
1737 #define OBD_MD_CLOSE_INTENT_EXECED (0x0020000000000000ULL) /* close intent
1738                                                               executed */
1739
1740 #define OBD_MD_DEFAULT_MEA   (0x0040000000000000ULL) /* default MEA */
1741
1742 #define OBD_MD_FLGETATTR (OBD_MD_FLID    | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1743                           OBD_MD_FLCTIME | OBD_MD_FLSIZE  | OBD_MD_FLBLKSZ | \
1744                           OBD_MD_FLMODE  | OBD_MD_FLTYPE  | OBD_MD_FLUID   | \
1745                           OBD_MD_FLGID   | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1746                           OBD_MD_FLGENER | OBD_MD_FLRDEV  | OBD_MD_FLGROUP)
1747
1748 #define OBD_MD_FLXATTRALL (OBD_MD_FLXATTR | OBD_MD_FLXATTRLS)
1749
1750 /* don't forget obdo_fid which is way down at the bottom so it can
1751  * come after the definition of llog_cookie */
1752
1753 enum hss_valid {
1754         HSS_SETMASK     = 0x01,
1755         HSS_CLEARMASK   = 0x02,
1756         HSS_ARCHIVE_ID  = 0x04,
1757 };
1758
1759 struct hsm_state_set {
1760         __u32   hss_valid;
1761         __u32   hss_archive_id;
1762         __u64   hss_setmask;
1763         __u64   hss_clearmask;
1764 };
1765
1766 extern void lustre_swab_hsm_user_state(struct hsm_user_state *hus);
1767 extern void lustre_swab_hsm_state_set(struct hsm_state_set *hss);
1768
1769 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
1770
1771 /* ost_body.data values for OST_BRW */
1772
1773 #define OBD_BRW_READ            0x01
1774 #define OBD_BRW_WRITE           0x02
1775 #define OBD_BRW_RWMASK          (OBD_BRW_READ | OBD_BRW_WRITE)
1776 #define OBD_BRW_SYNC            0x08 /* this page is a part of synchronous
1777                                       * transfer and is not accounted in
1778                                       * the grant. */
1779 #define OBD_BRW_CHECK           0x10
1780 #define OBD_BRW_FROM_GRANT      0x20 /* the osc manages this under llite */
1781 #define OBD_BRW_GRANTED         0x40 /* the ost manages this */
1782 #define OBD_BRW_NOCACHE         0x80 /* this page is a part of non-cached IO */
1783 #define OBD_BRW_NOQUOTA        0x100
1784 #define OBD_BRW_SRVLOCK        0x200 /* Client holds no lock over this page */
1785 #define OBD_BRW_ASYNC          0x400 /* Server may delay commit to disk */
1786 #define OBD_BRW_MEMALLOC       0x800 /* Client runs in the "kswapd" context */
1787 #define OBD_BRW_OVER_USRQUOTA 0x1000 /* Running out of user quota */
1788 #define OBD_BRW_OVER_GRPQUOTA 0x2000 /* Running out of group quota */
1789 #define OBD_BRW_SOFT_SYNC     0x4000 /* This flag notifies the server
1790                                       * that the client is running low on
1791                                       * space for unstable pages; asking
1792                                       * it to sync quickly */
1793
1794 #define OBD_OBJECT_EOF LUSTRE_EOF
1795
1796 #define OST_MIN_PRECREATE 32
1797 #define OST_MAX_PRECREATE 20000
1798
1799 struct obd_ioobj {
1800         struct ost_id   ioo_oid;        /* object ID, if multi-obj BRW */
1801         __u32           ioo_max_brw;    /* low 16 bits were o_mode before 2.4,
1802                                          * now (PTLRPC_BULK_OPS_COUNT - 1) in
1803                                          * high 16 bits in 2.4 and later */
1804         __u32           ioo_bufcnt;     /* number of niobufs for this object */
1805 };
1806
1807 #define IOOBJ_MAX_BRW_BITS      16
1808 #define IOOBJ_TYPE_MASK         ((1U << IOOBJ_MAX_BRW_BITS) - 1)
1809 #define ioobj_max_brw_get(ioo)  (((ioo)->ioo_max_brw >> IOOBJ_MAX_BRW_BITS) + 1)
1810 #define ioobj_max_brw_set(ioo, num)                                     \
1811 do { (ioo)->ioo_max_brw = ((num) - 1) << IOOBJ_MAX_BRW_BITS; } while (0)
1812
1813 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
1814
1815 /* multiple of 8 bytes => can array */
1816 struct niobuf_remote {
1817         __u64   rnb_offset;
1818         __u32   rnb_len;
1819         __u32   rnb_flags;
1820 };
1821
1822 void lustre_swab_niobuf_remote(struct niobuf_remote *nbr);
1823
1824 /* lock value block communicated between the filter and llite */
1825
1826 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1827  * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1828 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1829 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1830 #define OST_LVB_IS_ERR(blocks)                                          \
1831         ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1832 #define OST_LVB_SET_ERR(blocks, rc)                                     \
1833         do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1834 #define OST_LVB_GET_ERR(blocks)    (int)(blocks - OST_LVB_ERR_INIT)
1835
1836 struct ost_lvb_v1 {
1837         __u64   lvb_size;
1838         __s64   lvb_mtime;
1839         __s64   lvb_atime;
1840         __s64   lvb_ctime;
1841         __u64   lvb_blocks;
1842 };
1843
1844 extern void lustre_swab_ost_lvb_v1(struct ost_lvb_v1 *lvb);
1845
1846 struct ost_lvb {
1847         __u64   lvb_size;
1848         __s64   lvb_mtime;
1849         __s64   lvb_atime;
1850         __s64   lvb_ctime;
1851         __u64   lvb_blocks;
1852         __u32   lvb_mtime_ns;
1853         __u32   lvb_atime_ns;
1854         __u32   lvb_ctime_ns;
1855         __u32   lvb_padding;
1856 };
1857
1858 extern void lustre_swab_ost_lvb(struct ost_lvb *lvb);
1859
1860 /*
1861  *   lquota data structures
1862  */
1863
1864 #ifndef QUOTABLOCK_BITS
1865 # define QUOTABLOCK_BITS LUSTRE_QUOTABLOCK_BITS
1866 #endif
1867
1868 #ifndef QUOTABLOCK_SIZE
1869 # define QUOTABLOCK_SIZE LUSTRE_QUOTABLOCK_SIZE
1870 #endif
1871
1872 #ifndef toqb
1873 # define toqb lustre_stoqb
1874 #endif
1875
1876 /* The lquota_id structure is an union of all the possible identifier types that
1877  * can be used with quota, this includes:
1878  * - 64-bit user ID
1879  * - 64-bit group ID
1880  * - a FID which can be used for per-directory quota in the future */
1881 union lquota_id {
1882         struct lu_fid   qid_fid; /* FID for per-directory quota */
1883         __u64           qid_uid; /* user identifier */
1884         __u64           qid_gid; /* group identifier */
1885 };
1886
1887 /* quotactl management */
1888 struct obd_quotactl {
1889         __u32                   qc_cmd;
1890         __u32                   qc_type; /* see Q_* flag below */
1891         __u32                   qc_id;
1892         __u32                   qc_stat;
1893         struct obd_dqinfo       qc_dqinfo;
1894         struct obd_dqblk        qc_dqblk;
1895 };
1896
1897 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1898
1899 #define Q_COPY(out, in, member) (out)->member = (in)->member
1900
1901 #define QCTL_COPY(out, in)              \
1902 do {                                    \
1903         Q_COPY(out, in, qc_cmd);        \
1904         Q_COPY(out, in, qc_type);       \
1905         Q_COPY(out, in, qc_id);         \
1906         Q_COPY(out, in, qc_stat);       \
1907         Q_COPY(out, in, qc_dqinfo);     \
1908         Q_COPY(out, in, qc_dqblk);      \
1909 } while (0)
1910
1911 /* Body of quota request used for quota acquire/release RPCs between quota
1912  * master (aka QMT) and slaves (ak QSD). */
1913 struct quota_body {
1914         struct lu_fid   qb_fid;     /* FID of global index packing the pool ID
1915                                       * and type (data or metadata) as well as
1916                                       * the quota type (user or group). */
1917         union lquota_id qb_id;      /* uid or gid or directory FID */
1918         __u32           qb_flags;   /* see below */
1919         __u32           qb_padding;
1920         __u64           qb_count;   /* acquire/release count (kbytes/inodes) */
1921         __u64           qb_usage;   /* current slave usage (kbytes/inodes) */
1922         __u64           qb_slv_ver; /* slave index file version */
1923         struct lustre_handle    qb_lockh;     /* per-ID lock handle */
1924         struct lustre_handle    qb_glb_lockh; /* global lock handle */
1925         __u64           qb_padding1[4];
1926 };
1927
1928 /* When the quota_body is used in the reply of quota global intent
1929  * lock (IT_QUOTA_CONN) reply, qb_fid contains slave index file FID. */
1930 #define qb_slv_fid      qb_fid
1931 /* qb_usage is the current qunit (in kbytes/inodes) when quota_body is used in
1932  * quota reply */
1933 #define qb_qunit        qb_usage
1934
1935 #define QUOTA_DQACQ_FL_ACQ      0x1  /* acquire quota */
1936 #define QUOTA_DQACQ_FL_PREACQ   0x2  /* pre-acquire */
1937 #define QUOTA_DQACQ_FL_REL      0x4  /* release quota */
1938 #define QUOTA_DQACQ_FL_REPORT   0x8  /* report usage */
1939
1940 extern void lustre_swab_quota_body(struct quota_body *b);
1941
1942 /* Quota types currently supported */
1943 enum {
1944         LQUOTA_TYPE_USR = 0x00, /* maps to USRQUOTA */
1945         LQUOTA_TYPE_GRP = 0x01, /* maps to GRPQUOTA */
1946         LQUOTA_TYPE_MAX
1947 };
1948
1949 /* There are 2 different resource types on which a quota limit can be enforced:
1950  * - inodes on the MDTs
1951  * - blocks on the OSTs */
1952 enum {
1953         LQUOTA_RES_MD           = 0x01, /* skip 0 to avoid null oid in FID */
1954         LQUOTA_RES_DT           = 0x02,
1955         LQUOTA_LAST_RES,
1956         LQUOTA_FIRST_RES        = LQUOTA_RES_MD
1957 };
1958 #define LQUOTA_NR_RES (LQUOTA_LAST_RES - LQUOTA_FIRST_RES + 1)
1959
1960 /*
1961  * Space accounting support
1962  * Format of an accounting record, providing disk usage information for a given
1963  * user or group
1964  */
1965 struct lquota_acct_rec { /* 16 bytes */
1966         __u64 bspace;  /* current space in use */
1967         __u64 ispace;  /* current # inodes in use */
1968 };
1969
1970 /*
1971  * Global quota index support
1972  * Format of a global record, providing global quota settings for a given quota
1973  * identifier
1974  */
1975 struct lquota_glb_rec { /* 32 bytes */
1976         __u64 qbr_hardlimit; /* quota hard limit, in #inodes or kbytes */
1977         __u64 qbr_softlimit; /* quota soft limit, in #inodes or kbytes */
1978         __u64 qbr_time;      /* grace time, in seconds */
1979         __u64 qbr_granted;   /* how much is granted to slaves, in #inodes or
1980                               * kbytes */
1981 };
1982
1983 /*
1984  * Slave index support
1985  * Format of a slave record, recording how much space is granted to a given
1986  * slave
1987  */
1988 struct lquota_slv_rec { /* 8 bytes */
1989         __u64 qsr_granted; /* space granted to the slave for the key=ID,
1990                             * in #inodes or kbytes */
1991 };
1992
1993 /* Data structures associated with the quota locks */
1994
1995 /* Glimpse descriptor used for the index & per-ID quota locks */
1996 struct ldlm_gl_lquota_desc {
1997         union lquota_id gl_id;    /* quota ID subject to the glimpse */
1998         __u64           gl_flags; /* see LQUOTA_FL* below */
1999         __u64           gl_ver;   /* new index version */
2000         __u64           gl_hardlimit; /* new hardlimit or qunit value */
2001         __u64           gl_softlimit; /* new softlimit */
2002         __u64           gl_time;
2003         __u64           gl_pad2;
2004 };
2005 #define gl_qunit        gl_hardlimit /* current qunit value used when
2006                                       * glimpsing per-ID quota locks */
2007
2008 /* quota glimpse flags */
2009 #define LQUOTA_FL_EDQUOT 0x1 /* user/group out of quota space on QMT */
2010
2011 /* LVB used with quota (global and per-ID) locks */
2012 struct lquota_lvb {
2013         __u64   lvb_flags;      /* see LQUOTA_FL* above */
2014         __u64   lvb_id_may_rel; /* space that might be released later */
2015         __u64   lvb_id_rel;     /* space released by the slave for this ID */
2016         __u64   lvb_id_qunit;   /* current qunit value */
2017         __u64   lvb_pad1;
2018 };
2019
2020 extern void lustre_swab_lquota_lvb(struct lquota_lvb *lvb);
2021
2022 /* LVB used with global quota lock */
2023 #define lvb_glb_ver  lvb_id_may_rel /* current version of the global index */
2024
2025 /* op codes */
2026 typedef enum {
2027         QUOTA_DQACQ     = 601,
2028         QUOTA_DQREL     = 602,
2029         QUOTA_LAST_OPC
2030 } quota_cmd_t;
2031 #define QUOTA_FIRST_OPC QUOTA_DQACQ
2032
2033 /*
2034  *   MDS REQ RECORDS
2035  */
2036
2037 /* opcodes */
2038 typedef enum {
2039         MDS_GETATTR             = 33,
2040         MDS_GETATTR_NAME        = 34,
2041         MDS_CLOSE               = 35,
2042         MDS_REINT               = 36,
2043         MDS_READPAGE            = 37,
2044         MDS_CONNECT             = 38,
2045         MDS_DISCONNECT          = 39,
2046         MDS_GETSTATUS           = 40,
2047         MDS_STATFS              = 41,
2048         MDS_PIN                 = 42, /* obsolete, never used in a release */
2049         MDS_UNPIN               = 43, /* obsolete, never used in a release */
2050         MDS_SYNC                = 44,
2051         MDS_DONE_WRITING        = 45, /* obsolete since 2.8.0 */
2052         MDS_SET_INFO            = 46,
2053         MDS_QUOTACHECK          = 47, /* not used since 2.4 */
2054         MDS_QUOTACTL            = 48,
2055         MDS_GETXATTR            = 49,
2056         MDS_SETXATTR            = 50, /* obsolete, now it's MDS_REINT op */
2057         MDS_WRITEPAGE           = 51,
2058         MDS_IS_SUBDIR           = 52, /* obsolete, never used in a release */
2059         MDS_GET_INFO            = 53,
2060         MDS_HSM_STATE_GET       = 54,
2061         MDS_HSM_STATE_SET       = 55,
2062         MDS_HSM_ACTION          = 56,
2063         MDS_HSM_PROGRESS        = 57,
2064         MDS_HSM_REQUEST         = 58,
2065         MDS_HSM_CT_REGISTER     = 59,
2066         MDS_HSM_CT_UNREGISTER   = 60,
2067         MDS_SWAP_LAYOUTS        = 61,
2068         MDS_LAST_OPC
2069 } mds_cmd_t;
2070
2071 #define MDS_FIRST_OPC    MDS_GETATTR
2072
2073
2074 /* opcodes for object update */
2075 typedef enum {
2076         OUT_UPDATE      = 1000,
2077         OUT_UPDATE_LAST_OPC
2078 } update_cmd_t;
2079
2080 #define OUT_UPDATE_FIRST_OPC    OUT_UPDATE
2081
2082 /*
2083  * Do not exceed 63
2084  */
2085
2086 typedef enum {
2087         REINT_SETATTR  = 1,
2088         REINT_CREATE   = 2,
2089         REINT_LINK     = 3,
2090         REINT_UNLINK   = 4,
2091         REINT_RENAME   = 5,
2092         REINT_OPEN     = 6,
2093         REINT_SETXATTR = 7,
2094         REINT_RMENTRY  = 8,
2095         REINT_MIGRATE  = 9,
2096         REINT_MAX
2097 } mds_reint_t, mdt_reint_t;
2098
2099 extern void lustre_swab_generic_32s (__u32 *val);
2100
2101 /* the disposition of the intent outlines what was executed */
2102 #define DISP_IT_EXECD        0x00000001
2103 #define DISP_LOOKUP_EXECD    0x00000002
2104 #define DISP_LOOKUP_NEG      0x00000004
2105 #define DISP_LOOKUP_POS      0x00000008
2106 #define DISP_OPEN_CREATE     0x00000010
2107 #define DISP_OPEN_OPEN       0x00000020
2108 #define DISP_ENQ_COMPLETE    0x00400000         /* obsolete and unused */
2109 #define DISP_ENQ_OPEN_REF    0x00800000
2110 #define DISP_ENQ_CREATE_REF  0x01000000
2111 #define DISP_OPEN_LOCK       0x02000000
2112 #define DISP_OPEN_LEASE      0x04000000
2113 #define DISP_OPEN_STRIPE     0x08000000
2114 #define DISP_OPEN_DENY       0x10000000
2115
2116 /* INODE LOCK PARTS */
2117 #define MDS_INODELOCK_LOOKUP 0x000001   /* For namespace, dentry etc, and also
2118                                          * was used to protect permission (mode,
2119                                          * owner, group etc) before 2.4. */
2120 #define MDS_INODELOCK_UPDATE 0x000002   /* size, links, timestamps */
2121 #define MDS_INODELOCK_OPEN   0x000004   /* For opened files */
2122 #define MDS_INODELOCK_LAYOUT 0x000008   /* for layout */
2123
2124 /* The PERM bit is added int 2.4, and it is used to protect permission(mode,
2125  * owner, group, acl etc), so to separate the permission from LOOKUP lock.
2126  * Because for remote directories(in DNE), these locks will be granted by
2127  * different MDTs(different ldlm namespace).
2128  *
2129  * For local directory, MDT will always grant UPDATE_LOCK|PERM_LOCK together.
2130  * For Remote directory, the master MDT, where the remote directory is, will
2131  * grant UPDATE_LOCK|PERM_LOCK, and the remote MDT, where the name entry is,
2132  * will grant LOOKUP_LOCK. */
2133 #define MDS_INODELOCK_PERM   0x000010
2134 #define MDS_INODELOCK_XATTR  0x000020   /* extended attributes */
2135
2136 #define MDS_INODELOCK_MAXSHIFT 5
2137 /* This FULL lock is useful to take on unlink sort of operations */
2138 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
2139
2140 extern void lustre_swab_ll_fid (struct ll_fid *fid);
2141
2142 /* NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
2143  * but was moved into name[1] along with the OID to avoid consuming the
2144  * name[2,3] fields that need to be used for the quota id (also a FID). */
2145 enum {
2146         LUSTRE_RES_ID_SEQ_OFF = 0,
2147         LUSTRE_RES_ID_VER_OID_OFF = 1,
2148         LUSTRE_RES_ID_WAS_VER_OFF = 2, /* see note above */
2149         LUSTRE_RES_ID_QUOTA_SEQ_OFF = 2,
2150         LUSTRE_RES_ID_QUOTA_VER_OID_OFF = 3,
2151         LUSTRE_RES_ID_HSH_OFF = 3
2152 };
2153
2154 #define MDS_STATUS_CONN 1
2155 #define MDS_STATUS_LOV 2
2156
2157 /* these should be identical to their EXT4_*_FL counterparts, they are
2158  * redefined here only to avoid dragging in fs/ext4/ext4.h */
2159 #define LUSTRE_SYNC_FL          0x00000008 /* Synchronous updates */
2160 #define LUSTRE_IMMUTABLE_FL     0x00000010 /* Immutable file */
2161 #define LUSTRE_APPEND_FL        0x00000020 /* writes to file may only append */
2162 #define LUSTRE_NODUMP_FL        0x00000040 /* do not dump file */
2163 #define LUSTRE_NOATIME_FL       0x00000080 /* do not update atime */
2164 #define LUSTRE_INDEX_FL         0x00001000 /* hash-indexed directory */
2165 #define LUSTRE_DIRSYNC_FL       0x00010000 /* dirsync behaviour (dir only) */
2166 #define LUSTRE_TOPDIR_FL        0x00020000 /* Top of directory hierarchies*/
2167 #define LUSTRE_DIRECTIO_FL      0x00100000 /* Use direct i/o */
2168 #define LUSTRE_INLINE_DATA_FL   0x10000000 /* Inode has inline data. */
2169
2170 #ifdef __KERNEL__
2171 /* Convert wire LUSTRE_*_FL to corresponding client local VFS S_* values
2172  * for the client inode i_flags.  The LUSTRE_*_FL are the Lustre wire
2173  * protocol equivalents of LDISKFS_*_FL values stored on disk, while
2174  * the S_* flags are kernel-internal values that change between kernel
2175  * versions.  These flags are set/cleared via FSFILT_IOC_{GET,SET}_FLAGS.
2176  * See b=16526 for a full history. */
2177 static inline int ll_ext_to_inode_flags(int flags)
2178 {
2179         return (((flags & LUSTRE_SYNC_FL)      ? S_SYNC      : 0) |
2180                 ((flags & LUSTRE_NOATIME_FL)   ? S_NOATIME   : 0) |
2181                 ((flags & LUSTRE_APPEND_FL)    ? S_APPEND    : 0) |
2182 #if defined(S_DIRSYNC)
2183                 ((flags & LUSTRE_DIRSYNC_FL)   ? S_DIRSYNC   : 0) |
2184 #endif
2185                 ((flags & LUSTRE_IMMUTABLE_FL) ? S_IMMUTABLE : 0));
2186 }
2187
2188 static inline int ll_inode_to_ext_flags(int iflags)
2189 {
2190         return (((iflags & S_SYNC)      ? LUSTRE_SYNC_FL      : 0) |
2191                 ((iflags & S_NOATIME)   ? LUSTRE_NOATIME_FL   : 0) |
2192                 ((iflags & S_APPEND)    ? LUSTRE_APPEND_FL    : 0) |
2193 #if defined(S_DIRSYNC)
2194                 ((iflags & S_DIRSYNC)   ? LUSTRE_DIRSYNC_FL   : 0) |
2195 #endif
2196                 ((iflags & S_IMMUTABLE) ? LUSTRE_IMMUTABLE_FL : 0));
2197 }
2198 #endif
2199
2200 /* 64 possible states */
2201 enum md_transient_state {
2202         MS_RESTORE      = (1 << 0),     /* restore is running */
2203 };
2204
2205 struct mdt_body {
2206         struct lu_fid mbo_fid1;
2207         struct lu_fid mbo_fid2;
2208         struct lustre_handle mbo_handle;
2209         __u64   mbo_valid;
2210         __u64   mbo_size; /* Offset, in the case of MDS_READPAGE */
2211         __s64   mbo_mtime;
2212         __s64   mbo_atime;
2213         __s64   mbo_ctime;
2214         __u64   mbo_blocks; /* XID, in the case of MDS_READPAGE */
2215         __u64   mbo_ioepoch;
2216         __u64   mbo_t_state; /* transient file state defined in
2217                               * enum md_transient_state
2218                               * was "ino" until 2.4.0 */
2219         __u32   mbo_fsuid;
2220         __u32   mbo_fsgid;
2221         __u32   mbo_capability;
2222         __u32   mbo_mode;
2223         __u32   mbo_uid;
2224         __u32   mbo_gid;
2225         __u32   mbo_flags;   /* LUSTRE_*_FL file attributes */
2226         __u32   mbo_rdev;
2227         __u32   mbo_nlink; /* #bytes to read in the case of MDS_READPAGE */
2228         __u32   mbo_unused2; /* was "generation" until 2.4.0 */
2229         __u32   mbo_suppgid;
2230         __u32   mbo_eadatasize;
2231         __u32   mbo_aclsize;
2232         __u32   mbo_max_mdsize;
2233         __u32   mbo_unused3; /* was max_cookiesize until 2.8 */
2234         __u32   mbo_uid_h; /* high 32-bits of uid, for FUID */
2235         __u32   mbo_gid_h; /* high 32-bits of gid, for FUID */
2236         __u32   mbo_padding_5; /* also fix lustre_swab_mdt_body */
2237         __u64   mbo_padding_6;
2238         __u64   mbo_padding_7;
2239         __u64   mbo_padding_8;
2240         __u64   mbo_padding_9;
2241         __u64   mbo_padding_10;
2242 }; /* 216 */
2243
2244 extern void lustre_swab_mdt_body (struct mdt_body *b);
2245
2246 struct mdt_ioepoch {
2247         struct lustre_handle mio_handle;
2248         __u64 mio_unused1; /* was ioepoch */
2249         __u32 mio_unused2; /* was flags */
2250         __u32 mio_padding;
2251 };
2252
2253 extern void lustre_swab_mdt_ioepoch (struct mdt_ioepoch *b);
2254
2255 /* permissions for md_perm.mp_perm */
2256 enum {
2257         CFS_SETUID_PERM = 0x01,
2258         CFS_SETGID_PERM = 0x02,
2259         CFS_SETGRP_PERM = 0x04,
2260         CFS_RMTACL_PERM = 0x08,
2261         CFS_RMTOWN_PERM = 0x10
2262 };
2263
2264 /* inode access permission for remote user, the inode info are omitted,
2265  * for client knows them. */
2266 struct mdt_remote_perm {
2267         __u32           rp_uid;
2268         __u32           rp_gid;
2269         __u32           rp_fsuid;
2270         __u32           rp_fsuid_h;
2271         __u32           rp_fsgid;
2272         __u32           rp_fsgid_h;
2273         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
2274         __u32           rp_padding;
2275 };
2276
2277 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
2278
2279 struct mdt_rec_setattr {
2280         __u32           sa_opcode;
2281         __u32           sa_cap;
2282         __u32           sa_fsuid;
2283         __u32           sa_fsuid_h;
2284         __u32           sa_fsgid;
2285         __u32           sa_fsgid_h;
2286         __u32           sa_suppgid;
2287         __u32           sa_suppgid_h;
2288         __u32           sa_padding_1;
2289         __u32           sa_padding_1_h;
2290         struct lu_fid   sa_fid;
2291         __u64           sa_valid;
2292         __u32           sa_uid;
2293         __u32           sa_gid;
2294         __u64           sa_size;
2295         __u64           sa_blocks;
2296         __s64           sa_mtime;
2297         __s64           sa_atime;
2298         __s64           sa_ctime;
2299         __u32           sa_attr_flags;
2300         __u32           sa_mode;
2301         __u32           sa_bias;      /* some operation flags */
2302         __u32           sa_padding_3;
2303         __u32           sa_padding_4;
2304         __u32           sa_padding_5;
2305 };
2306
2307 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
2308
2309 /*
2310  * Attribute flags used in mdt_rec_setattr::sa_valid.
2311  * The kernel's #defines for ATTR_* should not be used over the network
2312  * since the client and MDS may run different kernels (see bug 13828)
2313  * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
2314  */
2315 #define MDS_ATTR_MODE          0x1ULL /* = 1 */
2316 #define MDS_ATTR_UID           0x2ULL /* = 2 */
2317 #define MDS_ATTR_GID           0x4ULL /* = 4 */
2318 #define MDS_ATTR_SIZE          0x8ULL /* = 8 */
2319 #define MDS_ATTR_ATIME        0x10ULL /* = 16 */
2320 #define MDS_ATTR_MTIME        0x20ULL /* = 32 */
2321 #define MDS_ATTR_CTIME        0x40ULL /* = 64 */
2322 #define MDS_ATTR_ATIME_SET    0x80ULL /* = 128 */
2323 #define MDS_ATTR_MTIME_SET   0x100ULL /* = 256 */
2324 #define MDS_ATTR_FORCE       0x200ULL /* = 512, Not a change, but a change it */
2325 #define MDS_ATTR_ATTR_FLAG   0x400ULL /* = 1024 */
2326 #define MDS_ATTR_KILL_SUID   0x800ULL /* = 2048 */
2327 #define MDS_ATTR_KILL_SGID  0x1000ULL /* = 4096 */
2328 #define MDS_ATTR_CTIME_SET  0x2000ULL /* = 8192 */
2329 #define MDS_ATTR_FROM_OPEN  0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
2330 #define MDS_ATTR_BLOCKS     0x8000ULL /* = 32768 */
2331
2332 #ifndef FMODE_READ
2333 #define FMODE_READ               00000001
2334 #define FMODE_WRITE              00000002
2335 #endif
2336
2337 #define MDS_FMODE_CLOSED         00000000
2338 #define MDS_FMODE_EXEC           00000004
2339 /*      MDS_FMODE_EPOCH          01000000 obsolete since 2.8.0 */
2340 /*      MDS_FMODE_TRUNC          02000000 obsolete since 2.8.0 */
2341 /*      MDS_FMODE_SOM            04000000 obsolete since 2.8.0 */
2342
2343 #define MDS_OPEN_CREATED         00000010
2344 #define MDS_OPEN_CROSS           00000020
2345
2346 #define MDS_OPEN_CREAT           00000100
2347 #define MDS_OPEN_EXCL            00000200
2348 #define MDS_OPEN_TRUNC           00001000
2349 #define MDS_OPEN_APPEND          00002000
2350 #define MDS_OPEN_SYNC            00010000
2351 #define MDS_OPEN_DIRECTORY       00200000
2352
2353 #define MDS_OPEN_BY_FID         040000000 /* open_by_fid for known object */
2354 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
2355 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
2356 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file.
2357                                            * We do not support JOIN FILE
2358                                            * anymore, reserve this flags
2359                                            * just for preventing such bit
2360                                            * to be reused. */
2361
2362 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
2363 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
2364 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
2365 #define MDS_OPEN_NORESTORE  0100000000000ULL /* Do not restore file at open */
2366 #define MDS_OPEN_NEWSTRIPE  0200000000000ULL /* New stripe needed (restripe or
2367                                               * hsm restore) */
2368 #define MDS_OPEN_VOLATILE   0400000000000ULL /* File is volatile = created
2369                                                 unlinked */
2370 #define MDS_OPEN_LEASE     01000000000000ULL /* Open the file and grant lease
2371                                               * delegation, succeed if it's not
2372                                               * being opened with conflict mode.
2373                                               */
2374 #define MDS_OPEN_RELEASE   02000000000000ULL /* Open the file for HSM release */
2375
2376 /* lustre internal open flags, which should not be set from user space */
2377 #define MDS_OPEN_FL_INTERNAL (MDS_OPEN_HAS_EA | MDS_OPEN_HAS_OBJS |     \
2378                               MDS_OPEN_OWNEROVERRIDE | MDS_OPEN_LOCK |  \
2379                               MDS_OPEN_BY_FID | MDS_OPEN_LEASE |        \
2380                               MDS_OPEN_RELEASE)
2381
2382 enum mds_op_bias {
2383         MDS_CHECK_SPLIT         = 1 << 0,
2384         MDS_CROSS_REF           = 1 << 1,
2385         MDS_VTX_BYPASS          = 1 << 2,
2386         MDS_PERM_BYPASS         = 1 << 3,
2387 /*      MDS_SOM                 = 1 << 4, obsolete since 2.8.0 */
2388         MDS_QUOTA_IGNORE        = 1 << 5,
2389         /* Was MDS_CLOSE_CLEANUP (1 << 6), No more used */
2390         MDS_KEEP_ORPHAN         = 1 << 7,
2391         MDS_RECOV_OPEN          = 1 << 8,
2392         MDS_DATA_MODIFIED       = 1 << 9,
2393         MDS_CREATE_VOLATILE     = 1 << 10,
2394         MDS_OWNEROVERRIDE       = 1 << 11,
2395         MDS_HSM_RELEASE         = 1 << 12,
2396         MDS_RENAME_MIGRATE      = 1 << 13,
2397         MDS_CLOSE_LAYOUT_SWAP   = 1 << 14,
2398 };
2399
2400 /* instance of mdt_reint_rec */
2401 struct mdt_rec_create {
2402         __u32           cr_opcode;
2403         __u32           cr_cap;
2404         __u32           cr_fsuid;
2405         __u32           cr_fsuid_h;
2406         __u32           cr_fsgid;
2407         __u32           cr_fsgid_h;
2408         __u32           cr_suppgid1;
2409         __u32           cr_suppgid1_h;
2410         __u32           cr_suppgid2;
2411         __u32           cr_suppgid2_h;
2412         struct lu_fid   cr_fid1;
2413         struct lu_fid   cr_fid2;
2414         struct lustre_handle cr_old_handle; /* handle in case of open replay */
2415         __s64           cr_time;
2416         __u64           cr_rdev;
2417         __u64           cr_ioepoch;
2418         __u64           cr_padding_1;   /* rr_blocks */
2419         __u32           cr_mode;
2420         __u32           cr_bias;
2421         /* use of helpers set/get_mrc_cr_flags() is needed to access
2422          * 64 bits cr_flags [cr_flags_l, cr_flags_h], this is done to
2423          * extend cr_flags size without breaking 1.8 compat */
2424         __u32           cr_flags_l;     /* for use with open, low  32 bits  */
2425         __u32           cr_flags_h;     /* for use with open, high 32 bits */
2426         __u32           cr_umask;       /* umask for create */
2427         __u32           cr_padding_4;   /* rr_padding_4 */
2428 };
2429
2430 static inline void set_mrc_cr_flags(struct mdt_rec_create *mrc, __u64 flags)
2431 {
2432         mrc->cr_flags_l = (__u32)(flags & 0xFFFFFFFFUll);
2433         mrc->cr_flags_h = (__u32)(flags >> 32);
2434 }
2435
2436 static inline __u64 get_mrc_cr_flags(struct mdt_rec_create *mrc)
2437 {
2438         return ((__u64)(mrc->cr_flags_l) | ((__u64)mrc->cr_flags_h << 32));
2439 }
2440
2441 /* instance of mdt_reint_rec */
2442 struct mdt_rec_link {
2443         __u32           lk_opcode;
2444         __u32           lk_cap;
2445         __u32           lk_fsuid;
2446         __u32           lk_fsuid_h;
2447         __u32           lk_fsgid;
2448         __u32           lk_fsgid_h;
2449         __u32           lk_suppgid1;
2450         __u32           lk_suppgid1_h;
2451         __u32           lk_suppgid2;
2452         __u32           lk_suppgid2_h;
2453         struct lu_fid   lk_fid1;
2454         struct lu_fid   lk_fid2;
2455         __s64           lk_time;
2456         __u64           lk_padding_1;   /* rr_atime */
2457         __u64           lk_padding_2;   /* rr_ctime */
2458         __u64           lk_padding_3;   /* rr_size */
2459         __u64           lk_padding_4;   /* rr_blocks */
2460         __u32           lk_bias;
2461         __u32           lk_padding_5;   /* rr_mode */
2462         __u32           lk_padding_6;   /* rr_flags */
2463         __u32           lk_padding_7;   /* rr_padding_2 */
2464         __u32           lk_padding_8;   /* rr_padding_3 */
2465         __u32           lk_padding_9;   /* rr_padding_4 */
2466 };
2467
2468 /* instance of mdt_reint_rec */
2469 struct mdt_rec_unlink {
2470         __u32           ul_opcode;
2471         __u32           ul_cap;
2472         __u32           ul_fsuid;
2473         __u32           ul_fsuid_h;
2474         __u32           ul_fsgid;
2475         __u32           ul_fsgid_h;
2476         __u32           ul_suppgid1;
2477         __u32           ul_suppgid1_h;
2478         __u32           ul_suppgid2;
2479         __u32           ul_suppgid2_h;
2480         struct lu_fid   ul_fid1;
2481         struct lu_fid   ul_fid2;
2482         __s64           ul_time;
2483         __u64           ul_padding_2;   /* rr_atime */
2484         __u64           ul_padding_3;   /* rr_ctime */
2485         __u64           ul_padding_4;   /* rr_size */
2486         __u64           ul_padding_5;   /* rr_blocks */
2487         __u32           ul_bias;
2488         __u32           ul_mode;
2489         __u32           ul_padding_6;   /* rr_flags */
2490         __u32           ul_padding_7;   /* rr_padding_2 */
2491         __u32           ul_padding_8;   /* rr_padding_3 */
2492         __u32           ul_padding_9;   /* rr_padding_4 */
2493 };
2494
2495 /* instance of mdt_reint_rec */
2496 struct mdt_rec_rename {
2497         __u32           rn_opcode;
2498         __u32           rn_cap;
2499         __u32           rn_fsuid;
2500         __u32           rn_fsuid_h;
2501         __u32           rn_fsgid;
2502         __u32           rn_fsgid_h;
2503         __u32           rn_suppgid1;
2504         __u32           rn_suppgid1_h;
2505         __u32           rn_suppgid2;
2506         __u32           rn_suppgid2_h;
2507         struct lu_fid   rn_fid1;
2508         struct lu_fid   rn_fid2;
2509         __s64           rn_time;
2510         __u64           rn_padding_1;   /* rr_atime */
2511         __u64           rn_padding_2;   /* rr_ctime */
2512         __u64           rn_padding_3;   /* rr_size */
2513         __u64           rn_padding_4;   /* rr_blocks */
2514         __u32           rn_bias;        /* some operation flags */
2515         __u32           rn_mode;        /* cross-ref rename has mode */
2516         __u32           rn_padding_5;   /* rr_flags */
2517         __u32           rn_padding_6;   /* rr_padding_2 */
2518         __u32           rn_padding_7;   /* rr_padding_3 */
2519         __u32           rn_padding_8;   /* rr_padding_4 */
2520 };
2521
2522 /* instance of mdt_reint_rec */
2523 struct mdt_rec_setxattr {
2524         __u32           sx_opcode;
2525         __u32           sx_cap;
2526         __u32           sx_fsuid;
2527         __u32           sx_fsuid_h;
2528         __u32           sx_fsgid;
2529         __u32           sx_fsgid_h;
2530         __u32           sx_suppgid1;
2531         __u32           sx_suppgid1_h;
2532         __u32           sx_suppgid2;
2533         __u32           sx_suppgid2_h;
2534         struct lu_fid   sx_fid;
2535         __u64           sx_padding_1;   /* These three are rr_fid2 */
2536         __u32           sx_padding_2;
2537         __u32           sx_padding_3;
2538         __u64           sx_valid;
2539         __s64           sx_time;
2540         __u64           sx_padding_5;   /* rr_ctime */
2541         __u64           sx_padding_6;   /* rr_size */
2542         __u64           sx_padding_7;   /* rr_blocks */
2543         __u32           sx_size;
2544         __u32           sx_flags;
2545         __u32           sx_padding_8;   /* rr_flags */
2546         __u32           sx_padding_9;   /* rr_padding_2 */
2547         __u32           sx_padding_10;  /* rr_padding_3 */
2548         __u32           sx_padding_11;  /* rr_padding_4 */
2549 };
2550
2551 /*
2552  * mdt_rec_reint is the template for all mdt_reint_xxx structures.
2553  * Do NOT change the size of various members, otherwise the value
2554  * will be broken in lustre_swab_mdt_rec_reint().
2555  *
2556  * If you add new members in other mdt_reint_xxx structres and need to use the
2557  * rr_padding_x fields, then update lustre_swab_mdt_rec_reint() also.
2558  */
2559 struct mdt_rec_reint {
2560         __u32           rr_opcode;
2561         __u32           rr_cap;
2562         __u32           rr_fsuid;
2563         __u32           rr_fsuid_h;
2564         __u32           rr_fsgid;
2565         __u32           rr_fsgid_h;
2566         __u32           rr_suppgid1;
2567         __u32           rr_suppgid1_h;
2568         __u32           rr_suppgid2;
2569         __u32           rr_suppgid2_h;
2570         struct lu_fid   rr_fid1;
2571         struct lu_fid   rr_fid2;
2572         __s64           rr_mtime;
2573         __s64           rr_atime;
2574         __s64           rr_ctime;
2575         __u64           rr_size;
2576         __u64           rr_blocks;
2577         __u32           rr_bias;
2578         __u32           rr_mode;
2579         __u32           rr_flags;
2580         __u32           rr_flags_h;
2581         __u32           rr_umask;
2582         __u32           rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
2583 };
2584
2585 extern void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
2586
2587 /* lmv structures */
2588 struct lmv_desc {
2589         __u32 ld_tgt_count;                /* how many MDS's */
2590         __u32 ld_active_tgt_count;         /* how many active */
2591         __u32 ld_default_stripe_count;     /* how many objects are used */
2592         __u32 ld_pattern;                  /* default hash pattern */
2593         __u64 ld_default_hash_size;
2594         __u64 ld_padding_1;                /* also fix lustre_swab_lmv_desc */
2595         __u32 ld_padding_2;                /* also fix lustre_swab_lmv_desc */
2596         __u32 ld_qos_maxage;               /* in second */
2597         __u32 ld_padding_3;                /* also fix lustre_swab_lmv_desc */
2598         __u32 ld_padding_4;                /* also fix lustre_swab_lmv_desc */
2599         struct obd_uuid ld_uuid;
2600 };
2601
2602 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
2603
2604 /* LMV layout EA, and it will be stored both in master and slave object */
2605 struct lmv_mds_md_v1 {
2606         __u32 lmv_magic;
2607         __u32 lmv_stripe_count;
2608         __u32 lmv_master_mdt_index;     /* On master object, it is master
2609                                          * MDT index, on slave object, it
2610                                          * is stripe index of the slave obj */
2611         __u32 lmv_hash_type;            /* dir stripe policy, i.e. indicate
2612                                          * which hash function to be used,
2613                                          * Note: only lower 16 bits is being
2614                                          * used for now. Higher 16 bits will
2615                                          * be used to mark the object status,
2616                                          * for example migrating or dead. */
2617         __u32 lmv_layout_version;       /* Used for directory restriping */
2618         __u32 lmv_padding1;
2619         __u64 lmv_padding2;
2620         __u64 lmv_padding3;
2621         char lmv_pool_name[LOV_MAXPOOLNAME + 1];        /* pool name */
2622         struct lu_fid lmv_stripe_fids[0];       /* FIDs for each stripe */
2623 };
2624
2625 #define LMV_MAGIC_V1    0x0CD20CD0    /* normal stripe lmv magic */
2626 #define LMV_MAGIC       LMV_MAGIC_V1
2627
2628 /* #define LMV_USER_MAGIC 0x0CD30CD0 */
2629 #define LMV_MAGIC_STRIPE 0x0CD40CD0 /* magic for dir sub_stripe */
2630
2631 /* Right now only the lower part(0-16bits) of lmv_hash_type is being used,
2632  * and the higher part will be the flag to indicate the status of object,
2633  * for example the object is being migrated. And the hash function
2634  * might be interpreted differently with different flags. */
2635 #define LMV_HASH_TYPE_MASK 0x0000ffff
2636
2637 #define LMV_HASH_FLAG_MIGRATION 0x80000000
2638 #define LMV_HASH_FLAG_DEAD      0x40000000
2639 #define LMV_HASH_FLAG_BAD_TYPE  0x20000000
2640
2641 /* The striped directory has ever lost its master LMV EA, then LFSCK
2642  * re-generated it. This flag is used to indicate such case. It is an
2643  * on-disk flag. */
2644 #define LMV_HASH_FLAG_LOST_LMV  0x10000000
2645
2646 /**
2647  * The FNV-1a hash algorithm is as follows:
2648  *      hash = FNV_offset_basis
2649  *      for each octet_of_data to be hashed
2650  *              hash = hash XOR octet_of_data
2651  *              hash = hash × FNV_prime
2652  *      return hash
2653  * http://en.wikipedia.org/wiki/Fowler–Noll–Vo_hash_function#FNV-1a_hash
2654  *
2655  * http://www.isthe.com/chongo/tech/comp/fnv/index.html#FNV-reference-source
2656  * FNV_prime is 2^40 + 2^8 + 0xb3 = 0x100000001b3ULL
2657  **/
2658 #define LUSTRE_FNV_1A_64_PRIME  0x100000001b3ULL
2659 #define LUSTRE_FNV_1A_64_OFFSET_BIAS 0xcbf29ce484222325ULL
2660 static inline __u64 lustre_hash_fnv_1a_64(const void *buf, size_t size)
2661 {
2662         __u64 hash = LUSTRE_FNV_1A_64_OFFSET_BIAS;
2663         const unsigned char *p = buf;
2664         size_t i;
2665
2666         for (i = 0; i < size; i++) {
2667                 hash ^= p[i];
2668                 hash *= LUSTRE_FNV_1A_64_PRIME;
2669         }
2670
2671         return hash;
2672 }
2673
2674 union lmv_mds_md {
2675         __u32                    lmv_magic;
2676         struct lmv_mds_md_v1     lmv_md_v1;
2677         struct lmv_user_md       lmv_user_md;
2678 };
2679
2680 extern void lustre_swab_lmv_mds_md(union lmv_mds_md *lmm);
2681
2682 static inline int lmv_mds_md_size(int stripe_count, unsigned int lmm_magic)
2683 {
2684         switch (lmm_magic) {
2685         case LMV_MAGIC_V1:{
2686                 struct lmv_mds_md_v1 *lmm1;
2687
2688                 return sizeof(*lmm1) + stripe_count *
2689                                        sizeof(lmm1->lmv_stripe_fids[0]);
2690         }
2691         default:
2692                 return -EINVAL;
2693         }
2694 }
2695
2696 static inline int lmv_mds_md_stripe_count_get(const union lmv_mds_md *lmm)
2697 {
2698         switch (le32_to_cpu(lmm->lmv_magic)) {
2699         case LMV_MAGIC_V1:
2700                 return le32_to_cpu(lmm->lmv_md_v1.lmv_stripe_count);
2701         case LMV_USER_MAGIC:
2702                 return le32_to_cpu(lmm->lmv_user_md.lum_stripe_count);
2703         default:
2704                 return -EINVAL;
2705         }
2706 }
2707
2708 static inline int lmv_mds_md_stripe_count_set(union lmv_mds_md *lmm,
2709                                               unsigned int stripe_count)
2710 {
2711         switch (le32_to_cpu(lmm->lmv_magic)) {
2712         case LMV_MAGIC_V1:
2713                 lmm->lmv_md_v1.lmv_stripe_count = cpu_to_le32(stripe_count);
2714                 break;
2715         case LMV_USER_MAGIC:
2716                 lmm->lmv_user_md.lum_stripe_count = cpu_to_le32(stripe_count);
2717                 break;
2718         default:
2719                 return -EINVAL;
2720         }
2721         return 0;
2722 }
2723
2724 enum fld_rpc_opc {
2725         FLD_QUERY       = 900,
2726         FLD_READ        = 901,
2727         FLD_LAST_OPC,
2728         FLD_FIRST_OPC   = FLD_QUERY
2729 };
2730
2731 enum seq_rpc_opc {
2732         SEQ_QUERY                       = 700,
2733         SEQ_LAST_OPC,
2734         SEQ_FIRST_OPC                   = SEQ_QUERY
2735 };
2736
2737 enum seq_op {
2738         SEQ_ALLOC_SUPER = 0,
2739         SEQ_ALLOC_META = 1
2740 };
2741
2742 enum fld_op {
2743         FLD_CREATE = 0,
2744         FLD_DELETE = 1,
2745         FLD_LOOKUP = 2,
2746 };
2747
2748 /* LFSCK opcodes */
2749 typedef enum {
2750         LFSCK_NOTIFY            = 1101,
2751         LFSCK_QUERY             = 1102,
2752         LFSCK_LAST_OPC,
2753         LFSCK_FIRST_OPC         = LFSCK_NOTIFY
2754 } lfsck_cmd_t;
2755
2756 /*
2757  *  LOV data structures
2758  */
2759
2760 #define LOV_MAX_UUID_BUFFER_SIZE  8192
2761 /* The size of the buffer the lov/mdc reserves for the
2762  * array of UUIDs returned by the MDS.  With the current
2763  * protocol, this will limit the max number of OSTs per LOV */
2764
2765 #define LOV_DESC_MAGIC 0xB0CCDE5C
2766 #define LOV_DESC_QOS_MAXAGE_DEFAULT 5  /* Seconds */
2767 #define LOV_DESC_STRIPE_SIZE_DEFAULT (1 << LNET_MTU_BITS)
2768
2769 /* LOV settings descriptor (should only contain static info) */
2770 struct lov_desc {
2771         __u32 ld_tgt_count;                /* how many OBD's */
2772         __u32 ld_active_tgt_count;         /* how many active */
2773         __u32 ld_default_stripe_count;     /* how many objects are used */
2774         __u32 ld_pattern;                  /* default PATTERN_RAID0 */
2775         __u64 ld_default_stripe_size;      /* in bytes */
2776         __u64 ld_default_stripe_offset;    /* in bytes */
2777         __u32 ld_padding_0;                /* unused */
2778         __u32 ld_qos_maxage;               /* in second */
2779         __u32 ld_padding_1;                /* also fix lustre_swab_lov_desc */
2780         __u32 ld_padding_2;                /* also fix lustre_swab_lov_desc */
2781         struct obd_uuid ld_uuid;
2782 };
2783
2784 #define ld_magic ld_active_tgt_count       /* for swabbing from llogs */
2785
2786 extern void lustre_swab_lov_desc (struct lov_desc *ld);
2787
2788 /*
2789  *   LDLM requests:
2790  */
2791 /* opcodes -- MUST be distinct from OST/MDS opcodes */
2792 typedef enum {
2793         LDLM_ENQUEUE     = 101,
2794         LDLM_CONVERT     = 102,
2795         LDLM_CANCEL      = 103,
2796         LDLM_BL_CALLBACK = 104,
2797         LDLM_CP_CALLBACK = 105,
2798         LDLM_GL_CALLBACK = 106,
2799         LDLM_SET_INFO    = 107,
2800         LDLM_LAST_OPC
2801 } ldlm_cmd_t;
2802 #define LDLM_FIRST_OPC LDLM_ENQUEUE
2803
2804 #define RES_NAME_SIZE 4
2805 struct ldlm_res_id {
2806         __u64 name[RES_NAME_SIZE];
2807 };
2808
2809 #define DLDLMRES        "[%#llx:%#llx:%#llx].%#llx"
2810 #define PLDLMRES(res)   (unsigned long long)(res)->lr_name.name[0],     \
2811                         (unsigned long long)(res)->lr_name.name[1],     \
2812                         (unsigned long long)(res)->lr_name.name[2],     \
2813                         (unsigned long long)(res)->lr_name.name[3]
2814
2815 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
2816
2817 static inline bool ldlm_res_eq(const struct ldlm_res_id *res0,
2818                                const struct ldlm_res_id *res1)
2819 {
2820         return memcmp(res0, res1, sizeof(*res0)) == 0;
2821 }
2822
2823 /* lock types */
2824 typedef enum ldlm_mode {
2825         LCK_MINMODE     = 0,
2826         LCK_EX          = 1,
2827         LCK_PW          = 2,
2828         LCK_PR          = 4,
2829         LCK_CW          = 8,
2830         LCK_CR          = 16,
2831         LCK_NL          = 32,
2832         LCK_GROUP       = 64,
2833         LCK_COS         = 128,
2834         LCK_MAXMODE
2835 } ldlm_mode_t;
2836
2837 #define LCK_MODE_NUM    8
2838
2839 typedef enum ldlm_type {
2840         LDLM_PLAIN      = 10,
2841         LDLM_EXTENT     = 11,
2842         LDLM_FLOCK      = 12,
2843         LDLM_IBITS      = 13,
2844         LDLM_MAX_TYPE
2845 } ldlm_type_t;
2846
2847 #define LDLM_MIN_TYPE LDLM_PLAIN
2848
2849 struct ldlm_extent {
2850         __u64 start;
2851         __u64 end;
2852         __u64 gid;
2853 };
2854
2855 static inline int ldlm_extent_overlap(const struct ldlm_extent *ex1,
2856                                       const struct ldlm_extent *ex2)
2857 {
2858         return ex1->start <= ex2->end && ex2->start <= ex1->end;
2859 }
2860
2861 /* check if @ex1 contains @ex2 */
2862 static inline int ldlm_extent_contain(const struct ldlm_extent *ex1,
2863                                       const struct ldlm_extent *ex2)
2864 {
2865         return ex1->start <= ex2->start && ex1->end >= ex2->end;
2866 }
2867
2868 struct ldlm_inodebits {
2869         __u64 bits;
2870 };
2871
2872 struct ldlm_flock_wire {
2873         __u64 lfw_start;
2874         __u64 lfw_end;
2875         __u64 lfw_owner;
2876         __u32 lfw_padding;
2877         __u32 lfw_pid;
2878 };
2879
2880 /* it's important that the fields of the ldlm_extent structure match
2881  * the first fields of the ldlm_flock structure because there is only
2882  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
2883  * this ever changes we will need to swab the union differently based
2884  * on the resource type. */
2885
2886 typedef union ldlm_wire_policy_data {
2887         struct ldlm_extent      l_extent;
2888         struct ldlm_flock_wire  l_flock;
2889         struct ldlm_inodebits   l_inodebits;
2890 } ldlm_wire_policy_data_t;
2891
2892 extern void lustre_swab_ldlm_policy_data(union ldlm_wire_policy_data *d);
2893
2894 union ldlm_gl_desc {
2895         struct ldlm_gl_lquota_desc      lquota_desc;
2896 };
2897
2898 extern void lustre_swab_gl_desc(union ldlm_gl_desc *);
2899
2900 enum ldlm_intent_flags {
2901         IT_OPEN        = 0x00000001,
2902         IT_CREAT       = 0x00000002,
2903         IT_OPEN_CREAT  = 0x00000003,
2904         IT_READDIR     = 0x00000004,
2905         IT_GETATTR     = 0x00000008,
2906         IT_LOOKUP      = 0x00000010,
2907         IT_UNLINK      = 0x00000020,
2908         IT_TRUNC       = 0x00000040,
2909         IT_GETXATTR    = 0x00000080,
2910         IT_EXEC        = 0x00000100,
2911         IT_PIN         = 0x00000200,
2912         IT_LAYOUT      = 0x00000400,
2913         IT_QUOTA_DQACQ = 0x00000800,
2914         IT_QUOTA_CONN  = 0x00001000,
2915         IT_SETXATTR    = 0x00002000,
2916 };
2917
2918 struct ldlm_intent {
2919         __u64 opc;
2920 };
2921
2922 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
2923
2924 struct ldlm_resource_desc {
2925         enum ldlm_type     lr_type;
2926         __u32              lr_pad; /* also fix lustre_swab_ldlm_resource_desc */
2927         struct ldlm_res_id lr_name;
2928 };
2929
2930 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
2931
2932 struct ldlm_lock_desc {
2933         struct ldlm_resource_desc l_resource;
2934         enum ldlm_mode l_req_mode;
2935         enum ldlm_mode l_granted_mode;
2936         union ldlm_wire_policy_data l_policy_data;
2937 };
2938
2939 extern void lustre_swab_ldlm_lock_desc(struct ldlm_lock_desc *l);
2940
2941 #define LDLM_LOCKREQ_HANDLES 2
2942 #define LDLM_ENQUEUE_CANCEL_OFF 1
2943
2944 struct ldlm_request {
2945         __u32 lock_flags;
2946         __u32 lock_count;
2947         struct ldlm_lock_desc lock_desc;
2948         struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
2949 };
2950
2951 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
2952
2953 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
2954  * Otherwise, 2 are available. */
2955 #define ldlm_request_bufsize(count,type)                                \
2956 ({                                                                      \
2957         int _avail = LDLM_LOCKREQ_HANDLES;                              \
2958         _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
2959         sizeof(struct ldlm_request) +                                   \
2960         (count > _avail ? count - _avail : 0) *                         \
2961         sizeof(struct lustre_handle);                                   \
2962 })
2963
2964 struct ldlm_reply {
2965         __u32 lock_flags;
2966         __u32 lock_padding;     /* also fix lustre_swab_ldlm_reply */
2967         struct ldlm_lock_desc lock_desc;
2968         struct lustre_handle lock_handle;
2969         __u64  lock_policy_res1;
2970         __u64  lock_policy_res2;
2971 };
2972
2973 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
2974
2975 #define ldlm_flags_to_wire(flags)    ((__u32)(flags))
2976 #define ldlm_flags_from_wire(flags)  ((__u64)(flags))
2977
2978 /*
2979  * Opcodes for mountconf (mgs and mgc)
2980  */
2981 typedef enum {
2982         MGS_CONNECT = 250,
2983         MGS_DISCONNECT,
2984         MGS_EXCEPTION,         /* node died, etc. */
2985         MGS_TARGET_REG,        /* whenever target starts up */
2986         MGS_TARGET_DEL,
2987         MGS_SET_INFO,
2988         MGS_CONFIG_READ,
2989         MGS_LAST_OPC
2990 } mgs_cmd_t;
2991 #define MGS_FIRST_OPC MGS_CONNECT
2992
2993 #define MGS_PARAM_MAXLEN 1024
2994 #define KEY_SET_INFO "set_info"
2995
2996 struct mgs_send_param {
2997         char             mgs_param[MGS_PARAM_MAXLEN];
2998 };
2999
3000 /* We pass this info to the MGS so it can write config logs */
3001 #define MTI_NAME_MAXLEN  64
3002 #define MTI_PARAM_MAXLEN 4096
3003 #define MTI_NIDS_MAX     32
3004 struct mgs_target_info {
3005         __u32            mti_lustre_ver;
3006         __u32            mti_stripe_index;
3007         __u32            mti_config_ver;
3008         __u32            mti_flags;
3009         __u32            mti_nid_count;
3010         __u32            mti_instance; /* Running instance of target */
3011         char             mti_fsname[MTI_NAME_MAXLEN];
3012         char             mti_svname[MTI_NAME_MAXLEN];
3013         char             mti_uuid[sizeof(struct obd_uuid)];
3014         __u64            mti_nids[MTI_NIDS_MAX];     /* host nids (lnet_nid_t)*/
3015         char             mti_params[MTI_PARAM_MAXLEN];
3016 };
3017 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
3018
3019 struct mgs_nidtbl_entry {
3020         __u64           mne_version;    /* table version of this entry */
3021         __u32           mne_instance;   /* target instance # */
3022         __u32           mne_index;      /* target index */
3023         __u32           mne_length;     /* length of this entry - by bytes */
3024         __u8            mne_type;       /* target type LDD_F_SV_TYPE_OST/MDT */
3025         __u8            mne_nid_type;   /* type of nid(mbz). for ipv6. */
3026         __u8            mne_nid_size;   /* size of each NID, by bytes */
3027         __u8            mne_nid_count;  /* # of NIDs in buffer */
3028         union {
3029                 lnet_nid_t nids[0];     /* variable size buffer for NIDs. */
3030         } u;
3031 };
3032 extern void lustre_swab_mgs_nidtbl_entry(struct mgs_nidtbl_entry *oinfo);
3033
3034 struct mgs_config_body {
3035         char     mcb_name[MTI_NAME_MAXLEN]; /* logname */
3036         __u64    mcb_offset;    /* next index of config log to request */
3037         __u16    mcb_type;      /* type of log: CONFIG_T_[CONFIG|RECOVER] */
3038         __u8     mcb_reserved;
3039         __u8     mcb_bits;      /* bits unit size of config log */
3040         __u32    mcb_units;     /* # of units for bulk transfer */
3041 };
3042 extern void lustre_swab_mgs_config_body(struct mgs_config_body *body);
3043
3044 struct mgs_config_res {
3045         __u64    mcr_offset;    /* index of last config log */
3046         __u64    mcr_size;      /* size of the log */
3047 };
3048 extern void lustre_swab_mgs_config_res(struct mgs_config_res *body);
3049
3050 /* Config marker flags (in config log) */
3051 #define CM_START       0x01
3052 #define CM_END         0x02
3053 #define CM_SKIP        0x04
3054 #define CM_UPGRADE146  0x08
3055 #define CM_EXCLUDE     0x10
3056 #define CM_START_SKIP (CM_START | CM_SKIP)
3057
3058 struct cfg_marker {
3059         __u32   cm_step;       /* aka config version */
3060         __u32   cm_flags;
3061         __u32   cm_vers;       /* lustre release version number */
3062         __u32   cm_padding;    /* 64 bit align */
3063         __s64   cm_createtime; /*when this record was first created */
3064         __s64   cm_canceltime; /*when this record is no longer valid*/
3065         char    cm_tgtname[MTI_NAME_MAXLEN];
3066         char    cm_comment[MTI_NAME_MAXLEN];
3067 };
3068
3069 extern void lustre_swab_cfg_marker(struct cfg_marker *marker,
3070                                    int swab, int size);
3071
3072 /*
3073  * Opcodes for multiple servers.
3074  */
3075
3076 typedef enum {
3077         OBD_PING = 400,
3078         OBD_LOG_CANCEL,
3079         OBD_QC_CALLBACK, /* not used since 2.4 */
3080         OBD_IDX_READ,
3081         OBD_LAST_OPC
3082 } obd_cmd_t;
3083 #define OBD_FIRST_OPC OBD_PING
3084
3085 /**
3086  * llog contexts indices.
3087  *
3088  * There is compatibility problem with indexes below, they are not
3089  * continuous and must keep their numbers for compatibility needs.
3090  * See LU-5218 for details.
3091  */
3092 enum llog_ctxt_id {
3093         LLOG_CONFIG_ORIG_CTXT  =  0,
3094         LLOG_CONFIG_REPL_CTXT = 1,
3095         LLOG_MDS_OST_ORIG_CTXT = 2,
3096         LLOG_MDS_OST_REPL_CTXT = 3, /* kept just to avoid re-assignment */
3097         LLOG_SIZE_ORIG_CTXT = 4,
3098         LLOG_SIZE_REPL_CTXT = 5,
3099         LLOG_TEST_ORIG_CTXT = 8,
3100         LLOG_TEST_REPL_CTXT = 9, /* kept just to avoid re-assignment */
3101         LLOG_CHANGELOG_ORIG_CTXT = 12, /**< changelog generation on mdd */
3102         LLOG_CHANGELOG_REPL_CTXT = 13, /**< changelog access on clients */
3103         /* for multiple changelog consumers */
3104         LLOG_CHANGELOG_USER_ORIG_CTXT = 14,
3105         LLOG_AGENT_ORIG_CTXT = 15, /**< agent requests generation on cdt */
3106         LLOG_UPDATELOG_ORIG_CTXT = 16, /* update log */
3107         LLOG_UPDATELOG_REPL_CTXT = 17, /* update log */
3108         LLOG_MAX_CTXTS
3109 };
3110
3111 /** Identifier for a single log object */
3112 struct llog_logid {
3113         struct ost_id           lgl_oi;
3114         __u32                   lgl_ogen;
3115 } __attribute__((packed));
3116
3117 /** Records written to the CATALOGS list */
3118 #define CATLIST "CATALOGS"
3119 struct llog_catid {
3120         struct llog_logid       lci_logid;
3121         __u32                   lci_padding1;
3122         __u32                   lci_padding2;
3123         __u32                   lci_padding3;
3124 } __attribute__((packed));
3125
3126 /* Log data record types - there is no specific reason that these need to
3127  * be related to the RPC opcodes, but no reason not to (may be handy later?)
3128  */
3129 #define LLOG_OP_MAGIC 0x10600000
3130 #define LLOG_OP_MASK  0xfff00000
3131
3132 typedef enum {
3133         LLOG_PAD_MAGIC          = LLOG_OP_MAGIC | 0x00000,
3134         OST_SZ_REC              = LLOG_OP_MAGIC | 0x00f00,
3135         /* OST_RAID1_REC        = LLOG_OP_MAGIC | 0x01000, never used */
3136         MDS_UNLINK_REC          = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) |
3137                                   REINT_UNLINK, /* obsolete after 2.5.0 */
3138         MDS_UNLINK64_REC        = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
3139                                   REINT_UNLINK,
3140         /* MDS_SETATTR_REC      = LLOG_OP_MAGIC | 0x12401, obsolete 1.8.0 */
3141         MDS_SETATTR64_REC       = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
3142                                   REINT_SETATTR,
3143         OBD_CFG_REC             = LLOG_OP_MAGIC | 0x20000,
3144         /* PTL_CFG_REC          = LLOG_OP_MAGIC | 0x30000, obsolete 1.4.0 */
3145         LLOG_GEN_REC            = LLOG_OP_MAGIC | 0x40000,
3146         /* LLOG_JOIN_REC        = LLOG_OP_MAGIC | 0x50000, obsolete  1.8.0 */
3147         CHANGELOG_REC           = LLOG_OP_MAGIC | 0x60000,
3148         CHANGELOG_USER_REC      = LLOG_OP_MAGIC | 0x70000,
3149         HSM_AGENT_REC           = LLOG_OP_MAGIC | 0x80000,
3150         UPDATE_REC              = LLOG_OP_MAGIC | 0xa0000,
3151         LLOG_HDR_MAGIC          = LLOG_OP_MAGIC | 0x45539,
3152         LLOG_LOGID_MAGIC        = LLOG_OP_MAGIC | 0x4553b,
3153 } llog_op_type;
3154
3155 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
3156         (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == __swab32(LLOG_OP_MAGIC))
3157
3158 /** Log record header - stored in little endian order.
3159  * Each record must start with this struct, end with a llog_rec_tail,
3160  * and be a multiple of 256 bits in size.
3161  */
3162 struct llog_rec_hdr {
3163         __u32   lrh_len;
3164         __u32   lrh_index;
3165         __u32   lrh_type;
3166         __u32   lrh_id;
3167 };
3168
3169 struct llog_rec_tail {
3170         __u32   lrt_len;
3171         __u32   lrt_index;
3172 };
3173
3174 /* Where data follow just after header */
3175 #define REC_DATA(ptr)                                           \
3176         ((void *)((char *)ptr + sizeof(struct llog_rec_hdr)))
3177
3178 #define REC_DATA_LEN(rec)                                       \
3179         (rec->lrh_len - sizeof(struct llog_rec_hdr) -           \
3180          sizeof(struct llog_rec_tail))
3181
3182 static inline void *rec_tail(struct llog_rec_hdr *rec)
3183 {
3184         return (void *)((char *)rec + rec->lrh_len -
3185                         sizeof(struct llog_rec_tail));
3186 }
3187
3188 struct llog_logid_rec {
3189         struct llog_rec_hdr     lid_hdr;
3190         struct llog_logid       lid_id;
3191         __u32                   lid_padding1;
3192         __u64                   lid_padding2;
3193         __u64                   lid_padding3;
3194         struct llog_rec_tail    lid_tail;
3195 } __attribute__((packed));
3196
3197 struct llog_unlink_rec {
3198         struct llog_rec_hdr     lur_hdr;
3199         __u64                   lur_oid;
3200         __u32                   lur_oseq;
3201         __u32                   lur_count;
3202         struct llog_rec_tail    lur_tail;
3203 } __attribute__((packed));
3204
3205 struct llog_unlink64_rec {
3206         struct llog_rec_hdr     lur_hdr;
3207         struct lu_fid           lur_fid;
3208         __u32                   lur_count; /* to destroy the lost precreated */
3209         __u32                   lur_padding1;
3210         __u64                   lur_padding2;
3211         __u64                   lur_padding3;
3212         struct llog_rec_tail    lur_tail;
3213 } __attribute__((packed));
3214
3215 struct llog_setattr64_rec {
3216         struct llog_rec_hdr     lsr_hdr;
3217         struct ost_id           lsr_oi;
3218         __u32                   lsr_uid;
3219         __u32                   lsr_uid_h;
3220         __u32                   lsr_gid;
3221         __u32                   lsr_gid_h;
3222         __u64                   lsr_valid;
3223         struct llog_rec_tail    lsr_tail;