Whamcloud - gitweb
b=19427 Correct lmm_object_id
[fs/lustre-release.git] / lustre / include / lustre / lustre_idl.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
30  * Use is subject to license terms.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/include/lustre/lustre_idl.h
37  *
38  * Lustre wire protocol definitions.
39  */
40
41 /** \defgroup lustreidl lustreidl
42  *
43  * Lustre wire protocol definitions.
44  *
45  * ALL structs passing over the wire should be declared here.  Structs
46  * that are used in interfaces with userspace should go in lustre_user.h.
47  *
48  * All structs being declared here should be built from simple fixed-size
49  * types (__u8, __u16, __u32, __u64) or be built from other types or
50  * structs also declared in this file.  Similarly, all flags and magic
51  * values in those structs should also be declared here.  This ensures
52  * that the Lustre wire protocol is not influenced by external dependencies.
53  *
54  * The only other acceptable items in this file are VERY SIMPLE accessor
55  * functions to avoid callers grubbing inside the structures, and the
56  * prototypes of the swabber functions for each struct.  Nothing that
57  * depends on external functions or definitions should be in here.
58  *
59  * Structs must be properly aligned to put 64-bit values on an 8-byte
60  * boundary.  Any structs being added here must also be added to
61  * utils/wirecheck.c and "make newwiretest" run to regenerate the
62  * utils/wiretest.c sources.  This allows us to verify that wire structs
63  * have the proper alignment/size on all architectures.
64  *
65  * DO NOT CHANGE any of the structs, flags, values declared here and used
66  * in released Lustre versions.  Some structs may have padding fields that
67  * can be used.  Some structs might allow addition at the end (verify this
68  * in the code to ensure that new/old clients that see this larger struct
69  * do not fail, otherwise you need to implement protocol compatibility).
70  *
71  * We assume all nodes are either little-endian or big-endian, and we
72  * always send messages in the sender's native format.  The receiver
73  * detects the message format by checking the 'magic' field of the message
74  * (see lustre_msg_swabbed() below).
75  *
76  * Each wire type has corresponding 'lustre_swab_xxxtypexxx()' routines,
77  * implemented either here, inline (trivial implementations) or in
78  * ptlrpc/pack_generic.c.  These 'swabbers' convert the type from "other"
79  * endian, in-place in the message buffer.
80  *
81  * A swabber takes a single pointer argument.  The caller must already have
82  * verified that the length of the message buffer >= sizeof (type).
83  *
84  * For variable length types, a second 'lustre_swab_v_xxxtypexxx()' routine
85  * may be defined that swabs just the variable part, after the caller has
86  * verified that the message buffer is large enough.
87  *
88  * @{
89  */
90
91 #ifndef _LUSTRE_IDL_H_
92 #define _LUSTRE_IDL_H_
93
94 #include <libcfs/libcfs.h> /* for LASSERT, LPUX64, etc */
95
96 /* Defn's shared with user-space. */
97 #include <lustre/lustre_user.h>
98
99 /*
100  *  GENERAL STUFF
101  */
102 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
103  * FOO_REPLY_PORTAL   is for incoming replies on the FOO
104  * FOO_BULK_PORTAL    is for incoming bulk on the FOO
105  */
106
107 #define CONNMGR_REQUEST_PORTAL          1
108 #define CONNMGR_REPLY_PORTAL            2
109 //#define OSC_REQUEST_PORTAL            3
110 #define OSC_REPLY_PORTAL                4
111 //#define OSC_BULK_PORTAL               5
112 #define OST_IO_PORTAL                   6
113 #define OST_CREATE_PORTAL               7
114 #define OST_BULK_PORTAL                 8
115 //#define MDC_REQUEST_PORTAL            9
116 #define MDC_REPLY_PORTAL               10
117 //#define MDC_BULK_PORTAL              11
118 #define MDS_REQUEST_PORTAL             12
119 //#define MDS_REPLY_PORTAL             13
120 #define MDS_BULK_PORTAL                14
121 #define LDLM_CB_REQUEST_PORTAL         15
122 #define LDLM_CB_REPLY_PORTAL           16
123 #define LDLM_CANCEL_REQUEST_PORTAL     17
124 #define LDLM_CANCEL_REPLY_PORTAL       18
125 //#define PTLBD_REQUEST_PORTAL           19
126 //#define PTLBD_REPLY_PORTAL             20
127 //#define PTLBD_BULK_PORTAL              21
128 #define MDS_SETATTR_PORTAL             22
129 #define MDS_READPAGE_PORTAL            23
130 #define MDS_MDS_PORTAL                 24
131
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
141 /* Portal 63 is reserved for the Cray Inc DVS - nic@cray.com, roe@cray.com, n8851@cray.com */
142
143 #define SVC_KILLED               1
144 #define SVC_EVENT                2
145 #define SVC_SIGNAL               4
146 #define SVC_RUNNING              8
147 #define SVC_STOPPING            16
148 #define SVC_STOPPED             32
149
150 /* packet types */
151 #define PTL_RPC_MSG_REQUEST 4711
152 #define PTL_RPC_MSG_ERR     4712
153 #define PTL_RPC_MSG_REPLY   4713
154
155 /* DON'T use swabbed values of MAGIC as magic! */
156 #define LUSTRE_MSG_MAGIC_V1 0x0BD00BD0
157 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
158
159 #define LUSTRE_MSG_MAGIC_V1_SWABBED 0xD00BD00B
160 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
161
162 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
163
164 #define PTLRPC_MSG_VERSION  0x00000003
165 #define LUSTRE_VERSION_MASK 0xffff0000
166 #define LUSTRE_OBD_VERSION  0x00010000
167 #define LUSTRE_MDS_VERSION  0x00020000
168 #define LUSTRE_OST_VERSION  0x00030000
169 #define LUSTRE_DLM_VERSION  0x00040000
170 #define LUSTRE_LOG_VERSION  0x00050000
171 #define LUSTRE_MGS_VERSION  0x00060000
172
173 typedef __u32 mdsno_t;
174 typedef __u64 seqno_t;
175 typedef __u64 obd_id;
176 typedef __u64 obd_seq;
177 typedef __s64 obd_time;
178 typedef __u64 obd_size;
179 typedef __u64 obd_off;
180 typedef __u64 obd_blocks;
181 typedef __u64 obd_valid;
182 typedef __u32 obd_blksize;
183 typedef __u32 obd_mode;
184 typedef __u32 obd_uid;
185 typedef __u32 obd_gid;
186 typedef __u32 obd_flag;
187 typedef __u32 obd_count;
188
189 /**
190  * Describes a range of sequence, lsr_start is included but lsr_end is
191  * not in the range.
192  * Same structure is used in fld module where lsr_mdt field holds mdt id
193  * of the home mdt.
194  */
195
196 struct lu_seq_range {
197         __u64 lsr_start;
198         __u64 lsr_end;
199         __u32 lsr_mdt;
200         __u32 lsr_padding;
201 };
202
203 /**
204  * returns  width of given range \a r
205  */
206
207 static inline __u64 range_space(const struct lu_seq_range *range)
208 {
209         return range->lsr_end - range->lsr_start;
210 }
211
212 /**
213  * initialize range to zero
214  */
215
216 static inline void range_init(struct lu_seq_range *range)
217 {
218         range->lsr_start = range->lsr_end = range->lsr_mdt = 0;
219 }
220
221 /**
222  * check if given seq id \a s is within given range \a r
223  */
224
225 static inline int range_within(const struct lu_seq_range *range,
226                                __u64 s)
227 {
228         return s >= range->lsr_start && s < range->lsr_end;
229 }
230
231 static inline int range_is_sane(const struct lu_seq_range *range)
232 {
233         return (range->lsr_end >= range->lsr_start);
234 }
235
236 static inline int range_is_zero(const struct lu_seq_range *range)
237 {
238         return (range->lsr_start == 0 && range->lsr_end == 0);
239 }
240
241 static inline int range_is_exhausted(const struct lu_seq_range *range)
242
243 {
244         return range_space(range) == 0;
245 }
246
247 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x):%x"
248
249 #define PRANGE(range)      \
250         (range)->lsr_start, \
251         (range)->lsr_end,    \
252         (range)->lsr_mdt
253
254 /** \defgroup lu_fid lu_fid
255  * @{ */
256
257 /**
258  * Flags for lustre_mdt_attrs::lma_compat and lustre_mdt_attrs::lma_incompat.
259  */
260 enum lma_compat {
261         LMAC_HSM = 0x00000001,
262         LMAC_SOM = 0x00000002,
263 };
264
265 /**
266  * Masks for all features that should be supported by a Lustre version to
267  * access a specific file.
268  * This information is stored in lustre_mdt_attrs::lma_incompat.
269  *
270  * NOTE: No incompat feature should be added before bug #17670 is landed.
271  */
272 #define LMA_INCOMPAT_SUPP 0x0
273
274 /**
275  * Following struct for MDT attributes, that will be kept inode's EA.
276  * Introduced in 2.0 release (please see b15993, for details)
277  */
278 struct lustre_mdt_attrs {
279         /**
280          * Bitfield for supported data in this structure. From enum lma_compat.
281          * lma_self_fid and lma_flags are always available.
282          */
283         __u32   lma_compat;
284         /**
285          * Per-file incompat feature list. Lustre version should support all
286          * flags set in this field. The supported feature mask is available in
287          * LMA_INCOMPAT_SUPP.
288          */
289         __u32   lma_incompat;
290         /** FID of this inode */
291         struct lu_fid  lma_self_fid;
292         /** mdt/ost type, others */
293         __u64   lma_flags;
294         /* IO Epoch SOM attributes belongs to */
295         __u64   lma_ioepoch;
296         /** total file size in objects */
297         __u64   lma_som_size;
298         /** total fs blocks in objects */
299         __u64   lma_som_blocks;
300         /** mds mount id the size is valid for */
301         __u64   lma_som_mountid;
302 };
303
304 /**
305  * Fill \a lma with its first content.
306  * Only fid is stored.
307  */
308 static inline void lustre_lma_init(struct lustre_mdt_attrs *lma,
309                                    const struct lu_fid *fid)
310 {
311         lma->lma_compat      = 0;
312         lma->lma_incompat    = 0;
313         memcpy(&lma->lma_self_fid, fid, sizeof(*fid));
314         lma->lma_flags       = 0;
315         lma->lma_ioepoch     = 0;
316         lma->lma_som_size    = 0;
317         lma->lma_som_blocks  = 0;
318         lma->lma_som_mountid = 0;
319
320         /* If a field is added in struct lustre_mdt_attrs, zero it explicitly
321          * and change the test below. */
322         LASSERT(sizeof(*lma) ==
323                 (offsetof(struct lustre_mdt_attrs, lma_som_mountid) +
324                  sizeof(lma->lma_som_mountid)));
325 };
326
327 extern void lustre_swab_lu_fid(struct lu_fid *fid);
328
329 /**
330  * Swab, if needed, lustre_mdt_attr struct to on-disk format.
331  * Otherwise, do not touch it.
332  */
333 static inline void lustre_lma_swab(struct lustre_mdt_attrs *lma)
334 {
335         /* Use LUSTRE_MSG_MAGIC to detect local endianess. */
336         if (LUSTRE_MSG_MAGIC != cpu_to_le32(LUSTRE_MSG_MAGIC)) {
337                 __swab32s(&lma->lma_compat);
338                 __swab32s(&lma->lma_incompat);
339                 lustre_swab_lu_fid(&lma->lma_self_fid);
340                 __swab64s(&lma->lma_flags);
341                 __swab64s(&lma->lma_ioepoch);
342                 __swab64s(&lma->lma_som_size);
343                 __swab64s(&lma->lma_som_blocks);
344                 __swab64s(&lma->lma_som_mountid);
345         }
346 };
347
348 /* This is the maximum number of MDTs allowed in CMD testing until such
349  * a time that FID-on-OST is implemented.  This is due to the limitations
350  * of packing non-0-MDT numbers into the FID SEQ namespace.  Once FID-on-OST
351  * is implemented this limit will be virtually unlimited. */
352 #define MAX_MDT_COUNT 8
353
354
355 /**
356  * fid constants
357  */
358 enum {
359         /** initial fid id value */
360         LUSTRE_FID_INIT_OID  = 1UL
361 };
362
363 /** returns fid object sequence */
364 static inline __u64 fid_seq(const struct lu_fid *fid)
365 {
366         return fid->f_seq;
367 }
368
369 /** returns fid object id */
370 static inline __u32 fid_oid(const struct lu_fid *fid)
371 {
372         return fid->f_oid;
373 }
374
375 /** returns fid object version */
376 static inline __u32 fid_ver(const struct lu_fid *fid)
377 {
378         return fid->f_ver;
379 }
380
381 static inline void fid_zero(struct lu_fid *fid)
382 {
383         memset(fid, 0, sizeof(*fid));
384 }
385
386 static inline obd_id fid_ver_oid(const struct lu_fid *fid)
387 {
388         return ((__u64)fid_ver(fid) << 32 | fid_oid(fid));
389 }
390
391 /**
392  * Note that reserved SEQ numbers below 12 will conflict with ldiskfs
393  * inodes in the IGIF namespace, so these reserved SEQ numbers can be
394  * used for other purposes and not risk collisions with existing inodes.
395  *
396  * Different FID Format
397  * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs#NEW.0
398  */
399 enum fid_seq {
400         FID_SEQ_OST_MDT0   = 0,
401         FID_SEQ_LLOG       = 1,
402         FID_SEQ_ECHO       = 2,
403         FID_SEQ_OST_MDT1   = 3,
404         FID_SEQ_OST_MAX    = 9, /* Max MDT count before OST_on_FID */
405         FID_SEQ_RSVD       = 11,
406         FID_SEQ_IGIF       = 12,
407         FID_SEQ_IGIF_MAX   = 0x0ffffffffULL,
408         FID_SEQ_IDIF       = 0x100000000ULL,
409         FID_SEQ_IDIF_MAX   = 0x1ffffffffULL,
410         /* Normal FID sequence starts from this value, i.e. 1<<33 */
411         FID_SEQ_START      = 0x200000000ULL,
412         FID_SEQ_LOCAL_FILE = 0x200000001ULL,
413         FID_SEQ_DOT_LUSTRE = 0x200000002ULL,
414         FID_SEQ_NORMAL     = 0x200000400ULL
415 };
416
417 #define OBIF_OID_MAX_BITS           32
418 #define OBIF_MAX_OID                (1ULL << OBIF_OID_MAX_BITS)
419 #define OBIF_OID_MASK               ((1ULL << OBIF_OID_MAX_BITS) - 1)
420 #define IDIF_OID_MAX_BITS           48
421 #define IDIF_MAX_OID                (1ULL << IDIF_OID_MAX_BITS)
422 #define IDIF_OID_MASK               ((1ULL << IDIF_OID_MAX_BITS) - 1)
423
424
425 static inline int fid_seq_is_mdt0(obd_seq seq)
426 {
427         return (seq == FID_SEQ_OST_MDT0);
428 }
429
430 static inline int fid_seq_is_cmd(const __u64 seq)
431 {
432         return (seq >= FID_SEQ_OST_MDT1 && seq <= FID_SEQ_OST_MAX);
433 };
434
435 static inline int fid_seq_is_mdt(const __u64 seq)
436 {
437         return seq == FID_SEQ_OST_MDT0 ||
438                (seq >= FID_SEQ_OST_MDT1 && seq <= FID_SEQ_OST_MAX);
439 };
440
441 static inline int fid_seq_is_rsvd(const __u64 seq)
442 {
443         return seq <= FID_SEQ_RSVD;
444 };
445
446 static inline int fid_is_mdt0(const struct lu_fid *fid)
447 {
448         return fid_seq_is_mdt0(fid_seq(fid));
449 }
450
451 /**
452  * Check if a fid is igif or not.
453  * \param fid the fid to be tested.
454  * \return true if the fid is a igif; otherwise false.
455  */
456 static inline int fid_seq_is_igif(const __u64 seq)
457 {
458         return seq >= FID_SEQ_IGIF && seq <= FID_SEQ_IGIF_MAX;
459 }
460
461 static inline int fid_is_igif(const struct lu_fid *fid)
462 {
463         return fid_seq_is_igif(fid_seq(fid));
464 }
465
466 /**
467  * Check if a fid is idif or not.
468  * \param fid the fid to be tested.
469  * \return true if the fid is a idif; otherwise false.
470  */
471 static inline int fid_seq_is_idif(const __u64 seq)
472 {
473         return seq >= FID_SEQ_IDIF && seq <= FID_SEQ_IDIF_MAX;
474 }
475
476 static inline int fid_is_idif(const struct lu_fid *fid)
477 {
478         return fid_seq_is_idif(fid_seq(fid));
479 }
480
481 struct ost_id {
482         obd_id                 oi_id;
483         obd_seq                oi_seq;
484 };
485
486 static inline int fid_seq_is_norm(const __u64 seq)
487 {
488         return (seq >= FID_SEQ_NORMAL);
489 }
490
491 static inline int fid_is_norm(const struct lu_fid *fid)
492 {
493         return fid_seq_is_norm(fid_seq(fid));
494 }
495
496 /* convert an OST objid into an IDIF FID SEQ number */
497 static inline obd_seq fid_idif_seq(obd_id id, __u32 ost_idx)
498 {
499         return FID_SEQ_IDIF | (ost_idx << 16) | ((id >> 32) & 0xffff);
500 }
501
502 /* convert a packed IDIF FID into an OST objid */
503 static inline obd_id fid_idif_id(obd_seq seq, __u32 oid, __u32 ver)
504 {
505         return ((__u64)ver << 48) | ((seq & 0xffff) << 32) | oid;
506 }
507
508 /* unpack an ostid (id/seq) from a wire/disk structure into an IDIF FID */
509 static inline void ostid_idif_unpack(struct ost_id *ostid,
510                                      struct lu_fid *fid, __u32 ost_idx)
511 {
512         fid->f_seq = fid_idif_seq(ostid->oi_id, ost_idx);
513         fid->f_oid = ostid->oi_id;       /* truncate to 32 bits by assignment */
514         fid->f_ver = ostid->oi_id >> 48; /* in theory, not currently used */
515 }
516
517 /* unpack an ostid (id/seq) from a wire/disk structure into a non-IDIF FID */
518 static inline void ostid_fid_unpack(struct ost_id *ostid, struct lu_fid *fid)
519 {
520         fid->f_seq = ostid->oi_seq;
521         fid->f_oid = ostid->oi_id;       /* truncate to 32 bits by assignment */
522         fid->f_ver = ostid->oi_id >> 32; /* in theory, not currently used */
523 }
524
525 /* Unpack an OST object id/seq (group) into a FID.  This is needed for
526  * converting all obdo, lmm, lsm, etc. 64-bit id/seq pairs into proper
527  * FIDs.  Note that if an id/seq is already in FID/IDIF format it will
528  * be passed through unchanged.  Only legacy OST objects in "group 0"
529  * will be mapped into the IDIF namespace so that they can fit into the
530  * struct lu_fid fields without loss.  For reference see:
531  * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs
532  */
533 static inline int fid_ostid_unpack(struct lu_fid *fid, struct ost_id *ostid,
534                                    __u32 ost_idx)
535 {
536         if (ost_idx > 0xffff) {
537                 CERROR("bad ost_idx, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
538                        ostid->oi_seq, ostid->oi_id, ost_idx);
539                 return -EBADF;
540         }
541
542         if (fid_seq_is_mdt0(ostid->oi_seq)) {
543                 /* This is a "legacy" (old 1.x/2.early) OST object in "group 0"
544                  * that we map into the IDIF namespace.  It allows up to 2^48
545                  * objects per OST, as this is the object namespace that has
546                  * been in production for years.  This can handle create rates
547                  * of 1M objects/s/OST for 9 years, or combinations thereof. */
548                 if (ostid->oi_id >= IDIF_MAX_OID) {
549                          CERROR("bad MDT0 id, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
550                                 ostid->oi_seq, ostid->oi_id, ost_idx);
551                          return -EBADF;
552                 }
553                 ostid_idif_unpack(ostid, fid, ost_idx);
554
555         } else if (fid_seq_is_rsvd(ostid->oi_seq)) {
556                 /* These are legacy OST objects for LLOG/ECHO and CMD testing.
557                  * We only support 2^32 objects in these groups, and cannot
558                  * uniquely identify them in the system (i.e. they are the
559                  * duplicated on all OSTs), but this is not strictly required
560                  * for the old object protocol, which has a separate ost_idx. */
561                 if (ostid->oi_id >= 0xffffffffULL) {
562                          CERROR("bad RSVD id, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
563                                 ostid->oi_seq, ostid->oi_id, ost_idx);
564                          return -EBADF;
565                 }
566                 ostid_fid_unpack(ostid, fid);
567
568         } else if (unlikely(fid_seq_is_igif(ostid->oi_seq))) {
569                 /* This is an MDT inode number, which should never collide with
570                  * proper OST object IDs, and is probably a broken filesystem */
571                 CERROR("bad IGIF, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
572                        ostid->oi_seq, ostid->oi_id, ost_idx);
573                 return -EBADF;
574
575         } else /* if (fid_seq_is_idif(seq) || fid_seq_is_norm(seq)) */ {
576                /* This is either an IDIF object, which identifies objects across
577                 * all OSTs, or a regular FID.  The IDIF namespace maps legacy
578                 * OST objects into the FID namespace.  In both cases, we just
579                 * pass the FID through, no conversion needed. */
580                 ostid_fid_unpack(ostid, fid);
581         }
582
583         return 0;
584 }
585
586 /* pack an IDIF FID into an ostid (id/seq) for the wire/disk */
587 static inline void ostid_idif_pack(struct lu_fid *fid, struct ost_id *ostid)
588 {
589         ostid->oi_seq = FID_SEQ_OST_MDT0;
590         ostid->oi_id  = fid_idif_id(fid->f_seq, fid->f_oid, fid->f_ver);
591 }
592
593 /* pack a non-IDIF FID into an ostid (id/seq) for the wire/disk */
594 static inline void ostid_fid_pack(struct lu_fid *fid, struct ost_id *ostid)
595 {
596         ostid->oi_seq = fid_seq(fid);
597         ostid->oi_id  = fid_ver_oid(fid);
598 }
599
600 /* pack any OST FID into an ostid (id/seq) for the wire/disk */
601 static inline int fid_ostid_pack(struct lu_fid *fid, struct ost_id *ostid)
602 {
603         if (unlikely(fid_seq_is_igif(fid->f_seq))) {
604                 CERROR("bad IGIF, "DFID"\n", PFID(fid));
605                 return -EBADF;
606         }
607
608         if (fid_is_idif(fid))
609                 ostid_idif_pack(fid, ostid);
610         else
611                 ostid_fid_pack(fid, ostid);
612
613         return 0;
614 }
615
616 /* extract OST sequence (group) from a wire ost_id (id/seq) pair */
617 static inline obd_seq ostid_seq(struct ost_id *ostid)
618 {
619         if (unlikely(fid_seq_is_igif(ostid->oi_seq)))
620                 CWARN("bad IGIF, oi_seq: "LPU64" oi_id: "LPX64"\n",
621                       ostid->oi_seq, ostid->oi_id);
622
623         if (unlikely(fid_seq_is_idif(ostid->oi_seq)))
624                 return FID_SEQ_OST_MDT0;
625
626         return ostid->oi_seq;
627 }
628
629 /* extract OST objid from a wire ost_id (id/seq) pair */
630 static inline obd_id ostid_id(struct ost_id *ostid)
631 {
632         if (ostid->oi_seq == FID_SEQ_OST_MDT0)
633                 return ostid->oi_id & IDIF_OID_MASK;
634
635         if (fid_seq_is_rsvd(ostid->oi_seq))
636                 return ostid->oi_id & OBIF_OID_MASK;
637
638         if (fid_seq_is_idif(ostid->oi_seq))
639                 return fid_idif_id(ostid->oi_seq, ostid->oi_id, 0);
640
641         return ostid->oi_id;
642 }
643
644 /**
645  * Get inode number from a igif.
646  * \param fid a igif to get inode number from.
647  * \return inode number for the igif.
648  */
649 static inline ino_t lu_igif_ino(const struct lu_fid *fid)
650 {
651         return fid_seq(fid);
652 }
653
654 /**
655  * Build igif from the inode number/generation.
656  */
657 #define LU_IGIF_BUILD(fid, ino, gen)                    \
658 do {                                                    \
659         fid->f_seq = ino;                               \
660         fid->f_oid = gen;                               \
661         fid->f_ver = 0;                                 \
662 } while(0)
663 static inline void lu_igif_build(struct lu_fid *fid, __u32 ino, __u32 gen)
664 {
665         LU_IGIF_BUILD(fid, ino, gen);
666         LASSERT(fid_is_igif(fid));
667 }
668
669 /**
670  * Get inode generation from a igif.
671  * \param fid a igif to get inode generation from.
672  * \return inode generation for the igif.
673  */
674 static inline __u32 lu_igif_gen(const struct lu_fid *fid)
675 {
676         return fid_oid(fid);
677 }
678
679 /*
680  * Fids are transmitted across network (in the sender byte-ordering),
681  * and stored on disk in big-endian order.
682  */
683 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
684 {
685         /* check that all fields are converted */
686         CLASSERT(sizeof *src ==
687                  sizeof fid_seq(src) +
688                  sizeof fid_oid(src) + sizeof fid_ver(src));
689         LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
690         dst->f_seq = cpu_to_le64(fid_seq(src));
691         dst->f_oid = cpu_to_le32(fid_oid(src));
692         dst->f_ver = cpu_to_le32(fid_ver(src));
693 }
694
695 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
696 {
697         /* check that all fields are converted */
698         CLASSERT(sizeof *src ==
699                  sizeof fid_seq(src) +
700                  sizeof fid_oid(src) + sizeof fid_ver(src));
701         dst->f_seq = le64_to_cpu(fid_seq(src));
702         dst->f_oid = le32_to_cpu(fid_oid(src));
703         dst->f_ver = le32_to_cpu(fid_ver(src));
704         LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
705 }
706
707 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
708 {
709         /* check that all fields are converted */
710         CLASSERT(sizeof *src ==
711                  sizeof fid_seq(src) +
712                  sizeof fid_oid(src) + sizeof fid_ver(src));
713         LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
714         dst->f_seq = cpu_to_be64(fid_seq(src));
715         dst->f_oid = cpu_to_be32(fid_oid(src));
716         dst->f_ver = cpu_to_be32(fid_ver(src));
717 }
718
719 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
720 {
721         /* check that all fields are converted */
722         CLASSERT(sizeof *src ==
723                  sizeof fid_seq(src) +
724                  sizeof fid_oid(src) + sizeof fid_ver(src));
725         dst->f_seq = be64_to_cpu(fid_seq(src));
726         dst->f_oid = be32_to_cpu(fid_oid(src));
727         dst->f_ver = be32_to_cpu(fid_ver(src));
728         LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
729 }
730
731 static inline int fid_is_sane(const struct lu_fid *fid)
732 {
733         return
734                 fid != NULL &&
735                 ((fid_seq(fid) >= FID_SEQ_START && fid_oid(fid) != 0
736                                                 && fid_ver(fid) == 0) ||
737                 fid_is_igif(fid));
738 }
739
740 static inline int fid_is_zero(const struct lu_fid *fid)
741 {
742         return fid_seq(fid) == 0 && fid_oid(fid) == 0;
743 }
744
745 extern void lustre_swab_lu_fid(struct lu_fid *fid);
746 extern void lustre_swab_lu_seq_range(struct lu_seq_range *range);
747
748 static inline int lu_fid_eq(const struct lu_fid *f0,
749                             const struct lu_fid *f1)
750 {
751         /* Check that there is no alignment padding. */
752         CLASSERT(sizeof *f0 ==
753                  sizeof f0->f_seq + sizeof f0->f_oid + sizeof f0->f_ver);
754         LASSERTF(fid_is_igif(f0) || fid_ver(f0) == 0, DFID, PFID(f0));
755         LASSERTF(fid_is_igif(f1) || fid_ver(f1) == 0, DFID, PFID(f1));
756         return memcmp(f0, f1, sizeof *f0) == 0;
757 }
758
759 #define __diff_normalize(val0, val1)                            \
760 ({                                                              \
761         typeof(val0) __val0 = (val0);                           \
762         typeof(val1) __val1 = (val1);                           \
763                                                                 \
764         (__val0 == __val1 ? 0 : __val0 > __val1 ? +1 : -1);     \
765 })
766
767 static inline int lu_fid_cmp(const struct lu_fid *f0,
768                              const struct lu_fid *f1)
769 {
770         return
771                 __diff_normalize(fid_seq(f0), fid_seq(f1)) ?:
772                 __diff_normalize(fid_oid(f0), fid_oid(f1)) ?:
773                 __diff_normalize(fid_ver(f0), fid_ver(f1));
774 }
775
776 /** @} lu_fid */
777
778 /** \defgroup lu_dir lu_dir
779  * @{ */
780
781 /**
782  * Enumeration of possible directory entry attributes.
783  *
784  * Attributes follow directory entry header in the order they appear in this
785  * enumeration.
786  */
787 enum lu_dirent_attrs {
788         LUDA_FID    = 0x0001,
789         LUDA_TYPE   = 0x0002,
790 };
791
792 /**
793  * Layout of readdir pages, as transmitted on wire.
794  */
795 struct lu_dirent {
796         /** valid if LUDA_FID is set. */
797         struct lu_fid lde_fid;
798         /** a unique entry identifier: a hash or an offset. */
799         __u64         lde_hash;
800         /** total record length, including all attributes. */
801         __u16         lde_reclen;
802         /** name length */
803         __u16         lde_namelen;
804         /** optional variable size attributes following this entry.
805          *  taken from enum lu_dirent_attrs.
806          */
807         __u32         lde_attrs;
808         /** name is followed by the attributes indicated in ->ldp_attrs, in
809          *  their natural order. After the last attribute, padding bytes are
810          *  added to make ->lde_reclen a multiple of 8.
811          */
812         char          lde_name[0];
813 };
814
815 /*
816  * Definitions of optional directory entry attributes formats.
817  *
818  * Individual attributes do not have their length encoded in a generic way. It
819  * is assumed that consumer of an attribute knows its format. This means that
820  * it is impossible to skip over an unknown attribute, except by skipping over all
821  * remaining attributes (by using ->lde_reclen), which is not too
822  * constraining, because new server versions will append new attributes at
823  * the end of an entry.
824  */
825
826 /**
827  * Fid directory attribute: a fid of an object referenced by the entry. This
828  * will be almost always requested by the client and supplied by the server.
829  *
830  * Aligned to 8 bytes.
831  */
832 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
833
834 /**
835  * File type.
836  *
837  * Aligned to 2 bytes.
838  */
839 struct luda_type {
840         __u16 lt_type;
841 };
842
843 struct lu_dirpage {
844         __u64            ldp_hash_start;
845         __u64            ldp_hash_end;
846         __u32            ldp_flags;
847         __u32            ldp_pad0;
848         struct lu_dirent ldp_entries[0];
849 };
850
851 enum lu_dirpage_flags {
852         LDF_EMPTY = 1 << 0
853 };
854
855 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
856 {
857         if (le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
858                 return NULL;
859         else
860                 return dp->ldp_entries;
861 }
862
863 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
864 {
865         struct lu_dirent *next;
866
867         if (le16_to_cpu(ent->lde_reclen) != 0)
868                 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
869         else
870                 next = NULL;
871
872         return next;
873 }
874
875 static inline int lu_dirent_calc_size(int namelen, __u16 attr)
876 {
877         int size;
878
879         if (attr & LUDA_TYPE) {
880                 const unsigned align = sizeof(struct luda_type) - 1;
881                 size = (sizeof(struct lu_dirent) + namelen + align) & ~align;
882                 size += sizeof(struct luda_type);
883         } else
884                 size = sizeof(struct lu_dirent) + namelen;
885
886         return (size + 7) & ~7;
887 }
888
889 static inline int lu_dirent_size(struct lu_dirent *ent)
890 {
891         if (le16_to_cpu(ent->lde_reclen) == 0) {
892                 return lu_dirent_calc_size(le16_to_cpu(ent->lde_namelen),
893                                            le32_to_cpu(ent->lde_attrs));
894         }
895         return le16_to_cpu(ent->lde_reclen);
896 }
897
898 #define DIR_END_OFF              0xfffffffffffffffeULL
899
900 /** @} lu_dir */
901
902 struct lustre_handle {
903         __u64 cookie;
904 };
905 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
906
907 static inline int lustre_handle_is_used(struct lustre_handle *lh)
908 {
909         return lh->cookie != 0ull;
910 }
911
912 static inline int lustre_handle_equal(struct lustre_handle *lh1,
913                                       struct lustre_handle *lh2)
914 {
915         return lh1->cookie == lh2->cookie;
916 }
917
918 static inline void lustre_handle_copy(struct lustre_handle *tgt,
919                                       struct lustre_handle *src)
920 {
921         tgt->cookie = src->cookie;
922 }
923
924 /* flags for lm_flags */
925 #define MSGHDR_AT_SUPPORT               0x1
926 #define MSGHDR_CKSUM_INCOMPAT18         0x2
927
928 #define lustre_msg lustre_msg_v2
929 /* we depend on this structure to be 8-byte aligned */
930 /* this type is only endian-adjusted in lustre_unpack_msg() */
931 struct lustre_msg_v2 {
932         __u32 lm_bufcount;
933         __u32 lm_secflvr;
934         __u32 lm_magic;
935         __u32 lm_repsize;
936         __u32 lm_cksum;
937         __u32 lm_flags;
938         __u32 lm_padding_2;
939         __u32 lm_padding_3;
940         __u32 lm_buflens[0];
941 };
942
943 /* without gss, ptlrpc_body is put at the first buffer. */
944 #define PTLRPC_NUM_VERSIONS     4
945 struct ptlrpc_body {
946         struct lustre_handle pb_handle;
947         __u32 pb_type;
948         __u32 pb_version;
949         __u32 pb_opc;
950         __u32 pb_status;
951         __u64 pb_last_xid;
952         __u64 pb_last_seen;
953         __u64 pb_last_committed;
954         __u64 pb_transno;
955         __u32 pb_flags;
956         __u32 pb_op_flags;
957         __u32 pb_conn_cnt;
958         __u32 pb_timeout;  /* for req, the deadline, for rep, the service est */
959         __u32 pb_service_time; /* for rep, actual service time */
960         __u32 pb_limit;
961         __u64 pb_slv;
962         /* VBR: pre-versions */
963         __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
964         /* padding for future needs */
965         __u64 pb_padding[4];
966 };
967
968 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
969
970 /* message body offset for lustre_msg_v2 */
971 /* ptlrpc body offset in all request/reply messages */
972 #define MSG_PTLRPC_BODY_OFF             0
973
974 /* normal request/reply message record offset */
975 #define REQ_REC_OFF                     1
976 #define REPLY_REC_OFF                   1
977
978 /* ldlm request message body offset */
979 #define DLM_LOCKREQ_OFF                 1 /* lockreq offset */
980 #define DLM_REQ_REC_OFF                 2 /* normal dlm request record offset */
981
982 /* ldlm intent lock message body offset */
983 #define DLM_INTENT_IT_OFF               2 /* intent lock it offset */
984 #define DLM_INTENT_REC_OFF              3 /* intent lock record offset */
985
986 /* ldlm reply message body offset */
987 #define DLM_LOCKREPLY_OFF               1 /* lockrep offset */
988 #define DLM_REPLY_REC_OFF               2 /* reply record offset */
989
990 /** only use in req->rq_{req,rep}_swab_mask */
991 #define MSG_PTLRPC_HEADER_OFF           31
992
993 /* Flags that are operation-specific go in the top 16 bits. */
994 #define MSG_OP_FLAG_MASK   0xffff0000
995 #define MSG_OP_FLAG_SHIFT  16
996
997 /* Flags that apply to all requests are in the bottom 16 bits */
998 #define MSG_GEN_FLAG_MASK     0x0000ffff
999 #define MSG_LAST_REPLAY           0x0001
1000 #define MSG_RESENT                0x0002
1001 #define MSG_REPLAY                0x0004
1002 /* #define MSG_AT_SUPPORT         0x0008
1003  * This was used in early prototypes of adaptive timeouts, and while there
1004  * shouldn't be any users of that code there also isn't a need for using this
1005  * bits. Defer usage until at least 1.10 to avoid potential conflict. */
1006 #define MSG_DELAY_REPLAY          0x0010
1007 #define MSG_VERSION_REPLAY        0x0020
1008 #define MSG_REQ_REPLAY_DONE       0x0040
1009 #define MSG_LOCK_REPLAY_DONE      0x0080
1010
1011 /*
1012  * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
1013  */
1014
1015 #define MSG_CONNECT_RECOVERING  0x00000001
1016 #define MSG_CONNECT_RECONNECT   0x00000002
1017 #define MSG_CONNECT_REPLAYABLE  0x00000004
1018 //#define MSG_CONNECT_PEER        0x8
1019 #define MSG_CONNECT_LIBCLIENT   0x00000010
1020 #define MSG_CONNECT_INITIAL     0x00000020
1021 #define MSG_CONNECT_ASYNC       0x00000040
1022 #define MSG_CONNECT_NEXT_VER    0x00000080 /* use next version of lustre_msg */
1023 #define MSG_CONNECT_TRANSNO     0x00000100 /* report transno */
1024
1025 /* Connect flags */
1026 #define OBD_CONNECT_RDONLY                0x1ULL /*client has read-only access*/
1027 #define OBD_CONNECT_INDEX                 0x2ULL /*connect specific LOV idx */
1028 #define OBD_CONNECT_MDS                   0x4ULL /*connect from MDT to OST */
1029 #define OBD_CONNECT_GRANT                 0x8ULL /*OSC gets grant at connect */
1030 #define OBD_CONNECT_SRVLOCK              0x10ULL /*server takes locks for cli */
1031 #define OBD_CONNECT_VERSION              0x20ULL /*Lustre versions in ocd */
1032 #define OBD_CONNECT_REQPORTAL            0x40ULL /*Separate non-IO req portal */
1033 #define OBD_CONNECT_ACL                  0x80ULL /*access control lists */
1034 #define OBD_CONNECT_XATTR               0x100ULL /*client use extended attr */
1035 #define OBD_CONNECT_CROW                0x200ULL /*MDS+OST create obj on write*/
1036 #define OBD_CONNECT_TRUNCLOCK           0x400ULL /*locks on server for punch */
1037 #define OBD_CONNECT_TRANSNO             0x800ULL /*replay sends init transno */
1038 #define OBD_CONNECT_IBITS              0x1000ULL /*support for inodebits locks*/
1039 #define OBD_CONNECT_JOIN               0x2000ULL /*files can be concatenated.
1040                                                   *We do not support JOIN FILE
1041                                                   *anymore, reserve this flags
1042                                                   *just for preventing such bit
1043                                                   *to be reused.*/
1044 #define OBD_CONNECT_ATTRFID            0x4000ULL /*Server can GetAttr By Fid*/
1045 #define OBD_CONNECT_NODEVOH            0x8000ULL /*No open hndl on specl nodes*/
1046 #define OBD_CONNECT_RMT_CLIENT        0x10000ULL /*Remote client */
1047 #define OBD_CONNECT_RMT_CLIENT_FORCE  0x20000ULL /*Remote client by force */
1048 #define OBD_CONNECT_BRW_SIZE          0x40000ULL /*Max bytes per rpc */
1049 #define OBD_CONNECT_QUOTA64           0x80000ULL /*64bit qunit_data.qd_count */
1050 #define OBD_CONNECT_MDS_CAPA         0x100000ULL /*MDS capability */
1051 #define OBD_CONNECT_OSS_CAPA         0x200000ULL /*OSS capability */
1052 #define OBD_CONNECT_CANCELSET        0x400000ULL /*Early batched cancels. */
1053 #define OBD_CONNECT_SOM              0x800000ULL /*Size on MDS */
1054 #define OBD_CONNECT_AT              0x1000000ULL /*client uses AT */
1055 #define OBD_CONNECT_LRU_RESIZE      0x2000000ULL /*LRU resize feature. */
1056 #define OBD_CONNECT_MDS_MDS         0x4000000ULL /*MDS-MDS connection */
1057 #define OBD_CONNECT_REAL            0x8000000ULL /*real connection */
1058 #define OBD_CONNECT_CHANGE_QS      0x10000000ULL /*shrink/enlarge qunit */
1059 #define OBD_CONNECT_CKSUM          0x20000000ULL /*support several cksum algos*/
1060 #define OBD_CONNECT_FID            0x40000000ULL /*FID is supported by server */
1061 #define OBD_CONNECT_VBR            0x80000000ULL /*version based recovery */
1062 #define OBD_CONNECT_LOV_V3        0x100000000ULL /*client supports LOV v3 EA */
1063 #define OBD_CONNECT_GRANT_SHRINK  0x200000000ULL /* support grant shrink */
1064 #define OBD_CONNECT_SKIP_ORPHAN   0x400000000ULL /* don't reuse orphan objids */
1065 #define OBD_CONNECT_MAX_EASIZE    0x800000000ULL /* preserved for large EA */
1066 #define OBD_CONNECT_FULL20       0x1000000000ULL /* it is 2.0 client */
1067 #define OBD_CONNECT_LAYOUTLOCK   0x2000000000ULL /* client supports layout lock */
1068 /* also update obd_connect_names[] for lprocfs_rd_connect_flags()
1069  * and lustre/utils/wirecheck.c */
1070
1071 #ifdef HAVE_LRU_RESIZE_SUPPORT
1072 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
1073 #else
1074 #define LRU_RESIZE_CONNECT_FLAG 0
1075 #endif
1076
1077 #define MDT_CONNECT_SUPPORTED  (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
1078                                 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
1079                                 OBD_CONNECT_IBITS | OBD_CONNECT_JOIN | \
1080                                 OBD_CONNECT_NODEVOH |/* OBD_CONNECT_ATTRFID |*/\
1081                                 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1082                                 OBD_CONNECT_RMT_CLIENT | \
1083                                 OBD_CONNECT_RMT_CLIENT_FORCE | \
1084                                 OBD_CONNECT_MDS_CAPA | OBD_CONNECT_OSS_CAPA | \
1085                                 OBD_CONNECT_MDS_MDS | OBD_CONNECT_FID | \
1086                                 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_VBR | \
1087                                 OBD_CONNECT_LOV_V3 | OBD_CONNECT_SOM | \
1088                                 OBD_CONNECT_FULL20)
1089 #define OST_CONNECT_SUPPORTED  (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
1090                                 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
1091                                 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
1092                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_QUOTA64 | \
1093                                 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1094                                 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_CKSUM | \
1095                                 OBD_CONNECT_CHANGE_QS | \
1096                                 OBD_CONNECT_OSS_CAPA  | OBD_CONNECT_RMT_CLIENT | \
1097                                 OBD_CONNECT_RMT_CLIENT_FORCE | OBD_CONNECT_VBR | \
1098                                 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
1099                                 OBD_CONNECT_GRANT_SHRINK | OBD_CONNECT_FULL20)
1100 #define ECHO_CONNECT_SUPPORTED (0)
1101 #define MGS_CONNECT_SUPPORTED  (OBD_CONNECT_VERSION | OBD_CONNECT_AT | \
1102                                 OBD_CONNECT_FULL20)
1103
1104 #define OBD_OCD_VERSION(major,minor,patch,fix) (((major)<<24) + ((minor)<<16) +\
1105                                                 ((patch)<<8) + (fix))
1106 #define OBD_OCD_VERSION_MAJOR(version) ((int)((version)>>24)&255)
1107 #define OBD_OCD_VERSION_MINOR(version) ((int)((version)>>16)&255)
1108 #define OBD_OCD_VERSION_PATCH(version) ((int)((version)>>8)&255)
1109 #define OBD_OCD_VERSION_FIX(version)   ((int)(version)&255)
1110
1111 /* This structure is used for both request and reply.
1112  *
1113  * If we eventually have separate connect data for different types, which we
1114  * almost certainly will, then perhaps we stick a union in here. */
1115 struct obd_connect_data {
1116         __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1117         __u32 ocd_version;       /* lustre release version number */
1118         __u32 ocd_grant;         /* initial cache grant amount (bytes) */
1119         __u32 ocd_index;         /* LOV index to connect to */
1120         __u32 ocd_brw_size;      /* Maximum BRW size in bytes */
1121         __u64 ocd_ibits_known;   /* inode bits this client understands */
1122         __u32 ocd_nllu;          /* non-local-lustre-user */
1123         __u32 ocd_nllg;          /* non-local-lustre-group */
1124         __u64 ocd_transno;       /* first transno from client to be replayed */
1125         __u32 ocd_group;         /* MDS group on OST */
1126         __u32 ocd_cksum_types;   /* supported checksum algorithms */
1127         __u64 padding1;          /* also fix lustre_swab_connect */
1128         __u64 padding2;          /* also fix lustre_swab_connect */
1129 };
1130
1131 extern void lustre_swab_connect(struct obd_connect_data *ocd);
1132
1133 /*
1134  * Supported checksum algorithms. Up to 32 checksum types are supported.
1135  * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
1136  * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
1137  * algorithm and also the OBD_FL_CKSUM* flags.
1138  */
1139 typedef enum {
1140         OBD_CKSUM_CRC32 = 0x00000001,
1141         OBD_CKSUM_ADLER = 0x00000002,
1142 } cksum_type_t;
1143
1144 /*
1145  *   OST requests: OBDO & OBD request records
1146  */
1147
1148 /* opcodes */
1149 typedef enum {
1150         OST_REPLY      =  0,       /* reply ? */
1151         OST_GETATTR    =  1,
1152         OST_SETATTR    =  2,
1153         OST_READ       =  3,
1154         OST_WRITE      =  4,
1155         OST_CREATE     =  5,
1156         OST_DESTROY    =  6,
1157         OST_GET_INFO   =  7,
1158         OST_CONNECT    =  8,
1159         OST_DISCONNECT =  9,
1160         OST_PUNCH      = 10,
1161         OST_OPEN       = 11,
1162         OST_CLOSE      = 12,
1163         OST_STATFS     = 13,
1164         OST_SYNC       = 16,
1165         OST_SET_INFO   = 17,
1166         OST_QUOTACHECK = 18,
1167         OST_QUOTACTL   = 19,
1168         OST_QUOTA_ADJUST_QUNIT = 20,
1169         OST_LAST_OPC
1170 } ost_cmd_t;
1171 #define OST_FIRST_OPC  OST_REPLY
1172
1173 enum obdo_flags {
1174         OBD_FL_INLINEDATA   = 0x00000001,
1175         OBD_FL_OBDMDEXISTS  = 0x00000002,
1176         OBD_FL_DELORPHAN    = 0x00000004, /* if set in o_flags delete orphans */
1177         OBD_FL_NORPC        = 0x00000008, /* set in o_flags do in OSC not OST */
1178         OBD_FL_IDONLY       = 0x00000010, /* set in o_flags only adjust obj id*/
1179         OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
1180         OBD_FL_DEBUG_CHECK  = 0x00000040, /* echo client/server debug check */
1181         OBD_FL_NO_USRQUOTA  = 0x00000100, /* the object's owner is over quota */
1182         OBD_FL_NO_GRPQUOTA  = 0x00000200, /* the object's group is over quota */
1183         OBD_FL_CREATE_CROW  = 0x00000400, /* object should be create on write */
1184         OBD_FL_SRVLOCK      = 0x00000800, /* delegate DLM locking to server */
1185         OBD_FL_CKSUM_CRC32  = 0x00001000, /* CRC32 checksum type */
1186         OBD_FL_CKSUM_ADLER  = 0x00002000, /* ADLER checksum type */
1187         OBD_FL_CKSUM_RSVD1  = 0x00004000, /* for future cksum types */
1188         OBD_FL_CKSUM_RSVD2  = 0x00008000, /* for future cksum types */
1189         OBD_FL_CKSUM_RSVD3  = 0x00010000, /* for future cksum types */
1190         OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
1191         OBD_FL_MMAP         = 0x00040000, /* object is mmapped on the client */
1192
1193         OBD_FL_CKSUM_ALL    = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER,
1194
1195         /* mask for local-only flag, which won't be sent over network */
1196         OBD_FL_LOCAL_MASK   = 0xF0000000,
1197 };
1198
1199 #define LOV_MAGIC_V1      0x0BD10BD0
1200 #define LOV_MAGIC         LOV_MAGIC_V1
1201 #define LOV_MAGIC_JOIN_V1 0x0BD20BD0
1202 #define LOV_MAGIC_V3      0x0BD30BD0
1203
1204 #define LOV_PATTERN_RAID0 0x001   /* stripes are used round-robin */
1205 #define LOV_PATTERN_RAID1 0x002   /* stripes are mirrors of each other */
1206 #define LOV_PATTERN_FIRST 0x100   /* first stripe is not in round-robin */
1207 #define LOV_PATTERN_CMOBD 0x200
1208
1209 #define LOV_OBJECT_GROUP_DEFAULT ~0ULL
1210 #define LOV_OBJECT_GROUP_CLEAR 0ULL
1211
1212 #define lov_ost_data lov_ost_data_v1
1213 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
1214         __u64 l_object_id;        /* OST object ID */
1215         __u64 l_object_seq;       /* OST object seq number */
1216         __u32 l_ost_gen;          /* generation of this l_ost_idx */
1217         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
1218 };
1219
1220 #define lov_mds_md lov_mds_md_v1
1221 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
1222         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
1223         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1224         __u64 lmm_object_id;      /* LOV object ID */
1225         __u64 lmm_object_seq;     /* LOV object seq number */
1226         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1227         __u32 lmm_stripe_count;   /* num stripes in use for this object */
1228         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1229 };
1230
1231 /* extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm); */
1232
1233 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
1234 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
1235
1236 #define XATTR_NAME_ACL_ACCESS   "system.posix_acl_access"
1237 #define XATTR_NAME_ACL_DEFAULT  "system.posix_acl_default"
1238 #define XATTR_USER_PREFIX       "user."
1239 #define XATTR_TRUSTED_PREFIX    "trusted."
1240 #define XATTR_SECURITY_PREFIX   "security."
1241 #define XATTR_LUSTRE_PREFIX     "lustre."
1242
1243 #define XATTR_NAME_LOV          "trusted.lov"
1244 #define XATTR_NAME_LMA          "trusted.lma"
1245 #define XATTR_NAME_LMV          "trusted.lmv"
1246 #define XATTR_NAME_LINK         "trusted.link"
1247
1248
1249 struct lov_mds_md_v3 {            /* LOV EA mds/wire data (little-endian) */
1250         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V3 */
1251         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1252         __u64 lmm_object_id;      /* LOV object ID */
1253         __u64 lmm_object_seq;     /* LOV object seq number */
1254         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1255         __u32 lmm_stripe_count;   /* num stripes in use for this object */
1256         char  lmm_pool_name[LOV_MAXPOOLNAME]; /* must be 32bit aligned */
1257         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1258 };
1259
1260
1261 #define OBD_MD_FLID        (0x00000001ULL) /* object ID */
1262 #define OBD_MD_FLATIME     (0x00000002ULL) /* access time */
1263 #define OBD_MD_FLMTIME     (0x00000004ULL) /* data modification time */
1264 #define OBD_MD_FLCTIME     (0x00000008ULL) /* change time */
1265 #define OBD_MD_FLSIZE      (0x00000010ULL) /* size */
1266 #define OBD_MD_FLBLOCKS    (0x00000020ULL) /* allocated blocks count */
1267 #define OBD_MD_FLBLKSZ     (0x00000040ULL) /* block size */
1268 #define OBD_MD_FLMODE      (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1269 #define OBD_MD_FLTYPE      (0x00000100ULL) /* object type (mode & S_IFMT) */
1270 #define OBD_MD_FLUID       (0x00000200ULL) /* user ID */
1271 #define OBD_MD_FLGID       (0x00000400ULL) /* group ID */
1272 #define OBD_MD_FLFLAGS     (0x00000800ULL) /* flags word */
1273 #define OBD_MD_FLNLINK     (0x00002000ULL) /* link count */
1274 #define OBD_MD_FLGENER     (0x00004000ULL) /* generation number */
1275 /*#define OBD_MD_FLINLINE    (0x00008000ULL)  inline data. used until 1.6.5 */
1276 #define OBD_MD_FLRDEV      (0x00010000ULL) /* device number */
1277 #define OBD_MD_FLEASIZE    (0x00020000ULL) /* extended attribute data */
1278 #define OBD_MD_LINKNAME    (0x00040000ULL) /* symbolic link target */
1279 #define OBD_MD_FLHANDLE    (0x00080000ULL) /* file/lock handle */
1280 #define OBD_MD_FLCKSUM     (0x00100000ULL) /* bulk data checksum */
1281 #define OBD_MD_FLQOS       (0x00200000ULL) /* quality of service stats */
1282 /*#define OBD_MD_FLOSCOPQ    (0x00400000ULL) osc opaque data, never used */
1283 #define OBD_MD_FLCOOKIE    (0x00800000ULL) /* log cancellation cookie */
1284 #define OBD_MD_FLGROUP     (0x01000000ULL) /* group */
1285 #define OBD_MD_FLFID       (0x02000000ULL) /* ->ost write inline fid */
1286 #define OBD_MD_FLEPOCH     (0x04000000ULL) /* ->ost write with ioepoch */
1287                                            /* ->mds if epoch opens or closes */
1288 #define OBD_MD_FLGRANT     (0x08000000ULL) /* ost preallocation space grant */
1289 #define OBD_MD_FLDIREA     (0x10000000ULL) /* dir's extended attribute data */
1290 #define OBD_MD_FLUSRQUOTA  (0x20000000ULL) /* over quota flags sent from ost */
1291 #define OBD_MD_FLGRPQUOTA  (0x40000000ULL) /* over quota flags sent from ost */
1292 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1293
1294 #define OBD_MD_MDS         (0x0000000100000000ULL) /* where an inode lives on */
1295 #define OBD_MD_REINT       (0x0000000200000000ULL) /* reintegrate oa */
1296 #define OBD_MD_MEA         (0x0000000400000000ULL) /* CMD split EA  */
1297 #define OBD_MD_MDTIDX      (0x0000000800000000ULL) /* Get MDT index  */
1298
1299 #define OBD_MD_FLXATTR     (0x0000001000000000ULL) /* xattr */
1300 #define OBD_MD_FLXATTRLS   (0x0000002000000000ULL) /* xattr list */
1301 #define OBD_MD_FLXATTRRM   (0x0000004000000000ULL) /* xattr remove */
1302 #define OBD_MD_FLACL       (0x0000008000000000ULL) /* ACL */
1303 #define OBD_MD_FLRMTPERM   (0x0000010000000000ULL) /* remote permission */
1304 #define OBD_MD_FLMDSCAPA   (0x0000020000000000ULL) /* MDS capability */
1305 #define OBD_MD_FLOSSCAPA   (0x0000040000000000ULL) /* OSS capability */
1306 #define OBD_MD_FLCKSPLIT   (0x0000080000000000ULL) /* Check split on server */
1307 #define OBD_MD_FLCROSSREF  (0x0000100000000000ULL) /* Cross-ref case */
1308 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1309                                                       * under lock */
1310 #define OBD_FL_TRUNC       (0x0000200000000000ULL) /* for filter_truncate */
1311
1312 #define OBD_MD_FLRMTLSETFACL    (0x0001000000000000ULL) /* lfs lsetfacl case */
1313 #define OBD_MD_FLRMTLGETFACL    (0x0002000000000000ULL) /* lfs lgetfacl case */
1314 #define OBD_MD_FLRMTRSETFACL    (0x0004000000000000ULL) /* lfs rsetfacl case */
1315 #define OBD_MD_FLRMTRGETFACL    (0x0008000000000000ULL) /* lfs rgetfacl case */
1316
1317 #define OBD_MD_FLGETATTR (OBD_MD_FLID    | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1318                           OBD_MD_FLCTIME | OBD_MD_FLSIZE  | OBD_MD_FLBLKSZ | \
1319                           OBD_MD_FLMODE  | OBD_MD_FLTYPE  | OBD_MD_FLUID   | \
1320                           OBD_MD_FLGID   | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1321                           OBD_MD_FLGENER | OBD_MD_FLRDEV  | OBD_MD_FLGROUP)
1322
1323 /* don't forget obdo_fid which is way down at the bottom so it can
1324  * come after the definition of llog_cookie */
1325
1326
1327 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
1328 #define OBD_STATFS_NODELAY      0x0001  /* requests should be send without delay
1329                                          * and resends for avoid deadlocks */
1330 #define OBD_STATFS_FROM_CACHE   0x0002  /* the statfs callback should not update
1331                                          * obd_osfs_age */
1332 #define OBD_STATFS_PTLRPCD      0x0004  /* requests will be sent via ptlrpcd
1333                                          * instead of a specific set. This
1334                                          * means that we cannot rely on the set
1335                                          * interpret routine to be called.
1336                                          * lov_statfs_fini() must thus be called
1337                                          * by the request interpret routine */
1338
1339 /* ost_body.data values for OST_BRW */
1340
1341 #define OBD_BRW_READ            0x01
1342 #define OBD_BRW_WRITE           0x02
1343 #define OBD_BRW_RWMASK          (OBD_BRW_READ | OBD_BRW_WRITE)
1344 #define OBD_BRW_SYNC            0x08 /* this page is a part of synchronous
1345                                       * transfer and is not accounted in
1346                                       * the grant. */
1347 #define OBD_BRW_CHECK           0x10
1348 #define OBD_BRW_FROM_GRANT      0x20 /* the osc manages this under llite */
1349 #define OBD_BRW_GRANTED         0x40 /* the ost manages this */
1350 #define OBD_BRW_NOCACHE         0x80 /* this page is a part of non-cached IO */
1351 #define OBD_BRW_NOQUOTA        0x100
1352 #define OBD_BRW_SRVLOCK        0x200 /* Client holds no lock over this page */
1353 #define OBD_BRW_ASYNC          0x400 /* Server may delay commit to disk */
1354 #define OBD_BRW_MEMALLOC       0x800 /* Client runs in the "kswapd" context */
1355
1356 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
1357
1358 #define OST_MIN_PRECREATE 32
1359 #define OST_MAX_PRECREATE 20000
1360
1361 struct obd_ioobj {
1362         obd_id               ioo_id;
1363         obd_seq              ioo_seq;
1364         __u32                ioo_type;
1365         __u32                ioo_bufcnt;
1366 };
1367
1368 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
1369
1370 /* multiple of 8 bytes => can array */
1371 struct niobuf_remote {
1372         __u64 offset;
1373         __u32 len;
1374         __u32 flags;
1375 };
1376
1377 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
1378
1379 /* lock value block communicated between the filter and llite */
1380
1381 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1382  * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1383 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1384 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1385 #define OST_LVB_IS_ERR(blocks)                                          \
1386         ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1387 #define OST_LVB_SET_ERR(blocks, rc)                                     \
1388         do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1389 #define OST_LVB_GET_ERR(blocks)    (int)(blocks - OST_LVB_ERR_INIT)
1390
1391 struct ost_lvb {
1392         __u64     lvb_size;
1393         obd_time  lvb_mtime;
1394         obd_time  lvb_atime;
1395         obd_time  lvb_ctime;
1396         __u64     lvb_blocks;
1397 };
1398
1399 extern void lustre_swab_ost_lvb(struct ost_lvb *);
1400
1401 /*
1402  *   MDS REQ RECORDS
1403  */
1404
1405 /* opcodes */
1406 typedef enum {
1407         MDS_GETATTR      = 33,
1408         MDS_GETATTR_NAME = 34,
1409         MDS_CLOSE        = 35,
1410         MDS_REINT        = 36,
1411         MDS_READPAGE     = 37,
1412         MDS_CONNECT      = 38,
1413         MDS_DISCONNECT   = 39,
1414         MDS_GETSTATUS    = 40,
1415         MDS_STATFS       = 41,
1416         MDS_PIN          = 42,
1417         MDS_UNPIN        = 43,
1418         MDS_SYNC         = 44,
1419         MDS_DONE_WRITING = 45,
1420         MDS_SET_INFO     = 46,
1421         MDS_QUOTACHECK   = 47,
1422         MDS_QUOTACTL     = 48,
1423         MDS_GETXATTR     = 49,
1424         MDS_SETXATTR     = 50, /* obsolete, now it's MDS_REINT op */
1425         MDS_WRITEPAGE    = 51,
1426         MDS_IS_SUBDIR    = 52,
1427         MDS_GET_INFO     = 53,
1428         MDS_LAST_OPC
1429 } mds_cmd_t;
1430
1431 #define MDS_FIRST_OPC    MDS_GETATTR
1432
1433 /*
1434  * Do not exceed 63
1435  */
1436
1437 typedef enum {
1438         REINT_SETATTR  = 1,
1439         REINT_CREATE   = 2,
1440         REINT_LINK     = 3,
1441         REINT_UNLINK   = 4,
1442         REINT_RENAME   = 5,
1443         REINT_OPEN     = 6,
1444         REINT_SETXATTR = 7,
1445 //      REINT_CLOSE    = 8,
1446 //      REINT_WRITE    = 9,
1447         REINT_MAX
1448 } mds_reint_t, mdt_reint_t;
1449
1450 extern void lustre_swab_generic_32s (__u32 *val);
1451
1452 /* the disposition of the intent outlines what was executed */
1453 #define DISP_IT_EXECD        0x00000001
1454 #define DISP_LOOKUP_EXECD    0x00000002
1455 #define DISP_LOOKUP_NEG      0x00000004
1456 #define DISP_LOOKUP_POS      0x00000008
1457 #define DISP_OPEN_CREATE     0x00000010
1458 #define DISP_OPEN_OPEN       0x00000020
1459 #define DISP_ENQ_COMPLETE    0x00400000
1460 #define DISP_ENQ_OPEN_REF    0x00800000
1461 #define DISP_ENQ_CREATE_REF  0x01000000
1462 #define DISP_OPEN_LOCK       0x02000000
1463
1464 /* INODE LOCK PARTS */
1465 #define MDS_INODELOCK_LOOKUP 0x000001       /* dentry, mode, owner, group */
1466 #define MDS_INODELOCK_UPDATE 0x000002       /* size, links, timestamps */
1467 #define MDS_INODELOCK_OPEN   0x000004       /* For opened files */
1468
1469 /* Do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits */
1470 #define MDS_INODELOCK_MAXSHIFT 2
1471 /* This FULL lock is useful to take on unlink sort of operations */
1472 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
1473
1474 extern void lustre_swab_ll_fid (struct ll_fid *fid);
1475
1476 #define MDS_STATUS_CONN 1
1477 #define MDS_STATUS_LOV 2
1478
1479 struct mds_status_req {
1480         __u32  flags;
1481         __u32  repbuf;
1482 };
1483
1484 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
1485
1486 /* mdt_thread_info.mti_flags. */
1487 enum md_op_flags {
1488         /* The flag indicates Size-on-MDS attributes are changed. */
1489         MF_SOM_CHANGE           = (1 << 0),
1490         /* Flags indicates an epoch opens or closes. */
1491         MF_EPOCH_OPEN           = (1 << 1),
1492         MF_EPOCH_CLOSE          = (1 << 2),
1493         MF_MDC_CANCEL_FID1      = (1 << 3),
1494         MF_MDC_CANCEL_FID2      = (1 << 4),
1495         MF_MDC_CANCEL_FID3      = (1 << 5),
1496         MF_MDC_CANCEL_FID4      = (1 << 6),
1497         /* There is a pending attribute update. */
1498         MF_SOM_AU               = (1 << 7),
1499         /* Cancel OST locks while getattr OST attributes. */
1500         MF_GETATTR_LOCK         = (1 << 8),
1501 };
1502
1503 #define MF_SOM_LOCAL_FLAGS (MF_SOM_CHANGE | MF_EPOCH_OPEN | MF_EPOCH_CLOSE)
1504
1505 #define MDS_BFLAG_UNCOMMITTED_WRITES   0x1
1506
1507 /* these should be identical to their EXT3_*_FL counterparts, and are
1508  * redefined here only to avoid dragging in ext3_fs.h */
1509 #define MDS_SYNC_FL             0x00000008 /* Synchronous updates */
1510 #define MDS_IMMUTABLE_FL        0x00000010 /* Immutable file */
1511 #define MDS_APPEND_FL           0x00000020 /* writes to file may only append */
1512 #define MDS_NOATIME_FL          0x00000080 /* do not update atime */
1513 #define MDS_DIRSYNC_FL          0x00010000 /* dirsync behaviour (dir only) */
1514
1515 #ifdef __KERNEL__
1516 /* Convert wire MDS_*_FL to corresponding client local VFS S_* values
1517  * for the client inode i_flags.  The MDS_*_FL are the Lustre wire
1518  * protocol equivalents of LDISKFS_*_FL values stored on disk, while
1519  * the S_* flags are kernel-internal values that change between kernel
1520  * versions.  These flags are set/cleared via FSFILT_IOC_{GET,SET}_FLAGS.
1521  * See b=16526 for a full history. */
1522 static inline int ll_ext_to_inode_flags(int flags)
1523 {
1524         return (((flags & MDS_SYNC_FL)      ? S_SYNC      : 0) |
1525                 ((flags & MDS_NOATIME_FL)   ? S_NOATIME   : 0) |
1526                 ((flags & MDS_APPEND_FL)    ? S_APPEND    : 0) |
1527 #if defined(S_DIRSYNC)
1528                 ((flags & MDS_DIRSYNC_FL)   ? S_DIRSYNC   : 0) |
1529 #endif
1530                 ((flags & MDS_IMMUTABLE_FL) ? S_IMMUTABLE : 0));
1531 }
1532
1533 static inline int ll_inode_to_ext_flags(int iflags)
1534 {
1535         return (((iflags & S_SYNC)      ? MDS_SYNC_FL      : 0) |
1536                 ((iflags & S_NOATIME)   ? MDS_NOATIME_FL   : 0) |
1537                 ((iflags & S_APPEND)    ? MDS_APPEND_FL    : 0) |
1538 #if defined(S_DIRSYNC)
1539                 ((iflags & S_DIRSYNC)   ? MDS_DIRSYNC_FL   : 0) |
1540 #endif
1541                 ((iflags & S_IMMUTABLE) ? MDS_IMMUTABLE_FL : 0));
1542 }
1543 #endif
1544
1545 /*
1546  * while mds_body is to interact with 1.6, mdt_body is to interact with 2.0.
1547  * both of them should have the same fields layout, because at client side
1548  * one could be dynamically cast to the other.
1549  *
1550  * mdt_body has large size than mds_body, with unused padding (48 bytes)
1551  * at the end. client always use size of mdt_body to prepare request/reply
1552  * buffers, and actual data could be interepeted as mdt_body or mds_body
1553  * accordingly.
1554  */
1555 struct mds_body {
1556         struct ll_fid  fid1;
1557         struct ll_fid  fid2;
1558         struct lustre_handle handle;
1559         __u64          valid;
1560         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1561         obd_time       mtime;
1562         obd_time       atime;
1563         obd_time       ctime;
1564         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1565         __u64          io_epoch;
1566         __u64          ino;
1567         __u32          fsuid;
1568         __u32          fsgid;
1569         __u32          capability;
1570         __u32          mode;
1571         __u32          uid;
1572         __u32          gid;
1573         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1574         __u32          rdev;
1575         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1576         __u32          generation;
1577         __u32          suppgid;
1578         __u32          eadatasize;
1579         __u32          aclsize;
1580         __u32          max_mdsize;
1581         __u32          max_cookiesize;
1582         __u32          padding_4; /* also fix lustre_swab_mds_body */
1583 };
1584
1585 extern void lustre_swab_mds_body (struct mds_body *b);
1586
1587 struct mdt_body {
1588         struct lu_fid  fid1;
1589         struct lu_fid  fid2;
1590         struct lustre_handle handle;
1591         __u64          valid;
1592         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1593        obd_time        mtime;
1594        obd_time        atime;
1595        obd_time        ctime;
1596         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1597         __u64          ioepoch;
1598         __u64          ino;    /* for 1.6 compatibility */
1599         __u32          fsuid;
1600         __u32          fsgid;
1601         __u32          capability;
1602         __u32          mode;
1603         __u32          uid;
1604         __u32          gid;
1605         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1606         __u32          rdev;
1607         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1608         __u32          generation; /* for 1.6 compatibility */
1609         __u32          suppgid;
1610         __u32          eadatasize;
1611         __u32          aclsize;
1612         __u32          max_mdsize;
1613         __u32          max_cookiesize;
1614         __u32          uid_h; /* high 32-bits of uid, for FUID */
1615         __u32          gid_h; /* high 32-bits of gid, for FUID */
1616         __u32          padding_5; /* also fix lustre_swab_mdt_body */
1617         __u64          padding_6;
1618         __u64          padding_7;
1619         __u64          padding_8;
1620         __u64          padding_9;
1621         __u64          padding_10;
1622 }; /* 216 */
1623
1624 extern void lustre_swab_mdt_body (struct mdt_body *b);
1625
1626 struct mdt_ioepoch {
1627         struct lustre_handle handle;
1628         __u64  ioepoch;
1629         __u32  flags;
1630         __u32  padding;
1631 };
1632
1633 extern void lustre_swab_mdt_ioepoch (struct mdt_ioepoch *b);
1634
1635 #define Q_QUOTACHECK    0x800100
1636 #define Q_INITQUOTA     0x800101        /* init slave limits */
1637 #define Q_GETOINFO      0x800102        /* get obd quota info */
1638 #define Q_GETOQUOTA     0x800103        /* get obd quotas */
1639 #define Q_FINVALIDATE   0x800104        /* invalidate operational quotas */
1640
1641 #define Q_TYPEMATCH(id, type) \
1642         ((id) == (type) || (id) == UGQUOTA)
1643
1644 #define Q_TYPESET(oqc, type) Q_TYPEMATCH((oqc)->qc_type, type)
1645
1646 #define Q_GETOCMD(oqc) \
1647         ((oqc)->qc_cmd == Q_GETOINFO || (oqc)->qc_cmd == Q_GETOQUOTA)
1648
1649 #define QCTL_COPY(out, in)              \
1650 do {                                    \
1651         Q_COPY(out, in, qc_cmd);        \
1652         Q_COPY(out, in, qc_type);       \
1653         Q_COPY(out, in, qc_id);         \
1654         Q_COPY(out, in, qc_stat);       \
1655         Q_COPY(out, in, qc_dqinfo);     \
1656         Q_COPY(out, in, qc_dqblk);      \
1657 } while (0)
1658
1659 struct obd_quotactl {
1660         __u32                   qc_cmd;
1661         __u32                   qc_type;
1662         __u32                   qc_id;
1663         __u32                   qc_stat;
1664         struct obd_dqinfo       qc_dqinfo;
1665         struct obd_dqblk        qc_dqblk;
1666 };
1667
1668 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1669
1670 struct quota_adjust_qunit {
1671         __u32 qaq_flags;
1672         __u32 qaq_id;
1673         __u64 qaq_bunit_sz;
1674         __u64 qaq_iunit_sz;
1675         __u64 padding1;
1676 };
1677 extern void lustre_swab_quota_adjust_qunit(struct quota_adjust_qunit *q);
1678
1679 /* flags is shared among quota structures */
1680 #define LQUOTA_FLAGS_GRP       1UL   /* 0 is user, 1 is group */
1681 #define LQUOTA_FLAGS_BLK       2UL   /* 0 is inode, 1 is block */
1682 #define LQUOTA_FLAGS_ADJBLK    4UL   /* adjust the block qunit size */
1683 #define LQUOTA_FLAGS_ADJINO    8UL   /* adjust the inode qunit size */
1684 #define LQUOTA_FLAGS_CHG_QS   16UL   /* indicate whether it has capability of
1685                                       * OBD_CONNECT_CHANGE_QS */
1686 #define LQUOTA_FLAGS_RECOVERY 32UL   /* recovery is going on a uid/gid */
1687 #define LQUOTA_FLAGS_SETQUOTA 64UL   /* being setquota on a uid/gid */
1688
1689 /* flags is specific for quota_adjust_qunit */
1690 #define LQUOTA_QAQ_CREATE_LQS  (1 << 31) /* when it is set, need create lqs */
1691
1692 /* the status of lqs_flags in struct lustre_qunit_size  */
1693 #define LQUOTA_QUNIT_FLAGS (LQUOTA_FLAGS_GRP | LQUOTA_FLAGS_BLK)
1694
1695 #define QAQ_IS_GRP(qaq)    ((qaq)->qaq_flags & LQUOTA_FLAGS_GRP)
1696 #define QAQ_IS_ADJBLK(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_ADJBLK)
1697 #define QAQ_IS_ADJINO(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_ADJINO)
1698 #define QAQ_IS_CREATE_LQS(qaq)  ((qaq)->qaq_flags & LQUOTA_QAQ_CREATE_LQS)
1699
1700 #define QAQ_SET_GRP(qaq)    ((qaq)->qaq_flags |= LQUOTA_FLAGS_GRP)
1701 #define QAQ_SET_ADJBLK(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_ADJBLK)
1702 #define QAQ_SET_ADJINO(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_ADJINO)
1703 #define QAQ_SET_CREATE_LQS(qaq) ((qaq)->qaq_flags |= LQUOTA_QAQ_CREATE_LQS)
1704
1705 /* inode access permission for remote user, the inode info are omitted,
1706  * for client knows them. */
1707 struct mds_remote_perm {
1708         __u32           rp_uid;
1709         __u32           rp_gid;
1710         __u32           rp_fsuid;
1711         __u32           rp_fsgid;
1712         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
1713 };
1714
1715 /* permissions for md_perm.mp_perm */
1716 enum {
1717         CFS_SETUID_PERM = 0x01,
1718         CFS_SETGID_PERM = 0x02,
1719         CFS_SETGRP_PERM = 0x04,
1720         CFS_RMTACL_PERM = 0x08,
1721         CFS_RMTOWN_PERM = 0x10
1722 };
1723
1724 extern void lustre_swab_mds_remote_perm(struct mds_remote_perm *p);
1725
1726 struct mdt_remote_perm {
1727         __u32           rp_uid;
1728         __u32           rp_gid;
1729         __u32           rp_fsuid;
1730         __u32           rp_fsuid_h;
1731         __u32           rp_fsgid;
1732         __u32           rp_fsgid_h;
1733         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
1734 };
1735
1736 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
1737
1738 struct mdt_rec_setattr {
1739         __u32           sa_opcode;
1740         __u32           sa_cap;
1741         __u32           sa_fsuid;
1742         __u32           sa_fsuid_h;
1743         __u32           sa_fsgid;
1744         __u32           sa_fsgid_h;
1745         __u32           sa_suppgid;
1746         __u32           sa_suppgid_h;
1747         __u32           sa_padding_1;
1748         __u32           sa_padding_1_h;
1749         struct lu_fid   sa_fid;
1750         __u64           sa_valid;
1751         __u32           sa_uid;
1752         __u32           sa_gid;
1753         __u64           sa_size;
1754         __u64           sa_blocks;
1755         obd_time        sa_mtime;
1756         obd_time        sa_atime;
1757         obd_time        sa_ctime;
1758         __u32           sa_attr_flags;
1759         __u32           sa_mode;
1760         __u32           sa_padding_2;
1761         __u32           sa_padding_3;
1762         __u32           sa_padding_4;
1763         __u32           sa_padding_5;
1764 };
1765
1766 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
1767
1768 /*
1769  * Attribute flags used in mdt_rec_setattr::sa_valid.
1770  * The kernel's #defines for ATTR_* should not be used over the network
1771  * since the client and MDS may run different kernels (see bug 13828)
1772  * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1773  */
1774 #define MDS_ATTR_MODE          0x1ULL /* = 1 */
1775 #define MDS_ATTR_UID           0x2ULL /* = 2 */
1776 #define MDS_ATTR_GID           0x4ULL /* = 4 */
1777 #define MDS_ATTR_SIZE          0x8ULL /* = 8 */
1778 #define MDS_ATTR_ATIME        0x10ULL /* = 16 */
1779 #define MDS_ATTR_MTIME        0x20ULL /* = 32 */
1780 #define MDS_ATTR_CTIME        0x40ULL /* = 64 */
1781 #define MDS_ATTR_ATIME_SET    0x80ULL /* = 128 */
1782 #define MDS_ATTR_MTIME_SET   0x100ULL /* = 256 */
1783 #define MDS_ATTR_FORCE       0x200ULL /* = 512, Not a change, but a change it */
1784 #define MDS_ATTR_ATTR_FLAG   0x400ULL /* = 1024 */
1785 #define MDS_ATTR_KILL_SUID   0x800ULL /* = 2048 */
1786 #define MDS_ATTR_KILL_SGID  0x1000ULL /* = 4096 */
1787 #define MDS_ATTR_CTIME_SET  0x2000ULL /* = 8192 */
1788 #define MDS_ATTR_FROM_OPEN  0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
1789 #define MDS_ATTR_BLOCKS     0x8000ULL /* = 32768 */
1790
1791 #ifndef FMODE_READ
1792 #define FMODE_READ               00000001
1793 #define FMODE_WRITE              00000002
1794 #endif
1795
1796 /* IO Epoch is opened on a closed file. */
1797 #define FMODE_EPOCH              01000000
1798 /* IO Epoch is opened on a file truncate. */
1799 #define FMODE_TRUNC              02000000
1800 /* Size-on-MDS Attribute Update is pending. */
1801 #define FMODE_SOM                04000000
1802 #define FMODE_CLOSED             0
1803
1804 #define MDS_OPEN_CREATED         00000010
1805 #define MDS_OPEN_CROSS           00000020
1806
1807 #define MDS_FMODE_EXEC           00000004
1808 #define MDS_OPEN_CREAT           00000100
1809 #define MDS_OPEN_EXCL            00000200
1810 #define MDS_OPEN_TRUNC           00001000
1811 #define MDS_OPEN_APPEND          00002000
1812 #define MDS_OPEN_SYNC            00010000
1813 #define MDS_OPEN_DIRECTORY       00200000
1814
1815 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
1816 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1817 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file.
1818                                            * We do not support JOIN FILE
1819                                            * anymore, reserve this flags
1820                                            * just for preventing such bit
1821                                            * to be reused. */
1822 #define MDS_CREATE_RMT_ACL    01000000000 /* indicate create on remote server
1823                                            * with default ACL */
1824 #define MDS_CREATE_SLAVE_OBJ  02000000000 /* indicate create slave object
1825                                            * actually, this is for create, not
1826                                            * conflict with other open flags */
1827 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
1828 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
1829 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
1830
1831 /* permission for create non-directory file */
1832 #define MAY_CREATE      (1 << 7)
1833 /* permission for create directory file */
1834 #define MAY_LINK        (1 << 8)
1835 /* permission for delete from the directory */
1836 #define MAY_UNLINK      (1 << 9)
1837 /* source's permission for rename */
1838 #define MAY_RENAME_SRC  (1 << 10)
1839 /* target's permission for rename */
1840 #define MAY_RENAME_TAR  (1 << 11)
1841 /* part (parent's) VTX permission check */
1842 #define MAY_VTX_PART    (1 << 12)
1843 /* full VTX permission check */
1844 #define MAY_VTX_FULL    (1 << 13)
1845 /* lfs rgetfacl permission check */
1846 #define MAY_RGETFACL    (1 << 14)
1847
1848 enum {
1849         MDS_CHECK_SPLIT   = 1 << 0,
1850         MDS_CROSS_REF     = 1 << 1,
1851         MDS_VTX_BYPASS    = 1 << 2,
1852         MDS_PERM_BYPASS   = 1 << 3,
1853         MDS_SOM           = 1 << 4,
1854         MDS_QUOTA_IGNORE  = 1 << 5,
1855         MDS_CLOSE_CLEANUP = 1 << 6
1856 };
1857
1858 /* instance of mdt_reint_rec */
1859 struct mdt_rec_create {
1860         __u32           cr_opcode;
1861         __u32           cr_cap;
1862         __u32           cr_fsuid;
1863         __u32           cr_fsuid_h;
1864         __u32           cr_fsgid;
1865         __u32           cr_fsgid_h;
1866         __u32           cr_suppgid1;
1867         __u32           cr_suppgid1_h;
1868         __u32           cr_suppgid2;
1869         __u32           cr_suppgid2_h;
1870         struct lu_fid   cr_fid1;
1871         struct lu_fid   cr_fid2;
1872         struct lustre_handle cr_old_handle; /* handle in case of open replay */
1873         obd_time        cr_time;
1874         __u64           cr_rdev;
1875         __u64           cr_ioepoch;
1876         __u64           cr_padding_1;   /* rr_blocks */
1877         __u32           cr_mode;
1878         __u32           cr_bias;
1879         __u32           cr_flags;       /* for use with open */
1880         __u32           cr_padding_2;   /* rr_padding_2 */
1881         __u32           cr_padding_3;   /* rr_padding_3 */
1882         __u32           cr_padding_4;   /* rr_padding_4 */
1883 };
1884
1885 /* instance of mdt_reint_rec */
1886 struct mdt_rec_link {
1887         __u32           lk_opcode;
1888         __u32           lk_cap;
1889         __u32           lk_fsuid;
1890         __u32           lk_fsuid_h;
1891         __u32           lk_fsgid;
1892         __u32           lk_fsgid_h;
1893         __u32           lk_suppgid1;
1894         __u32           lk_suppgid1_h;
1895         __u32           lk_suppgid2;
1896         __u32           lk_suppgid2_h;
1897         struct lu_fid   lk_fid1;
1898         struct lu_fid   lk_fid2;
1899         obd_time        lk_time;
1900         __u64           lk_padding_1;   /* rr_atime */
1901         __u64           lk_padding_2;   /* rr_ctime */
1902         __u64           lk_padding_3;   /* rr_size */
1903         __u64           lk_padding_4;   /* rr_blocks */
1904         __u32           lk_bias;
1905         __u32           lk_padding_5;   /* rr_mode */
1906         __u32           lk_padding_6;   /* rr_flags */
1907         __u32           lk_padding_7;   /* rr_padding_2 */
1908         __u32           lk_padding_8;   /* rr_padding_3 */
1909         __u32           lk_padding_9;   /* rr_padding_4 */
1910 };
1911
1912 /* instance of mdt_reint_rec */
1913 struct mdt_rec_unlink {
1914         __u32           ul_opcode;
1915         __u32           ul_cap;
1916         __u32           ul_fsuid;
1917         __u32           ul_fsuid_h;
1918         __u32           ul_fsgid;
1919         __u32           ul_fsgid_h;
1920         __u32           ul_suppgid1;
1921         __u32           ul_suppgid1_h;
1922         __u32           ul_suppgid2;
1923         __u32           ul_suppgid2_h;
1924         struct lu_fid   ul_fid1;
1925         struct lu_fid   ul_fid2;
1926         obd_time        ul_time;
1927         __u64           ul_padding_2;   /* rr_atime */
1928         __u64           ul_padding_3;   /* rr_ctime */
1929         __u64           ul_padding_4;   /* rr_size */
1930         __u64           ul_padding_5;   /* rr_blocks */
1931         __u32           ul_bias;
1932         __u32           ul_mode;
1933         __u32           ul_padding_6;   /* rr_flags */
1934         __u32           ul_padding_7;   /* rr_padding_2 */
1935         __u32           ul_padding_8;   /* rr_padding_3 */
1936         __u32           ul_padding_9;   /* rr_padding_4 */
1937 };
1938
1939 /* instance of mdt_reint_rec */
1940 struct mdt_rec_rename {
1941         __u32           rn_opcode;
1942         __u32           rn_cap;
1943         __u32           rn_fsuid;
1944         __u32           rn_fsuid_h;
1945         __u32           rn_fsgid;
1946         __u32           rn_fsgid_h;
1947         __u32           rn_suppgid1;
1948         __u32           rn_suppgid1_h;
1949         __u32           rn_suppgid2;
1950         __u32           rn_suppgid2_h;
1951         struct lu_fid   rn_fid1;
1952         struct lu_fid   rn_fid2;
1953         obd_time        rn_time;
1954         __u64           rn_padding_1;   /* rr_atime */
1955         __u64           rn_padding_2;   /* rr_ctime */
1956         __u64           rn_padding_3;   /* rr_size */
1957         __u64           rn_padding_4;   /* rr_blocks */
1958         __u32           rn_bias;        /* some operation flags */
1959         __u32           rn_mode;        /* cross-ref rename has mode */
1960         __u32           rn_padding_5;   /* rr_flags */
1961         __u32           rn_padding_6;   /* rr_padding_2 */
1962         __u32           rn_padding_7;   /* rr_padding_3 */
1963         __u32           rn_padding_8;   /* rr_padding_4 */
1964 };
1965
1966 /* instance of mdt_reint_rec */
1967 struct mdt_rec_setxattr {
1968         __u32           sx_opcode;
1969         __u32           sx_cap;
1970         __u32           sx_fsuid;
1971         __u32           sx_fsuid_h;
1972         __u32           sx_fsgid;
1973         __u32           sx_fsgid_h;
1974         __u32           sx_suppgid1;
1975         __u32           sx_suppgid1_h;
1976         __u32           sx_suppgid2;
1977         __u32           sx_suppgid2_h;
1978         struct lu_fid   sx_fid;
1979         __u64           sx_padding_1;   /* These three are rr_fid2 */
1980         __u32           sx_padding_2;
1981         __u32           sx_padding_3;
1982         __u64           sx_valid;
1983         obd_time        sx_time;
1984         __u64           sx_padding_5;   /* rr_ctime */
1985         __u64           sx_padding_6;   /* rr_size */
1986         __u64           sx_padding_7;   /* rr_blocks */
1987         __u32           sx_size;
1988         __u32           sx_flags;
1989         __u32           sx_padding_8;   /* rr_flags */
1990         __u32           sx_padding_9;   /* rr_padding_2 */
1991         __u32           sx_padding_10;  /* rr_padding_3 */
1992         __u32           sx_padding_11;  /* rr_padding_4 */
1993 };
1994
1995 /*
1996  * mdt_rec_reint is the template for all mdt_reint_xxx structures.
1997  * Do NOT change the size of various members, otherwise the value
1998  * will be broken in lustre_swab_mdt_rec_reint().
1999  *
2000  * If you add new members in other mdt_reint_xxx structres and need to use the
2001  * rr_padding_x fields, then update lustre_swab_mdt_rec_reint() also.
2002  */
2003 struct mdt_rec_reint {
2004         __u32           rr_opcode;
2005         __u32           rr_cap;
2006         __u32           rr_fsuid;
2007         __u32           rr_fsuid_h;
2008         __u32           rr_fsgid;
2009         __u32           rr_fsgid_h;
2010         __u32           rr_suppgid1;
2011         __u32           rr_suppgid1_h;
2012         __u32           rr_suppgid2;
2013         __u32           rr_suppgid2_h;
2014         struct lu_fid   rr_fid1;
2015         struct lu_fid   rr_fid2;
2016         obd_time        rr_mtime;
2017         obd_time        rr_atime;
2018         obd_time        rr_ctime;
2019         __u64           rr_size;
2020         __u64           rr_blocks;
2021         __u32           rr_bias;
2022         __u32           rr_mode;
2023         __u32           rr_flags;
2024         __u32           rr_padding_2; /* also fix lustre_swab_mdt_rec_reint */
2025         __u32           rr_padding_3; /* also fix lustre_swab_mdt_rec_reint */
2026         __u32           rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
2027 };
2028
2029 extern void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
2030
2031 struct lmv_desc {
2032         __u32 ld_tgt_count;                /* how many MDS's */
2033         __u32 ld_active_tgt_count;         /* how many active */
2034         __u32 ld_default_stripe_count;     /* how many objects are used */
2035         __u32 ld_pattern;                  /* default MEA_MAGIC_* */
2036         __u64 ld_default_hash_size;
2037         __u64 ld_padding_1;                /* also fix lustre_swab_lmv_desc */
2038         __u32 ld_padding_2;                /* also fix lustre_swab_lmv_desc */
2039         __u32 ld_qos_maxage;               /* in second */
2040         __u32 ld_padding_3;                /* also fix lustre_swab_lmv_desc */
2041         __u32 ld_padding_4;                /* also fix lustre_swab_lmv_desc */
2042         struct obd_uuid ld_uuid;
2043 };
2044
2045 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
2046
2047 /* TODO: lmv_stripe_md should contain mds capabilities for all slave fids */
2048 struct lmv_stripe_md {
2049         __u32         mea_magic;
2050         __u32         mea_count;
2051         __u32         mea_master;
2052         __u32         mea_padding;
2053         char          mea_pool_name[LOV_MAXPOOLNAME];
2054         struct lu_fid mea_ids[0];
2055 };
2056
2057 extern void lustre_swab_lmv_stripe_md(struct lmv_stripe_md *mea);
2058
2059 /* lmv structures */
2060 #define MEA_MAGIC_LAST_CHAR      0xb2221ca1
2061 #define MEA_MAGIC_ALL_CHARS      0xb222a11c
2062 #define MEA_MAGIC_HASH_SEGMENT   0xb222a11b
2063
2064 #define MAX_HASH_SIZE_32         0x7fffffffUL
2065 #define MAX_HASH_SIZE            0x7fffffffffffffffULL
2066 #define MAX_HASH_HIGHEST_BIT     0x1000000000000000ULL
2067
2068 struct md_fld {
2069         seqno_t mf_seq;
2070         mdsno_t mf_mds;
2071 };
2072
2073 extern void lustre_swab_md_fld (struct md_fld *mf);
2074
2075 enum fld_rpc_opc {
2076         FLD_QUERY                       = 900,
2077         FLD_LAST_OPC,
2078         FLD_FIRST_OPC                   = FLD_QUERY
2079 };
2080
2081 enum seq_rpc_opc {
2082         SEQ_QUERY                       = 700,
2083         SEQ_LAST_OPC,
2084         SEQ_FIRST_OPC                   = SEQ_QUERY
2085 };
2086
2087 enum seq_op {
2088         SEQ_ALLOC_SUPER = 0,
2089         SEQ_ALLOC_META = 1
2090 };
2091
2092 /*
2093  *  LOV data structures
2094  */
2095
2096 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
2097 #define LOV_MIN_STRIPE_SIZE (1<<LOV_MIN_STRIPE_BITS)
2098 #define LOV_MAX_STRIPE_COUNT  160   /* until bug 4424 is fixed */
2099 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
2100
2101 #define LOV_MAX_UUID_BUFFER_SIZE  8192
2102 /* The size of the buffer the lov/mdc reserves for the
2103  * array of UUIDs returned by the MDS.  With the current
2104  * protocol, this will limit the max number of OSTs per LOV */
2105
2106 #define LOV_DESC_MAGIC 0xB0CCDE5C
2107
2108 /* LOV settings descriptor (should only contain static info) */
2109 struct lov_desc {
2110         __u32 ld_tgt_count;                /* how many OBD's */
2111         __u32 ld_active_tgt_count;         /* how many active */
2112         __u32 ld_default_stripe_count;     /* how many objects are used */
2113         __u32 ld_pattern;                  /* default PATTERN_RAID0 */
2114         __u64 ld_default_stripe_size;      /* in bytes */
2115         __u64 ld_default_stripe_offset;    /* in bytes */
2116         __u32 ld_padding_0;                /* unused */
2117         __u32 ld_qos_maxage;               /* in second */
2118         __u32 ld_padding_1;                /* also fix lustre_swab_lov_desc */
2119         __u32 ld_padding_2;                /* also fix lustre_swab_lov_desc */
2120         struct obd_uuid ld_uuid;
2121 };
2122
2123 #define ld_magic ld_active_tgt_count       /* for swabbing from llogs */
2124
2125 extern void lustre_swab_lov_desc (struct lov_desc *ld);
2126
2127 /*
2128  *   LDLM requests:
2129  */
2130 /* opcodes -- MUST be distinct from OST/MDS opcodes */
2131 typedef enum {
2132         LDLM_ENQUEUE     = 101,
2133         LDLM_CONVERT     = 102,
2134         LDLM_CANCEL      = 103,
2135         LDLM_BL_CALLBACK = 104,
2136         LDLM_CP_CALLBACK = 105,
2137         LDLM_GL_CALLBACK = 106,
2138         LDLM_SET_INFO    = 107,
2139         LDLM_LAST_OPC
2140 } ldlm_cmd_t;
2141 #define LDLM_FIRST_OPC LDLM_ENQUEUE
2142
2143 #define RES_NAME_SIZE 4
2144 struct ldlm_res_id {
2145         __u64 name[RES_NAME_SIZE];
2146 };
2147
2148 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
2149
2150 /* lock types */
2151 typedef enum {
2152         LCK_MINMODE = 0,
2153         LCK_EX      = 1,
2154         LCK_PW      = 2,
2155         LCK_PR      = 4,
2156         LCK_CW      = 8,
2157         LCK_CR      = 16,
2158         LCK_NL      = 32,
2159         LCK_GROUP   = 64,
2160         LCK_COS     = 128,
2161         LCK_MAXMODE
2162 } ldlm_mode_t;
2163
2164 #define LCK_MODE_NUM    8
2165
2166 typedef enum {
2167         LDLM_PLAIN     = 10,
2168         LDLM_EXTENT    = 11,
2169         LDLM_FLOCK     = 12,
2170         LDLM_IBITS     = 13,
2171         LDLM_MAX_TYPE
2172 } ldlm_type_t;
2173
2174 #define LDLM_MIN_TYPE LDLM_PLAIN
2175
2176 struct ldlm_extent {
2177         __u64 start;
2178         __u64 end;
2179         __u64 gid;
2180 };
2181
2182 static inline int ldlm_extent_overlap(struct ldlm_extent *ex1,
2183                                       struct ldlm_extent *ex2)
2184 {
2185         return (ex1->start <= ex2->end) && (ex2->start <= ex1->end);
2186 }
2187
2188 struct ldlm_inodebits {
2189         __u64 bits;
2190 };
2191
2192 struct ldlm_flock {
2193         __u64 start;
2194         __u64 end;
2195         __u64 blocking_export;  /* not actually used over the wire */
2196         __u32 blocking_pid;     /* not actually used over the wire */
2197         __u32 pid;
2198 };
2199
2200 /* it's important that the fields of the ldlm_extent structure match
2201  * the first fields of the ldlm_flock structure because there is only
2202  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
2203  * this ever changes we will need to swab the union differently based
2204  * on the resource type. */
2205
2206 typedef union {
2207         struct ldlm_extent l_extent;
2208         struct ldlm_flock  l_flock;
2209         struct ldlm_inodebits l_inodebits;
2210 } ldlm_policy_data_t;
2211
2212 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
2213
2214 struct ldlm_intent {
2215         __u64 opc;
2216 };
2217
2218 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
2219
2220 struct ldlm_resource_desc {
2221         ldlm_type_t lr_type;
2222         __u32 lr_padding;       /* also fix lustre_swab_ldlm_resource_desc */
2223         struct ldlm_res_id lr_name;
2224 };
2225
2226 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
2227
2228 struct ldlm_lock_desc {
2229         struct ldlm_resource_desc l_resource;
2230         ldlm_mode_t l_req_mode;
2231         ldlm_mode_t l_granted_mode;
2232         ldlm_policy_data_t l_policy_data;
2233 };
2234
2235 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
2236
2237 #define LDLM_LOCKREQ_HANDLES 2
2238 #define LDLM_ENQUEUE_CANCEL_OFF 1
2239
2240 struct ldlm_request {
2241         __u32 lock_flags;
2242         __u32 lock_count;
2243         struct ldlm_lock_desc lock_desc;
2244         struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
2245 };
2246
2247 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
2248
2249 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
2250  * Otherwise, 2 are available. */
2251 #define ldlm_request_bufsize(count,type)                                \
2252 ({                                                                      \
2253         int _avail = LDLM_LOCKREQ_HANDLES;                              \
2254         _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
2255         sizeof(struct ldlm_request) +                                   \
2256         (count > _avail ? count - _avail : 0) *                         \
2257         sizeof(struct lustre_handle);                                   \
2258 })
2259
2260 struct ldlm_reply {
2261         __u32 lock_flags;
2262         __u32 lock_padding;     /* also fix lustre_swab_ldlm_reply */
2263         struct ldlm_lock_desc lock_desc;
2264         struct lustre_handle lock_handle;
2265         __u64  lock_policy_res1;
2266         __u64  lock_policy_res2;
2267 };
2268
2269 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
2270
2271 /*
2272  * Opcodes for mountconf (mgs and mgc)
2273  */
2274 typedef enum {
2275         MGS_CONNECT = 250,
2276         MGS_DISCONNECT,
2277         MGS_EXCEPTION,         /* node died, etc. */
2278         MGS_TARGET_REG,        /* whenever target starts up */
2279         MGS_TARGET_DEL,
2280         MGS_SET_INFO,
2281         MGS_LAST_OPC
2282 } mgs_cmd_t;
2283 #define MGS_FIRST_OPC MGS_CONNECT
2284
2285 #define MGS_PARAM_MAXLEN 1024
2286 #define KEY_SET_INFO "set_info"
2287
2288 struct mgs_send_param {
2289         char             mgs_param[MGS_PARAM_MAXLEN];
2290 };
2291
2292 /* We pass this info to the MGS so it can write config logs */
2293 #define MTI_NAME_MAXLEN 64
2294 #define MTI_PARAM_MAXLEN 4096
2295 #define MTI_NIDS_MAX 32
2296 struct mgs_target_info {
2297         __u32            mti_lustre_ver;
2298         __u32            mti_stripe_index;
2299         __u32            mti_config_ver;
2300         __u32            mti_flags;
2301         __u32            mti_nid_count;
2302         __u32            padding;                    /* 64 bit align */
2303         char             mti_fsname[MTI_NAME_MAXLEN];
2304         char             mti_svname[MTI_NAME_MAXLEN];
2305         char             mti_uuid[sizeof(struct obd_uuid)];
2306         __u64            mti_nids[MTI_NIDS_MAX];     /* host nids (lnet_nid_t)*/
2307         char             mti_params[MTI_PARAM_MAXLEN];
2308 };
2309
2310 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
2311
2312 /* Config marker flags (in config log) */
2313 #define CM_START       0x01
2314 #define CM_END         0x02
2315 #define CM_SKIP        0x04
2316 #define CM_UPGRADE146  0x08
2317 #define CM_EXCLUDE     0x10
2318 #define CM_START_SKIP (CM_START | CM_SKIP)
2319
2320 struct cfg_marker {
2321         __u32             cm_step;       /* aka config version */
2322         __u32             cm_flags;
2323         __u32             cm_vers;       /* lustre release version number */
2324         __u32             padding;       /* 64 bit align */
2325         obd_time          cm_createtime; /*when this record was first created */
2326         obd_time          cm_canceltime; /*when this record is no longer valid*/
2327         char              cm_tgtname[MTI_NAME_MAXLEN];
2328         char              cm_comment[MTI_NAME_MAXLEN];
2329 };
2330
2331 extern void lustre_swab_cfg_marker(struct cfg_marker *marker,
2332                                    int swab, int size);
2333
2334 /*
2335  * Opcodes for multiple servers.
2336  */
2337
2338 typedef enum {
2339         OBD_PING = 400,
2340         OBD_LOG_CANCEL,
2341         OBD_QC_CALLBACK,
2342         OBD_LAST_OPC
2343 } obd_cmd_t;
2344 #define OBD_FIRST_OPC OBD_PING
2345
2346 /* catalog of log objects */
2347
2348 /** Identifier for a single log object */
2349 struct llog_logid {
2350         __u64                   lgl_oid;
2351         __u64                   lgl_oseq;
2352         __u32                   lgl_ogen;
2353 } __attribute__((packed));
2354
2355 /** Records written to the CATALOGS list */
2356 #define CATLIST "CATALOGS"
2357 struct llog_catid {
2358         struct llog_logid       lci_logid;
2359         __u32                   lci_padding1;
2360         __u32                   lci_padding2;
2361         __u32                   lci_padding3;
2362 } __attribute__((packed));
2363
2364 /* Log data record types - there is no specific reason that these need to
2365  * be related to the RPC opcodes, but no reason not to (may be handy later?)
2366  */
2367 #define LLOG_OP_MAGIC 0x10600000
2368 #define LLOG_OP_MASK  0xfff00000
2369
2370 typedef enum {
2371         LLOG_PAD_MAGIC     = LLOG_OP_MAGIC | 0x00000,
2372         OST_SZ_REC         = LLOG_OP_MAGIC | 0x00f00,
2373         OST_RAID1_REC      = LLOG_OP_MAGIC | 0x01000,
2374         MDS_UNLINK_REC     = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_UNLINK,
2375         MDS_SETATTR_REC    = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_SETATTR,
2376         MDS_SETATTR64_REC  = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) | REINT_SETATTR,
2377         OBD_CFG_REC        = LLOG_OP_MAGIC | 0x20000,
2378         PTL_CFG_REC        = LLOG_OP_MAGIC | 0x30000, /* obsolete */
2379         LLOG_GEN_REC       = LLOG_OP_MAGIC | 0x40000,
2380         LLOG_JOIN_REC      = LLOG_OP_MAGIC | 0x50000, /* obsolete */
2381         CHANGELOG_REC      = LLOG_OP_MAGIC | 0x60000,
2382         CHANGELOG_USER_REC = LLOG_OP_MAGIC | 0x70000,
2383         LLOG_HDR_MAGIC     = LLOG_OP_MAGIC | 0x45539,
2384         LLOG_LOGID_MAGIC   = LLOG_OP_MAGIC | 0x4553b,
2385 } llog_op_type;
2386
2387 /*
2388  * for now, continue to support old pad records which have 0 for their
2389  * type but still need to be swabbed for their length
2390  */
2391 #define LLOG_REC_HDR_NEEDS_SWABBING(r)                                  \
2392         (((r)->lrh_type & __swab32(LLOG_OP_MASK)) ==                    \
2393          __swab32(LLOG_OP_MAGIC) ||                                     \
2394          (((r)->lrh_type == 0) && ((r)->lrh_len > LLOG_CHUNK_SIZE)))
2395
2396 /** Log record header - stored in little endian order.
2397  * Each record must start with this struct, end with a llog_rec_tail,
2398  * and be a multiple of 256 bits in size.
2399  */
2400 struct llog_rec_hdr {
2401         __u32                   lrh_len;
2402         __u32                   lrh_index;
2403         __u32                   lrh_type;
2404         __u32                   padding;
2405 };
2406
2407 struct llog_rec_tail {
2408         __u32 lrt_len;
2409         __u32 lrt_index;
2410 };
2411
2412 struct llog_logid_rec {
2413         struct llog_rec_hdr     lid_hdr;
2414         struct llog_logid       lid_id;
2415         __u32                   padding1;
2416         __u32                   padding2;
2417         __u32                   padding3;
2418         __u32                   padding4;
2419         __u32                   padding5;
2420         struct llog_rec_tail    lid_tail;
2421 } __attribute__((packed));
2422
2423 struct llog_create_rec {
2424         struct llog_rec_hdr     lcr_hdr;
2425         struct ll_fid           lcr_fid;
2426         obd_id                  lcr_oid;
2427         obd_count               lcr_oseq;
2428         __u32                   padding;
2429         struct llog_rec_tail    lcr_tail;
2430 } __attribute__((packed));
2431
2432 struct llog_orphan_rec {
2433         struct llog_rec_hdr     lor_hdr;
2434         obd_id                  lor_oid;
2435         obd_count               lor_ogen;
2436         __u32                   padding;
2437         struct llog_rec_tail    lor_tail;
2438 } __attribute__((packed));
2439
2440 struct llog_unlink_rec {
2441         struct llog_rec_hdr     lur_hdr;
2442         obd_id                  lur_oid;
2443         obd_count               lur_oseq;
2444         obd_count               lur_count;
2445         struct llog_rec_tail    lur_tail;
2446 } __attribute__((packed));
2447
2448 struct llog_setattr_rec {
2449         struct llog_rec_hdr     lsr_hdr;
2450         obd_id                  lsr_oid;
2451         obd_count               lsr_oseq;
2452         __u32                   lsr_uid;
2453         __u32                   lsr_gid;
2454         __u32                   padding;
2455         struct llog_rec_tail    lsr_tail;
2456 } __attribute__((packed));
2457
2458 struct llog_setattr64_rec {
2459         struct llog_rec_hdr     lsr_hdr;
2460         obd_id                  lsr_oid;
2461         obd_count               lsr_oseq;
2462         __u32                   padding;
2463         __u32                   lsr_uid;
2464         __u32                   lsr_uid_h;
2465         __u32                   lsr_gid;
2466         __u32                   lsr_gid_h;
2467         struct llog_rec_tail    lsr_tail;
2468 } __attribute__((packed));
2469
2470 struct llog_size_change_rec {
2471         struct llog_rec_hdr     lsc_hdr;
2472         struct ll_fid           lsc_fid;
2473         __u32                   lsc_ioepoch;
2474         __u32                   padding;
2475         struct llog_rec_tail    lsc_tail;
2476 } __attribute__((packed));
2477
2478 #define CHANGELOG_MAGIC 0xca103000
2479
2480 /** \a changelog_rec_type's that can't be masked */
2481 #define CHANGELOG_MINMASK (1 << CL_MARK)
2482 /** bits covering all \a changelog_rec_type's */
2483 #define CHANGELOG_ALLMASK 0XFFFFFFFF
2484 /** default \a changelog_rec_type mask */
2485 #define CHANGELOG_DEFMASK CHANGELOG_ALLMASK & ~(1 << CL_ATIME)
2486
2487 /* changelog llog name, needed by client replicators */
2488 #define CHANGELOG_CATALOG "changelog_catalog"
2489
2490 struct changelog_setinfo {
2491         __u64 cs_recno;
2492         __u32 cs_id;
2493 } __attribute__((packed));
2494
2495 /** changelog record */
2496 struct llog_changelog_rec {
2497         struct llog_rec_hdr  cr_hdr;
2498         struct changelog_rec cr;
2499         struct llog_rec_tail cr_tail; /**< for_sizezof_only */
2500 } __attribute__((packed));
2501
2502 #define CHANGELOG_USER_PREFIX "cl"
2503
2504 struct llog_changelog_user_rec {
2505         struct llog_rec_hdr   cur_hdr;
2506         __u32                 cur_id;
2507         __u32                 cur_padding;
2508         __u64                 cur_endrec;
2509         struct llog_rec_tail  cur_tail;
2510 } __attribute__((packed));
2511
2512 struct llog_gen {
2513         __u64 mnt_cnt;
2514         __u64 conn_cnt;
2515 } __attribute__((packed));
2516
2517 struct llog_gen_rec {
2518         struct llog_rec_hdr     lgr_hdr;
2519         struct llog_gen         lgr_gen;
2520         struct llog_rec_tail    lgr_tail;
2521 };
2522 /* On-disk header structure of each log object, stored in little endian order */
2523 #define LLOG_CHUNK_SIZE         8192
2524 #define LLOG_HEADER_SIZE        (96)
2525 #define LLOG_BITMAP_BYTES       (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
2526
2527 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
2528
2529 /* flags for the logs */
2530 #define LLOG_F_ZAP_WHEN_EMPTY   0x1
2531 #define LLOG_F_IS_CAT           0x2
2532 #define LLOG_F_IS_PLAIN         0x4
2533
2534 struct llog_log_hdr {
2535         struct llog_rec_hdr     llh_hdr;
2536         obd_time                llh_timestamp;
2537         __u32                   llh_count;
2538         __u32                   llh_bitmap_offset;
2539         __u32                   llh_size;
2540         __u32                   llh_flags;
2541         __u32                   llh_cat_idx;
2542         /* for a catalog the first plain slot is next to it */
2543         struct obd_uuid         llh_tgtuuid;
2544         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
2545         __u32                   llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
2546         struct llog_rec_tail    llh_tail;
2547 } __attribute__((packed));
2548
2549 #define LLOG_BITMAP_SIZE(llh)  ((llh->llh_hdr.lrh_len -         \
2550                                  llh->llh_bitmap_offset -       \
2551                                  sizeof(llh->llh_tail)) * 8)
2552
2553 /** log cookies are used to reference a specific log file and a record therein */
2554 struct llog_cookie {
2555         struct llog_logid       lgc_lgl;
2556         __u32                   lgc_subsys;
2557         __u32                   lgc_index;
2558         __u32                   lgc_padding;
2559 } __attribute__((packed));
2560
2561 /** llog protocol */
2562 enum llogd_rpc_ops {
2563         LLOG_ORIGIN_HANDLE_CREATE       = 501,
2564         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
2565         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
2566         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
2567         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
2568         LLOG_ORIGIN_CONNECT             = 506,
2569         LLOG_CATINFO                    = 507,  /* for lfs catinfo */
2570         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
2571         LLOG_ORIGIN_HANDLE_DESTROY      = 509,  /* for destroy llog object*/
2572         LLOG_LAST_OPC,
2573         LLOG_FIRST_OPC                  = LLOG_ORIGIN_HANDLE_CREATE
2574 };
2575
2576 struct llogd_body {
2577         struct llog_logid  lgd_logid;
2578         __u32 lgd_ctxt_idx;
2579         __u32 lgd_llh_flags;
2580         __u32 lgd_index;
2581         __u32 lgd_saved_index;
2582         __u32 lgd_len;
2583         __u64 lgd_cur_offset;
2584 } __attribute__((packed));
2585
2586 struct llogd_conn_body {
2587         struct llog_gen         lgdc_gen;
2588         struct llog_logid       lgdc_logid;
2589         __u32                   lgdc_ctxt_idx;
2590 } __attribute__((packed));
2591
2592 /* Note: 64-bit types are 64-bit aligned in structure */
2593 struct obdo {
2594         obd_valid               o_valid;        /* hot fields in this obdo */
2595         struct ost_id           o_oi;
2596         obd_id                  o_parent_seq;
2597         obd_size                o_size;         /* o_size-o_blocks == ost_lvb */
2598         obd_time                o_mtime;
2599         obd_time                o_atime;
2600         obd_time                o_ctime;
2601         obd_blocks              o_blocks;       /* brw: cli sent cached bytes */
2602         obd_size                o_grant;
2603
2604         /* 32-bit fields start here: keep an even number of them via padding */
2605         obd_blksize             o_blksize;      /* optimal IO blocksize */
2606         obd_mode                o_mode;         /* brw: cli sent cache remain */
2607         obd_uid                 o_uid;
2608         obd_gid                 o_gid;
2609         obd_flag                o_flags;
2610         obd_count               o_nlink;        /* brw: checksum */
2611         obd_count               o_parent_oid;
2612         obd_count               o_misc;         /* brw: o_dropped */
2613         __u64                   o_ioepoch;      /* epoch in ost writes */
2614         __u32                   o_stripe_idx;   /* holds stripe idx */
2615         __u32                   o_parent_ver;
2616         struct lustre_handle    o_handle;       /* brw: lock handle to prolong locks */
2617         struct llog_cookie      o_lcookie;      /* destroy: unlink cookie from MDS */
2618
2619         __u32                   o_uid_h;
2620         __u32                   o_gid_h;
2621         __u64                   o_padding_3;
2622         __u64                   o_padding_4;
2623         __u64                   o_padding_5;
2624         __u64                   o_padding_6;
2625 };
2626
2627 #define o_id     o_oi.oi_id
2628 #define o_seq    o_oi.oi_seq
2629 #define o_dirty   o_blocks
2630 #define o_undirty o_mode
2631 #define o_dropped o_misc
2632 #define o_cksum   o_nlink
2633
2634 static inline void lustre_set_wire_obdo(struct obdo *wobdo, struct obdo *lobdo)
2635 {
2636         memcpy(wobdo, lobdo, sizeof(*lobdo));
2637         wobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
2638 }
2639
2640 static inline void lustre_get_wire_obdo(struct obdo *lobdo, struct obdo *wobdo)
2641 {
2642         obd_flag local_flags = lobdo->o_flags & OBD_FL_LOCAL_MASK;
2643
2644         LASSERT(!(wobdo->o_flags & OBD_FL_LOCAL_MASK));
2645
2646         memcpy(lobdo, wobdo, sizeof(*lobdo));
2647         lobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
2648         lobdo->o_flags |= local_flags;
2649 }
2650
2651 extern void lustre_swab_obdo (struct obdo *o);
2652
2653 /* request structure for OST's */
2654 struct ost_body {
2655         struct  obdo oa;
2656 };
2657
2658 /* Key for FIEMAP to be used in get_info calls */
2659 struct ll_fiemap_info_key {
2660         char    name[8];
2661         struct  obdo oa;
2662         struct  ll_user_fiemap fiemap;
2663 };
2664
2665 extern void lustre_swab_ost_body (struct ost_body *b);
2666 extern void lustre_swab_ost_last_id(obd_id *id);
2667 extern void lustre_swab_fiemap(struct ll_user_fiemap *fiemap);
2668
2669 extern void lustre_swab_lov_user_md_v1(struct lov_user_md_v1 *lum);
2670 extern void lustre_swab_lov_user_md_v3(struct lov_user_md_v3 *lum);
2671 extern void lustre_swab_lov_user_md_objects(struct lov_user_ost_data *lod,
2672                                             int stripe_count);
2673 extern void lustre_swab_lov_mds_md(struct lov_mds_md *lmm);
2674
2675 /* llog_swab.c */
2676 extern void lustre_swab_llogd_body (struct llogd_body *d);
2677 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
2678 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
2679 extern void lustre_swab_llog_rec(struct llog_rec_hdr  *rec,
2680                                  struct llog_rec_tail *tail);
2681
2682 struct lustre_cfg;
2683 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
2684
2685 /* Functions for dumping PTLRPC fields */
2686 void dump_rniobuf(struct niobuf_remote *rnb);
2687 void dump_ioo(struct obd_ioobj *nb);
2688 void dump_obdo(struct obdo *oa);
2689 void dump_ost_body(struct ost_body *ob);
2690 void dump_rcs(__u32 *rc);
2691
2692 /* this will be used when OBD_CONNECT_CHANGE_QS is set */
2693 struct qunit_data {
2694         /**
2695          * ID appiles to (uid, gid)
2696          */
2697         __u32 qd_id;
2698         /**
2699          * LQUOTA_FLAGS_* affect the responding bits
2700          */
2701         __u32 qd_flags;
2702         /**
2703          * acquire/release count (bytes for block quota)
2704          */
2705         __u64 qd_count;
2706         /**
2707          * when a master returns the reply to a slave, it will
2708          * contain the current corresponding qunit size
2709          */
2710         __u64 qd_qunit;
2711         __u64 padding;
2712 };
2713
2714 #define QDATA_IS_GRP(qdata)    ((qdata)->qd_flags & LQUOTA_FLAGS_GRP)
2715 #define QDATA_IS_BLK(qdata)    ((qdata)->qd_flags & LQUOTA_FLAGS_BLK)
2716 #define QDATA_IS_ADJBLK(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_ADJBLK)
2717 #define QDATA_IS_ADJINO(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_ADJINO)
2718 #define QDATA_IS_CHANGE_QS(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_CHG_QS)
2719
2720 #define QDATA_SET_GRP(qdata)    ((qdata)->qd_flags |= LQUOTA_FLAGS_GRP)
2721 #define QDATA_SET_BLK(qdata)    ((qdata)->qd_flags |= LQUOTA_FLAGS_BLK)
2722 #define QDATA_SET_ADJBLK(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_ADJBLK)
2723 #define QDATA_SET_ADJINO(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_ADJINO)
2724 #define QDATA_SET_CHANGE_QS(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_CHG_QS)
2725
2726 #define QDATA_CLR_GRP(qdata)        ((qdata)->qd_flags &= ~LQUOTA_FLAGS_GRP)
2727 #define QDATA_CLR_CHANGE_QS(qdata)  ((qdata)->qd_flags &= ~LQUOTA_FLAGS_CHG_QS)
2728
2729 extern void lustre_swab_qdata(struct qunit_data *d);
2730 extern struct qunit_data *quota_get_qdata(void *req, int is_req, int is_exp);
2731 extern int quota_copy_qdata(void *request, struct qunit_data *qdata,
2732                             int is_req, int is_exp);
2733
2734 typedef enum {
2735         QUOTA_DQACQ     = 601,
2736         QUOTA_DQREL     = 602,
2737         QUOTA_LAST_OPC
2738 } quota_cmd_t;
2739 #define QUOTA_FIRST_OPC QUOTA_DQACQ
2740
2741 #define QUOTA_REQUEST   1
2742 #define QUOTA_REPLY     0
2743 #define QUOTA_EXPORT    1
2744 #define QUOTA_IMPORT    0
2745
2746 /* quota check function */
2747 #define QUOTA_RET_OK           0 /**< return successfully */
2748 #define QUOTA_RET_NOQUOTA      1 /**< not support quota */
2749 #define QUOTA_RET_NOLIMIT      2 /**< quota limit isn't set */
2750 #define QUOTA_RET_ACQUOTA      4 /**< need to acquire extra quota */
2751
2752
2753 /* security opcodes */
2754 typedef enum {
2755         SEC_CTX_INIT            = 801,
2756         SEC_CTX_INIT_CONT       = 802,
2757         SEC_CTX_FINI            = 803,
2758         SEC_LAST_OPC,
2759         SEC_FIRST_OPC           = SEC_CTX_INIT
2760 } sec_cmd_t;
2761
2762 /*
2763  * capa related definitions
2764  */
2765 #define CAPA_HMAC_MAX_LEN       64
2766 #define CAPA_HMAC_KEY_MAX_LEN   56
2767
2768 /* NB take care when changing the sequence of elements this struct,
2769  * because the offset info is used in find_capa() */
2770 struct lustre_capa {
2771         struct lu_fid   lc_fid;         /** fid */
2772         __u64           lc_opc;         /** operations allowed */
2773         __u64           lc_uid;         /** file owner */
2774         __u64           lc_gid;         /** file group */
2775         __u32           lc_flags;       /** HMAC algorithm & flags */
2776         __u32           lc_keyid;       /** key# used for the capability */
2777         __u32           lc_timeout;     /** capa timeout value (sec) */
2778         __u32           lc_expiry;      /** expiry time (sec) */
2779         __u8            lc_hmac[CAPA_HMAC_MAX_LEN];   /** HMAC */
2780 } __attribute__((packed));
2781
2782 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
2783
2784 /** lustre_capa::lc_opc */
2785 enum {
2786         CAPA_OPC_BODY_WRITE   = 1<<0,  /**< write object data */
2787         CAPA_OPC_BODY_READ    = 1<<1,  /**< read object data */
2788         CAPA_OPC_INDEX_LOOKUP = 1<<2,  /**< lookup object fid */
2789         CAPA_OPC_INDEX_INSERT = 1<<3,  /**< insert object fid */
2790         CAPA_OPC_INDEX_DELETE = 1<<4,  /**< delete object fid */
2791         CAPA_OPC_OSS_WRITE    = 1<<5,  /**< write oss object data */
2792         CAPA_OPC_OSS_READ     = 1<<6,  /**< read oss object data */
2793         CAPA_OPC_OSS_TRUNC    = 1<<7,  /**< truncate oss object */
2794         CAPA_OPC_OSS_DESTROY  = 1<<8,  /**< destroy oss object */
2795         CAPA_OPC_META_WRITE   = 1<<9,  /**< write object meta data */
2796         CAPA_OPC_META_READ    = 1<<10, /**< read object meta data */
2797 };
2798
2799 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
2800 #define CAPA_OPC_MDS_ONLY                                                   \
2801         (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
2802          CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
2803 #define CAPA_OPC_OSS_ONLY                                                   \
2804         (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC |      \
2805          CAPA_OPC_OSS_DESTROY)
2806 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
2807 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
2808
2809 /* MDS capability covers object capability for operations of body r/w
2810  * (dir readpage/sendpage), index lookup/insert/delete and meta data r/w,
2811  * while OSS capability only covers object capability for operations of
2812  * oss data(file content) r/w/truncate.
2813  */
2814 static inline int capa_for_mds(struct lustre_capa *c)
2815 {
2816         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) != 0;
2817 }
2818
2819 static inline int capa_for_oss(struct lustre_capa *c)
2820 {
2821         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) == 0;
2822 }
2823
2824 /* lustre_capa::lc_hmac_alg */
2825 enum {
2826         CAPA_HMAC_ALG_SHA1 = 1, /**< sha1 algorithm */
2827         CAPA_HMAC_ALG_MAX,
2828 };
2829
2830 #define CAPA_FL_MASK            0x00ffffff
2831 #define CAPA_HMAC_ALG_MASK      0xff000000
2832
2833 struct lustre_capa_key {
2834         __u64   lk_seq;       /**< mds# */
2835         __u32   lk_keyid;     /**< key# */
2836         __u32   lk_padding;
2837         __u8    lk_key[CAPA_HMAC_KEY_MAX_LEN];    /**< key */
2838 } __attribute__((packed));
2839
2840 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
2841
2842 /** The link ea holds 1 \a link_ea_entry for each hardlink */
2843 #define LINK_EA_MAGIC 0x11EAF1DFUL
2844 struct link_ea_header {
2845         __u32 leh_magic;
2846         __u32 leh_reccount;
2847         __u64 leh_len;      /* total size */
2848         /* future use */
2849         __u32 padding1;
2850         __u32 padding2;
2851 };
2852
2853 /** Hardlink data is name and parent fid.
2854  * Stored in this crazy struct for maximum packing and endian-neutrality
2855  */
2856 struct link_ea_entry {
2857         /** __u16 stored big-endian, unaligned */
2858         unsigned char      lee_reclen[2];
2859         unsigned char      lee_parent_fid[sizeof(struct lu_fid)];
2860         char               lee_name[0];
2861 }__attribute__((packed));
2862
2863 /** fid2path request/reply structure */
2864 struct getinfo_fid2path {
2865         struct lu_fid   gf_fid;
2866         __u64           gf_recno;
2867         __u32           gf_linkno;
2868         __u32           gf_pathlen;
2869         char            gf_path[0];
2870 } __attribute__((packed));
2871
2872 void lustre_swab_fid2path (struct getinfo_fid2path *gf);
2873
2874
2875 #endif
2876 /** @} lustreidl */