4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/lustre/lustre_idl.h
38 * Lustre wire protocol definitions.
41 /** \defgroup lustreidl lustreidl
43 * Lustre wire protocol definitions.
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.
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.
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.
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.
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).
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).
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.
81 * A swabber takes a single pointer argument. The caller must already have
82 * verified that the length of the message buffer >= sizeof (type).
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.
91 #ifndef _LUSTRE_IDL_H_
92 #define _LUSTRE_IDL_H_
94 #if !defined(LASSERT) && !defined(LPU64)
95 #include <libcfs/libcfs.h> /* for LASSERT, LPUX64, etc */
98 /* Defn's shared with user-space. */
99 #include <lustre/lustre_user.h>
104 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
105 * FOO_REPLY_PORTAL is for incoming replies on the FOO
106 * FOO_BULK_PORTAL is for incoming bulk on the FOO
109 #define CONNMGR_REQUEST_PORTAL 1
110 #define CONNMGR_REPLY_PORTAL 2
111 //#define OSC_REQUEST_PORTAL 3
112 #define OSC_REPLY_PORTAL 4
113 //#define OSC_BULK_PORTAL 5
114 #define OST_IO_PORTAL 6
115 #define OST_CREATE_PORTAL 7
116 #define OST_BULK_PORTAL 8
117 //#define MDC_REQUEST_PORTAL 9
118 #define MDC_REPLY_PORTAL 10
119 //#define MDC_BULK_PORTAL 11
120 #define MDS_REQUEST_PORTAL 12
121 //#define MDS_REPLY_PORTAL 13
122 #define MDS_BULK_PORTAL 14
123 #define LDLM_CB_REQUEST_PORTAL 15
124 #define LDLM_CB_REPLY_PORTAL 16
125 #define LDLM_CANCEL_REQUEST_PORTAL 17
126 #define LDLM_CANCEL_REPLY_PORTAL 18
127 //#define PTLBD_REQUEST_PORTAL 19
128 //#define PTLBD_REPLY_PORTAL 20
129 //#define PTLBD_BULK_PORTAL 21
130 #define MDS_SETATTR_PORTAL 22
131 #define MDS_READPAGE_PORTAL 23
132 #define MDS_MDS_PORTAL 24
134 #define MGC_REPLY_PORTAL 25
135 #define MGS_REQUEST_PORTAL 26
136 #define MGS_REPLY_PORTAL 27
137 #define OST_REQUEST_PORTAL 28
138 #define FLD_REQUEST_PORTAL 29
139 #define SEQ_METADATA_PORTAL 30
140 #define SEQ_DATA_PORTAL 31
141 #define SEQ_CONTROLLER_PORTAL 32
142 #define MGS_BULK_PORTAL 33
144 /* Portal 63 is reserved for the Cray Inc DVS - nic@cray.com, roe@cray.com, n8851@cray.com */
147 #define PTL_RPC_MSG_REQUEST 4711
148 #define PTL_RPC_MSG_ERR 4712
149 #define PTL_RPC_MSG_REPLY 4713
151 /* DON'T use swabbed values of MAGIC as magic! */
152 #define LUSTRE_MSG_MAGIC_V1 0x0BD00BD0
153 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
155 #define LUSTRE_MSG_MAGIC_V1_SWABBED 0xD00BD00B
156 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
158 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
160 #define PTLRPC_MSG_VERSION 0x00000003
161 #define LUSTRE_VERSION_MASK 0xffff0000
162 #define LUSTRE_OBD_VERSION 0x00010000
163 #define LUSTRE_MDS_VERSION 0x00020000
164 #define LUSTRE_OST_VERSION 0x00030000
165 #define LUSTRE_DLM_VERSION 0x00040000
166 #define LUSTRE_LOG_VERSION 0x00050000
167 #define LUSTRE_MGS_VERSION 0x00060000
169 typedef __u32 mdsno_t;
170 typedef __u64 seqno_t;
171 typedef __u64 obd_id;
172 typedef __u64 obd_seq;
173 typedef __s64 obd_time;
174 typedef __u64 obd_size;
175 typedef __u64 obd_off;
176 typedef __u64 obd_blocks;
177 typedef __u64 obd_valid;
178 typedef __u32 obd_blksize;
179 typedef __u32 obd_mode;
180 typedef __u32 obd_uid;
181 typedef __u32 obd_gid;
182 typedef __u32 obd_flag;
183 typedef __u32 obd_count;
186 * Describes a range of sequence, lsr_start is included but lsr_end is
188 * Same structure is used in fld module where lsr_index field holds mdt id
191 struct lu_seq_range {
198 #define LU_SEQ_RANGE_MDT 0x0
199 #define LU_SEQ_RANGE_OST 0x1
200 #define LU_SEQ_RANGE_ANY 0x3
202 #define LU_SEQ_RANGE_MASK 0x3
204 static inline unsigned fld_range_type(const struct lu_seq_range *range)
206 return range->lsr_flags & LU_SEQ_RANGE_MASK;
209 static inline int fld_range_is_ost(const struct lu_seq_range *range)
211 return fld_range_type(range) == LU_SEQ_RANGE_OST;
214 static inline int fld_range_is_mdt(const struct lu_seq_range *range)
216 return fld_range_type(range) == LU_SEQ_RANGE_MDT;
220 * This all range is only being used when fld client sends fld query request,
221 * but it does not know whether the seq is MDT or OST, so it will send req
222 * with ALL type, which means either seq type gotten from lookup can be
225 static inline unsigned fld_range_is_any(const struct lu_seq_range *range)
227 return fld_range_type(range) == LU_SEQ_RANGE_ANY;
230 static inline void fld_range_set_type(struct lu_seq_range *range,
233 LASSERT(!(flags & ~LU_SEQ_RANGE_MASK));
234 range->lsr_flags |= flags;
237 static inline void fld_range_set_mdt(struct lu_seq_range *range)
239 fld_range_set_type(range, LU_SEQ_RANGE_MDT);
242 static inline void fld_range_set_ost(struct lu_seq_range *range)
244 fld_range_set_type(range, LU_SEQ_RANGE_OST);
247 static inline void fld_range_set_any(struct lu_seq_range *range)
249 fld_range_set_type(range, LU_SEQ_RANGE_ANY);
253 * returns width of given range \a r
256 static inline __u64 range_space(const struct lu_seq_range *range)
258 return range->lsr_end - range->lsr_start;
262 * initialize range to zero
265 static inline void range_init(struct lu_seq_range *range)
267 range->lsr_start = range->lsr_end = range->lsr_index = 0;
271 * check if given seq id \a s is within given range \a r
274 static inline int range_within(const struct lu_seq_range *range,
277 return s >= range->lsr_start && s < range->lsr_end;
280 static inline int range_is_sane(const struct lu_seq_range *range)
282 return (range->lsr_end >= range->lsr_start);
285 static inline int range_is_zero(const struct lu_seq_range *range)
287 return (range->lsr_start == 0 && range->lsr_end == 0);
290 static inline int range_is_exhausted(const struct lu_seq_range *range)
293 return range_space(range) == 0;
296 /* return 0 if two range have the same location */
297 static inline int range_compare_loc(const struct lu_seq_range *r1,
298 const struct lu_seq_range *r2)
300 return r1->lsr_index != r2->lsr_index ||
301 r1->lsr_flags != r2->lsr_flags;
304 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x):%x:%s"
306 #define PRANGE(range) \
307 (range)->lsr_start, \
309 (range)->lsr_index, \
310 fld_range_is_mdt(range) ? "mdt" : "ost"
313 /** \defgroup lu_fid lu_fid
317 * Flags for lustre_mdt_attrs::lma_compat and lustre_mdt_attrs::lma_incompat.
318 * Deprecated since HSM and SOM attributes are now stored in separate on-disk
322 LMAC_HSM = 0x00000001,
323 LMAC_SOM = 0x00000002,
327 * Masks for all features that should be supported by a Lustre version to
328 * access a specific file.
329 * This information is stored in lustre_mdt_attrs::lma_incompat.
332 LMAI_RELEASED = 0x0000001, /* file is released */
333 LMAI_AGENT = 0x00000002, /* agent inode */
334 LMAI_REMOTE_PARENT = 0x00000004, /* the parent of the object
335 is on the remote MDT */
337 #define LMA_INCOMPAT_SUPP (LMAI_AGENT | LMAI_REMOTE_PARENT)
339 extern void lustre_lma_swab(struct lustre_mdt_attrs *lma);
340 extern void lustre_lma_init(struct lustre_mdt_attrs *lma,
341 const struct lu_fid *fid, __u32 incompat);
343 * SOM on-disk attributes stored in a separate xattr.
346 /** Bitfield for supported data in this structure. For future use. */
349 /** Incompat feature list. The supported feature mask is availabe in
350 * SOM_INCOMPAT_SUPP */
353 /** IO Epoch SOM attributes belongs to */
355 /** total file size in objects */
357 /** total fs blocks in objects */
359 /** mds mount id the size is valid for */
362 extern void lustre_som_swab(struct som_attrs *attrs);
364 #define SOM_INCOMPAT_SUPP 0x0
367 * HSM on-disk attributes stored in a separate xattr.
370 /** Bitfield for supported data in this structure. For future use. */
373 /** HSM flags, see hsm_flags enum below */
375 /** backend archive id associated with the file */
377 /** version associated with the last archiving, if any */
380 extern void lustre_hsm_swab(struct hsm_attrs *attrs);
386 /** initial fid id value */
387 LUSTRE_FID_INIT_OID = 1UL
390 /** returns fid object sequence */
391 static inline __u64 fid_seq(const struct lu_fid *fid)
396 /** returns fid object id */
397 static inline __u32 fid_oid(const struct lu_fid *fid)
402 /** returns fid object version */
403 static inline __u32 fid_ver(const struct lu_fid *fid)
408 static inline void fid_zero(struct lu_fid *fid)
410 memset(fid, 0, sizeof(*fid));
413 static inline obd_id fid_ver_oid(const struct lu_fid *fid)
415 return ((__u64)fid_ver(fid) << 32 | fid_oid(fid));
419 * Note that reserved SEQ numbers below 12 will conflict with ldiskfs
420 * inodes in the IGIF namespace, so these reserved SEQ numbers can be
421 * used for other purposes and not risk collisions with existing inodes.
423 * Different FID Format
424 * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs#NEW.0
427 FID_SEQ_OST_MDT0 = 0,
428 FID_SEQ_LLOG = 1, /* unnamed llogs */
430 FID_SEQ_OST_MDT1 = 3,
431 FID_SEQ_OST_MAX = 9, /* Max MDT count before OST_on_FID */
432 FID_SEQ_LLOG_NAME = 10, /* named llogs */
435 FID_SEQ_IGIF_MAX = 0x0ffffffffULL,
436 FID_SEQ_IDIF = 0x100000000ULL,
437 FID_SEQ_IDIF_MAX = 0x1ffffffffULL,
438 /* Normal FID sequence starts from this value, i.e. 1<<33 */
439 FID_SEQ_START = 0x200000000ULL,
440 /* sequence for local pre-defined FIDs listed in local_oid */
441 FID_SEQ_LOCAL_FILE = 0x200000001ULL,
442 FID_SEQ_DOT_LUSTRE = 0x200000002ULL,
443 /* sequence is used for local named objects FIDs generated
444 * by local_object_storage library */
445 FID_SEQ_LOCAL_NAME = 0x200000003ULL,
446 /* Because current FLD will only cache the fid sequence, instead
447 * of oid on the client side, if the FID needs to be exposed to
448 * clients sides, it needs to make sure all of fids under one
449 * sequence will be located in one MDT. */
450 FID_SEQ_SPECIAL = 0x200000004ULL,
451 FID_SEQ_QUOTA = 0x200000005ULL,
452 FID_SEQ_QUOTA_GLB = 0x200000006ULL,
453 FID_SEQ_ROOT = 0x200000007ULL, /* Located on MDT0 */
454 FID_SEQ_NORMAL = 0x200000400ULL,
455 FID_SEQ_LOV_DEFAULT = 0xffffffffffffffffULL
458 #define OBIF_OID_MAX_BITS 32
459 #define OBIF_MAX_OID (1ULL << OBIF_OID_MAX_BITS)
460 #define OBIF_OID_MASK ((1ULL << OBIF_OID_MAX_BITS) - 1)
461 #define IDIF_OID_MAX_BITS 48
462 #define IDIF_MAX_OID (1ULL << IDIF_OID_MAX_BITS)
463 #define IDIF_OID_MASK ((1ULL << IDIF_OID_MAX_BITS) - 1)
465 /** OID for FID_SEQ_SPECIAL */
467 /* Big Filesystem Lock to serialize rename operations */
468 FID_OID_SPECIAL_BFL = 1UL,
471 /** OID for FID_SEQ_DOT_LUSTRE */
472 enum dot_lustre_oid {
473 FID_OID_DOT_LUSTRE = 1UL,
474 FID_OID_DOT_LUSTRE_OBF = 2UL,
477 static inline int fid_seq_is_mdt0(obd_seq seq)
479 return (seq == FID_SEQ_OST_MDT0);
482 static inline int fid_seq_is_mdt(const __u64 seq)
484 return seq == FID_SEQ_OST_MDT0 || seq >= FID_SEQ_NORMAL;
487 static inline int fid_seq_is_echo(obd_seq seq)
489 return (seq == FID_SEQ_ECHO);
492 static inline int fid_is_echo(const struct lu_fid *fid)
494 return fid_seq_is_echo(fid_seq(fid));
497 static inline int fid_seq_is_llog(obd_seq seq)
499 return (seq == FID_SEQ_LLOG);
502 static inline int fid_is_llog(const struct lu_fid *fid)
504 /* file with OID == 1 is not llog but contains last oid */
505 return fid_seq_is_llog(fid_seq(fid)) && fid_oid(fid) > 1;
508 static inline int fid_seq_is_rsvd(const __u64 seq)
510 return (seq > FID_SEQ_OST_MDT0 && seq <= FID_SEQ_RSVD);
513 static inline int fid_seq_is_special(const __u64 seq)
515 return seq == FID_SEQ_SPECIAL;
518 static inline int fid_seq_is_local_file(const __u64 seq)
520 return seq == FID_SEQ_LOCAL_FILE ||
521 seq == FID_SEQ_LOCAL_NAME;
524 static inline int fid_seq_is_root(const __u64 seq)
526 return seq == FID_SEQ_ROOT;
529 static inline int fid_seq_is_dot(const __u64 seq)
531 return seq == FID_SEQ_DOT_LUSTRE;
534 static inline int fid_seq_is_default(const __u64 seq)
536 return seq == FID_SEQ_LOV_DEFAULT;
539 static inline int fid_is_mdt0(const struct lu_fid *fid)
541 return fid_seq_is_mdt0(fid_seq(fid));
544 static inline void lu_root_fid(struct lu_fid *fid)
546 fid->f_seq = FID_SEQ_ROOT;
552 * Check if a fid is igif or not.
553 * \param fid the fid to be tested.
554 * \return true if the fid is a igif; otherwise false.
556 static inline int fid_seq_is_igif(const __u64 seq)
558 return seq >= FID_SEQ_IGIF && seq <= FID_SEQ_IGIF_MAX;
561 static inline int fid_is_igif(const struct lu_fid *fid)
563 return fid_seq_is_igif(fid_seq(fid));
567 * Check if a fid is idif or not.
568 * \param fid the fid to be tested.
569 * \return true if the fid is a idif; otherwise false.
571 static inline int fid_seq_is_idif(const __u64 seq)
573 return seq >= FID_SEQ_IDIF && seq <= FID_SEQ_IDIF_MAX;
576 static inline int fid_is_idif(const struct lu_fid *fid)
578 return fid_seq_is_idif(fid_seq(fid));
581 static inline int fid_is_local_file(const struct lu_fid *fid)
583 return fid_seq_is_local_file(fid_seq(fid));
586 static inline int fid_seq_is_norm(const __u64 seq)
588 return (seq >= FID_SEQ_NORMAL);
591 static inline int fid_is_norm(const struct lu_fid *fid)
593 return fid_seq_is_norm(fid_seq(fid));
596 /* convert an OST objid into an IDIF FID SEQ number */
597 static inline obd_seq fid_idif_seq(obd_id id, __u32 ost_idx)
599 return FID_SEQ_IDIF | (ost_idx << 16) | ((id >> 32) & 0xffff);
602 /* convert a packed IDIF FID into an OST objid */
603 static inline obd_id fid_idif_id(obd_seq seq, __u32 oid, __u32 ver)
605 return ((__u64)ver << 48) | ((seq & 0xffff) << 32) | oid;
608 /* extract ost index from IDIF FID */
609 static inline __u32 fid_idif_ost_idx(const struct lu_fid *fid)
611 LASSERT(fid_is_idif(fid));
612 return (fid_seq(fid) >> 16) & 0xffff;
615 /* extract OST sequence (group) from a wire ost_id (id/seq) pair */
616 static inline obd_seq ostid_seq(const struct ost_id *ostid)
618 if (fid_seq_is_mdt0(ostid->oi.oi_seq))
619 return FID_SEQ_OST_MDT0;
621 if (fid_seq_is_default(ostid->oi.oi_seq))
622 return FID_SEQ_LOV_DEFAULT;
624 if (fid_is_idif(&ostid->oi_fid))
625 return FID_SEQ_OST_MDT0;
627 return fid_seq(&ostid->oi_fid);
630 /* extract OST objid from a wire ost_id (id/seq) pair */
631 static inline obd_id ostid_id(const struct ost_id *ostid)
633 if (fid_seq_is_mdt0(ostid_seq(ostid)))
634 return ostid->oi.oi_id & IDIF_OID_MASK;
636 if (fid_is_idif(&ostid->oi_fid))
637 return fid_idif_id(fid_seq(&ostid->oi_fid),
638 fid_oid(&ostid->oi_fid), 0);
640 return fid_oid(&ostid->oi_fid);
643 static inline void ostid_set_seq(struct ost_id *oi, __u64 seq)
645 if (fid_seq_is_mdt0(seq) || fid_seq_is_default(seq)) {
648 oi->oi_fid.f_seq = seq;
649 /* Note: if f_oid + f_ver is zero, we need init it
650 * to be 1, otherwise, ostid_seq will treat this
651 * as old ostid (oi_seq == 0) */
652 if (oi->oi_fid.f_oid == 0 && oi->oi_fid.f_ver == 0)
653 oi->oi_fid.f_oid = LUSTRE_FID_INIT_OID;
657 static inline void ostid_set_seq_mdt0(struct ost_id *oi)
659 ostid_set_seq(oi, FID_SEQ_OST_MDT0);
662 static inline void ostid_set_seq_echo(struct ost_id *oi)
664 ostid_set_seq(oi, FID_SEQ_ECHO);
667 static inline void ostid_set_seq_llog(struct ost_id *oi)
669 ostid_set_seq(oi, FID_SEQ_LLOG);
673 * Note: we need check oi_seq to decide where to set oi_id,
674 * so oi_seq should always be set ahead of oi_id.
676 static inline void ostid_set_id(struct ost_id *oi, __u64 oid)
678 if (fid_seq_is_mdt0(ostid_seq(oi))) {
679 if (oid >= IDIF_MAX_OID) {
680 CERROR("Bad "LPU64" to set "DOSTID"\n",
686 if (oid > OBIF_MAX_OID) {
687 CERROR("Bad "LPU64" to set "DOSTID"\n",
691 oi->oi_fid.f_oid = oid;
695 static inline void ostid_inc_id(struct ost_id *oi)
697 if (fid_seq_is_mdt0(ostid_seq(oi))) {
698 if (unlikely(ostid_id(oi) + 1 > IDIF_MAX_OID)) {
699 CERROR("Bad inc "DOSTID"\n", POSTID(oi));
708 static inline void ostid_dec_id(struct ost_id *oi)
710 if (fid_seq_is_mdt0(ostid_seq(oi)))
717 * Unpack an OST object id/seq (group) into a FID. This is needed for
718 * converting all obdo, lmm, lsm, etc. 64-bit id/seq pairs into proper
719 * FIDs. Note that if an id/seq is already in FID/IDIF format it will
720 * be passed through unchanged. Only legacy OST objects in "group 0"
721 * will be mapped into the IDIF namespace so that they can fit into the
722 * struct lu_fid fields without loss. For reference see:
723 * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs
725 static inline int ostid_to_fid(struct lu_fid *fid, struct ost_id *ostid,
728 if (ost_idx > 0xffff) {
729 CERROR("bad ost_idx, "DOSTID" ost_idx:%u\n", POSTID(ostid),
734 if (fid_seq_is_mdt0(ostid_seq(ostid))) {
735 /* This is a "legacy" (old 1.x/2.early) OST object in "group 0"
736 * that we map into the IDIF namespace. It allows up to 2^48
737 * objects per OST, as this is the object namespace that has
738 * been in production for years. This can handle create rates
739 * of 1M objects/s/OST for 9 years, or combinations thereof. */
740 if (ostid_id(ostid) >= IDIF_MAX_OID) {
741 CERROR("bad MDT0 id, "DOSTID" ost_idx:%u\n",
742 POSTID(ostid), ost_idx);
745 fid->f_seq = fid_idif_seq(ostid_id(ostid), ost_idx);
746 /* truncate to 32 bits by assignment */
747 fid->f_oid = ostid_id(ostid);
748 /* in theory, not currently used */
749 fid->f_ver = ostid_id(ostid) >> 48;
750 } else /* if (fid_seq_is_idif(seq) || fid_seq_is_norm(seq)) */ {
751 /* This is either an IDIF object, which identifies objects across
752 * all OSTs, or a regular FID. The IDIF namespace maps legacy
753 * OST objects into the FID namespace. In both cases, we just
754 * pass the FID through, no conversion needed. */
755 if (ostid->oi_fid.f_ver != 0) {
756 CERROR("bad MDT0 id, "DOSTID" ost_idx:%u\n",
757 POSTID(ostid), ost_idx);
760 *fid = ostid->oi_fid;
766 /* pack any OST FID into an ostid (id/seq) for the wire/disk */
767 static inline int fid_to_ostid(const struct lu_fid *fid, struct ost_id *ostid)
769 if (unlikely(fid_seq_is_igif(fid->f_seq))) {
770 CERROR("bad IGIF, "DFID"\n", PFID(fid));
774 if (fid_is_idif(fid)) {
775 ostid_set_seq_mdt0(ostid);
776 ostid_set_id(ostid, fid_idif_id(fid_seq(fid), fid_oid(fid),
779 ostid->oi_fid = *fid;
785 /* Check whether the fid is for LAST_ID */
786 static inline int fid_is_last_id(const struct lu_fid *fid)
788 return (fid_is_idif(fid) || fid_is_norm(fid) || fid_is_echo(fid)) &&
793 * Get inode number from a igif.
794 * \param fid a igif to get inode number from.
795 * \return inode number for the igif.
797 static inline ino_t lu_igif_ino(const struct lu_fid *fid)
802 extern void lustre_swab_ost_id(struct ost_id *oid);
805 * Get inode generation from a igif.
806 * \param fid a igif to get inode generation from.
807 * \return inode generation for the igif.
809 static inline __u32 lu_igif_gen(const struct lu_fid *fid)
815 * Build igif from the inode number/generation.
817 static inline void lu_igif_build(struct lu_fid *fid, __u32 ino, __u32 gen)
825 * Fids are transmitted across network (in the sender byte-ordering),
826 * and stored on disk in big-endian order.
828 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
830 /* check that all fields are converted */
831 CLASSERT(sizeof *src ==
832 sizeof fid_seq(src) +
833 sizeof fid_oid(src) + sizeof fid_ver(src));
834 dst->f_seq = cpu_to_le64(fid_seq(src));
835 dst->f_oid = cpu_to_le32(fid_oid(src));
836 dst->f_ver = cpu_to_le32(fid_ver(src));
839 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
841 /* check that all fields are converted */
842 CLASSERT(sizeof *src ==
843 sizeof fid_seq(src) +
844 sizeof fid_oid(src) + sizeof fid_ver(src));
845 dst->f_seq = le64_to_cpu(fid_seq(src));
846 dst->f_oid = le32_to_cpu(fid_oid(src));
847 dst->f_ver = le32_to_cpu(fid_ver(src));
850 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
852 /* check that all fields are converted */
853 CLASSERT(sizeof *src ==
854 sizeof fid_seq(src) +
855 sizeof fid_oid(src) + sizeof fid_ver(src));
856 dst->f_seq = cpu_to_be64(fid_seq(src));
857 dst->f_oid = cpu_to_be32(fid_oid(src));
858 dst->f_ver = cpu_to_be32(fid_ver(src));
861 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
863 /* check that all fields are converted */
864 CLASSERT(sizeof *src ==
865 sizeof fid_seq(src) +
866 sizeof fid_oid(src) + sizeof fid_ver(src));
867 dst->f_seq = be64_to_cpu(fid_seq(src));
868 dst->f_oid = be32_to_cpu(fid_oid(src));
869 dst->f_ver = be32_to_cpu(fid_ver(src));
872 static inline int fid_is_sane(const struct lu_fid *fid)
874 return fid != NULL &&
875 ((fid_seq(fid) >= FID_SEQ_START && fid_ver(fid) == 0) ||
876 fid_is_igif(fid) || fid_is_idif(fid) ||
877 fid_seq_is_rsvd(fid_seq(fid)));
880 static inline int fid_is_zero(const struct lu_fid *fid)
882 return fid_seq(fid) == 0 && fid_oid(fid) == 0;
885 extern void lustre_swab_lu_fid(struct lu_fid *fid);
886 extern void lustre_swab_lu_seq_range(struct lu_seq_range *range);
888 static inline int lu_fid_eq(const struct lu_fid *f0, const struct lu_fid *f1)
890 /* Check that there is no alignment padding. */
891 CLASSERT(sizeof *f0 ==
892 sizeof f0->f_seq + sizeof f0->f_oid + sizeof f0->f_ver);
893 return memcmp(f0, f1, sizeof *f0) == 0;
896 #define __diff_normalize(val0, val1) \
898 typeof(val0) __val0 = (val0); \
899 typeof(val1) __val1 = (val1); \
901 (__val0 == __val1 ? 0 : __val0 > __val1 ? +1 : -1); \
904 static inline int lu_fid_cmp(const struct lu_fid *f0,
905 const struct lu_fid *f1)
908 __diff_normalize(fid_seq(f0), fid_seq(f1)) ?:
909 __diff_normalize(fid_oid(f0), fid_oid(f1)) ?:
910 __diff_normalize(fid_ver(f0), fid_ver(f1));
913 static inline void ostid_cpu_to_le(struct ost_id *src_oi,
914 struct ost_id *dst_oi)
916 if (fid_seq_is_mdt0(ostid_seq(src_oi))) {
917 dst_oi->oi.oi_id = cpu_to_le64(src_oi->oi.oi_id);
918 dst_oi->oi.oi_seq = cpu_to_le64(src_oi->oi.oi_seq);
920 fid_cpu_to_le(&dst_oi->oi_fid, &src_oi->oi_fid);
924 static inline void ostid_le_to_cpu(struct ost_id *src_oi,
925 struct ost_id *dst_oi)
927 if (fid_seq_is_mdt0(ostid_seq(src_oi))) {
928 dst_oi->oi.oi_id = le64_to_cpu(src_oi->oi.oi_id);
929 dst_oi->oi.oi_seq = le64_to_cpu(src_oi->oi.oi_seq);
931 fid_le_to_cpu(&dst_oi->oi_fid, &src_oi->oi_fid);
937 /** \defgroup lu_dir lu_dir
941 * Enumeration of possible directory entry attributes.
943 * Attributes follow directory entry header in the order they appear in this
946 enum lu_dirent_attrs {
949 LUDA_64BITHASH = 0x0004,
951 /* The following attrs are used for MDT interanl only,
952 * not visible to client */
954 /* Verify the dirent consistency */
955 LUDA_VERIFY = 0x8000,
956 /* Only check but not repair the dirent inconsistency */
957 LUDA_VERIFY_DRYRUN = 0x4000,
958 /* The dirent has been repaired, or to be repaired (dryrun). */
959 LUDA_REPAIR = 0x2000,
960 /* The system is upgraded, has beed or to be repaired (dryrun). */
961 LUDA_UPGRADE = 0x1000,
962 /* Ignore this record, go to next directly. */
963 LUDA_IGNORE = 0x0800,
966 #define LU_DIRENT_ATTRS_MASK 0xf800
969 * Layout of readdir pages, as transmitted on wire.
972 /** valid if LUDA_FID is set. */
973 struct lu_fid lde_fid;
974 /** a unique entry identifier: a hash or an offset. */
976 /** total record length, including all attributes. */
980 /** optional variable size attributes following this entry.
981 * taken from enum lu_dirent_attrs.
984 /** name is followed by the attributes indicated in ->ldp_attrs, in
985 * their natural order. After the last attribute, padding bytes are
986 * added to make ->lde_reclen a multiple of 8.
992 * Definitions of optional directory entry attributes formats.
994 * Individual attributes do not have their length encoded in a generic way. It
995 * is assumed that consumer of an attribute knows its format. This means that
996 * it is impossible to skip over an unknown attribute, except by skipping over all
997 * remaining attributes (by using ->lde_reclen), which is not too
998 * constraining, because new server versions will append new attributes at
999 * the end of an entry.
1003 * Fid directory attribute: a fid of an object referenced by the entry. This
1004 * will be almost always requested by the client and supplied by the server.
1006 * Aligned to 8 bytes.
1008 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
1013 * Aligned to 2 bytes.
1020 __u64 ldp_hash_start;
1024 struct lu_dirent ldp_entries[0];
1027 enum lu_dirpage_flags {
1029 * dirpage contains no entry.
1033 * last entry's lde_hash equals ldp_hash_end.
1035 LDF_COLLIDE = 1 << 1
1038 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
1040 if (le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
1043 return dp->ldp_entries;
1046 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
1048 struct lu_dirent *next;
1050 if (le16_to_cpu(ent->lde_reclen) != 0)
1051 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
1058 static inline int lu_dirent_calc_size(int namelen, __u16 attr)
1062 if (attr & LUDA_TYPE) {
1063 const unsigned align = sizeof(struct luda_type) - 1;
1064 size = (sizeof(struct lu_dirent) + namelen + align) & ~align;
1065 size += sizeof(struct luda_type);
1067 size = sizeof(struct lu_dirent) + namelen;
1069 return (size + 7) & ~7;
1072 static inline int lu_dirent_size(struct lu_dirent *ent)
1074 if (le16_to_cpu(ent->lde_reclen) == 0) {
1075 return lu_dirent_calc_size(le16_to_cpu(ent->lde_namelen),
1076 le32_to_cpu(ent->lde_attrs));
1078 return le16_to_cpu(ent->lde_reclen);
1081 #define MDS_DIR_END_OFF 0xfffffffffffffffeULL
1084 * MDS_READPAGE page size
1086 * This is the directory page size packed in MDS_READPAGE RPC.
1087 * It's different than CFS_PAGE_SIZE because the client needs to
1088 * access the struct lu_dirpage header packed at the beginning of
1089 * the "page" and without this there isn't any way to know find the
1090 * lu_dirpage header is if client and server CFS_PAGE_SIZE differ.
1092 #define LU_PAGE_SHIFT 12
1093 #define LU_PAGE_SIZE (1UL << LU_PAGE_SHIFT)
1094 #define LU_PAGE_MASK (~(LU_PAGE_SIZE - 1))
1096 #define LU_PAGE_COUNT (1 << (CFS_PAGE_SHIFT - LU_PAGE_SHIFT))
1100 struct lustre_handle {
1103 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
1105 static inline int lustre_handle_is_used(struct lustre_handle *lh)
1107 return lh->cookie != 0ull;
1110 static inline int lustre_handle_equal(const struct lustre_handle *lh1,
1111 const struct lustre_handle *lh2)
1113 return lh1->cookie == lh2->cookie;
1116 static inline void lustre_handle_copy(struct lustre_handle *tgt,
1117 struct lustre_handle *src)
1119 tgt->cookie = src->cookie;
1122 /* flags for lm_flags */
1123 #define MSGHDR_AT_SUPPORT 0x1
1124 #define MSGHDR_CKSUM_INCOMPAT18 0x2
1126 #define lustre_msg lustre_msg_v2
1127 /* we depend on this structure to be 8-byte aligned */
1128 /* this type is only endian-adjusted in lustre_unpack_msg() */
1129 struct lustre_msg_v2 {
1138 __u32 lm_buflens[0];
1141 /* without gss, ptlrpc_body is put at the first buffer. */
1142 #define PTLRPC_NUM_VERSIONS 4
1143 #define JOBSTATS_JOBID_SIZE 32 /* 32 bytes string */
1144 struct ptlrpc_body_v3 {
1145 struct lustre_handle pb_handle;
1152 __u64 pb_last_committed;
1157 __u32 pb_timeout; /* for req, the deadline, for rep, the service est */
1158 __u32 pb_service_time; /* for rep, actual service time */
1161 /* VBR: pre-versions */
1162 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1163 /* padding for future needs */
1164 __u64 pb_padding[4];
1165 char pb_jobid[JOBSTATS_JOBID_SIZE];
1167 #define ptlrpc_body ptlrpc_body_v3
1169 struct ptlrpc_body_v2 {
1170 struct lustre_handle pb_handle;
1177 __u64 pb_last_committed;
1182 __u32 pb_timeout; /* for req, the deadline, for rep, the service est */
1183 __u32 pb_service_time; /* for rep, actual service time, also used for
1184 net_latency of req */
1187 /* VBR: pre-versions */
1188 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1189 /* padding for future needs */
1190 __u64 pb_padding[4];
1193 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
1195 /* message body offset for lustre_msg_v2 */
1196 /* ptlrpc body offset in all request/reply messages */
1197 #define MSG_PTLRPC_BODY_OFF 0
1199 /* normal request/reply message record offset */
1200 #define REQ_REC_OFF 1
1201 #define REPLY_REC_OFF 1
1203 /* ldlm request message body offset */
1204 #define DLM_LOCKREQ_OFF 1 /* lockreq offset */
1205 #define DLM_REQ_REC_OFF 2 /* normal dlm request record offset */
1207 /* ldlm intent lock message body offset */
1208 #define DLM_INTENT_IT_OFF 2 /* intent lock it offset */
1209 #define DLM_INTENT_REC_OFF 3 /* intent lock record offset */
1211 /* ldlm reply message body offset */
1212 #define DLM_LOCKREPLY_OFF 1 /* lockrep offset */
1213 #define DLM_REPLY_REC_OFF 2 /* reply record offset */
1215 /** only use in req->rq_{req,rep}_swab_mask */
1216 #define MSG_PTLRPC_HEADER_OFF 31
1218 /* Flags that are operation-specific go in the top 16 bits. */
1219 #define MSG_OP_FLAG_MASK 0xffff0000
1220 #define MSG_OP_FLAG_SHIFT 16
1222 /* Flags that apply to all requests are in the bottom 16 bits */
1223 #define MSG_GEN_FLAG_MASK 0x0000ffff
1224 #define MSG_LAST_REPLAY 0x0001
1225 #define MSG_RESENT 0x0002
1226 #define MSG_REPLAY 0x0004
1227 /* #define MSG_AT_SUPPORT 0x0008
1228 * This was used in early prototypes of adaptive timeouts, and while there
1229 * shouldn't be any users of that code there also isn't a need for using this
1230 * bits. Defer usage until at least 1.10 to avoid potential conflict. */
1231 #define MSG_DELAY_REPLAY 0x0010
1232 #define MSG_VERSION_REPLAY 0x0020
1233 #define MSG_REQ_REPLAY_DONE 0x0040
1234 #define MSG_LOCK_REPLAY_DONE 0x0080
1237 * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
1240 #define MSG_CONNECT_RECOVERING 0x00000001
1241 #define MSG_CONNECT_RECONNECT 0x00000002
1242 #define MSG_CONNECT_REPLAYABLE 0x00000004
1243 //#define MSG_CONNECT_PEER 0x8
1244 #define MSG_CONNECT_LIBCLIENT 0x00000010
1245 #define MSG_CONNECT_INITIAL 0x00000020
1246 #define MSG_CONNECT_ASYNC 0x00000040
1247 #define MSG_CONNECT_NEXT_VER 0x00000080 /* use next version of lustre_msg */
1248 #define MSG_CONNECT_TRANSNO 0x00000100 /* report transno */
1251 #define OBD_CONNECT_RDONLY 0x1ULL /*client has read-only access*/
1252 #define OBD_CONNECT_INDEX 0x2ULL /*connect specific LOV idx */
1253 #define OBD_CONNECT_MDS 0x4ULL /*connect from MDT to OST */
1254 #define OBD_CONNECT_GRANT 0x8ULL /*OSC gets grant at connect */
1255 #define OBD_CONNECT_SRVLOCK 0x10ULL /*server takes locks for cli */
1256 #define OBD_CONNECT_VERSION 0x20ULL /*Lustre versions in ocd */
1257 #define OBD_CONNECT_REQPORTAL 0x40ULL /*Separate non-IO req portal */
1258 #define OBD_CONNECT_ACL 0x80ULL /*access control lists */
1259 #define OBD_CONNECT_XATTR 0x100ULL /*client use extended attr */
1260 #define OBD_CONNECT_CROW 0x200ULL /*MDS+OST create obj on write*/
1261 #define OBD_CONNECT_TRUNCLOCK 0x400ULL /*locks on server for punch */
1262 #define OBD_CONNECT_TRANSNO 0x800ULL /*replay sends init transno */
1263 #define OBD_CONNECT_IBITS 0x1000ULL /*support for inodebits locks*/
1264 #define OBD_CONNECT_JOIN 0x2000ULL /*files can be concatenated.
1265 *We do not support JOIN FILE
1266 *anymore, reserve this flags
1267 *just for preventing such bit
1269 #define OBD_CONNECT_ATTRFID 0x4000ULL /*Server can GetAttr By Fid*/
1270 #define OBD_CONNECT_NODEVOH 0x8000ULL /*No open hndl on specl nodes*/
1271 #define OBD_CONNECT_RMT_CLIENT 0x10000ULL /*Remote client */
1272 #define OBD_CONNECT_RMT_CLIENT_FORCE 0x20000ULL /*Remote client by force */
1273 #define OBD_CONNECT_BRW_SIZE 0x40000ULL /*Max bytes per rpc */
1274 #define OBD_CONNECT_QUOTA64 0x80000ULL /*Not used since 2.4 */
1275 #define OBD_CONNECT_MDS_CAPA 0x100000ULL /*MDS capability */
1276 #define OBD_CONNECT_OSS_CAPA 0x200000ULL /*OSS capability */
1277 #define OBD_CONNECT_CANCELSET 0x400000ULL /*Early batched cancels. */
1278 #define OBD_CONNECT_SOM 0x800000ULL /*Size on MDS */
1279 #define OBD_CONNECT_AT 0x1000000ULL /*client uses AT */
1280 #define OBD_CONNECT_LRU_RESIZE 0x2000000ULL /*LRU resize feature. */
1281 #define OBD_CONNECT_MDS_MDS 0x4000000ULL /*MDS-MDS connection */
1282 #define OBD_CONNECT_REAL 0x8000000ULL /*real connection */
1283 #define OBD_CONNECT_CHANGE_QS 0x10000000ULL /*Not used since 2.4 */
1284 #define OBD_CONNECT_CKSUM 0x20000000ULL /*support several cksum algos*/
1285 #define OBD_CONNECT_FID 0x40000000ULL /*FID is supported by server */
1286 #define OBD_CONNECT_VBR 0x80000000ULL /*version based recovery */
1287 #define OBD_CONNECT_LOV_V3 0x100000000ULL /*client supports LOV v3 EA */
1288 #define OBD_CONNECT_GRANT_SHRINK 0x200000000ULL /* support grant shrink */
1289 #define OBD_CONNECT_SKIP_ORPHAN 0x400000000ULL /* don't reuse orphan objids */
1290 #define OBD_CONNECT_MAX_EASIZE 0x800000000ULL /* preserved for large EA */
1291 #define OBD_CONNECT_FULL20 0x1000000000ULL /* it is 2.0 client */
1292 #define OBD_CONNECT_LAYOUTLOCK 0x2000000000ULL /* client uses layout lock */
1293 #define OBD_CONNECT_64BITHASH 0x4000000000ULL /* client supports 64-bits
1295 #define OBD_CONNECT_MAXBYTES 0x8000000000ULL /* max stripe size */
1296 #define OBD_CONNECT_IMP_RECOV 0x10000000000ULL /* imp recovery support */
1297 #define OBD_CONNECT_JOBSTATS 0x20000000000ULL /* jobid in ptlrpc_body */
1298 #define OBD_CONNECT_UMASK 0x40000000000ULL /* create uses client umask */
1299 #define OBD_CONNECT_EINPROGRESS 0x80000000000ULL /* client handles -EINPROGRESS
1300 * RPC error properly */
1301 #define OBD_CONNECT_GRANT_PARAM 0x100000000000ULL/* extra grant params used for
1302 * finer space reservation */
1303 #define OBD_CONNECT_FLOCK_OWNER 0x200000000000ULL /* for the fixed 1.8
1304 * policy and 2.x server */
1305 #define OBD_CONNECT_LVB_TYPE 0x400000000000ULL /* variable type of LVB */
1306 #define OBD_CONNECT_NANOSEC_TIME 0x800000000000ULL /* nanosecond timestamps */
1307 #define OBD_CONNECT_LIGHTWEIGHT 0x1000000000000ULL/* lightweight connection */
1308 #define OBD_CONNECT_SHORTIO 0x2000000000000ULL/* short io */
1309 #define OBD_CONNECT_PINGLESS 0x4000000000000ULL/* pings not required */
1311 * Please DO NOT add flag values here before first ensuring that this same
1312 * flag value is not in use on some other branch. Please clear any such
1313 * changes with senior engineers before starting to use a new flag. Then,
1314 * submit a small patch against EVERY branch that ONLY adds the new flag,
1315 * updates obd_connect_names[] for lprocfs_rd_connect_flags(), adds the
1316 * flag to check_obd_connect_data(), and updates wiretests accordingly, so it
1317 * can be approved and landed easily to reserve the flag for future use. */
1319 /* The MNE_SWAB flag is overloading the MDS_MDS bit only for the MGS
1320 * connection. It is a temporary bug fix for Imperative Recovery interop
1321 * between 2.2 and 2.3 x86/ppc nodes, and can be removed when interop for
1322 * 2.2 clients/servers is no longer needed. LU-1252/LU-1644. */
1323 #define OBD_CONNECT_MNE_SWAB OBD_CONNECT_MDS_MDS
1325 #define OCD_HAS_FLAG(ocd, flg) \
1326 (!!((ocd)->ocd_connect_flags & OBD_CONNECT_##flg))
1329 #ifdef HAVE_LRU_RESIZE_SUPPORT
1330 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
1332 #define LRU_RESIZE_CONNECT_FLAG 0
1335 #define MDT_CONNECT_SUPPORTED (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
1336 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
1337 OBD_CONNECT_IBITS | \
1338 OBD_CONNECT_NODEVOH | OBD_CONNECT_ATTRFID | \
1339 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1340 OBD_CONNECT_RMT_CLIENT | \
1341 OBD_CONNECT_RMT_CLIENT_FORCE | \
1342 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_MDS_CAPA | \
1343 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_MDS_MDS | \
1344 OBD_CONNECT_FID | LRU_RESIZE_CONNECT_FLAG | \
1345 OBD_CONNECT_VBR | OBD_CONNECT_LOV_V3 | \
1346 OBD_CONNECT_SOM | OBD_CONNECT_FULL20 | \
1347 OBD_CONNECT_64BITHASH | OBD_CONNECT_JOBSTATS | \
1348 OBD_CONNECT_EINPROGRESS | \
1349 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_UMASK | \
1350 OBD_CONNECT_LVB_TYPE | OBD_CONNECT_LAYOUTLOCK |\
1351 OBD_CONNECT_PINGLESS)
1352 #define OST_CONNECT_SUPPORTED (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
1353 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
1354 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
1355 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_OSS_CAPA | \
1356 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1357 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_CKSUM | \
1358 OBD_CONNECT_RMT_CLIENT | \
1359 OBD_CONNECT_RMT_CLIENT_FORCE | OBD_CONNECT_VBR | \
1360 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
1361 OBD_CONNECT_GRANT_SHRINK | OBD_CONNECT_FULL20 | \
1362 OBD_CONNECT_64BITHASH | OBD_CONNECT_MAXBYTES | \
1363 OBD_CONNECT_MAX_EASIZE | \
1364 OBD_CONNECT_EINPROGRESS | \
1365 OBD_CONNECT_JOBSTATS | \
1366 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_LVB_TYPE|\
1367 OBD_CONNECT_LAYOUTLOCK | OBD_CONNECT_FID | \
1368 OBD_CONNECT_PINGLESS)
1369 #define ECHO_CONNECT_SUPPORTED (0)
1370 #define MGS_CONNECT_SUPPORTED (OBD_CONNECT_VERSION | OBD_CONNECT_AT | \
1371 OBD_CONNECT_FULL20 | OBD_CONNECT_IMP_RECOV | \
1372 OBD_CONNECT_MNE_SWAB | OBD_CONNECT_PINGLESS)
1374 /* Features required for this version of the client to work with server */
1375 #define CLIENT_CONNECT_MDT_REQD (OBD_CONNECT_IBITS | OBD_CONNECT_FID | \
1378 #define OBD_OCD_VERSION(major,minor,patch,fix) (((major)<<24) + ((minor)<<16) +\
1379 ((patch)<<8) + (fix))
1380 #define OBD_OCD_VERSION_MAJOR(version) ((int)((version)>>24)&255)
1381 #define OBD_OCD_VERSION_MINOR(version) ((int)((version)>>16)&255)
1382 #define OBD_OCD_VERSION_PATCH(version) ((int)((version)>>8)&255)
1383 #define OBD_OCD_VERSION_FIX(version) ((int)(version)&255)
1385 /* This structure is used for both request and reply.
1387 * If we eventually have separate connect data for different types, which we
1388 * almost certainly will, then perhaps we stick a union in here. */
1389 struct obd_connect_data_v1 {
1390 __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1391 __u32 ocd_version; /* lustre release version number */
1392 __u32 ocd_grant; /* initial cache grant amount (bytes) */
1393 __u32 ocd_index; /* LOV index to connect to */
1394 __u32 ocd_brw_size; /* Maximum BRW size in bytes, must be 2^n */
1395 __u64 ocd_ibits_known; /* inode bits this client understands */
1396 __u8 ocd_blocksize; /* log2 of the backend filesystem blocksize */
1397 __u8 ocd_inodespace; /* log2 of the per-inode space consumption */
1398 __u16 ocd_grant_extent; /* per-extent grant overhead, in 1K blocks */
1399 __u32 ocd_unused; /* also fix lustre_swab_connect */
1400 __u64 ocd_transno; /* first transno from client to be replayed */
1401 __u32 ocd_group; /* MDS group on OST */
1402 __u32 ocd_cksum_types; /* supported checksum algorithms */
1403 __u32 ocd_max_easize; /* How big LOV EA can be on MDS */
1404 __u32 ocd_instance; /* also fix lustre_swab_connect */
1405 __u64 ocd_maxbytes; /* Maximum stripe size in bytes */
1408 struct obd_connect_data {
1409 __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1410 __u32 ocd_version; /* lustre release version number */
1411 __u32 ocd_grant; /* initial cache grant amount (bytes) */
1412 __u32 ocd_index; /* LOV index to connect to */
1413 __u32 ocd_brw_size; /* Maximum BRW size in bytes */
1414 __u64 ocd_ibits_known; /* inode bits this client understands */
1415 __u8 ocd_blocksize; /* log2 of the backend filesystem blocksize */
1416 __u8 ocd_inodespace; /* log2 of the per-inode space consumption */
1417 __u16 ocd_grant_extent; /* per-extent grant overhead, in 1K blocks */
1418 __u32 ocd_unused; /* also fix lustre_swab_connect */
1419 __u64 ocd_transno; /* first transno from client to be replayed */
1420 __u32 ocd_group; /* MDS group on OST */
1421 __u32 ocd_cksum_types; /* supported checksum algorithms */
1422 __u32 ocd_max_easize; /* How big LOV EA can be on MDS */
1423 __u32 ocd_instance; /* instance # of this target */
1424 __u64 ocd_maxbytes; /* Maximum stripe size in bytes */
1425 /* Fields after ocd_maxbytes are only accessible by the receiver
1426 * if the corresponding flag in ocd_connect_flags is set. Accessing
1427 * any field after ocd_maxbytes on the receiver without a valid flag
1428 * may result in out-of-bound memory access and kernel oops. */
1429 __u64 padding1; /* added 2.1.0. also fix lustre_swab_connect */
1430 __u64 padding2; /* added 2.1.0. also fix lustre_swab_connect */
1431 __u64 padding3; /* added 2.1.0. also fix lustre_swab_connect */
1432 __u64 padding4; /* added 2.1.0. also fix lustre_swab_connect */
1433 __u64 padding5; /* added 2.1.0. also fix lustre_swab_connect */
1434 __u64 padding6; /* added 2.1.0. also fix lustre_swab_connect */
1435 __u64 padding7; /* added 2.1.0. also fix lustre_swab_connect */
1436 __u64 padding8; /* added 2.1.0. also fix lustre_swab_connect */
1437 __u64 padding9; /* added 2.1.0. also fix lustre_swab_connect */
1438 __u64 paddingA; /* added 2.1.0. also fix lustre_swab_connect */
1439 __u64 paddingB; /* added 2.1.0. also fix lustre_swab_connect */
1440 __u64 paddingC; /* added 2.1.0. also fix lustre_swab_connect */
1441 __u64 paddingD; /* added 2.1.0. also fix lustre_swab_connect */
1442 __u64 paddingE; /* added 2.1.0. also fix lustre_swab_connect */
1443 __u64 paddingF; /* added 2.1.0. also fix lustre_swab_connect */
1446 * Please DO NOT use any fields here before first ensuring that this same
1447 * field is not in use on some other branch. Please clear any such changes
1448 * with senior engineers before starting to use a new field. Then, submit
1449 * a small patch against EVERY branch that ONLY adds the new field along with
1450 * the matching OBD_CONNECT flag, so that can be approved and landed easily to
1451 * reserve the flag for future use. */
1454 extern void lustre_swab_connect(struct obd_connect_data *ocd);
1457 * Supported checksum algorithms. Up to 32 checksum types are supported.
1458 * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
1459 * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
1460 * algorithm and also the OBD_FL_CKSUM* flags.
1463 OBD_CKSUM_CRC32 = 0x00000001,
1464 OBD_CKSUM_ADLER = 0x00000002,
1465 OBD_CKSUM_CRC32C= 0x00000004,
1469 * OST requests: OBDO & OBD request records
1474 OST_REPLY = 0, /* reply ? */
1490 OST_QUOTACHECK = 18,
1492 OST_QUOTA_ADJUST_QUNIT = 20, /* not used since 2.4 */
1495 #define OST_FIRST_OPC OST_REPLY
1498 OBD_FL_INLINEDATA = 0x00000001,
1499 OBD_FL_OBDMDEXISTS = 0x00000002,
1500 OBD_FL_DELORPHAN = 0x00000004, /* if set in o_flags delete orphans */
1501 OBD_FL_NORPC = 0x00000008, /* set in o_flags do in OSC not OST */
1502 OBD_FL_IDONLY = 0x00000010, /* set in o_flags only adjust obj id*/
1503 OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
1504 OBD_FL_DEBUG_CHECK = 0x00000040, /* echo client/server debug check */
1505 OBD_FL_NO_USRQUOTA = 0x00000100, /* the object's owner is over quota */
1506 OBD_FL_NO_GRPQUOTA = 0x00000200, /* the object's group is over quota */
1507 OBD_FL_CREATE_CROW = 0x00000400, /* object should be create on write */
1508 OBD_FL_SRVLOCK = 0x00000800, /* delegate DLM locking to server */
1509 OBD_FL_CKSUM_CRC32 = 0x00001000, /* CRC32 checksum type */
1510 OBD_FL_CKSUM_ADLER = 0x00002000, /* ADLER checksum type */
1511 OBD_FL_CKSUM_CRC32C = 0x00004000, /* CRC32C checksum type */
1512 OBD_FL_CKSUM_RSVD2 = 0x00008000, /* for future cksum types */
1513 OBD_FL_CKSUM_RSVD3 = 0x00010000, /* for future cksum types */
1514 OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
1515 OBD_FL_MMAP = 0x00040000, /* object is mmapped on the client.
1516 * XXX: obsoleted - reserved for old
1517 * clients prior than 2.2 */
1518 OBD_FL_RECOV_RESEND = 0x00080000, /* recoverable resent */
1519 OBD_FL_NOSPC_BLK = 0x00100000, /* no more block space on OST */
1521 /* Note that while these checksum values are currently separate bits,
1522 * in 2.x we can actually allow all values from 1-31 if we wanted. */
1523 OBD_FL_CKSUM_ALL = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER |
1524 OBD_FL_CKSUM_CRC32C,
1526 /* mask for local-only flag, which won't be sent over network */
1527 OBD_FL_LOCAL_MASK = 0xF0000000,
1530 #define LOV_MAGIC_V1 0x0BD10BD0
1531 #define LOV_MAGIC LOV_MAGIC_V1
1532 #define LOV_MAGIC_JOIN_V1 0x0BD20BD0
1533 #define LOV_MAGIC_V3 0x0BD30BD0
1536 * magic for fully defined striping
1537 * the idea is that we should have different magics for striping "hints"
1538 * (struct lov_user_md_v[13]) and defined ready-to-use striping (struct
1539 * lov_mds_md_v[13]). at the moment the magics are used in wire protocol,
1540 * we can't just change it w/o long way preparation, but we still need a
1541 * mechanism to allow LOD to differentiate hint versus ready striping.
1542 * so, at the moment we do a trick: MDT knows what to expect from request
1543 * depending on the case (replay uses ready striping, non-replay req uses
1544 * hints), so MDT replaces magic with appropriate one and now LOD can
1545 * easily understand what's inside -bzzz
1547 #define LOV_MAGIC_V1_DEF 0x0CD10BD0
1548 #define LOV_MAGIC_V3_DEF 0x0CD30BD0
1550 #define LOV_PATTERN_RAID0 0x001 /* stripes are used round-robin */
1551 #define LOV_PATTERN_RAID1 0x002 /* stripes are mirrors of each other */
1552 #define LOV_PATTERN_FIRST 0x100 /* first stripe is not in round-robin */
1553 #define LOV_PATTERN_CMOBD 0x200
1555 #define lov_ost_data lov_ost_data_v1
1556 struct lov_ost_data_v1 { /* per-stripe data structure (little-endian)*/
1557 struct ost_id l_ost_oi; /* OST object ID */
1558 __u32 l_ost_gen; /* generation of this l_ost_idx */
1559 __u32 l_ost_idx; /* OST index in LOV (lov_tgt_desc->tgts) */
1562 #define lov_mds_md lov_mds_md_v1
1563 struct lov_mds_md_v1 { /* LOV EA mds/wire data (little-endian) */
1564 __u32 lmm_magic; /* magic number = LOV_MAGIC_V1 */
1565 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1566 struct ost_id lmm_oi; /* LOV object ID */
1567 __u32 lmm_stripe_size; /* size of stripe in bytes */
1568 /* lmm_stripe_count used to be __u32 */
1569 __u16 lmm_stripe_count; /* num stripes in use for this object */
1570 __u16 lmm_layout_gen; /* layout generation number */
1571 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1575 * Sigh, because pre-2.4 uses
1576 * struct lov_mds_md_v1 {
1578 * __u64 lmm_object_id;
1579 * __u64 lmm_object_seq;
1582 * to identify the LOV(MDT) object, and lmm_object_seq will
1583 * be normal_fid, which make it hard to combine these conversion
1584 * to ostid_to FID. so we will do lmm_oi/fid conversion separately
1586 * We can tell the lmm_oi by this way,
1587 * 1.8: lmm_object_id = {inode}, lmm_object_gr = 0
1588 * 2.1: lmm_object_id = {oid < 128k}, lmm_object_seq = FID_SEQ_NORMAL
1589 * 2.4: lmm_oi.f_seq = FID_SEQ_NORMAL, lmm_oi.f_oid = {oid < 128k},
1592 * But currently lmm_oi/lsm_oi does not have any "real" usages,
1593 * except for printing some information, and the user can always
1594 * get the real FID from LMA, besides this multiple case check might
1595 * make swab more complicate. So we will keep using id/seq for lmm_oi.
1598 static inline void fid_to_lmm_oi(const struct lu_fid *fid,
1601 oi->oi.oi_id = fid_oid(fid);
1602 oi->oi.oi_seq = fid_seq(fid);
1605 static inline void lmm_oi_set_seq(struct ost_id *oi, __u64 seq)
1607 oi->oi.oi_seq = seq;
1610 static inline __u64 lmm_oi_id(struct ost_id *oi)
1612 return oi->oi.oi_id;
1615 static inline __u64 lmm_oi_seq(struct ost_id *oi)
1617 return oi->oi.oi_seq;
1620 static inline void lmm_oi_le_to_cpu(struct ost_id *dst_oi,
1621 struct ost_id *src_oi)
1623 dst_oi->oi.oi_id = le64_to_cpu(src_oi->oi.oi_id);
1624 dst_oi->oi.oi_seq = le64_to_cpu(src_oi->oi.oi_seq);
1627 static inline void lmm_oi_cpu_to_le(struct ost_id *dst_oi,
1628 struct ost_id *src_oi)
1630 dst_oi->oi.oi_id = cpu_to_le64(src_oi->oi.oi_id);
1631 dst_oi->oi.oi_seq = cpu_to_le64(src_oi->oi.oi_seq);
1634 /* extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm); */
1636 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
1637 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
1639 #define XATTR_NAME_ACL_ACCESS "system.posix_acl_access"
1640 #define XATTR_NAME_ACL_DEFAULT "system.posix_acl_default"
1641 #define XATTR_USER_PREFIX "user."
1642 #define XATTR_TRUSTED_PREFIX "trusted."
1643 #define XATTR_SECURITY_PREFIX "security."
1644 #define XATTR_LUSTRE_PREFIX "lustre."
1646 #define XATTR_NAME_LOV "trusted.lov"
1647 #define XATTR_NAME_LMA "trusted.lma"
1648 #define XATTR_NAME_LMV "trusted.lmv"
1649 #define XATTR_NAME_LINK "trusted.link"
1650 #define XATTR_NAME_FID "trusted.fid"
1651 #define XATTR_NAME_VERSION "trusted.version"
1652 #define XATTR_NAME_SOM "trusted.som"
1653 #define XATTR_NAME_HSM "trusted.hsm"
1654 #define XATTR_NAME_LFSCK_NAMESPACE "trusted.lfsck_namespace"
1656 struct lov_mds_md_v3 { /* LOV EA mds/wire data (little-endian) */
1657 __u32 lmm_magic; /* magic number = LOV_MAGIC_V3 */
1658 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1659 struct ost_id lmm_oi; /* LOV object ID */
1660 __u32 lmm_stripe_size; /* size of stripe in bytes */
1661 /* lmm_stripe_count used to be __u32 */
1662 __u16 lmm_stripe_count; /* num stripes in use for this object */
1663 __u16 lmm_layout_gen; /* layout generation number */
1664 char lmm_pool_name[LOV_MAXPOOLNAME]; /* must be 32bit aligned */
1665 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1668 #define OBD_MD_FLID (0x00000001ULL) /* object ID */
1669 #define OBD_MD_FLATIME (0x00000002ULL) /* access time */
1670 #define OBD_MD_FLMTIME (0x00000004ULL) /* data modification time */
1671 #define OBD_MD_FLCTIME (0x00000008ULL) /* change time */
1672 #define OBD_MD_FLSIZE (0x00000010ULL) /* size */
1673 #define OBD_MD_FLBLOCKS (0x00000020ULL) /* allocated blocks count */
1674 #define OBD_MD_FLBLKSZ (0x00000040ULL) /* block size */
1675 #define OBD_MD_FLMODE (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1676 #define OBD_MD_FLTYPE (0x00000100ULL) /* object type (mode & S_IFMT) */
1677 #define OBD_MD_FLUID (0x00000200ULL) /* user ID */
1678 #define OBD_MD_FLGID (0x00000400ULL) /* group ID */
1679 #define OBD_MD_FLFLAGS (0x00000800ULL) /* flags word */
1680 #define OBD_MD_FLNLINK (0x00002000ULL) /* link count */
1681 #define OBD_MD_FLGENER (0x00004000ULL) /* generation number */
1682 /*#define OBD_MD_FLINLINE (0x00008000ULL) inline data. used until 1.6.5 */
1683 #define OBD_MD_FLRDEV (0x00010000ULL) /* device number */
1684 #define OBD_MD_FLEASIZE (0x00020000ULL) /* extended attribute data */
1685 #define OBD_MD_LINKNAME (0x00040000ULL) /* symbolic link target */
1686 #define OBD_MD_FLHANDLE (0x00080000ULL) /* file/lock handle */
1687 #define OBD_MD_FLCKSUM (0x00100000ULL) /* bulk data checksum */
1688 #define OBD_MD_FLQOS (0x00200000ULL) /* quality of service stats */
1689 /*#define OBD_MD_FLOSCOPQ (0x00400000ULL) osc opaque data, never used */
1690 #define OBD_MD_FLCOOKIE (0x00800000ULL) /* log cancellation cookie */
1691 #define OBD_MD_FLGROUP (0x01000000ULL) /* group */
1692 #define OBD_MD_FLFID (0x02000000ULL) /* ->ost write inline fid */
1693 #define OBD_MD_FLEPOCH (0x04000000ULL) /* ->ost write with ioepoch */
1694 /* ->mds if epoch opens or closes */
1695 #define OBD_MD_FLGRANT (0x08000000ULL) /* ost preallocation space grant */
1696 #define OBD_MD_FLDIREA (0x10000000ULL) /* dir's extended attribute data */
1697 #define OBD_MD_FLUSRQUOTA (0x20000000ULL) /* over quota flags sent from ost */
1698 #define OBD_MD_FLGRPQUOTA (0x40000000ULL) /* over quota flags sent from ost */
1699 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1701 #define OBD_MD_MDS (0x0000000100000000ULL) /* where an inode lives on */
1702 #define OBD_MD_REINT (0x0000000200000000ULL) /* reintegrate oa */
1703 #define OBD_MD_MEA (0x0000000400000000ULL) /* CMD split EA */
1705 /* OBD_MD_MDTIDX is used to get MDT index, but it is never been used overwire,
1706 * and it is already obsolete since 2.3 */
1707 /* #define OBD_MD_MDTIDX (0x0000000800000000ULL) */
1709 #define OBD_MD_FLXATTR (0x0000001000000000ULL) /* xattr */
1710 #define OBD_MD_FLXATTRLS (0x0000002000000000ULL) /* xattr list */
1711 #define OBD_MD_FLXATTRRM (0x0000004000000000ULL) /* xattr remove */
1712 #define OBD_MD_FLACL (0x0000008000000000ULL) /* ACL */
1713 #define OBD_MD_FLRMTPERM (0x0000010000000000ULL) /* remote permission */
1714 #define OBD_MD_FLMDSCAPA (0x0000020000000000ULL) /* MDS capability */
1715 #define OBD_MD_FLOSSCAPA (0x0000040000000000ULL) /* OSS capability */
1716 #define OBD_MD_FLCKSPLIT (0x0000080000000000ULL) /* Check split on server */
1717 #define OBD_MD_FLCROSSREF (0x0000100000000000ULL) /* Cross-ref case */
1718 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1720 #define OBD_MD_FLOBJCOUNT (0x0000400000000000ULL) /* for multiple destroy */
1722 #define OBD_MD_FLRMTLSETFACL (0x0001000000000000ULL) /* lfs lsetfacl case */
1723 #define OBD_MD_FLRMTLGETFACL (0x0002000000000000ULL) /* lfs lgetfacl case */
1724 #define OBD_MD_FLRMTRSETFACL (0x0004000000000000ULL) /* lfs rsetfacl case */
1725 #define OBD_MD_FLRMTRGETFACL (0x0008000000000000ULL) /* lfs rgetfacl case */
1727 #define OBD_MD_FLDATAVERSION (0x0010000000000000ULL) /* iversion sum */
1729 #define OBD_MD_FLGETATTR (OBD_MD_FLID | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1730 OBD_MD_FLCTIME | OBD_MD_FLSIZE | OBD_MD_FLBLKSZ | \
1731 OBD_MD_FLMODE | OBD_MD_FLTYPE | OBD_MD_FLUID | \
1732 OBD_MD_FLGID | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1733 OBD_MD_FLGENER | OBD_MD_FLRDEV | OBD_MD_FLGROUP)
1735 /* don't forget obdo_fid which is way down at the bottom so it can
1736 * come after the definition of llog_cookie */
1740 HSS_CLEARMASK = 0x02,
1741 HSS_ARCHIVE_ID = 0x04,
1744 struct hsm_state_set {
1746 __u32 hss_archive_id;
1748 __u64 hss_clearmask;
1751 extern void lustre_swab_hsm_user_state(struct hsm_user_state *hus);
1752 extern void lustre_swab_hsm_state_set(struct hsm_state_set *hss);
1754 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
1756 /* ost_body.data values for OST_BRW */
1758 #define OBD_BRW_READ 0x01
1759 #define OBD_BRW_WRITE 0x02
1760 #define OBD_BRW_RWMASK (OBD_BRW_READ | OBD_BRW_WRITE)
1761 #define OBD_BRW_SYNC 0x08 /* this page is a part of synchronous
1762 * transfer and is not accounted in
1764 #define OBD_BRW_CHECK 0x10
1765 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
1766 #define OBD_BRW_GRANTED 0x40 /* the ost manages this */
1767 #define OBD_BRW_NOCACHE 0x80 /* this page is a part of non-cached IO */
1768 #define OBD_BRW_NOQUOTA 0x100
1769 #define OBD_BRW_SRVLOCK 0x200 /* Client holds no lock over this page */
1770 #define OBD_BRW_ASYNC 0x400 /* Server may delay commit to disk */
1771 #define OBD_BRW_MEMALLOC 0x800 /* Client runs in the "kswapd" context */
1772 #define OBD_BRW_OVER_USRQUOTA 0x1000 /* Running out of user quota */
1773 #define OBD_BRW_OVER_GRPQUOTA 0x2000 /* Running out of group quota */
1775 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
1777 #define OST_MIN_PRECREATE 32
1778 #define OST_MAX_PRECREATE 20000
1781 struct ost_id ioo_oid; /* object ID, if multi-obj BRW */
1782 __u32 ioo_max_brw; /* low 16 bits were o_mode before 2.4,
1783 * now (PTLRPC_BULK_OPS_COUNT - 1) in
1784 * high 16 bits in 2.4 and later */
1785 __u32 ioo_bufcnt; /* number of niobufs for this object */
1788 #define IOOBJ_MAX_BRW_BITS 16
1789 #define IOOBJ_TYPE_MASK ((1U << IOOBJ_MAX_BRW_BITS) - 1)
1790 #define ioobj_max_brw_get(ioo) (((ioo)->ioo_max_brw >> IOOBJ_MAX_BRW_BITS) + 1)
1791 #define ioobj_max_brw_set(ioo, num) \
1792 do { (ioo)->ioo_max_brw = ((num) - 1) << IOOBJ_MAX_BRW_BITS; } while (0)
1794 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
1796 /* multiple of 8 bytes => can array */
1797 struct niobuf_remote {
1803 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
1805 /* lock value block communicated between the filter and llite */
1807 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1808 * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1809 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1810 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1811 #define OST_LVB_IS_ERR(blocks) \
1812 ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1813 #define OST_LVB_SET_ERR(blocks, rc) \
1814 do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1815 #define OST_LVB_GET_ERR(blocks) (int)(blocks - OST_LVB_ERR_INIT)
1825 extern void lustre_swab_ost_lvb_v1(struct ost_lvb_v1 *lvb);
1839 extern void lustre_swab_ost_lvb(struct ost_lvb *lvb);
1842 * lquota data structures
1845 #ifndef QUOTABLOCK_BITS
1846 #define QUOTABLOCK_BITS 10
1849 #ifndef QUOTABLOCK_SIZE
1850 #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
1854 #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
1857 /* The lquota_id structure is an union of all the possible identifier types that
1858 * can be used with quota, this includes:
1861 * - a FID which can be used for per-directory quota in the future */
1863 struct lu_fid qid_fid; /* FID for per-directory quota */
1864 __u64 qid_uid; /* user identifier */
1865 __u64 qid_gid; /* group identifier */
1868 /* quotactl management */
1869 struct obd_quotactl {
1871 __u32 qc_type; /* see Q_* flag below */
1874 struct obd_dqinfo qc_dqinfo;
1875 struct obd_dqblk qc_dqblk;
1878 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1880 #define Q_QUOTACHECK 0x800100 /* deprecated as of 2.4 */
1881 #define Q_INITQUOTA 0x800101 /* deprecated as of 2.4 */
1882 #define Q_GETOINFO 0x800102 /* get obd quota info */
1883 #define Q_GETOQUOTA 0x800103 /* get obd quotas */
1884 #define Q_FINVALIDATE 0x800104 /* deprecated as of 2.4 */
1886 #define Q_COPY(out, in, member) (out)->member = (in)->member
1888 #define QCTL_COPY(out, in) \
1890 Q_COPY(out, in, qc_cmd); \
1891 Q_COPY(out, in, qc_type); \
1892 Q_COPY(out, in, qc_id); \
1893 Q_COPY(out, in, qc_stat); \
1894 Q_COPY(out, in, qc_dqinfo); \
1895 Q_COPY(out, in, qc_dqblk); \
1898 /* Body of quota request used for quota acquire/release RPCs between quota
1899 * master (aka QMT) and slaves (ak QSD). */
1901 struct lu_fid qb_fid; /* FID of global index packing the pool ID
1902 * and type (data or metadata) as well as
1903 * the quota type (user or group). */
1904 union lquota_id qb_id; /* uid or gid or directory FID */
1905 __u32 qb_flags; /* see below */
1907 __u64 qb_count; /* acquire/release count (kbytes/inodes) */
1908 __u64 qb_usage; /* current slave usage (kbytes/inodes) */
1909 __u64 qb_slv_ver; /* slave index file version */
1910 struct lustre_handle qb_lockh; /* per-ID lock handle */
1911 struct lustre_handle qb_glb_lockh; /* global lock handle */
1912 __u64 qb_padding1[4];
1915 /* When the quota_body is used in the reply of quota global intent
1916 * lock (IT_QUOTA_CONN) reply, qb_fid contains slave index file FID. */
1917 #define qb_slv_fid qb_fid
1918 /* qb_usage is the current qunit (in kbytes/inodes) when quota_body is used in
1920 #define qb_qunit qb_usage
1922 #define QUOTA_DQACQ_FL_ACQ 0x1 /* acquire quota */
1923 #define QUOTA_DQACQ_FL_PREACQ 0x2 /* pre-acquire */
1924 #define QUOTA_DQACQ_FL_REL 0x4 /* release quota */
1925 #define QUOTA_DQACQ_FL_REPORT 0x8 /* report usage */
1927 extern void lustre_swab_quota_body(struct quota_body *b);
1929 /* Quota types currently supported */
1931 LQUOTA_TYPE_USR = 0x00, /* maps to USRQUOTA */
1932 LQUOTA_TYPE_GRP = 0x01, /* maps to GRPQUOTA */
1936 /* There are 2 different resource types on which a quota limit can be enforced:
1937 * - inodes on the MDTs
1938 * - blocks on the OSTs */
1940 LQUOTA_RES_MD = 0x01, /* skip 0 to avoid null oid in FID */
1941 LQUOTA_RES_DT = 0x02,
1943 LQUOTA_FIRST_RES = LQUOTA_RES_MD
1945 #define LQUOTA_NR_RES (LQUOTA_LAST_RES - LQUOTA_FIRST_RES + 1)
1948 * Space accounting support
1949 * Format of an accounting record, providing disk usage information for a given
1952 struct lquota_acct_rec { /* 16 bytes */
1953 __u64 bspace; /* current space in use */
1954 __u64 ispace; /* current # inodes in use */
1958 * Global quota index support
1959 * Format of a global record, providing global quota settings for a given quota
1962 struct lquota_glb_rec { /* 32 bytes */
1963 __u64 qbr_hardlimit; /* quota hard limit, in #inodes or kbytes */
1964 __u64 qbr_softlimit; /* quota soft limit, in #inodes or kbytes */
1965 __u64 qbr_time; /* grace time, in seconds */
1966 __u64 qbr_granted; /* how much is granted to slaves, in #inodes or
1971 * Slave index support
1972 * Format of a slave record, recording how much space is granted to a given
1975 struct lquota_slv_rec { /* 8 bytes */
1976 __u64 qsr_granted; /* space granted to the slave for the key=ID,
1977 * in #inodes or kbytes */
1980 /* Data structures associated with the quota locks */
1982 /* Glimpse descriptor used for the index & per-ID quota locks */
1983 struct ldlm_gl_lquota_desc {
1984 union lquota_id gl_id; /* quota ID subject to the glimpse */
1985 __u64 gl_flags; /* see LQUOTA_FL* below */
1986 __u64 gl_ver; /* new index version */
1987 __u64 gl_hardlimit; /* new hardlimit or qunit value */
1988 __u64 gl_softlimit; /* new softlimit */
1992 #define gl_qunit gl_hardlimit /* current qunit value used when
1993 * glimpsing per-ID quota locks */
1995 /* quota glimpse flags */
1996 #define LQUOTA_FL_EDQUOT 0x1 /* user/group out of quota space on QMT */
1998 /* LVB used with quota (global and per-ID) locks */
2000 __u64 lvb_flags; /* see LQUOTA_FL* above */
2001 __u64 lvb_id_may_rel; /* space that might be released later */
2002 __u64 lvb_id_rel; /* space released by the slave for this ID */
2003 __u64 lvb_id_qunit; /* current qunit value */
2007 extern void lustre_swab_lquota_lvb(struct lquota_lvb *lvb);
2009 /* LVB used with global quota lock */
2010 #define lvb_glb_ver lvb_id_may_rel /* current version of the global index */
2018 #define QUOTA_FIRST_OPC QUOTA_DQACQ
2027 MDS_GETATTR_NAME = 34,
2032 MDS_DISCONNECT = 39,
2038 MDS_DONE_WRITING = 45,
2040 MDS_QUOTACHECK = 47,
2043 MDS_SETXATTR = 50, /* obsolete, now it's MDS_REINT op */
2047 MDS_HSM_STATE_GET = 54,
2048 MDS_HSM_STATE_SET = 55,
2049 MDS_HSM_ACTION = 56,
2050 MDS_HSM_PROGRESS = 57,
2051 MDS_HSM_REQUEST = 58,
2052 MDS_HSM_CT_REGISTER = 59,
2053 MDS_HSM_CT_UNREGISTER = 60,
2054 MDS_SWAP_LAYOUTS = 61,
2058 #define MDS_FIRST_OPC MDS_GETATTR
2061 /* opcodes for object update */
2067 #define UPDATE_FIRST_OPC UPDATE_OBJ
2084 } mds_reint_t, mdt_reint_t;
2086 extern void lustre_swab_generic_32s (__u32 *val);
2088 /* the disposition of the intent outlines what was executed */
2089 #define DISP_IT_EXECD 0x00000001
2090 #define DISP_LOOKUP_EXECD 0x00000002
2091 #define DISP_LOOKUP_NEG 0x00000004
2092 #define DISP_LOOKUP_POS 0x00000008
2093 #define DISP_OPEN_CREATE 0x00000010
2094 #define DISP_OPEN_OPEN 0x00000020
2095 #define DISP_ENQ_COMPLETE 0x00400000
2096 #define DISP_ENQ_OPEN_REF 0x00800000
2097 #define DISP_ENQ_CREATE_REF 0x01000000
2098 #define DISP_OPEN_LOCK 0x02000000
2100 /* INODE LOCK PARTS */
2101 #define MDS_INODELOCK_LOOKUP 0x000001 /* dentry, mode, owner, group */
2102 #define MDS_INODELOCK_UPDATE 0x000002 /* size, links, timestamps */
2103 #define MDS_INODELOCK_OPEN 0x000004 /* For opened files */
2104 #define MDS_INODELOCK_LAYOUT 0x000008 /* for layout */
2105 #define MDS_INODELOCK_PERM 0x000010 /* for permission */
2107 #define MDS_INODELOCK_MAXSHIFT 4
2108 /* This FULL lock is useful to take on unlink sort of operations */
2109 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
2111 extern void lustre_swab_ll_fid (struct ll_fid *fid);
2113 /* NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
2114 * but was moved into name[1] along with the OID to avoid consuming the
2115 * name[2,3] fields that need to be used for the quota id (also a FID). */
2117 LUSTRE_RES_ID_SEQ_OFF = 0,
2118 LUSTRE_RES_ID_VER_OID_OFF = 1,
2119 LUSTRE_RES_ID_WAS_VER_OFF = 2, /* see note above */
2120 LUSTRE_RES_ID_QUOTA_SEQ_OFF = 2,
2121 LUSTRE_RES_ID_QUOTA_VER_OID_OFF = 3,
2122 LUSTRE_RES_ID_HSH_OFF = 3
2125 #define MDS_STATUS_CONN 1
2126 #define MDS_STATUS_LOV 2
2128 /* mdt_thread_info.mti_flags. */
2130 /* The flag indicates Size-on-MDS attributes are changed. */
2131 MF_SOM_CHANGE = (1 << 0),
2132 /* Flags indicates an epoch opens or closes. */
2133 MF_EPOCH_OPEN = (1 << 1),
2134 MF_EPOCH_CLOSE = (1 << 2),
2135 MF_MDC_CANCEL_FID1 = (1 << 3),
2136 MF_MDC_CANCEL_FID2 = (1 << 4),
2137 MF_MDC_CANCEL_FID3 = (1 << 5),
2138 MF_MDC_CANCEL_FID4 = (1 << 6),
2139 /* There is a pending attribute update. */
2140 MF_SOM_AU = (1 << 7),
2141 /* Cancel OST locks while getattr OST attributes. */
2142 MF_GETATTR_LOCK = (1 << 8),
2143 MF_GET_MDT_IDX = (1 << 9),
2146 #define MF_SOM_LOCAL_FLAGS (MF_SOM_CHANGE | MF_EPOCH_OPEN | MF_EPOCH_CLOSE)
2148 #define LUSTRE_BFLAG_UNCOMMITTED_WRITES 0x1
2150 /* these should be identical to their EXT4_*_FL counterparts, they are
2151 * redefined here only to avoid dragging in fs/ext4/ext4.h */
2152 #define LUSTRE_SYNC_FL 0x00000008 /* Synchronous updates */
2153 #define LUSTRE_IMMUTABLE_FL 0x00000010 /* Immutable file */
2154 #define LUSTRE_APPEND_FL 0x00000020 /* writes to file may only append */
2155 #define LUSTRE_NOATIME_FL 0x00000080 /* do not update atime */
2156 #define LUSTRE_DIRSYNC_FL 0x00010000 /* dirsync behaviour (dir only) */
2159 /* Convert wire LUSTRE_*_FL to corresponding client local VFS S_* values
2160 * for the client inode i_flags. The LUSTRE_*_FL are the Lustre wire
2161 * protocol equivalents of LDISKFS_*_FL values stored on disk, while
2162 * the S_* flags are kernel-internal values that change between kernel
2163 * versions. These flags are set/cleared via FSFILT_IOC_{GET,SET}_FLAGS.
2164 * See b=16526 for a full history. */
2165 static inline int ll_ext_to_inode_flags(int flags)
2167 return (((flags & LUSTRE_SYNC_FL) ? S_SYNC : 0) |
2168 ((flags & LUSTRE_NOATIME_FL) ? S_NOATIME : 0) |
2169 ((flags & LUSTRE_APPEND_FL) ? S_APPEND : 0) |
2170 #if defined(S_DIRSYNC)
2171 ((flags & LUSTRE_DIRSYNC_FL) ? S_DIRSYNC : 0) |
2173 ((flags & LUSTRE_IMMUTABLE_FL) ? S_IMMUTABLE : 0));
2176 static inline int ll_inode_to_ext_flags(int iflags)
2178 return (((iflags & S_SYNC) ? LUSTRE_SYNC_FL : 0) |
2179 ((iflags & S_NOATIME) ? LUSTRE_NOATIME_FL : 0) |
2180 ((iflags & S_APPEND) ? LUSTRE_APPEND_FL : 0) |
2181 #if defined(S_DIRSYNC)
2182 ((iflags & S_DIRSYNC) ? LUSTRE_DIRSYNC_FL : 0) |
2184 ((iflags & S_IMMUTABLE) ? LUSTRE_IMMUTABLE_FL : 0));
2191 struct lustre_handle handle;
2193 __u64 size; /* Offset, in the case of MDS_READPAGE */
2197 __u64 blocks; /* XID, in the case of MDS_READPAGE */
2199 __u64 unused1; /* was "ino" until 2.4.0 */
2206 __u32 flags; /* from vfs for pin/unpin, LUSTRE_BFLAG close */
2208 __u32 nlink; /* #bytes to read in the case of MDS_READPAGE */
2209 __u32 unused2; /* was "generation" until 2.4.0 */
2214 __u32 max_cookiesize;
2215 __u32 uid_h; /* high 32-bits of uid, for FUID */
2216 __u32 gid_h; /* high 32-bits of gid, for FUID */
2217 __u32 padding_5; /* also fix lustre_swab_mdt_body */
2225 extern void lustre_swab_mdt_body (struct mdt_body *b);
2227 struct mdt_ioepoch {
2228 struct lustre_handle handle;
2234 extern void lustre_swab_mdt_ioepoch (struct mdt_ioepoch *b);
2236 /* permissions for md_perm.mp_perm */
2238 CFS_SETUID_PERM = 0x01,
2239 CFS_SETGID_PERM = 0x02,
2240 CFS_SETGRP_PERM = 0x04,
2241 CFS_RMTACL_PERM = 0x08,
2242 CFS_RMTOWN_PERM = 0x10
2245 /* inode access permission for remote user, the inode info are omitted,
2246 * for client knows them. */
2247 struct mdt_remote_perm {
2254 __u32 rp_access_perm; /* MAY_READ/WRITE/EXEC */
2258 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
2260 struct mdt_rec_setattr {
2270 __u32 sa_padding_1_h;
2271 struct lu_fid sa_fid;
2280 __u32 sa_attr_flags;
2282 __u32 sa_bias; /* some operation flags */
2288 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
2291 * Attribute flags used in mdt_rec_setattr::sa_valid.
2292 * The kernel's #defines for ATTR_* should not be used over the network
2293 * since the client and MDS may run different kernels (see bug 13828)
2294 * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
2296 #define MDS_ATTR_MODE 0x1ULL /* = 1 */
2297 #define MDS_ATTR_UID 0x2ULL /* = 2 */
2298 #define MDS_ATTR_GID 0x4ULL /* = 4 */
2299 #define MDS_ATTR_SIZE 0x8ULL /* = 8 */
2300 #define MDS_ATTR_ATIME 0x10ULL /* = 16 */
2301 #define MDS_ATTR_MTIME 0x20ULL /* = 32 */
2302 #define MDS_ATTR_CTIME 0x40ULL /* = 64 */
2303 #define MDS_ATTR_ATIME_SET 0x80ULL /* = 128 */
2304 #define MDS_ATTR_MTIME_SET 0x100ULL /* = 256 */
2305 #define MDS_ATTR_FORCE 0x200ULL /* = 512, Not a change, but a change it */
2306 #define MDS_ATTR_ATTR_FLAG 0x400ULL /* = 1024 */
2307 #define MDS_ATTR_KILL_SUID 0x800ULL /* = 2048 */
2308 #define MDS_ATTR_KILL_SGID 0x1000ULL /* = 4096 */
2309 #define MDS_ATTR_CTIME_SET 0x2000ULL /* = 8192 */
2310 #define MDS_ATTR_FROM_OPEN 0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
2311 #define MDS_ATTR_BLOCKS 0x8000ULL /* = 32768 */
2314 #define FMODE_READ 00000001
2315 #define FMODE_WRITE 00000002
2318 #define MDS_FMODE_CLOSED 00000000
2319 #define MDS_FMODE_EXEC 00000004
2320 /* IO Epoch is opened on a closed file. */
2321 #define MDS_FMODE_EPOCH 01000000
2322 /* IO Epoch is opened on a file truncate. */
2323 #define MDS_FMODE_TRUNC 02000000
2324 /* Size-on-MDS Attribute Update is pending. */
2325 #define MDS_FMODE_SOM 04000000
2327 #define MDS_OPEN_CREATED 00000010
2328 #define MDS_OPEN_CROSS 00000020
2330 #define MDS_OPEN_CREAT 00000100
2331 #define MDS_OPEN_EXCL 00000200
2332 #define MDS_OPEN_TRUNC 00001000
2333 #define MDS_OPEN_APPEND 00002000
2334 #define MDS_OPEN_SYNC 00010000
2335 #define MDS_OPEN_DIRECTORY 00200000
2337 #define MDS_OPEN_BY_FID 040000000 /* open_by_fid for known object */
2338 #define MDS_OPEN_DELAY_CREATE 0100000000 /* delay initial object create */
2339 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
2340 #define MDS_OPEN_JOIN_FILE 0400000000 /* open for join file.
2341 * We do not support JOIN FILE
2342 * anymore, reserve this flags
2343 * just for preventing such bit
2346 #define MDS_OPEN_LOCK 04000000000 /* This open requires open lock */
2347 #define MDS_OPEN_HAS_EA 010000000000 /* specify object create pattern */
2348 #define MDS_OPEN_HAS_OBJS 020000000000 /* Just set the EA the obj exist */
2349 #define MDS_OPEN_NORESTORE 0100000000000ULL /* Do not restore file at open */
2350 #define MDS_OPEN_NEWSTRIPE 0200000000000ULL /* New stripe needed (restripe or
2352 #define MDS_OPEN_VOLATILE 0400000000000ULL /* File is volatile = created
2355 /* permission for create non-directory file */
2356 #define MAY_CREATE (1 << 7)
2357 /* permission for create directory file */
2358 #define MAY_LINK (1 << 8)
2359 /* permission for delete from the directory */
2360 #define MAY_UNLINK (1 << 9)
2361 /* source's permission for rename */
2362 #define MAY_RENAME_SRC (1 << 10)
2363 /* target's permission for rename */
2364 #define MAY_RENAME_TAR (1 << 11)
2365 /* part (parent's) VTX permission check */
2366 #define MAY_VTX_PART (1 << 12)
2367 /* full VTX permission check */
2368 #define MAY_VTX_FULL (1 << 13)
2369 /* lfs rgetfacl permission check */
2370 #define MAY_RGETFACL (1 << 14)
2373 MDS_CHECK_SPLIT = 1 << 0,
2374 MDS_CROSS_REF = 1 << 1,
2375 MDS_VTX_BYPASS = 1 << 2,
2376 MDS_PERM_BYPASS = 1 << 3,
2378 MDS_QUOTA_IGNORE = 1 << 5,
2379 MDS_CLOSE_CLEANUP = 1 << 6,
2380 MDS_KEEP_ORPHAN = 1 << 7,
2381 MDS_RECOV_OPEN = 1 << 8,
2382 MDS_DATA_MODIFIED = 1 << 9,
2383 MDS_CREATE_VOLATILE = 1 << 10,
2384 MDS_OWNEROVERRIDE = 1 << 11,
2387 /* instance of mdt_reint_rec */
2388 struct mdt_rec_create {
2396 __u32 cr_suppgid1_h;
2398 __u32 cr_suppgid2_h;
2399 struct lu_fid cr_fid1;
2400 struct lu_fid cr_fid2;
2401 struct lustre_handle cr_old_handle; /* handle in case of open replay */
2405 __u64 cr_padding_1; /* rr_blocks */
2408 /* use of helpers set/get_mrc_cr_flags() is needed to access
2409 * 64 bits cr_flags [cr_flags_l, cr_flags_h], this is done to
2410 * extend cr_flags size without breaking 1.8 compat */
2411 __u32 cr_flags_l; /* for use with open, low 32 bits */
2412 __u32 cr_flags_h; /* for use with open, high 32 bits */
2413 __u32 cr_umask; /* umask for create */
2414 __u32 cr_padding_4; /* rr_padding_4 */
2417 static inline void set_mrc_cr_flags(struct mdt_rec_create *mrc, __u64 flags)
2419 mrc->cr_flags_l = (__u32)(flags & 0xFFFFFFFFUll);
2420 mrc->cr_flags_h = (__u32)(flags >> 32);
2423 static inline __u64 get_mrc_cr_flags(struct mdt_rec_create *mrc)
2425 return ((__u64)(mrc->cr_flags_l) | ((__u64)mrc->cr_flags_h << 32));
2428 /* instance of mdt_reint_rec */
2429 struct mdt_rec_link {
2437 __u32 lk_suppgid1_h;
2439 __u32 lk_suppgid2_h;
2440 struct lu_fid lk_fid1;
2441 struct lu_fid lk_fid2;
2443 __u64 lk_padding_1; /* rr_atime */
2444 __u64 lk_padding_2; /* rr_ctime */
2445 __u64 lk_padding_3; /* rr_size */
2446 __u64 lk_padding_4; /* rr_blocks */
2448 __u32 lk_padding_5; /* rr_mode */
2449 __u32 lk_padding_6; /* rr_flags */
2450 __u32 lk_padding_7; /* rr_padding_2 */
2451 __u32 lk_padding_8; /* rr_padding_3 */
2452 __u32 lk_padding_9; /* rr_padding_4 */
2455 /* instance of mdt_reint_rec */
2456 struct mdt_rec_unlink {
2464 __u32 ul_suppgid1_h;
2466 __u32 ul_suppgid2_h;
2467 struct lu_fid ul_fid1;
2468 struct lu_fid ul_fid2;
2470 __u64 ul_padding_2; /* rr_atime */
2471 __u64 ul_padding_3; /* rr_ctime */
2472 __u64 ul_padding_4; /* rr_size */
2473 __u64 ul_padding_5; /* rr_blocks */
2476 __u32 ul_padding_6; /* rr_flags */
2477 __u32 ul_padding_7; /* rr_padding_2 */
2478 __u32 ul_padding_8; /* rr_padding_3 */
2479 __u32 ul_padding_9; /* rr_padding_4 */
2482 /* instance of mdt_reint_rec */
2483 struct mdt_rec_rename {
2491 __u32 rn_suppgid1_h;
2493 __u32 rn_suppgid2_h;
2494 struct lu_fid rn_fid1;
2495 struct lu_fid rn_fid2;
2497 __u64 rn_padding_1; /* rr_atime */
2498 __u64 rn_padding_2; /* rr_ctime */
2499 __u64 rn_padding_3; /* rr_size */
2500 __u64 rn_padding_4; /* rr_blocks */
2501 __u32 rn_bias; /* some operation flags */
2502 __u32 rn_mode; /* cross-ref rename has mode */
2503 __u32 rn_padding_5; /* rr_flags */
2504 __u32 rn_padding_6; /* rr_padding_2 */
2505 __u32 rn_padding_7; /* rr_padding_3 */
2506 __u32 rn_padding_8; /* rr_padding_4 */
2509 /* instance of mdt_reint_rec */
2510 struct mdt_rec_setxattr {
2518 __u32 sx_suppgid1_h;
2520 __u32 sx_suppgid2_h;
2521 struct lu_fid sx_fid;
2522 __u64 sx_padding_1; /* These three are rr_fid2 */
2527 __u64 sx_padding_5; /* rr_ctime */
2528 __u64 sx_padding_6; /* rr_size */
2529 __u64 sx_padding_7; /* rr_blocks */
2532 __u32 sx_padding_8; /* rr_flags */
2533 __u32 sx_padding_9; /* rr_padding_2 */
2534 __u32 sx_padding_10; /* rr_padding_3 */
2535 __u32 sx_padding_11; /* rr_padding_4 */
2539 * mdt_rec_reint is the template for all mdt_reint_xxx structures.
2540 * Do NOT change the size of various members, otherwise the value
2541 * will be broken in lustre_swab_mdt_rec_reint().
2543 * If you add new members in other mdt_reint_xxx structres and need to use the
2544 * rr_padding_x fields, then update lustre_swab_mdt_rec_reint() also.
2546 struct mdt_rec_reint {
2554 __u32 rr_suppgid1_h;
2556 __u32 rr_suppgid2_h;
2557 struct lu_fid rr_fid1;
2558 struct lu_fid rr_fid2;
2569 __u32 rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
2572 extern void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
2575 __u32 ld_tgt_count; /* how many MDS's */
2576 __u32 ld_active_tgt_count; /* how many active */
2577 __u32 ld_default_stripe_count; /* how many objects are used */
2578 __u32 ld_pattern; /* default MEA_MAGIC_* */
2579 __u64 ld_default_hash_size;
2580 __u64 ld_padding_1; /* also fix lustre_swab_lmv_desc */
2581 __u32 ld_padding_2; /* also fix lustre_swab_lmv_desc */
2582 __u32 ld_qos_maxage; /* in second */
2583 __u32 ld_padding_3; /* also fix lustre_swab_lmv_desc */
2584 __u32 ld_padding_4; /* also fix lustre_swab_lmv_desc */
2585 struct obd_uuid ld_uuid;
2588 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
2590 /* TODO: lmv_stripe_md should contain mds capabilities for all slave fids */
2591 struct lmv_stripe_md {
2596 char mea_pool_name[LOV_MAXPOOLNAME];
2597 struct lu_fid mea_ids[0];
2600 extern void lustre_swab_lmv_stripe_md(struct lmv_stripe_md *mea);
2602 /* lmv structures */
2603 #define MEA_MAGIC_LAST_CHAR 0xb2221ca1
2604 #define MEA_MAGIC_ALL_CHARS 0xb222a11c
2605 #define MEA_MAGIC_HASH_SEGMENT 0xb222a11b
2607 #define MAX_HASH_SIZE_32 0x7fffffffUL
2608 #define MAX_HASH_SIZE 0x7fffffffffffffffULL
2609 #define MAX_HASH_HIGHEST_BIT 0x1000000000000000ULL
2614 FLD_FIRST_OPC = FLD_QUERY
2620 SEQ_FIRST_OPC = SEQ_QUERY
2624 SEQ_ALLOC_SUPER = 0,
2629 * LOV data structures
2632 #define LOV_MAX_UUID_BUFFER_SIZE 8192
2633 /* The size of the buffer the lov/mdc reserves for the
2634 * array of UUIDs returned by the MDS. With the current
2635 * protocol, this will limit the max number of OSTs per LOV */
2637 #define LOV_DESC_MAGIC 0xB0CCDE5C
2639 /* LOV settings descriptor (should only contain static info) */
2641 __u32 ld_tgt_count; /* how many OBD's */
2642 __u32 ld_active_tgt_count; /* how many active */
2643 __u32 ld_default_stripe_count; /* how many objects are used */
2644 __u32 ld_pattern; /* default PATTERN_RAID0 */
2645 __u64 ld_default_stripe_size; /* in bytes */
2646 __u64 ld_default_stripe_offset; /* in bytes */
2647 __u32 ld_padding_0; /* unused */
2648 __u32 ld_qos_maxage; /* in second */
2649 __u32 ld_padding_1; /* also fix lustre_swab_lov_desc */
2650 __u32 ld_padding_2; /* also fix lustre_swab_lov_desc */
2651 struct obd_uuid ld_uuid;
2654 #define ld_magic ld_active_tgt_count /* for swabbing from llogs */
2656 extern void lustre_swab_lov_desc (struct lov_desc *ld);
2661 /* opcodes -- MUST be distinct from OST/MDS opcodes */
2666 LDLM_BL_CALLBACK = 104,
2667 LDLM_CP_CALLBACK = 105,
2668 LDLM_GL_CALLBACK = 106,
2669 LDLM_SET_INFO = 107,
2672 #define LDLM_FIRST_OPC LDLM_ENQUEUE
2674 #define RES_NAME_SIZE 4
2675 struct ldlm_res_id {
2676 __u64 name[RES_NAME_SIZE];
2679 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
2681 static inline int ldlm_res_eq(const struct ldlm_res_id *res0,
2682 const struct ldlm_res_id *res1)
2684 return !memcmp(res0, res1, sizeof(*res0));
2701 #define LCK_MODE_NUM 8
2711 #define LDLM_MIN_TYPE LDLM_PLAIN
2713 struct ldlm_extent {
2719 static inline int ldlm_extent_overlap(struct ldlm_extent *ex1,
2720 struct ldlm_extent *ex2)
2722 return (ex1->start <= ex2->end) && (ex2->start <= ex1->end);
2725 /* check if @ex1 contains @ex2 */
2726 static inline int ldlm_extent_contain(struct ldlm_extent *ex1,
2727 struct ldlm_extent *ex2)
2729 return (ex1->start <= ex2->start) && (ex1->end >= ex2->end);
2732 struct ldlm_inodebits {
2736 struct ldlm_flock_wire {
2744 /* it's important that the fields of the ldlm_extent structure match
2745 * the first fields of the ldlm_flock structure because there is only
2746 * one ldlm_swab routine to process the ldlm_policy_data_t union. if
2747 * this ever changes we will need to swab the union differently based
2748 * on the resource type. */
2751 struct ldlm_extent l_extent;
2752 struct ldlm_flock_wire l_flock;
2753 struct ldlm_inodebits l_inodebits;
2754 } ldlm_wire_policy_data_t;
2756 extern void lustre_swab_ldlm_policy_data (ldlm_wire_policy_data_t *d);
2758 union ldlm_gl_desc {
2759 struct ldlm_gl_lquota_desc lquota_desc;
2762 extern void lustre_swab_gl_desc(union ldlm_gl_desc *);
2764 struct ldlm_intent {
2768 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
2770 struct ldlm_resource_desc {
2771 ldlm_type_t lr_type;
2772 __u32 lr_padding; /* also fix lustre_swab_ldlm_resource_desc */
2773 struct ldlm_res_id lr_name;
2776 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
2778 struct ldlm_lock_desc {
2779 struct ldlm_resource_desc l_resource;
2780 ldlm_mode_t l_req_mode;
2781 ldlm_mode_t l_granted_mode;
2782 ldlm_wire_policy_data_t l_policy_data;
2785 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
2787 #define LDLM_LOCKREQ_HANDLES 2
2788 #define LDLM_ENQUEUE_CANCEL_OFF 1
2790 struct ldlm_request {
2793 struct ldlm_lock_desc lock_desc;
2794 struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
2797 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
2799 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
2800 * Otherwise, 2 are available. */
2801 #define ldlm_request_bufsize(count,type) \
2803 int _avail = LDLM_LOCKREQ_HANDLES; \
2804 _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
2805 sizeof(struct ldlm_request) + \
2806 (count > _avail ? count - _avail : 0) * \
2807 sizeof(struct lustre_handle); \
2812 __u32 lock_padding; /* also fix lustre_swab_ldlm_reply */
2813 struct ldlm_lock_desc lock_desc;
2814 struct lustre_handle lock_handle;
2815 __u64 lock_policy_res1;
2816 __u64 lock_policy_res2;
2819 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
2821 #define ldlm_flags_to_wire(flags) ((__u32)(flags))
2822 #define ldlm_flags_from_wire(flags) ((__u64)(flags))
2825 * Opcodes for mountconf (mgs and mgc)
2830 MGS_EXCEPTION, /* node died, etc. */
2831 MGS_TARGET_REG, /* whenever target starts up */
2837 #define MGS_FIRST_OPC MGS_CONNECT
2839 #define MGS_PARAM_MAXLEN 1024
2840 #define KEY_SET_INFO "set_info"
2842 struct mgs_send_param {
2843 char mgs_param[MGS_PARAM_MAXLEN];
2846 /* We pass this info to the MGS so it can write config logs */
2847 #define MTI_NAME_MAXLEN 64
2848 #define MTI_PARAM_MAXLEN 4096
2849 #define MTI_NIDS_MAX 32
2850 struct mgs_target_info {
2851 __u32 mti_lustre_ver;
2852 __u32 mti_stripe_index;
2853 __u32 mti_config_ver;
2855 __u32 mti_nid_count;
2856 __u32 mti_instance; /* Running instance of target */
2857 char mti_fsname[MTI_NAME_MAXLEN];
2858 char mti_svname[MTI_NAME_MAXLEN];
2859 char mti_uuid[sizeof(struct obd_uuid)];
2860 __u64 mti_nids[MTI_NIDS_MAX]; /* host nids (lnet_nid_t)*/
2861 char mti_params[MTI_PARAM_MAXLEN];
2863 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
2865 struct mgs_nidtbl_entry {
2866 __u64 mne_version; /* table version of this entry */
2867 __u32 mne_instance; /* target instance # */
2868 __u32 mne_index; /* target index */
2869 __u32 mne_length; /* length of this entry - by bytes */
2870 __u8 mne_type; /* target type LDD_F_SV_TYPE_OST/MDT */
2871 __u8 mne_nid_type; /* type of nid(mbz). for ipv6. */
2872 __u8 mne_nid_size; /* size of each NID, by bytes */
2873 __u8 mne_nid_count; /* # of NIDs in buffer */
2875 lnet_nid_t nids[0]; /* variable size buffer for NIDs. */
2878 extern void lustre_swab_mgs_nidtbl_entry(struct mgs_nidtbl_entry *oinfo);
2880 struct mgs_config_body {
2881 char mcb_name[MTI_NAME_MAXLEN]; /* logname */
2882 __u64 mcb_offset; /* next index of config log to request */
2883 __u16 mcb_type; /* type of log: CONFIG_T_[CONFIG|RECOVER] */
2885 __u8 mcb_bits; /* bits unit size of config log */
2886 __u32 mcb_units; /* # of units for bulk transfer */
2888 extern void lustre_swab_mgs_config_body(struct mgs_config_body *body);
2890 struct mgs_config_res {
2891 __u64 mcr_offset; /* index of last config log */
2892 __u64 mcr_size; /* size of the log */
2894 extern void lustre_swab_mgs_config_res(struct mgs_config_res *body);
2896 /* Config marker flags (in config log) */
2897 #define CM_START 0x01
2899 #define CM_SKIP 0x04
2900 #define CM_UPGRADE146 0x08
2901 #define CM_EXCLUDE 0x10
2902 #define CM_START_SKIP (CM_START | CM_SKIP)
2905 __u32 cm_step; /* aka config version */
2907 __u32 cm_vers; /* lustre release version number */
2908 __u32 cm_padding; /* 64 bit align */
2909 obd_time cm_createtime; /*when this record was first created */
2910 obd_time cm_canceltime; /*when this record is no longer valid*/
2911 char cm_tgtname[MTI_NAME_MAXLEN];
2912 char cm_comment[MTI_NAME_MAXLEN];
2915 extern void lustre_swab_cfg_marker(struct cfg_marker *marker,
2916 int swab, int size);
2919 * Opcodes for multiple servers.
2929 #define OBD_FIRST_OPC OBD_PING
2931 /* catalog of log objects */
2933 /** Identifier for a single log object */
2935 struct ost_id lgl_oi;
2937 } __attribute__((packed));
2939 /** Records written to the CATALOGS list */
2940 #define CATLIST "CATALOGS"
2942 struct llog_logid lci_logid;
2946 } __attribute__((packed));
2948 /* Log data record types - there is no specific reason that these need to
2949 * be related to the RPC opcodes, but no reason not to (may be handy later?)
2951 #define LLOG_OP_MAGIC 0x10600000
2952 #define LLOG_OP_MASK 0xfff00000
2955 LLOG_PAD_MAGIC = LLOG_OP_MAGIC | 0x00000,
2956 OST_SZ_REC = LLOG_OP_MAGIC | 0x00f00,
2957 /* OST_RAID1_REC = LLOG_OP_MAGIC | 0x01000, never used */
2958 MDS_UNLINK_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) |
2959 REINT_UNLINK, /* obsolete after 2.5.0 */
2960 MDS_UNLINK64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2962 /* MDS_SETATTR_REC = LLOG_OP_MAGIC | 0x12401, obsolete 1.8.0 */
2963 MDS_SETATTR64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2965 OBD_CFG_REC = LLOG_OP_MAGIC | 0x20000,
2966 /* PTL_CFG_REC = LLOG_OP_MAGIC | 0x30000, obsolete 1.4.0 */
2967 LLOG_GEN_REC = LLOG_OP_MAGIC | 0x40000,
2968 /* LLOG_JOIN_REC = LLOG_OP_MAGIC | 0x50000, obsolete 1.8.0 */
2969 CHANGELOG_REC = LLOG_OP_MAGIC | 0x60000,
2970 CHANGELOG_USER_REC = LLOG_OP_MAGIC | 0x70000,
2971 LLOG_HDR_MAGIC = LLOG_OP_MAGIC | 0x45539,
2972 LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
2975 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
2976 (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == __swab32(LLOG_OP_MAGIC))
2978 /** Log record header - stored in little endian order.
2979 * Each record must start with this struct, end with a llog_rec_tail,
2980 * and be a multiple of 256 bits in size.
2982 struct llog_rec_hdr {
2989 struct llog_rec_tail {
2994 /* Where data follow just after header */
2995 #define REC_DATA(ptr) \
2996 ((void *)((char *)ptr + sizeof(struct llog_rec_hdr)))
2998 #define REC_DATA_LEN(rec) \
2999 (rec->lrh_len - sizeof(struct llog_rec_hdr) - \
3000 sizeof(struct llog_rec_tail))
3002 struct llog_logid_rec {
3003 struct llog_rec_hdr lid_hdr;
3004 struct llog_logid lid_id;
3008 struct llog_rec_tail lid_tail;
3009 } __attribute__((packed));
3011 struct llog_unlink_rec {
3012 struct llog_rec_hdr lur_hdr;
3015 obd_count lur_count;
3016 struct llog_rec_tail lur_tail;
3017 } __attribute__((packed));
3019 struct llog_unlink64_rec {
3020 struct llog_rec_hdr lur_hdr;
3021 struct lu_fid lur_fid;
3022 obd_count lur_count; /* to destroy the lost precreated */
3026 struct llog_rec_tail lur_tail;
3027 } __attribute__((packed));
3029 struct llog_setattr64_rec {
3030 struct llog_rec_hdr lsr_hdr;
3031 struct ost_id lsr_oi;
3037 struct llog_rec_tail lsr_tail;
3038 } __attribute__((packed));
3040 struct llog_size_change_rec {
3041 struct llog_rec_hdr lsc_hdr;
3042 struct ll_fid lsc_fid;
3047 struct llog_rec_tail lsc_tail;
3048 } __attribute__((packed));
3050 #define CHANGELOG_MAGIC 0xca103000
3052 /** \a changelog_rec_type's that can't be masked */
3053 #define CHANGELOG_MINMASK (1 << CL_MARK)
3054 /** bits covering all \a changelog_rec_type's */
3055 #define CHANGELOG_ALLMASK 0XFFFFFFFF
3056 /** default \a changelog_rec_type mask */
3057 #define CHANGELOG_DEFMASK CHANGELOG_ALLMASK & ~(1 << CL_ATIME | 1 << CL_CLOSE)
3059 /* changelog llog name, needed by client replicators */
3060 #define CHANGELOG_CATALOG "changelog_catalog"
3062 struct changelog_setinfo {
3065 } __attribute__((packed));
3067 /** changelog record */
3068 struct llog_changelog_rec {
3069 struct llog_rec_hdr cr_hdr;
3070 struct changelog_rec cr;
3071 struct llog_rec_tail cr_tail; /**< for_sizezof_only */
3072 } __attribute__((packed));
3074 struct llog_changelog_ext_rec {
3075 struct llog_rec_hdr cr_hdr;
3076 struct changelog_ext_rec cr;
3077 struct llog_rec_tail cr_tail; /**< for_sizezof_only */
3078 } __attribute__((packed));
3080 #define CHANGELOG_USER_PREFIX "cl"
3082 struct llog_changelog_user_rec {
3083 struct llog_rec_hdr cur_hdr;
3087 struct llog_rec_tail cur_tail;
3088 } __attribute__((packed));
3090 /* Old llog gen for compatibility */
3094 } __attribute__((packed));
3096 struct llog_gen_rec {
3097 struct llog_rec_hdr lgr_hdr;
3098 struct llog_gen lgr_gen;
3102 struct llog_rec_tail lgr_tail;
3105 /* On-disk header structure of each log object, stored in little endian order */
3106 #define LLOG_CHUNK_SIZE 8192
3107 #define LLOG_HEADER_SIZE (96)
3108 #define LLOG_BITMAP_BYTES (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
3110 #define LLOG_MIN_REC_SIZE (24) /* round(llog_rec_hdr + llog_rec_tail) */
3112 /* flags for the logs */
3114 LLOG_F_ZAP_WHEN_EMPTY = 0x1,
3115 LLOG_F_IS_CAT = 0x2,
3116 LLOG_F_IS_PLAIN = 0x4,
3119 struct llog_log_hdr {
3120 struct llog_rec_hdr llh_hdr;
3121 obd_time llh_timestamp;
3123 __u32 llh_bitmap_offset;
3127 /* for a catalog the first plain slot is next to it */
3128 struct obd_uuid llh_tgtuuid;
3129 __u32 llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
3130 __u32 llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
3131 struct llog_rec_tail llh_tail;
3132 } __attribute__((packed));
3134 #define LLOG_BITMAP_SIZE(llh) (__u32)((llh->llh_hdr.lrh_len - \
3135 llh->llh_bitmap_offset - \
3136 sizeof(llh->llh_tail)) * 8)
3138 /** log cookies are used to reference a specific log file and a record therein */
3139 struct llog_cookie {
3140 struct llog_logid lgc_lgl;
3144 } __attribute__((packed));
3146 /** llog protocol */
3147 enum llogd_rpc_ops {
3148 LLOG_ORIGIN_HANDLE_CREATE = 501,
3149 LLOG_ORIGIN_HANDLE_NEXT_BLOCK = 502,
3150 LLOG_ORIGIN_HANDLE_READ_HEADER = 503,
3151 LLOG_ORIGIN_HANDLE_WRITE_REC = 504,
3152 LLOG_ORIGIN_HANDLE_CLOSE = 505,
3153 LLOG_ORIGIN_CONNECT = 506,
3154 LLOG_CATINFO = 507, /* deprecated */
3155 LLOG_ORIGIN_HANDLE_PREV_BLOCK = 508,
3156 LLOG_ORIGIN_HANDLE_DESTROY = 509, /* for destroy llog object*/
3158 LLOG_FIRST_OPC = LLOG_ORIGIN_HANDLE_CREATE
3162 struct llog_logid lgd_logid;
3164 __u32 lgd_llh_flags;
3166 __u32 lgd_saved_index;
3168 __u64 lgd_cur_offset;
3169 } __attribute__((packed));
3171 struct llogd_conn_body {
3172 struct llog_gen lgdc_gen;
3173 struct llog_logid lgdc_logid;
3174 __u32 lgdc_ctxt_idx;
3175 } __attribute__((packed));
3177 /* Note: 64-bit types are 64-bit aligned in structure */
3179 obd_valid o_valid; /* hot fields in this obdo */
3181 obd_id o_parent_seq;
3182 obd_size o_size; /* o_size-o_blocks == ost_lvb */
3186 obd_blocks o_blocks; /* brw: cli sent cached bytes */
3189 /* 32-bit fields start here: keep an even number of them via padding */
3190 obd_blksize o_blksize; /* optimal IO blocksize */
3191 obd_mode o_mode; /* brw: cli sent cache remain */
3195 obd_count o_nlink; /* brw: checksum */
3196 obd_count o_parent_oid;
3197 obd_count o_misc; /* brw: o_dropped */
3199 __u64 o_ioepoch; /* epoch in ost writes */
3200 __u32 o_stripe_idx; /* holds stripe idx */
3202 struct lustre_handle o_handle; /* brw: lock handle to prolong
3204 struct llog_cookie o_lcookie; /* destroy: unlink cookie from
3209 __u64 o_data_version; /* getattr: sum of iversion for
3211 * brw: grant space consumed on
3212 * the client for the write */
3218 #define o_dirty o_blocks
3219 #define o_undirty o_mode
3220 #define o_dropped o_misc
3221 #define o_cksum o_nlink
3222 #define o_grant_used o_data_version
3224 static inline void lustre_set_wire_obdo(struct obdo *wobdo, struct obdo *lobdo)
3226 memcpy(wobdo, lobdo, sizeof(*lobdo));
3227 wobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
3230 static inline void lustre_get_wire_obdo(struct obdo *lobdo, struct obdo *wobdo)
3232 obd_flag local_flags = 0;
3234 if (lobdo->o_valid & OBD_MD_FLFLAGS)
3235 local_flags = lobdo->o_flags & OBD_FL_LOCAL_MASK;
3237 LASSERT(!(wobdo->o_flags & OBD_FL_LOCAL_MASK));
3239 memcpy(lobdo, wobdo, sizeof(*lobdo));
3240 if (local_flags != 0) {
3241 lobdo->o_valid |= OBD_MD_FLFLAGS;
3242 lobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
3243 lobdo->o_flags |= local_flags;
3247 extern void lustre_swab_obdo (struct obdo *o);
3249 /* request structure for OST's */
3254 /* Key for FIEMAP to be used in get_info calls */
3255 struct ll_fiemap_info_key {
3258 struct ll_user_fiemap fiemap;
3261 extern void lustre_swab_ost_body (struct ost_body *b);
3262 extern void lustre_swab_ost_last_id(obd_id *id);
3263 extern void lustre_swab_fiemap(struct ll_user_fiemap *fiemap);
3265 extern void lustre_swab_lov_user_md_v1(struct lov_user_md_v1 *lum);
3266 extern void lustre_swab_lov_user_md_v3(struct lov_user_md_v3 *lum);
3267 extern void lustre_swab_lov_user_md_objects(struct lov_user_ost_data *lod,
3269 extern void lustre_swab_lov_mds_md(struct lov_mds_md *lmm);
3272 extern void lustre_swab_llogd_body (struct llogd_body *d);
3273 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
3274 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
3275 extern void lustre_swab_llog_rec(struct llog_rec_hdr *rec);
3278 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
3280 /* Functions for dumping PTLRPC fields */
3281 void dump_rniobuf(struct niobuf_remote *rnb);
3282 void dump_ioo(struct obd_ioobj *nb);
3283 void dump_obdo(struct obdo *oa);
3284 void dump_ost_body(struct ost_body *ob);
3285 void dump_rcs(__u32 *rc);
3287 #define IDX_INFO_MAGIC 0x3D37CC37
3289 /* Index file transfer through the network. The server serializes the index into
3290 * a byte stream which is sent to the client via a bulk transfer */
3294 /* reply: see idx_info_flags below */
3297 /* request & reply: number of lu_idxpage (to be) transferred */
3301 /* request: requested attributes passed down to the iterator API */
3304 /* request & reply: index file identifier (FID) */
3305 struct lu_fid ii_fid;
3307 /* reply: version of the index file before starting to walk the index.
3308 * Please note that the version can be modified at any time during the
3312 /* request: hash to start with:
3313 * reply: hash of the first entry of the first lu_idxpage and hash
3314 * of the entry to read next if any */
3315 __u64 ii_hash_start;
3318 /* reply: size of keys in lu_idxpages, minimal one if II_FL_VARKEY is
3322 /* reply: size of records in lu_idxpages, minimal one if II_FL_VARREC
3330 extern void lustre_swab_idx_info(struct idx_info *ii);
3332 #define II_END_OFF MDS_DIR_END_OFF /* all entries have been read */
3334 /* List of flags used in idx_info::ii_flags */
3335 enum idx_info_flags {
3336 II_FL_NOHASH = 1 << 0, /* client doesn't care about hash value */
3337 II_FL_VARKEY = 1 << 1, /* keys can be of variable size */
3338 II_FL_VARREC = 1 << 2, /* records can be of variable size */
3339 II_FL_NONUNQ = 1 << 3, /* index supports non-unique keys */
3342 #define LIP_MAGIC 0x8A6D6B6C
3344 /* 4KB (= LU_PAGE_SIZE) container gathering key/record pairs */
3346 /* 16-byte header */
3349 __u16 lip_nr; /* number of entries in the container */
3350 __u64 lip_pad0; /* additional padding for future use */
3352 /* key/record pairs are stored in the remaining 4080 bytes.
3353 * depending upon the flags in idx_info::ii_flags, each key/record
3354 * pair might be preceded by:
3356 * - the key size (II_FL_VARKEY is set)
3357 * - the record size (II_FL_VARREC is set)
3359 * For the time being, we only support fixed-size key & record. */
3360 char lip_entries[0];
3362 extern void lustre_swab_lip_header(struct lu_idxpage *lip);
3364 #define LIP_HDR_SIZE (offsetof(struct lu_idxpage, lip_entries))
3366 /* Gather all possible type associated with a 4KB container */
3368 struct lu_dirpage lp_dir; /* for MDS_READPAGE */
3369 struct lu_idxpage lp_idx; /* for OBD_IDX_READ */
3370 char lp_array[LU_PAGE_SIZE];
3373 /* security opcodes */
3376 SEC_CTX_INIT_CONT = 802,
3379 SEC_FIRST_OPC = SEC_CTX_INIT
3383 * capa related definitions
3385 #define CAPA_HMAC_MAX_LEN 64
3386 #define CAPA_HMAC_KEY_MAX_LEN 56
3388 /* NB take care when changing the sequence of elements this struct,
3389 * because the offset info is used in find_capa() */
3390 struct lustre_capa {
3391 struct lu_fid lc_fid; /** fid */
3392 __u64 lc_opc; /** operations allowed */
3393 __u64 lc_uid; /** file owner */
3394 __u64 lc_gid; /** file group */
3395 __u32 lc_flags; /** HMAC algorithm & flags */
3396 __u32 lc_keyid; /** key# used for the capability */
3397 __u32 lc_timeout; /** capa timeout value (sec) */
3398 __u32 lc_expiry; /** expiry time (sec) */
3399 __u8 lc_hmac[CAPA_HMAC_MAX_LEN]; /** HMAC */
3400 } __attribute__((packed));
3402 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
3404 /** lustre_capa::lc_opc */
3406 CAPA_OPC_BODY_WRITE = 1<<0, /**< write object data */
3407 CAPA_OPC_BODY_READ = 1<<1, /**< read object data */
3408 CAPA_OPC_INDEX_LOOKUP = 1<<2, /**< lookup object fid */
3409 CAPA_OPC_INDEX_INSERT = 1<<3, /**< insert object fid */
3410 CAPA_OPC_INDEX_DELETE = 1<<4, /**< delete object fid */
3411 CAPA_OPC_OSS_WRITE = 1<<5, /**< write oss object data */
3412 CAPA_OPC_OSS_READ = 1<<6, /**< read oss object data */
3413 CAPA_OPC_OSS_TRUNC = 1<<7, /**< truncate oss object */
3414 CAPA_OPC_OSS_DESTROY = 1<<8, /**< destroy oss object */
3415 CAPA_OPC_META_WRITE = 1<<9, /**< write object meta data */
3416 CAPA_OPC_META_READ = 1<<10, /**< read object meta data */
3419 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
3420 #define CAPA_OPC_MDS_ONLY \
3421 (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
3422 CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
3423 #define CAPA_OPC_OSS_ONLY \
3424 (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC | \
3425 CAPA_OPC_OSS_DESTROY)
3426 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
3427 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
3429 /* MDS capability covers object capability for operations of body r/w
3430 * (dir readpage/sendpage), index lookup/insert/delete and meta data r/w,
3431 * while OSS capability only covers object capability for operations of
3432 * oss data(file content) r/w/truncate.
3434 static inline int capa_for_mds(struct lustre_capa *c)
3436 return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) != 0;
3439 static inline int capa_for_oss(struct lustre_capa *c)
3441 return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) == 0;
3444 /* lustre_capa::lc_hmac_alg */
3446 CAPA_HMAC_ALG_SHA1 = 1, /**< sha1 algorithm */
3450 #define CAPA_FL_MASK 0x00ffffff
3451 #define CAPA_HMAC_ALG_MASK 0xff000000
3453 struct lustre_capa_key {
3454 __u64 lk_seq; /**< mds# */
3455 __u32 lk_keyid; /**< key# */
3457 __u8 lk_key[CAPA_HMAC_KEY_MAX_LEN]; /**< key */
3458 } __attribute__((packed));
3460 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
3462 /** The link ea holds 1 \a link_ea_entry for each hardlink */
3463 #define LINK_EA_MAGIC 0x11EAF1DFUL
3464 struct link_ea_header {
3467 __u64 leh_len; /* total size */
3473 /** Hardlink data is name and parent fid.
3474 * Stored in this crazy struct for maximum packing and endian-neutrality
3476 struct link_ea_entry {
3477 /** __u16 stored big-endian, unaligned */
3478 unsigned char lee_reclen[2];
3479 unsigned char lee_parent_fid[sizeof(struct lu_fid)];
3481 }__attribute__((packed));
3483 /** fid2path request/reply structure */
3484 struct getinfo_fid2path {
3485 struct lu_fid gf_fid;
3490 } __attribute__((packed));
3492 void lustre_swab_fid2path (struct getinfo_fid2path *gf);
3495 LAYOUT_INTENT_ACCESS = 0,
3496 LAYOUT_INTENT_READ = 1,
3497 LAYOUT_INTENT_WRITE = 2,
3498 LAYOUT_INTENT_GLIMPSE = 3,
3499 LAYOUT_INTENT_TRUNC = 4,
3500 LAYOUT_INTENT_RELEASE = 5,
3501 LAYOUT_INTENT_RESTORE = 6
3504 /* enqueue layout lock with intent */
3505 struct layout_intent {
3506 __u32 li_opc; /* intent operation for enqueue, read, write etc */
3512 void lustre_swab_layout_intent(struct layout_intent *li);
3515 * On the wire version of hsm_progress structure.
3517 * Contains the userspace hsm_progress and some internal fields.
3519 struct hsm_progress_kernel {
3520 /* Field taken from struct hsm_progress */
3523 struct hsm_extent hpk_extent;
3525 __u16 hpk_errval; /* positive val */
3527 /* Additional fields */
3528 __u64 hpk_data_version;
3530 } __attribute__((packed));
3532 extern void lustre_swab_hsm_user_state(struct hsm_user_state *hus);
3533 extern void lustre_swab_hsm_current_action(struct hsm_current_action *action);
3534 extern void lustre_swab_hsm_progress_kernel(struct hsm_progress_kernel *hpk);
3535 extern void lustre_swab_hsm_user_state(struct hsm_user_state *hus);
3536 extern void lustre_swab_hsm_user_item(struct hsm_user_item *hui);
3537 extern void lustre_swab_hsm_request(struct hsm_request *hr);
3540 * These are object update opcode under UPDATE_OBJ, which is currently
3541 * being used by cross-ref operations between MDT.
3543 * During the cross-ref operation, the Master MDT, which the client send the
3544 * request to, will disassembly the operation into object updates, then OSP
3545 * will send these updates to the remote MDT to be executed.
3547 * Update request format
3548 * magic: UPDATE_BUFFER_MAGIC_V1
3549 * Count: How many updates in the req.
3550 * bufs[0] : following are packets of object.
3552 * type: object_update_op, the op code of update
3553 * fid: The object fid of the update.
3554 * lens/bufs: other parameters of the update.
3556 * type: object_update_op, the op code of update
3557 * fid: The object fid of the update.
3558 * lens/bufs: other parameters of the update.
3560 * update[7]: type: object_update_op, the op code of update
3561 * fid: The object fid of the update.
3562 * lens/bufs: other parameters of the update.
3563 * Current 8 maxim updates per object update request.
3565 *******************************************************************
3566 * update reply format:
3568 * ur_version: UPDATE_REPLY_V1
3569 * ur_count: The count of the reply, which is usually equal
3570 * to the number of updates in the request.
3571 * ur_lens: The reply lengths of each object update.
3573 * replies: 1st update reply [4bytes_ret: other body]
3574 * 2nd update reply [4bytes_ret: other body]
3576 * nth update reply [4bytes_ret: other body]
3578 * For each reply of the update, the format would be
3579 * result(4 bytes):Other stuff
3582 #define UPDATE_MAX_OPS 10
3583 #define UPDATE_BUFFER_MAGIC_V1 0xBDDE0001
3584 #define UPDATE_BUFFER_MAGIC UPDATE_BUFFER_MAGIC_V1
3585 #define UPDATE_BUF_COUNT 8
3586 enum object_update_op {
3595 OBJ_INDEX_LOOKUP = 9,
3596 OBJ_INDEX_INSERT = 10,
3597 OBJ_INDEX_DELETE = 11,
3604 struct lu_fid u_fid;
3605 __u32 u_lens[UPDATE_BUF_COUNT];
3615 #define UPDATE_REPLY_V1 0x00BD0001
3616 struct update_reply {
3622 void lustre_swab_update_buf(struct update_buf *ub);
3623 void lustre_swab_update_reply_buf(struct update_reply *ur);
3625 /** layout swap request structure
3626 * fid1 and fid2 are in mdt_body
3628 struct mdc_swap_layouts {
3632 void lustre_swab_swap_layouts(struct mdc_swap_layouts *msl);