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, 2013, 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>
101 #include <lustre/lustre_errno.h>
106 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
107 * FOO_REPLY_PORTAL is for incoming replies on the FOO
108 * FOO_BULK_PORTAL is for incoming bulk on the FOO
111 #define CONNMGR_REQUEST_PORTAL 1
112 #define CONNMGR_REPLY_PORTAL 2
113 //#define OSC_REQUEST_PORTAL 3
114 #define OSC_REPLY_PORTAL 4
115 //#define OSC_BULK_PORTAL 5
116 #define OST_IO_PORTAL 6
117 #define OST_CREATE_PORTAL 7
118 #define OST_BULK_PORTAL 8
119 //#define MDC_REQUEST_PORTAL 9
120 #define MDC_REPLY_PORTAL 10
121 //#define MDC_BULK_PORTAL 11
122 #define MDS_REQUEST_PORTAL 12
123 //#define MDS_REPLY_PORTAL 13
124 #define MDS_BULK_PORTAL 14
125 #define LDLM_CB_REQUEST_PORTAL 15
126 #define LDLM_CB_REPLY_PORTAL 16
127 #define LDLM_CANCEL_REQUEST_PORTAL 17
128 #define LDLM_CANCEL_REPLY_PORTAL 18
129 //#define PTLBD_REQUEST_PORTAL 19
130 //#define PTLBD_REPLY_PORTAL 20
131 //#define PTLBD_BULK_PORTAL 21
132 #define MDS_SETATTR_PORTAL 22
133 #define MDS_READPAGE_PORTAL 23
134 #define MDS_MDS_PORTAL 24
136 #define MGC_REPLY_PORTAL 25
137 #define MGS_REQUEST_PORTAL 26
138 #define MGS_REPLY_PORTAL 27
139 #define OST_REQUEST_PORTAL 28
140 #define FLD_REQUEST_PORTAL 29
141 #define SEQ_METADATA_PORTAL 30
142 #define SEQ_DATA_PORTAL 31
143 #define SEQ_CONTROLLER_PORTAL 32
144 #define MGS_BULK_PORTAL 33
146 /* Portal 63 is reserved for the Cray Inc DVS - nic@cray.com, roe@cray.com, n8851@cray.com */
149 #define PTL_RPC_MSG_REQUEST 4711
150 #define PTL_RPC_MSG_ERR 4712
151 #define PTL_RPC_MSG_REPLY 4713
153 /* DON'T use swabbed values of MAGIC as magic! */
154 #define LUSTRE_MSG_MAGIC_V1 0x0BD00BD0
155 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
157 #define LUSTRE_MSG_MAGIC_V1_SWABBED 0xD00BD00B
158 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
160 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
162 #define PTLRPC_MSG_VERSION 0x00000003
163 #define LUSTRE_VERSION_MASK 0xffff0000
164 #define LUSTRE_OBD_VERSION 0x00010000
165 #define LUSTRE_MDS_VERSION 0x00020000
166 #define LUSTRE_OST_VERSION 0x00030000
167 #define LUSTRE_DLM_VERSION 0x00040000
168 #define LUSTRE_LOG_VERSION 0x00050000
169 #define LUSTRE_MGS_VERSION 0x00060000
171 typedef __u32 mdsno_t;
172 typedef __u64 seqno_t;
173 typedef __u64 obd_id;
174 typedef __u64 obd_seq;
175 typedef __s64 obd_time;
176 typedef __u64 obd_size;
177 typedef __u64 obd_off;
178 typedef __u64 obd_blocks;
179 typedef __u64 obd_valid;
180 typedef __u32 obd_blksize;
181 typedef __u32 obd_mode;
182 typedef __u32 obd_uid;
183 typedef __u32 obd_gid;
184 typedef __u32 obd_flag;
185 typedef __u32 obd_count;
188 * Describes a range of sequence, lsr_start is included but lsr_end is
190 * Same structure is used in fld module where lsr_index field holds mdt id
193 struct lu_seq_range {
200 #define LU_SEQ_RANGE_MDT 0x0
201 #define LU_SEQ_RANGE_OST 0x1
202 #define LU_SEQ_RANGE_ANY 0x3
204 #define LU_SEQ_RANGE_MASK 0x3
206 static inline unsigned fld_range_type(const struct lu_seq_range *range)
208 return range->lsr_flags & LU_SEQ_RANGE_MASK;
211 static inline int fld_range_is_ost(const struct lu_seq_range *range)
213 return fld_range_type(range) == LU_SEQ_RANGE_OST;
216 static inline int fld_range_is_mdt(const struct lu_seq_range *range)
218 return fld_range_type(range) == LU_SEQ_RANGE_MDT;
222 * This all range is only being used when fld client sends fld query request,
223 * but it does not know whether the seq is MDT or OST, so it will send req
224 * with ALL type, which means either seq type gotten from lookup can be
227 static inline unsigned fld_range_is_any(const struct lu_seq_range *range)
229 return fld_range_type(range) == LU_SEQ_RANGE_ANY;
232 static inline void fld_range_set_type(struct lu_seq_range *range,
235 LASSERT(!(flags & ~LU_SEQ_RANGE_MASK));
236 range->lsr_flags |= flags;
239 static inline void fld_range_set_mdt(struct lu_seq_range *range)
241 fld_range_set_type(range, LU_SEQ_RANGE_MDT);
244 static inline void fld_range_set_ost(struct lu_seq_range *range)
246 fld_range_set_type(range, LU_SEQ_RANGE_OST);
249 static inline void fld_range_set_any(struct lu_seq_range *range)
251 fld_range_set_type(range, LU_SEQ_RANGE_ANY);
255 * returns width of given range \a r
258 static inline __u64 range_space(const struct lu_seq_range *range)
260 return range->lsr_end - range->lsr_start;
264 * initialize range to zero
267 static inline void range_init(struct lu_seq_range *range)
269 range->lsr_start = range->lsr_end = range->lsr_index = 0;
273 * check if given seq id \a s is within given range \a r
276 static inline int range_within(const struct lu_seq_range *range,
279 return s >= range->lsr_start && s < range->lsr_end;
282 static inline int range_is_sane(const struct lu_seq_range *range)
284 return (range->lsr_end >= range->lsr_start);
287 static inline int range_is_zero(const struct lu_seq_range *range)
289 return (range->lsr_start == 0 && range->lsr_end == 0);
292 static inline int range_is_exhausted(const struct lu_seq_range *range)
295 return range_space(range) == 0;
298 /* return 0 if two range have the same location */
299 static inline int range_compare_loc(const struct lu_seq_range *r1,
300 const struct lu_seq_range *r2)
302 return r1->lsr_index != r2->lsr_index ||
303 r1->lsr_flags != r2->lsr_flags;
306 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x):%x:%s"
308 #define PRANGE(range) \
309 (range)->lsr_start, \
311 (range)->lsr_index, \
312 fld_range_is_mdt(range) ? "mdt" : "ost"
315 /** \defgroup lu_fid lu_fid
319 * Flags for lustre_mdt_attrs::lma_compat and lustre_mdt_attrs::lma_incompat.
320 * Deprecated since HSM and SOM attributes are now stored in separate on-disk
324 LMAC_HSM = 0x00000001,
325 LMAC_SOM = 0x00000002,
329 * Masks for all features that should be supported by a Lustre version to
330 * access a specific file.
331 * This information is stored in lustre_mdt_attrs::lma_incompat.
334 LMAI_RELEASED = 0x0000001, /* file is released */
335 LMAI_AGENT = 0x00000002, /* agent inode */
336 LMAI_REMOTE_PARENT = 0x00000004, /* the parent of the object
337 is on the remote MDT */
339 #define LMA_INCOMPAT_SUPP (LMAI_AGENT | LMAI_REMOTE_PARENT)
341 extern void lustre_lma_swab(struct lustre_mdt_attrs *lma);
342 extern void lustre_lma_init(struct lustre_mdt_attrs *lma,
343 const struct lu_fid *fid, __u32 incompat);
345 * SOM on-disk attributes stored in a separate xattr.
348 /** Bitfield for supported data in this structure. For future use. */
351 /** Incompat feature list. The supported feature mask is availabe in
352 * SOM_INCOMPAT_SUPP */
355 /** IO Epoch SOM attributes belongs to */
357 /** total file size in objects */
359 /** total fs blocks in objects */
361 /** mds mount id the size is valid for */
364 extern void lustre_som_swab(struct som_attrs *attrs);
366 #define SOM_INCOMPAT_SUPP 0x0
369 * HSM on-disk attributes stored in a separate xattr.
372 /** Bitfield for supported data in this structure. For future use. */
375 /** HSM flags, see hsm_flags enum below */
377 /** backend archive id associated with the file */
379 /** version associated with the last archiving, if any */
382 extern void lustre_hsm_swab(struct hsm_attrs *attrs);
388 /** LASTID file has zero OID */
389 LUSTRE_FID_LASTID_OID = 0UL,
390 /** initial fid id value */
391 LUSTRE_FID_INIT_OID = 1UL
394 /** returns fid object sequence */
395 static inline __u64 fid_seq(const struct lu_fid *fid)
400 /** returns fid object id */
401 static inline __u32 fid_oid(const struct lu_fid *fid)
406 /** returns fid object version */
407 static inline __u32 fid_ver(const struct lu_fid *fid)
412 static inline void fid_zero(struct lu_fid *fid)
414 memset(fid, 0, sizeof(*fid));
417 static inline obd_id fid_ver_oid(const struct lu_fid *fid)
419 return ((__u64)fid_ver(fid) << 32 | fid_oid(fid));
423 * Note that reserved SEQ numbers below 12 will conflict with ldiskfs
424 * inodes in the IGIF namespace, so these reserved SEQ numbers can be
425 * used for other purposes and not risk collisions with existing inodes.
427 * Different FID Format
428 * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs#NEW.0
431 FID_SEQ_OST_MDT0 = 0,
432 FID_SEQ_LLOG = 1, /* unnamed llogs */
434 FID_SEQ_OST_MDT1 = 3,
435 FID_SEQ_OST_MAX = 9, /* Max MDT count before OST_on_FID */
436 FID_SEQ_LLOG_NAME = 10, /* named llogs */
439 FID_SEQ_IGIF_MAX = 0x0ffffffffULL,
440 FID_SEQ_IDIF = 0x100000000ULL,
441 FID_SEQ_IDIF_MAX = 0x1ffffffffULL,
442 /* Normal FID sequence starts from this value, i.e. 1<<33 */
443 FID_SEQ_START = 0x200000000ULL,
444 /* sequence for local pre-defined FIDs listed in local_oid */
445 FID_SEQ_LOCAL_FILE = 0x200000001ULL,
446 FID_SEQ_DOT_LUSTRE = 0x200000002ULL,
447 /* sequence is used for local named objects FIDs generated
448 * by local_object_storage library */
449 FID_SEQ_LOCAL_NAME = 0x200000003ULL,
450 /* Because current FLD will only cache the fid sequence, instead
451 * of oid on the client side, if the FID needs to be exposed to
452 * clients sides, it needs to make sure all of fids under one
453 * sequence will be located in one MDT. */
454 FID_SEQ_SPECIAL = 0x200000004ULL,
455 FID_SEQ_QUOTA = 0x200000005ULL,
456 FID_SEQ_QUOTA_GLB = 0x200000006ULL,
457 FID_SEQ_ROOT = 0x200000007ULL, /* Located on MDT0 */
458 FID_SEQ_NORMAL = 0x200000400ULL,
459 FID_SEQ_LOV_DEFAULT = 0xffffffffffffffffULL
462 #define OBIF_OID_MAX_BITS 32
463 #define OBIF_MAX_OID (1ULL << OBIF_OID_MAX_BITS)
464 #define OBIF_OID_MASK ((1ULL << OBIF_OID_MAX_BITS) - 1)
465 #define IDIF_OID_MAX_BITS 48
466 #define IDIF_MAX_OID (1ULL << IDIF_OID_MAX_BITS)
467 #define IDIF_OID_MASK ((1ULL << IDIF_OID_MAX_BITS) - 1)
469 /** OID for FID_SEQ_SPECIAL */
471 /* Big Filesystem Lock to serialize rename operations */
472 FID_OID_SPECIAL_BFL = 1UL,
475 /** OID for FID_SEQ_DOT_LUSTRE */
476 enum dot_lustre_oid {
477 FID_OID_DOT_LUSTRE = 1UL,
478 FID_OID_DOT_LUSTRE_OBF = 2UL,
481 static inline int fid_seq_is_mdt0(obd_seq seq)
483 return (seq == FID_SEQ_OST_MDT0);
486 static inline int fid_seq_is_mdt(const __u64 seq)
488 return seq == FID_SEQ_OST_MDT0 || seq >= FID_SEQ_NORMAL;
491 static inline int fid_seq_is_echo(obd_seq seq)
493 return (seq == FID_SEQ_ECHO);
496 static inline int fid_is_echo(const struct lu_fid *fid)
498 return fid_seq_is_echo(fid_seq(fid));
501 static inline int fid_seq_is_llog(obd_seq seq)
503 return (seq == FID_SEQ_LLOG);
506 static inline int fid_is_llog(const struct lu_fid *fid)
508 /* file with OID == 0 is not llog but contains last oid */
509 return fid_seq_is_llog(fid_seq(fid)) && fid_oid(fid) > 0;
512 static inline int fid_seq_is_rsvd(const __u64 seq)
514 return (seq > FID_SEQ_OST_MDT0 && seq <= FID_SEQ_RSVD);
517 static inline int fid_seq_is_special(const __u64 seq)
519 return seq == FID_SEQ_SPECIAL;
522 static inline int fid_seq_is_local_file(const __u64 seq)
524 return seq == FID_SEQ_LOCAL_FILE ||
525 seq == FID_SEQ_LOCAL_NAME;
528 static inline int fid_seq_is_root(const __u64 seq)
530 return seq == FID_SEQ_ROOT;
533 static inline int fid_seq_is_dot(const __u64 seq)
535 return seq == FID_SEQ_DOT_LUSTRE;
538 static inline int fid_seq_is_default(const __u64 seq)
540 return seq == FID_SEQ_LOV_DEFAULT;
543 static inline int fid_is_mdt0(const struct lu_fid *fid)
545 return fid_seq_is_mdt0(fid_seq(fid));
548 static inline void lu_root_fid(struct lu_fid *fid)
550 fid->f_seq = FID_SEQ_ROOT;
556 * Check if a fid is igif or not.
557 * \param fid the fid to be tested.
558 * \return true if the fid is a igif; otherwise false.
560 static inline int fid_seq_is_igif(const __u64 seq)
562 return seq >= FID_SEQ_IGIF && seq <= FID_SEQ_IGIF_MAX;
565 static inline int fid_is_igif(const struct lu_fid *fid)
567 return fid_seq_is_igif(fid_seq(fid));
571 * Check if a fid is idif or not.
572 * \param fid the fid to be tested.
573 * \return true if the fid is a idif; otherwise false.
575 static inline int fid_seq_is_idif(const __u64 seq)
577 return seq >= FID_SEQ_IDIF && seq <= FID_SEQ_IDIF_MAX;
580 static inline int fid_is_idif(const struct lu_fid *fid)
582 return fid_seq_is_idif(fid_seq(fid));
585 static inline int fid_is_local_file(const struct lu_fid *fid)
587 return fid_seq_is_local_file(fid_seq(fid));
590 static inline int fid_seq_is_norm(const __u64 seq)
592 return (seq >= FID_SEQ_NORMAL);
595 static inline int fid_is_norm(const struct lu_fid *fid)
597 return fid_seq_is_norm(fid_seq(fid));
600 /* convert an OST objid into an IDIF FID SEQ number */
601 static inline obd_seq fid_idif_seq(obd_id id, __u32 ost_idx)
603 return FID_SEQ_IDIF | (ost_idx << 16) | ((id >> 32) & 0xffff);
606 /* convert a packed IDIF FID into an OST objid */
607 static inline obd_id fid_idif_id(obd_seq seq, __u32 oid, __u32 ver)
609 return ((__u64)ver << 48) | ((seq & 0xffff) << 32) | oid;
612 /* extract ost index from IDIF FID */
613 static inline __u32 fid_idif_ost_idx(const struct lu_fid *fid)
615 LASSERT(fid_is_idif(fid));
616 return (fid_seq(fid) >> 16) & 0xffff;
619 /* extract OST sequence (group) from a wire ost_id (id/seq) pair */
620 static inline obd_seq ostid_seq(const struct ost_id *ostid)
622 if (fid_seq_is_mdt0(ostid->oi.oi_seq))
623 return FID_SEQ_OST_MDT0;
625 if (fid_seq_is_default(ostid->oi.oi_seq))
626 return FID_SEQ_LOV_DEFAULT;
628 if (fid_is_idif(&ostid->oi_fid))
629 return FID_SEQ_OST_MDT0;
631 return fid_seq(&ostid->oi_fid);
634 /* extract OST objid from a wire ost_id (id/seq) pair */
635 static inline obd_id ostid_id(const struct ost_id *ostid)
637 if (fid_seq_is_mdt0(ostid_seq(ostid)))
638 return ostid->oi.oi_id & IDIF_OID_MASK;
640 if (fid_is_idif(&ostid->oi_fid))
641 return fid_idif_id(fid_seq(&ostid->oi_fid),
642 fid_oid(&ostid->oi_fid), 0);
644 return fid_oid(&ostid->oi_fid);
647 static inline void ostid_set_seq(struct ost_id *oi, __u64 seq)
649 if (fid_seq_is_mdt0(seq) || fid_seq_is_default(seq)) {
652 oi->oi_fid.f_seq = seq;
653 /* Note: if f_oid + f_ver is zero, we need init it
654 * to be 1, otherwise, ostid_seq will treat this
655 * as old ostid (oi_seq == 0) */
656 if (oi->oi_fid.f_oid == 0 && oi->oi_fid.f_ver == 0)
657 oi->oi_fid.f_oid = LUSTRE_FID_INIT_OID;
661 static inline void ostid_set_seq_mdt0(struct ost_id *oi)
663 ostid_set_seq(oi, FID_SEQ_OST_MDT0);
666 static inline void ostid_set_seq_echo(struct ost_id *oi)
668 ostid_set_seq(oi, FID_SEQ_ECHO);
671 static inline void ostid_set_seq_llog(struct ost_id *oi)
673 ostid_set_seq(oi, FID_SEQ_LLOG);
677 * Note: we need check oi_seq to decide where to set oi_id,
678 * so oi_seq should always be set ahead of oi_id.
680 static inline void ostid_set_id(struct ost_id *oi, __u64 oid)
682 if (fid_seq_is_mdt0(ostid_seq(oi))) {
683 if (oid >= IDIF_MAX_OID) {
684 CERROR("Bad "LPU64" to set "DOSTID"\n",
690 if (oid > OBIF_MAX_OID) {
691 CERROR("Bad "LPU64" to set "DOSTID"\n",
695 oi->oi_fid.f_oid = oid;
699 static inline void ostid_inc_id(struct ost_id *oi)
701 if (fid_seq_is_mdt0(ostid_seq(oi))) {
702 if (unlikely(ostid_id(oi) + 1 > IDIF_MAX_OID)) {
703 CERROR("Bad inc "DOSTID"\n", POSTID(oi));
712 static inline void ostid_dec_id(struct ost_id *oi)
714 if (fid_seq_is_mdt0(ostid_seq(oi)))
721 * Unpack an OST object id/seq (group) into a FID. This is needed for
722 * converting all obdo, lmm, lsm, etc. 64-bit id/seq pairs into proper
723 * FIDs. Note that if an id/seq is already in FID/IDIF format it will
724 * be passed through unchanged. Only legacy OST objects in "group 0"
725 * will be mapped into the IDIF namespace so that they can fit into the
726 * struct lu_fid fields without loss. For reference see:
727 * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs
729 static inline int ostid_to_fid(struct lu_fid *fid, struct ost_id *ostid,
732 if (ost_idx > 0xffff) {
733 CERROR("bad ost_idx, "DOSTID" ost_idx:%u\n", POSTID(ostid),
738 if (fid_seq_is_mdt0(ostid_seq(ostid))) {
739 /* This is a "legacy" (old 1.x/2.early) OST object in "group 0"
740 * that we map into the IDIF namespace. It allows up to 2^48
741 * objects per OST, as this is the object namespace that has
742 * been in production for years. This can handle create rates
743 * of 1M objects/s/OST for 9 years, or combinations thereof. */
744 if (ostid_id(ostid) >= IDIF_MAX_OID) {
745 CERROR("bad MDT0 id, "DOSTID" ost_idx:%u\n",
746 POSTID(ostid), ost_idx);
749 fid->f_seq = fid_idif_seq(ostid_id(ostid), ost_idx);
750 /* truncate to 32 bits by assignment */
751 fid->f_oid = ostid_id(ostid);
752 /* in theory, not currently used */
753 fid->f_ver = ostid_id(ostid) >> 48;
754 } else /* if (fid_seq_is_idif(seq) || fid_seq_is_norm(seq)) */ {
755 /* This is either an IDIF object, which identifies objects across
756 * all OSTs, or a regular FID. The IDIF namespace maps legacy
757 * OST objects into the FID namespace. In both cases, we just
758 * pass the FID through, no conversion needed. */
759 if (ostid->oi_fid.f_ver != 0) {
760 CERROR("bad MDT0 id, "DOSTID" ost_idx:%u\n",
761 POSTID(ostid), ost_idx);
764 *fid = ostid->oi_fid;
770 /* pack any OST FID into an ostid (id/seq) for the wire/disk */
771 static inline int fid_to_ostid(const struct lu_fid *fid, struct ost_id *ostid)
773 if (unlikely(fid_seq_is_igif(fid->f_seq))) {
774 CERROR("bad IGIF, "DFID"\n", PFID(fid));
778 if (fid_is_idif(fid)) {
779 ostid_set_seq_mdt0(ostid);
780 ostid_set_id(ostid, fid_idif_id(fid_seq(fid), fid_oid(fid),
783 ostid->oi_fid = *fid;
789 /* Check whether the fid is for LAST_ID */
790 static inline int fid_is_last_id(const struct lu_fid *fid)
792 return (fid_oid(fid) == 0);
796 * Get inode number from a igif.
797 * \param fid a igif to get inode number from.
798 * \return inode number for the igif.
800 static inline ino_t lu_igif_ino(const struct lu_fid *fid)
805 extern void lustre_swab_ost_id(struct ost_id *oid);
808 * Get inode generation from a igif.
809 * \param fid a igif to get inode generation from.
810 * \return inode generation for the igif.
812 static inline __u32 lu_igif_gen(const struct lu_fid *fid)
818 * Build igif from the inode number/generation.
820 static inline void lu_igif_build(struct lu_fid *fid, __u32 ino, __u32 gen)
828 * Fids are transmitted across network (in the sender byte-ordering),
829 * and stored on disk in big-endian order.
831 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
833 /* check that all fields are converted */
834 CLASSERT(sizeof *src ==
835 sizeof fid_seq(src) +
836 sizeof fid_oid(src) + sizeof fid_ver(src));
837 dst->f_seq = cpu_to_le64(fid_seq(src));
838 dst->f_oid = cpu_to_le32(fid_oid(src));
839 dst->f_ver = cpu_to_le32(fid_ver(src));
842 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
844 /* check that all fields are converted */
845 CLASSERT(sizeof *src ==
846 sizeof fid_seq(src) +
847 sizeof fid_oid(src) + sizeof fid_ver(src));
848 dst->f_seq = le64_to_cpu(fid_seq(src));
849 dst->f_oid = le32_to_cpu(fid_oid(src));
850 dst->f_ver = le32_to_cpu(fid_ver(src));
853 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
855 /* check that all fields are converted */
856 CLASSERT(sizeof *src ==
857 sizeof fid_seq(src) +
858 sizeof fid_oid(src) + sizeof fid_ver(src));
859 dst->f_seq = cpu_to_be64(fid_seq(src));
860 dst->f_oid = cpu_to_be32(fid_oid(src));
861 dst->f_ver = cpu_to_be32(fid_ver(src));
864 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
866 /* check that all fields are converted */
867 CLASSERT(sizeof *src ==
868 sizeof fid_seq(src) +
869 sizeof fid_oid(src) + sizeof fid_ver(src));
870 dst->f_seq = be64_to_cpu(fid_seq(src));
871 dst->f_oid = be32_to_cpu(fid_oid(src));
872 dst->f_ver = be32_to_cpu(fid_ver(src));
875 static inline int fid_is_sane(const struct lu_fid *fid)
877 return fid != NULL &&
878 ((fid_seq(fid) >= FID_SEQ_START && fid_ver(fid) == 0) ||
879 fid_is_igif(fid) || fid_is_idif(fid) ||
880 fid_seq_is_rsvd(fid_seq(fid)));
883 static inline int fid_is_zero(const struct lu_fid *fid)
885 return fid_seq(fid) == 0 && fid_oid(fid) == 0;
888 extern void lustre_swab_lu_fid(struct lu_fid *fid);
889 extern void lustre_swab_lu_seq_range(struct lu_seq_range *range);
891 static inline int lu_fid_eq(const struct lu_fid *f0, const struct lu_fid *f1)
893 /* Check that there is no alignment padding. */
894 CLASSERT(sizeof *f0 ==
895 sizeof f0->f_seq + sizeof f0->f_oid + sizeof f0->f_ver);
896 return memcmp(f0, f1, sizeof *f0) == 0;
899 #define __diff_normalize(val0, val1) \
901 typeof(val0) __val0 = (val0); \
902 typeof(val1) __val1 = (val1); \
904 (__val0 == __val1 ? 0 : __val0 > __val1 ? +1 : -1); \
907 static inline int lu_fid_cmp(const struct lu_fid *f0,
908 const struct lu_fid *f1)
911 __diff_normalize(fid_seq(f0), fid_seq(f1)) ?:
912 __diff_normalize(fid_oid(f0), fid_oid(f1)) ?:
913 __diff_normalize(fid_ver(f0), fid_ver(f1));
916 static inline void ostid_cpu_to_le(const struct ost_id *src_oi,
917 struct ost_id *dst_oi)
919 if (fid_seq_is_mdt0(ostid_seq(src_oi))) {
920 dst_oi->oi.oi_id = cpu_to_le64(src_oi->oi.oi_id);
921 dst_oi->oi.oi_seq = cpu_to_le64(src_oi->oi.oi_seq);
923 fid_cpu_to_le(&dst_oi->oi_fid, &src_oi->oi_fid);
927 static inline void ostid_le_to_cpu(const struct ost_id *src_oi,
928 struct ost_id *dst_oi)
930 if (fid_seq_is_mdt0(ostid_seq(src_oi))) {
931 dst_oi->oi.oi_id = le64_to_cpu(src_oi->oi.oi_id);
932 dst_oi->oi.oi_seq = le64_to_cpu(src_oi->oi.oi_seq);
934 fid_le_to_cpu(&dst_oi->oi_fid, &src_oi->oi_fid);
940 /** \defgroup lu_dir lu_dir
944 * Enumeration of possible directory entry attributes.
946 * Attributes follow directory entry header in the order they appear in this
949 enum lu_dirent_attrs {
952 LUDA_64BITHASH = 0x0004,
954 /* The following attrs are used for MDT interanl only,
955 * not visible to client */
957 /* Verify the dirent consistency */
958 LUDA_VERIFY = 0x8000,
959 /* Only check but not repair the dirent inconsistency */
960 LUDA_VERIFY_DRYRUN = 0x4000,
961 /* The dirent has been repaired, or to be repaired (dryrun). */
962 LUDA_REPAIR = 0x2000,
963 /* The system is upgraded, has beed or to be repaired (dryrun). */
964 LUDA_UPGRADE = 0x1000,
965 /* Ignore this record, go to next directly. */
966 LUDA_IGNORE = 0x0800,
969 #define LU_DIRENT_ATTRS_MASK 0xf800
972 * Layout of readdir pages, as transmitted on wire.
975 /** valid if LUDA_FID is set. */
976 struct lu_fid lde_fid;
977 /** a unique entry identifier: a hash or an offset. */
979 /** total record length, including all attributes. */
983 /** optional variable size attributes following this entry.
984 * taken from enum lu_dirent_attrs.
987 /** name is followed by the attributes indicated in ->ldp_attrs, in
988 * their natural order. After the last attribute, padding bytes are
989 * added to make ->lde_reclen a multiple of 8.
995 * Definitions of optional directory entry attributes formats.
997 * Individual attributes do not have their length encoded in a generic way. It
998 * is assumed that consumer of an attribute knows its format. This means that
999 * it is impossible to skip over an unknown attribute, except by skipping over all
1000 * remaining attributes (by using ->lde_reclen), which is not too
1001 * constraining, because new server versions will append new attributes at
1002 * the end of an entry.
1006 * Fid directory attribute: a fid of an object referenced by the entry. This
1007 * will be almost always requested by the client and supplied by the server.
1009 * Aligned to 8 bytes.
1011 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
1016 * Aligned to 2 bytes.
1023 __u64 ldp_hash_start;
1027 struct lu_dirent ldp_entries[0];
1030 enum lu_dirpage_flags {
1032 * dirpage contains no entry.
1036 * last entry's lde_hash equals ldp_hash_end.
1038 LDF_COLLIDE = 1 << 1
1041 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
1043 if (le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
1046 return dp->ldp_entries;
1049 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
1051 struct lu_dirent *next;
1053 if (le16_to_cpu(ent->lde_reclen) != 0)
1054 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
1061 static inline int lu_dirent_calc_size(int namelen, __u16 attr)
1065 if (attr & LUDA_TYPE) {
1066 const unsigned align = sizeof(struct luda_type) - 1;
1067 size = (sizeof(struct lu_dirent) + namelen + align) & ~align;
1068 size += sizeof(struct luda_type);
1070 size = sizeof(struct lu_dirent) + namelen;
1072 return (size + 7) & ~7;
1075 static inline int lu_dirent_size(struct lu_dirent *ent)
1077 if (le16_to_cpu(ent->lde_reclen) == 0) {
1078 return lu_dirent_calc_size(le16_to_cpu(ent->lde_namelen),
1079 le32_to_cpu(ent->lde_attrs));
1081 return le16_to_cpu(ent->lde_reclen);
1084 #define MDS_DIR_END_OFF 0xfffffffffffffffeULL
1087 * MDS_READPAGE page size
1089 * This is the directory page size packed in MDS_READPAGE RPC.
1090 * It's different than CFS_PAGE_SIZE because the client needs to
1091 * access the struct lu_dirpage header packed at the beginning of
1092 * the "page" and without this there isn't any way to know find the
1093 * lu_dirpage header is if client and server CFS_PAGE_SIZE differ.
1095 #define LU_PAGE_SHIFT 12
1096 #define LU_PAGE_SIZE (1UL << LU_PAGE_SHIFT)
1097 #define LU_PAGE_MASK (~(LU_PAGE_SIZE - 1))
1099 #define LU_PAGE_COUNT (1 << (CFS_PAGE_SHIFT - LU_PAGE_SHIFT))
1103 struct lustre_handle {
1106 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
1108 static inline int lustre_handle_is_used(struct lustre_handle *lh)
1110 return lh->cookie != 0ull;
1113 static inline int lustre_handle_equal(const struct lustre_handle *lh1,
1114 const struct lustre_handle *lh2)
1116 return lh1->cookie == lh2->cookie;
1119 static inline void lustre_handle_copy(struct lustre_handle *tgt,
1120 struct lustre_handle *src)
1122 tgt->cookie = src->cookie;
1125 /* flags for lm_flags */
1126 #define MSGHDR_AT_SUPPORT 0x1
1127 #define MSGHDR_CKSUM_INCOMPAT18 0x2
1129 #define lustre_msg lustre_msg_v2
1130 /* we depend on this structure to be 8-byte aligned */
1131 /* this type is only endian-adjusted in lustre_unpack_msg() */
1132 struct lustre_msg_v2 {
1141 __u32 lm_buflens[0];
1144 /* without gss, ptlrpc_body is put at the first buffer. */
1145 #define PTLRPC_NUM_VERSIONS 4
1146 #define JOBSTATS_JOBID_SIZE 32 /* 32 bytes string */
1147 struct ptlrpc_body_v3 {
1148 struct lustre_handle pb_handle;
1155 __u64 pb_last_committed;
1160 __u32 pb_timeout; /* for req, the deadline, for rep, the service est */
1161 __u32 pb_service_time; /* for rep, actual service time */
1164 /* VBR: pre-versions */
1165 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1166 /* padding for future needs */
1167 __u64 pb_padding[4];
1168 char pb_jobid[JOBSTATS_JOBID_SIZE];
1170 #define ptlrpc_body ptlrpc_body_v3
1172 struct ptlrpc_body_v2 {
1173 struct lustre_handle pb_handle;
1180 __u64 pb_last_committed;
1185 __u32 pb_timeout; /* for req, the deadline, for rep, the service est */
1186 __u32 pb_service_time; /* for rep, actual service time, also used for
1187 net_latency of req */
1190 /* VBR: pre-versions */
1191 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1192 /* padding for future needs */
1193 __u64 pb_padding[4];
1196 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
1198 /* message body offset for lustre_msg_v2 */
1199 /* ptlrpc body offset in all request/reply messages */
1200 #define MSG_PTLRPC_BODY_OFF 0
1202 /* normal request/reply message record offset */
1203 #define REQ_REC_OFF 1
1204 #define REPLY_REC_OFF 1
1206 /* ldlm request message body offset */
1207 #define DLM_LOCKREQ_OFF 1 /* lockreq offset */
1208 #define DLM_REQ_REC_OFF 2 /* normal dlm request record offset */
1210 /* ldlm intent lock message body offset */
1211 #define DLM_INTENT_IT_OFF 2 /* intent lock it offset */
1212 #define DLM_INTENT_REC_OFF 3 /* intent lock record offset */
1214 /* ldlm reply message body offset */
1215 #define DLM_LOCKREPLY_OFF 1 /* lockrep offset */
1216 #define DLM_REPLY_REC_OFF 2 /* reply record offset */
1218 /** only use in req->rq_{req,rep}_swab_mask */
1219 #define MSG_PTLRPC_HEADER_OFF 31
1221 /* Flags that are operation-specific go in the top 16 bits. */
1222 #define MSG_OP_FLAG_MASK 0xffff0000
1223 #define MSG_OP_FLAG_SHIFT 16
1225 /* Flags that apply to all requests are in the bottom 16 bits */
1226 #define MSG_GEN_FLAG_MASK 0x0000ffff
1227 #define MSG_LAST_REPLAY 0x0001
1228 #define MSG_RESENT 0x0002
1229 #define MSG_REPLAY 0x0004
1230 /* #define MSG_AT_SUPPORT 0x0008
1231 * This was used in early prototypes of adaptive timeouts, and while there
1232 * shouldn't be any users of that code there also isn't a need for using this
1233 * bits. Defer usage until at least 1.10 to avoid potential conflict. */
1234 #define MSG_DELAY_REPLAY 0x0010
1235 #define MSG_VERSION_REPLAY 0x0020
1236 #define MSG_REQ_REPLAY_DONE 0x0040
1237 #define MSG_LOCK_REPLAY_DONE 0x0080
1240 * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
1243 #define MSG_CONNECT_RECOVERING 0x00000001
1244 #define MSG_CONNECT_RECONNECT 0x00000002
1245 #define MSG_CONNECT_REPLAYABLE 0x00000004
1246 //#define MSG_CONNECT_PEER 0x8
1247 #define MSG_CONNECT_LIBCLIENT 0x00000010
1248 #define MSG_CONNECT_INITIAL 0x00000020
1249 #define MSG_CONNECT_ASYNC 0x00000040
1250 #define MSG_CONNECT_NEXT_VER 0x00000080 /* use next version of lustre_msg */
1251 #define MSG_CONNECT_TRANSNO 0x00000100 /* report transno */
1254 #define OBD_CONNECT_RDONLY 0x1ULL /*client has read-only access*/
1255 #define OBD_CONNECT_INDEX 0x2ULL /*connect specific LOV idx */
1256 #define OBD_CONNECT_MDS 0x4ULL /*connect from MDT to OST */
1257 #define OBD_CONNECT_GRANT 0x8ULL /*OSC gets grant at connect */
1258 #define OBD_CONNECT_SRVLOCK 0x10ULL /*server takes locks for cli */
1259 #define OBD_CONNECT_VERSION 0x20ULL /*Lustre versions in ocd */
1260 #define OBD_CONNECT_REQPORTAL 0x40ULL /*Separate non-IO req portal */
1261 #define OBD_CONNECT_ACL 0x80ULL /*access control lists */
1262 #define OBD_CONNECT_XATTR 0x100ULL /*client use extended attr */
1263 #define OBD_CONNECT_CROW 0x200ULL /*MDS+OST create obj on write*/
1264 #define OBD_CONNECT_TRUNCLOCK 0x400ULL /*locks on server for punch */
1265 #define OBD_CONNECT_TRANSNO 0x800ULL /*replay sends init transno */
1266 #define OBD_CONNECT_IBITS 0x1000ULL /*support for inodebits locks*/
1267 #define OBD_CONNECT_JOIN 0x2000ULL /*files can be concatenated.
1268 *We do not support JOIN FILE
1269 *anymore, reserve this flags
1270 *just for preventing such bit
1272 #define OBD_CONNECT_ATTRFID 0x4000ULL /*Server can GetAttr By Fid*/
1273 #define OBD_CONNECT_NODEVOH 0x8000ULL /*No open hndl on specl nodes*/
1274 #define OBD_CONNECT_RMT_CLIENT 0x10000ULL /*Remote client */
1275 #define OBD_CONNECT_RMT_CLIENT_FORCE 0x20000ULL /*Remote client by force */
1276 #define OBD_CONNECT_BRW_SIZE 0x40000ULL /*Max bytes per rpc */
1277 #define OBD_CONNECT_QUOTA64 0x80000ULL /*Not used since 2.4 */
1278 #define OBD_CONNECT_MDS_CAPA 0x100000ULL /*MDS capability */
1279 #define OBD_CONNECT_OSS_CAPA 0x200000ULL /*OSS capability */
1280 #define OBD_CONNECT_CANCELSET 0x400000ULL /*Early batched cancels. */
1281 #define OBD_CONNECT_SOM 0x800000ULL /*Size on MDS */
1282 #define OBD_CONNECT_AT 0x1000000ULL /*client uses AT */
1283 #define OBD_CONNECT_LRU_RESIZE 0x2000000ULL /*LRU resize feature. */
1284 #define OBD_CONNECT_MDS_MDS 0x4000000ULL /*MDS-MDS connection */
1285 #define OBD_CONNECT_REAL 0x8000000ULL /*real connection */
1286 #define OBD_CONNECT_CHANGE_QS 0x10000000ULL /*Not used since 2.4 */
1287 #define OBD_CONNECT_CKSUM 0x20000000ULL /*support several cksum algos*/
1288 #define OBD_CONNECT_FID 0x40000000ULL /*FID is supported by server */
1289 #define OBD_CONNECT_VBR 0x80000000ULL /*version based recovery */
1290 #define OBD_CONNECT_LOV_V3 0x100000000ULL /*client supports LOV v3 EA */
1291 #define OBD_CONNECT_GRANT_SHRINK 0x200000000ULL /* support grant shrink */
1292 #define OBD_CONNECT_SKIP_ORPHAN 0x400000000ULL /* don't reuse orphan objids */
1293 #define OBD_CONNECT_MAX_EASIZE 0x800000000ULL /* preserved for large EA */
1294 #define OBD_CONNECT_FULL20 0x1000000000ULL /* it is 2.0 client */
1295 #define OBD_CONNECT_LAYOUTLOCK 0x2000000000ULL /* client uses layout lock */
1296 #define OBD_CONNECT_64BITHASH 0x4000000000ULL /* client supports 64-bits
1298 #define OBD_CONNECT_MAXBYTES 0x8000000000ULL /* max stripe size */
1299 #define OBD_CONNECT_IMP_RECOV 0x10000000000ULL /* imp recovery support */
1300 #define OBD_CONNECT_JOBSTATS 0x20000000000ULL /* jobid in ptlrpc_body */
1301 #define OBD_CONNECT_UMASK 0x40000000000ULL /* create uses client umask */
1302 #define OBD_CONNECT_EINPROGRESS 0x80000000000ULL /* client handles -EINPROGRESS
1303 * RPC error properly */
1304 #define OBD_CONNECT_GRANT_PARAM 0x100000000000ULL/* extra grant params used for
1305 * finer space reservation */
1306 #define OBD_CONNECT_FLOCK_OWNER 0x200000000000ULL /* for the fixed 1.8
1307 * policy and 2.x server */
1308 #define OBD_CONNECT_LVB_TYPE 0x400000000000ULL /* variable type of LVB */
1309 #define OBD_CONNECT_NANOSEC_TIME 0x800000000000ULL /* nanosecond timestamps */
1310 #define OBD_CONNECT_LIGHTWEIGHT 0x1000000000000ULL/* lightweight connection */
1311 #define OBD_CONNECT_SHORTIO 0x2000000000000ULL/* short io */
1312 #define OBD_CONNECT_PINGLESS 0x4000000000000ULL/* pings not required */
1314 * Please DO NOT add flag values here before first ensuring that this same
1315 * flag value is not in use on some other branch. Please clear any such
1316 * changes with senior engineers before starting to use a new flag. Then,
1317 * submit a small patch against EVERY branch that ONLY adds the new flag,
1318 * updates obd_connect_names[] for lprocfs_rd_connect_flags(), adds the
1319 * flag to check_obd_connect_data(), and updates wiretests accordingly, so it
1320 * can be approved and landed easily to reserve the flag for future use. */
1322 /* The MNE_SWAB flag is overloading the MDS_MDS bit only for the MGS
1323 * connection. It is a temporary bug fix for Imperative Recovery interop
1324 * between 2.2 and 2.3 x86/ppc nodes, and can be removed when interop for
1325 * 2.2 clients/servers is no longer needed. LU-1252/LU-1644. */
1326 #define OBD_CONNECT_MNE_SWAB OBD_CONNECT_MDS_MDS
1328 #define OCD_HAS_FLAG(ocd, flg) \
1329 (!!((ocd)->ocd_connect_flags & OBD_CONNECT_##flg))
1332 #ifdef HAVE_LRU_RESIZE_SUPPORT
1333 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
1335 #define LRU_RESIZE_CONNECT_FLAG 0
1338 #define MDT_CONNECT_SUPPORTED (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
1339 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
1340 OBD_CONNECT_IBITS | \
1341 OBD_CONNECT_NODEVOH | OBD_CONNECT_ATTRFID | \
1342 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1343 OBD_CONNECT_RMT_CLIENT | \
1344 OBD_CONNECT_RMT_CLIENT_FORCE | \
1345 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_MDS_CAPA | \
1346 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_MDS_MDS | \
1347 OBD_CONNECT_FID | LRU_RESIZE_CONNECT_FLAG | \
1348 OBD_CONNECT_VBR | OBD_CONNECT_LOV_V3 | \
1349 OBD_CONNECT_SOM | OBD_CONNECT_FULL20 | \
1350 OBD_CONNECT_64BITHASH | OBD_CONNECT_JOBSTATS | \
1351 OBD_CONNECT_EINPROGRESS | \
1352 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_UMASK | \
1353 OBD_CONNECT_LVB_TYPE | OBD_CONNECT_LAYOUTLOCK |\
1354 OBD_CONNECT_PINGLESS)
1355 #define OST_CONNECT_SUPPORTED (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
1356 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
1357 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
1358 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_OSS_CAPA | \
1359 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1360 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_CKSUM | \
1361 OBD_CONNECT_RMT_CLIENT | \
1362 OBD_CONNECT_RMT_CLIENT_FORCE | OBD_CONNECT_VBR | \
1363 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
1364 OBD_CONNECT_GRANT_SHRINK | OBD_CONNECT_FULL20 | \
1365 OBD_CONNECT_64BITHASH | OBD_CONNECT_MAXBYTES | \
1366 OBD_CONNECT_MAX_EASIZE | \
1367 OBD_CONNECT_EINPROGRESS | \
1368 OBD_CONNECT_JOBSTATS | \
1369 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_LVB_TYPE|\
1370 OBD_CONNECT_LAYOUTLOCK | OBD_CONNECT_FID | \
1371 OBD_CONNECT_PINGLESS)
1372 #define ECHO_CONNECT_SUPPORTED (0)
1373 #define MGS_CONNECT_SUPPORTED (OBD_CONNECT_VERSION | OBD_CONNECT_AT | \
1374 OBD_CONNECT_FULL20 | OBD_CONNECT_IMP_RECOV | \
1375 OBD_CONNECT_MNE_SWAB | OBD_CONNECT_PINGLESS)
1377 /* Features required for this version of the client to work with server */
1378 #define CLIENT_CONNECT_MDT_REQD (OBD_CONNECT_IBITS | OBD_CONNECT_FID | \
1381 #define OBD_OCD_VERSION(major,minor,patch,fix) (((major)<<24) + ((minor)<<16) +\
1382 ((patch)<<8) + (fix))
1383 #define OBD_OCD_VERSION_MAJOR(version) ((int)((version)>>24)&255)
1384 #define OBD_OCD_VERSION_MINOR(version) ((int)((version)>>16)&255)
1385 #define OBD_OCD_VERSION_PATCH(version) ((int)((version)>>8)&255)
1386 #define OBD_OCD_VERSION_FIX(version) ((int)(version)&255)
1388 /* This structure is used for both request and reply.
1390 * If we eventually have separate connect data for different types, which we
1391 * almost certainly will, then perhaps we stick a union in here. */
1392 struct obd_connect_data_v1 {
1393 __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1394 __u32 ocd_version; /* lustre release version number */
1395 __u32 ocd_grant; /* initial cache grant amount (bytes) */
1396 __u32 ocd_index; /* LOV index to connect to */
1397 __u32 ocd_brw_size; /* Maximum BRW size in bytes, must be 2^n */
1398 __u64 ocd_ibits_known; /* inode bits this client understands */
1399 __u8 ocd_blocksize; /* log2 of the backend filesystem blocksize */
1400 __u8 ocd_inodespace; /* log2 of the per-inode space consumption */
1401 __u16 ocd_grant_extent; /* per-extent grant overhead, in 1K blocks */
1402 __u32 ocd_unused; /* also fix lustre_swab_connect */
1403 __u64 ocd_transno; /* first transno from client to be replayed */
1404 __u32 ocd_group; /* MDS group on OST */
1405 __u32 ocd_cksum_types; /* supported checksum algorithms */
1406 __u32 ocd_max_easize; /* How big LOV EA can be on MDS */
1407 __u32 ocd_instance; /* also fix lustre_swab_connect */
1408 __u64 ocd_maxbytes; /* Maximum stripe size in bytes */
1411 struct obd_connect_data {
1412 __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1413 __u32 ocd_version; /* lustre release version number */
1414 __u32 ocd_grant; /* initial cache grant amount (bytes) */
1415 __u32 ocd_index; /* LOV index to connect to */
1416 __u32 ocd_brw_size; /* Maximum BRW size in bytes */
1417 __u64 ocd_ibits_known; /* inode bits this client understands */
1418 __u8 ocd_blocksize; /* log2 of the backend filesystem blocksize */
1419 __u8 ocd_inodespace; /* log2 of the per-inode space consumption */
1420 __u16 ocd_grant_extent; /* per-extent grant overhead, in 1K blocks */
1421 __u32 ocd_unused; /* also fix lustre_swab_connect */
1422 __u64 ocd_transno; /* first transno from client to be replayed */
1423 __u32 ocd_group; /* MDS group on OST */
1424 __u32 ocd_cksum_types; /* supported checksum algorithms */
1425 __u32 ocd_max_easize; /* How big LOV EA can be on MDS */
1426 __u32 ocd_instance; /* instance # of this target */
1427 __u64 ocd_maxbytes; /* Maximum stripe size in bytes */
1428 /* Fields after ocd_maxbytes are only accessible by the receiver
1429 * if the corresponding flag in ocd_connect_flags is set. Accessing
1430 * any field after ocd_maxbytes on the receiver without a valid flag
1431 * may result in out-of-bound memory access and kernel oops. */
1432 __u64 padding1; /* added 2.1.0. also fix lustre_swab_connect */
1433 __u64 padding2; /* added 2.1.0. also fix lustre_swab_connect */
1434 __u64 padding3; /* added 2.1.0. also fix lustre_swab_connect */
1435 __u64 padding4; /* added 2.1.0. also fix lustre_swab_connect */
1436 __u64 padding5; /* added 2.1.0. also fix lustre_swab_connect */
1437 __u64 padding6; /* added 2.1.0. also fix lustre_swab_connect */
1438 __u64 padding7; /* added 2.1.0. also fix lustre_swab_connect */
1439 __u64 padding8; /* added 2.1.0. also fix lustre_swab_connect */
1440 __u64 padding9; /* added 2.1.0. also fix lustre_swab_connect */
1441 __u64 paddingA; /* added 2.1.0. also fix lustre_swab_connect */
1442 __u64 paddingB; /* added 2.1.0. also fix lustre_swab_connect */
1443 __u64 paddingC; /* added 2.1.0. also fix lustre_swab_connect */
1444 __u64 paddingD; /* added 2.1.0. also fix lustre_swab_connect */
1445 __u64 paddingE; /* added 2.1.0. also fix lustre_swab_connect */
1446 __u64 paddingF; /* added 2.1.0. also fix lustre_swab_connect */
1449 * Please DO NOT use any fields here before first ensuring that this same
1450 * field is not in use on some other branch. Please clear any such changes
1451 * with senior engineers before starting to use a new field. Then, submit
1452 * a small patch against EVERY branch that ONLY adds the new field along with
1453 * the matching OBD_CONNECT flag, so that can be approved and landed easily to
1454 * reserve the flag for future use. */
1457 extern void lustre_swab_connect(struct obd_connect_data *ocd);
1460 * Supported checksum algorithms. Up to 32 checksum types are supported.
1461 * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
1462 * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
1463 * algorithm and also the OBD_FL_CKSUM* flags.
1466 OBD_CKSUM_CRC32 = 0x00000001,
1467 OBD_CKSUM_ADLER = 0x00000002,
1468 OBD_CKSUM_CRC32C= 0x00000004,
1472 * OST requests: OBDO & OBD request records
1477 OST_REPLY = 0, /* reply ? */
1493 OST_QUOTACHECK = 18,
1495 OST_QUOTA_ADJUST_QUNIT = 20, /* not used since 2.4 */
1498 #define OST_FIRST_OPC OST_REPLY
1501 OBD_FL_INLINEDATA = 0x00000001,
1502 OBD_FL_OBDMDEXISTS = 0x00000002,
1503 OBD_FL_DELORPHAN = 0x00000004, /* if set in o_flags delete orphans */
1504 OBD_FL_NORPC = 0x00000008, /* set in o_flags do in OSC not OST */
1505 OBD_FL_IDONLY = 0x00000010, /* set in o_flags only adjust obj id*/
1506 OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
1507 OBD_FL_DEBUG_CHECK = 0x00000040, /* echo client/server debug check */
1508 OBD_FL_NO_USRQUOTA = 0x00000100, /* the object's owner is over quota */
1509 OBD_FL_NO_GRPQUOTA = 0x00000200, /* the object's group is over quota */
1510 OBD_FL_CREATE_CROW = 0x00000400, /* object should be create on write */
1511 OBD_FL_SRVLOCK = 0x00000800, /* delegate DLM locking to server */
1512 OBD_FL_CKSUM_CRC32 = 0x00001000, /* CRC32 checksum type */
1513 OBD_FL_CKSUM_ADLER = 0x00002000, /* ADLER checksum type */
1514 OBD_FL_CKSUM_CRC32C = 0x00004000, /* CRC32C checksum type */
1515 OBD_FL_CKSUM_RSVD2 = 0x00008000, /* for future cksum types */
1516 OBD_FL_CKSUM_RSVD3 = 0x00010000, /* for future cksum types */
1517 OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
1518 OBD_FL_MMAP = 0x00040000, /* object is mmapped on the client.
1519 * XXX: obsoleted - reserved for old
1520 * clients prior than 2.2 */
1521 OBD_FL_RECOV_RESEND = 0x00080000, /* recoverable resent */
1522 OBD_FL_NOSPC_BLK = 0x00100000, /* no more block space on OST */
1524 /* Note that while these checksum values are currently separate bits,
1525 * in 2.x we can actually allow all values from 1-31 if we wanted. */
1526 OBD_FL_CKSUM_ALL = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER |
1527 OBD_FL_CKSUM_CRC32C,
1529 /* mask for local-only flag, which won't be sent over network */
1530 OBD_FL_LOCAL_MASK = 0xF0000000,
1533 #define LOV_MAGIC_V1 0x0BD10BD0
1534 #define LOV_MAGIC LOV_MAGIC_V1
1535 #define LOV_MAGIC_JOIN_V1 0x0BD20BD0
1536 #define LOV_MAGIC_V3 0x0BD30BD0
1539 * magic for fully defined striping
1540 * the idea is that we should have different magics for striping "hints"
1541 * (struct lov_user_md_v[13]) and defined ready-to-use striping (struct
1542 * lov_mds_md_v[13]). at the moment the magics are used in wire protocol,
1543 * we can't just change it w/o long way preparation, but we still need a
1544 * mechanism to allow LOD to differentiate hint versus ready striping.
1545 * so, at the moment we do a trick: MDT knows what to expect from request
1546 * depending on the case (replay uses ready striping, non-replay req uses
1547 * hints), so MDT replaces magic with appropriate one and now LOD can
1548 * easily understand what's inside -bzzz
1550 #define LOV_MAGIC_V1_DEF 0x0CD10BD0
1551 #define LOV_MAGIC_V3_DEF 0x0CD30BD0
1553 #define LOV_PATTERN_RAID0 0x001 /* stripes are used round-robin */
1554 #define LOV_PATTERN_RAID1 0x002 /* stripes are mirrors of each other */
1555 #define LOV_PATTERN_FIRST 0x100 /* first stripe is not in round-robin */
1556 #define LOV_PATTERN_CMOBD 0x200
1558 #define LOV_PATTERN_F_MASK 0xffff0000
1559 #define LOV_PATTERN_F_RELEASED 0x80000000 /* HSM released file */
1561 #define lov_pattern(pattern) (pattern & ~LOV_PATTERN_F_MASK)
1562 #define lov_pattern_flags(pattern) (pattern & LOV_PATTERN_F_MASK)
1564 #define lov_ost_data lov_ost_data_v1
1565 struct lov_ost_data_v1 { /* per-stripe data structure (little-endian)*/
1566 struct ost_id l_ost_oi; /* OST object ID */
1567 __u32 l_ost_gen; /* generation of this l_ost_idx */
1568 __u32 l_ost_idx; /* OST index in LOV (lov_tgt_desc->tgts) */
1571 #define lov_mds_md lov_mds_md_v1
1572 struct lov_mds_md_v1 { /* LOV EA mds/wire data (little-endian) */
1573 __u32 lmm_magic; /* magic number = LOV_MAGIC_V1 */
1574 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1575 struct ost_id lmm_oi; /* LOV object ID */
1576 __u32 lmm_stripe_size; /* size of stripe in bytes */
1577 /* lmm_stripe_count used to be __u32 */
1578 __u16 lmm_stripe_count; /* num stripes in use for this object */
1579 __u16 lmm_layout_gen; /* layout generation number */
1580 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1584 * Sigh, because pre-2.4 uses
1585 * struct lov_mds_md_v1 {
1587 * __u64 lmm_object_id;
1588 * __u64 lmm_object_seq;
1591 * to identify the LOV(MDT) object, and lmm_object_seq will
1592 * be normal_fid, which make it hard to combine these conversion
1593 * to ostid_to FID. so we will do lmm_oi/fid conversion separately
1595 * We can tell the lmm_oi by this way,
1596 * 1.8: lmm_object_id = {inode}, lmm_object_gr = 0
1597 * 2.1: lmm_object_id = {oid < 128k}, lmm_object_seq = FID_SEQ_NORMAL
1598 * 2.4: lmm_oi.f_seq = FID_SEQ_NORMAL, lmm_oi.f_oid = {oid < 128k},
1601 * But currently lmm_oi/lsm_oi does not have any "real" usages,
1602 * except for printing some information, and the user can always
1603 * get the real FID from LMA, besides this multiple case check might
1604 * make swab more complicate. So we will keep using id/seq for lmm_oi.
1607 static inline void fid_to_lmm_oi(const struct lu_fid *fid,
1610 oi->oi.oi_id = fid_oid(fid);
1611 oi->oi.oi_seq = fid_seq(fid);
1614 static inline void lmm_oi_set_seq(struct ost_id *oi, __u64 seq)
1616 oi->oi.oi_seq = seq;
1619 static inline __u64 lmm_oi_id(struct ost_id *oi)
1621 return oi->oi.oi_id;
1624 static inline __u64 lmm_oi_seq(struct ost_id *oi)
1626 return oi->oi.oi_seq;
1629 static inline void lmm_oi_le_to_cpu(struct ost_id *dst_oi,
1630 struct ost_id *src_oi)
1632 dst_oi->oi.oi_id = le64_to_cpu(src_oi->oi.oi_id);
1633 dst_oi->oi.oi_seq = le64_to_cpu(src_oi->oi.oi_seq);
1636 static inline void lmm_oi_cpu_to_le(struct ost_id *dst_oi,
1637 struct ost_id *src_oi)
1639 dst_oi->oi.oi_id = cpu_to_le64(src_oi->oi.oi_id);
1640 dst_oi->oi.oi_seq = cpu_to_le64(src_oi->oi.oi_seq);
1643 /* extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm); */
1645 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
1646 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
1648 #define XATTR_NAME_ACL_ACCESS "system.posix_acl_access"
1649 #define XATTR_NAME_ACL_DEFAULT "system.posix_acl_default"
1650 #define XATTR_USER_PREFIX "user."
1651 #define XATTR_TRUSTED_PREFIX "trusted."
1652 #define XATTR_SECURITY_PREFIX "security."
1653 #define XATTR_LUSTRE_PREFIX "lustre."
1655 #define XATTR_NAME_LOV "trusted.lov"
1656 #define XATTR_NAME_LMA "trusted.lma"
1657 #define XATTR_NAME_LMV "trusted.lmv"
1658 #define XATTR_NAME_LINK "trusted.link"
1659 #define XATTR_NAME_FID "trusted.fid"
1660 #define XATTR_NAME_VERSION "trusted.version"
1661 #define XATTR_NAME_SOM "trusted.som"
1662 #define XATTR_NAME_HSM "trusted.hsm"
1663 #define XATTR_NAME_LFSCK_NAMESPACE "trusted.lfsck_namespace"
1665 struct lov_mds_md_v3 { /* LOV EA mds/wire data (little-endian) */
1666 __u32 lmm_magic; /* magic number = LOV_MAGIC_V3 */
1667 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1668 struct ost_id lmm_oi; /* LOV object ID */
1669 __u32 lmm_stripe_size; /* size of stripe in bytes */
1670 /* lmm_stripe_count used to be __u32 */
1671 __u16 lmm_stripe_count; /* num stripes in use for this object */
1672 __u16 lmm_layout_gen; /* layout generation number */
1673 char lmm_pool_name[LOV_MAXPOOLNAME]; /* must be 32bit aligned */
1674 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1677 static inline __u32 lov_mds_md_size(__u16 stripes, __u32 lmm_magic)
1679 if (lmm_magic == LOV_MAGIC_V3)
1680 return sizeof(struct lov_mds_md_v3) +
1681 stripes * sizeof(struct lov_ost_data_v1);
1683 return sizeof(struct lov_mds_md_v1) +
1684 stripes * sizeof(struct lov_ost_data_v1);
1688 #define OBD_MD_FLID (0x00000001ULL) /* object ID */
1689 #define OBD_MD_FLATIME (0x00000002ULL) /* access time */
1690 #define OBD_MD_FLMTIME (0x00000004ULL) /* data modification time */
1691 #define OBD_MD_FLCTIME (0x00000008ULL) /* change time */
1692 #define OBD_MD_FLSIZE (0x00000010ULL) /* size */
1693 #define OBD_MD_FLBLOCKS (0x00000020ULL) /* allocated blocks count */
1694 #define OBD_MD_FLBLKSZ (0x00000040ULL) /* block size */
1695 #define OBD_MD_FLMODE (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1696 #define OBD_MD_FLTYPE (0x00000100ULL) /* object type (mode & S_IFMT) */
1697 #define OBD_MD_FLUID (0x00000200ULL) /* user ID */
1698 #define OBD_MD_FLGID (0x00000400ULL) /* group ID */
1699 #define OBD_MD_FLFLAGS (0x00000800ULL) /* flags word */
1700 #define OBD_MD_FLNLINK (0x00002000ULL) /* link count */
1701 #define OBD_MD_FLGENER (0x00004000ULL) /* generation number */
1702 /*#define OBD_MD_FLINLINE (0x00008000ULL) inline data. used until 1.6.5 */
1703 #define OBD_MD_FLRDEV (0x00010000ULL) /* device number */
1704 #define OBD_MD_FLEASIZE (0x00020000ULL) /* extended attribute data */
1705 #define OBD_MD_LINKNAME (0x00040000ULL) /* symbolic link target */
1706 #define OBD_MD_FLHANDLE (0x00080000ULL) /* file/lock handle */
1707 #define OBD_MD_FLCKSUM (0x00100000ULL) /* bulk data checksum */
1708 #define OBD_MD_FLQOS (0x00200000ULL) /* quality of service stats */
1709 /*#define OBD_MD_FLOSCOPQ (0x00400000ULL) osc opaque data, never used */
1710 #define OBD_MD_FLCOOKIE (0x00800000ULL) /* log cancellation cookie */
1711 #define OBD_MD_FLGROUP (0x01000000ULL) /* group */
1712 #define OBD_MD_FLFID (0x02000000ULL) /* ->ost write inline fid */
1713 #define OBD_MD_FLEPOCH (0x04000000ULL) /* ->ost write with ioepoch */
1714 /* ->mds if epoch opens or closes */
1715 #define OBD_MD_FLGRANT (0x08000000ULL) /* ost preallocation space grant */
1716 #define OBD_MD_FLDIREA (0x10000000ULL) /* dir's extended attribute data */
1717 #define OBD_MD_FLUSRQUOTA (0x20000000ULL) /* over quota flags sent from ost */
1718 #define OBD_MD_FLGRPQUOTA (0x40000000ULL) /* over quota flags sent from ost */
1719 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1721 #define OBD_MD_MDS (0x0000000100000000ULL) /* where an inode lives on */
1722 #define OBD_MD_REINT (0x0000000200000000ULL) /* reintegrate oa */
1723 #define OBD_MD_MEA (0x0000000400000000ULL) /* CMD split EA */
1725 /* OBD_MD_MDTIDX is used to get MDT index, but it is never been used overwire,
1726 * and it is already obsolete since 2.3 */
1727 /* #define OBD_MD_MDTIDX (0x0000000800000000ULL) */
1729 #define OBD_MD_FLXATTR (0x0000001000000000ULL) /* xattr */
1730 #define OBD_MD_FLXATTRLS (0x0000002000000000ULL) /* xattr list */
1731 #define OBD_MD_FLXATTRRM (0x0000004000000000ULL) /* xattr remove */
1732 #define OBD_MD_FLACL (0x0000008000000000ULL) /* ACL */
1733 #define OBD_MD_FLRMTPERM (0x0000010000000000ULL) /* remote permission */
1734 #define OBD_MD_FLMDSCAPA (0x0000020000000000ULL) /* MDS capability */
1735 #define OBD_MD_FLOSSCAPA (0x0000040000000000ULL) /* OSS capability */
1736 #define OBD_MD_FLCKSPLIT (0x0000080000000000ULL) /* Check split on server */
1737 #define OBD_MD_FLCROSSREF (0x0000100000000000ULL) /* Cross-ref case */
1738 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1740 #define OBD_MD_FLOBJCOUNT (0x0000400000000000ULL) /* for multiple destroy */
1742 #define OBD_MD_FLRMTLSETFACL (0x0001000000000000ULL) /* lfs lsetfacl case */
1743 #define OBD_MD_FLRMTLGETFACL (0x0002000000000000ULL) /* lfs lgetfacl case */
1744 #define OBD_MD_FLRMTRSETFACL (0x0004000000000000ULL) /* lfs rsetfacl case */
1745 #define OBD_MD_FLRMTRGETFACL (0x0008000000000000ULL) /* lfs rgetfacl case */
1747 #define OBD_MD_FLDATAVERSION (0x0010000000000000ULL) /* iversion sum */
1749 #define OBD_MD_FLGETATTR (OBD_MD_FLID | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1750 OBD_MD_FLCTIME | OBD_MD_FLSIZE | OBD_MD_FLBLKSZ | \
1751 OBD_MD_FLMODE | OBD_MD_FLTYPE | OBD_MD_FLUID | \
1752 OBD_MD_FLGID | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1753 OBD_MD_FLGENER | OBD_MD_FLRDEV | OBD_MD_FLGROUP)
1755 /* don't forget obdo_fid which is way down at the bottom so it can
1756 * come after the definition of llog_cookie */
1760 HSS_CLEARMASK = 0x02,
1761 HSS_ARCHIVE_ID = 0x04,
1764 struct hsm_state_set {
1766 __u32 hss_archive_id;
1768 __u64 hss_clearmask;
1771 extern void lustre_swab_hsm_user_state(struct hsm_user_state *hus);
1772 extern void lustre_swab_hsm_state_set(struct hsm_state_set *hss);
1774 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
1776 /* ost_body.data values for OST_BRW */
1778 #define OBD_BRW_READ 0x01
1779 #define OBD_BRW_WRITE 0x02
1780 #define OBD_BRW_RWMASK (OBD_BRW_READ | OBD_BRW_WRITE)
1781 #define OBD_BRW_SYNC 0x08 /* this page is a part of synchronous
1782 * transfer and is not accounted in
1784 #define OBD_BRW_CHECK 0x10
1785 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
1786 #define OBD_BRW_GRANTED 0x40 /* the ost manages this */
1787 #define OBD_BRW_NOCACHE 0x80 /* this page is a part of non-cached IO */
1788 #define OBD_BRW_NOQUOTA 0x100
1789 #define OBD_BRW_SRVLOCK 0x200 /* Client holds no lock over this page */
1790 #define OBD_BRW_ASYNC 0x400 /* Server may delay commit to disk */
1791 #define OBD_BRW_MEMALLOC 0x800 /* Client runs in the "kswapd" context */
1792 #define OBD_BRW_OVER_USRQUOTA 0x1000 /* Running out of user quota */
1793 #define OBD_BRW_OVER_GRPQUOTA 0x2000 /* Running out of group quota */
1795 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
1797 #define OST_MIN_PRECREATE 32
1798 #define OST_MAX_PRECREATE 20000
1801 struct ost_id ioo_oid; /* object ID, if multi-obj BRW */
1802 __u32 ioo_max_brw; /* low 16 bits were o_mode before 2.4,
1803 * now (PTLRPC_BULK_OPS_COUNT - 1) in
1804 * high 16 bits in 2.4 and later */
1805 __u32 ioo_bufcnt; /* number of niobufs for this object */
1808 #define IOOBJ_MAX_BRW_BITS 16
1809 #define IOOBJ_TYPE_MASK ((1U << IOOBJ_MAX_BRW_BITS) - 1)
1810 #define ioobj_max_brw_get(ioo) (((ioo)->ioo_max_brw >> IOOBJ_MAX_BRW_BITS) + 1)
1811 #define ioobj_max_brw_set(ioo, num) \
1812 do { (ioo)->ioo_max_brw = ((num) - 1) << IOOBJ_MAX_BRW_BITS; } while (0)
1814 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
1816 /* multiple of 8 bytes => can array */
1817 struct niobuf_remote {
1823 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
1825 /* lock value block communicated between the filter and llite */
1827 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1828 * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1829 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1830 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1831 #define OST_LVB_IS_ERR(blocks) \
1832 ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1833 #define OST_LVB_SET_ERR(blocks, rc) \
1834 do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1835 #define OST_LVB_GET_ERR(blocks) (int)(blocks - OST_LVB_ERR_INIT)
1845 extern void lustre_swab_ost_lvb_v1(struct ost_lvb_v1 *lvb);
1859 extern void lustre_swab_ost_lvb(struct ost_lvb *lvb);
1862 * lquota data structures
1865 #ifndef QUOTABLOCK_BITS
1866 #define QUOTABLOCK_BITS 10
1869 #ifndef QUOTABLOCK_SIZE
1870 #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
1874 #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
1877 /* The lquota_id structure is an union of all the possible identifier types that
1878 * can be used with quota, this includes:
1881 * - a FID which can be used for per-directory quota in the future */
1883 struct lu_fid qid_fid; /* FID for per-directory quota */
1884 __u64 qid_uid; /* user identifier */
1885 __u64 qid_gid; /* group identifier */
1888 /* quotactl management */
1889 struct obd_quotactl {
1891 __u32 qc_type; /* see Q_* flag below */
1894 struct obd_dqinfo qc_dqinfo;
1895 struct obd_dqblk qc_dqblk;
1898 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1900 #define Q_QUOTACHECK 0x800100 /* deprecated as of 2.4 */
1901 #define Q_INITQUOTA 0x800101 /* deprecated as of 2.4 */
1902 #define Q_GETOINFO 0x800102 /* get obd quota info */
1903 #define Q_GETOQUOTA 0x800103 /* get obd quotas */
1904 #define Q_FINVALIDATE 0x800104 /* deprecated as of 2.4 */
1906 #define Q_COPY(out, in, member) (out)->member = (in)->member
1908 #define QCTL_COPY(out, in) \
1910 Q_COPY(out, in, qc_cmd); \
1911 Q_COPY(out, in, qc_type); \
1912 Q_COPY(out, in, qc_id); \
1913 Q_COPY(out, in, qc_stat); \
1914 Q_COPY(out, in, qc_dqinfo); \
1915 Q_COPY(out, in, qc_dqblk); \
1918 /* Body of quota request used for quota acquire/release RPCs between quota
1919 * master (aka QMT) and slaves (ak QSD). */
1921 struct lu_fid qb_fid; /* FID of global index packing the pool ID
1922 * and type (data or metadata) as well as
1923 * the quota type (user or group). */
1924 union lquota_id qb_id; /* uid or gid or directory FID */
1925 __u32 qb_flags; /* see below */
1927 __u64 qb_count; /* acquire/release count (kbytes/inodes) */
1928 __u64 qb_usage; /* current slave usage (kbytes/inodes) */
1929 __u64 qb_slv_ver; /* slave index file version */
1930 struct lustre_handle qb_lockh; /* per-ID lock handle */
1931 struct lustre_handle qb_glb_lockh; /* global lock handle */
1932 __u64 qb_padding1[4];
1935 /* When the quota_body is used in the reply of quota global intent
1936 * lock (IT_QUOTA_CONN) reply, qb_fid contains slave index file FID. */
1937 #define qb_slv_fid qb_fid
1938 /* qb_usage is the current qunit (in kbytes/inodes) when quota_body is used in
1940 #define qb_qunit qb_usage
1942 #define QUOTA_DQACQ_FL_ACQ 0x1 /* acquire quota */
1943 #define QUOTA_DQACQ_FL_PREACQ 0x2 /* pre-acquire */
1944 #define QUOTA_DQACQ_FL_REL 0x4 /* release quota */
1945 #define QUOTA_DQACQ_FL_REPORT 0x8 /* report usage */
1947 extern void lustre_swab_quota_body(struct quota_body *b);
1949 /* Quota types currently supported */
1951 LQUOTA_TYPE_USR = 0x00, /* maps to USRQUOTA */
1952 LQUOTA_TYPE_GRP = 0x01, /* maps to GRPQUOTA */
1956 /* There are 2 different resource types on which a quota limit can be enforced:
1957 * - inodes on the MDTs
1958 * - blocks on the OSTs */
1960 LQUOTA_RES_MD = 0x01, /* skip 0 to avoid null oid in FID */
1961 LQUOTA_RES_DT = 0x02,
1963 LQUOTA_FIRST_RES = LQUOTA_RES_MD
1965 #define LQUOTA_NR_RES (LQUOTA_LAST_RES - LQUOTA_FIRST_RES + 1)
1968 * Space accounting support
1969 * Format of an accounting record, providing disk usage information for a given
1972 struct lquota_acct_rec { /* 16 bytes */
1973 __u64 bspace; /* current space in use */
1974 __u64 ispace; /* current # inodes in use */
1978 * Global quota index support
1979 * Format of a global record, providing global quota settings for a given quota
1982 struct lquota_glb_rec { /* 32 bytes */
1983 __u64 qbr_hardlimit; /* quota hard limit, in #inodes or kbytes */
1984 __u64 qbr_softlimit; /* quota soft limit, in #inodes or kbytes */
1985 __u64 qbr_time; /* grace time, in seconds */
1986 __u64 qbr_granted; /* how much is granted to slaves, in #inodes or
1991 * Slave index support
1992 * Format of a slave record, recording how much space is granted to a given
1995 struct lquota_slv_rec { /* 8 bytes */
1996 __u64 qsr_granted; /* space granted to the slave for the key=ID,
1997 * in #inodes or kbytes */
2000 /* Data structures associated with the quota locks */
2002 /* Glimpse descriptor used for the index & per-ID quota locks */
2003 struct ldlm_gl_lquota_desc {
2004 union lquota_id gl_id; /* quota ID subject to the glimpse */
2005 __u64 gl_flags; /* see LQUOTA_FL* below */
2006 __u64 gl_ver; /* new index version */
2007 __u64 gl_hardlimit; /* new hardlimit or qunit value */
2008 __u64 gl_softlimit; /* new softlimit */
2012 #define gl_qunit gl_hardlimit /* current qunit value used when
2013 * glimpsing per-ID quota locks */
2015 /* quota glimpse flags */
2016 #define LQUOTA_FL_EDQUOT 0x1 /* user/group out of quota space on QMT */
2018 /* LVB used with quota (global and per-ID) locks */
2020 __u64 lvb_flags; /* see LQUOTA_FL* above */
2021 __u64 lvb_id_may_rel; /* space that might be released later */
2022 __u64 lvb_id_rel; /* space released by the slave for this ID */
2023 __u64 lvb_id_qunit; /* current qunit value */
2027 extern void lustre_swab_lquota_lvb(struct lquota_lvb *lvb);
2029 /* LVB used with global quota lock */
2030 #define lvb_glb_ver lvb_id_may_rel /* current version of the global index */
2038 #define QUOTA_FIRST_OPC QUOTA_DQACQ
2047 MDS_GETATTR_NAME = 34,
2052 MDS_DISCONNECT = 39,
2058 MDS_DONE_WRITING = 45,
2060 MDS_QUOTACHECK = 47,
2063 MDS_SETXATTR = 50, /* obsolete, now it's MDS_REINT op */
2067 MDS_HSM_STATE_GET = 54,
2068 MDS_HSM_STATE_SET = 55,
2069 MDS_HSM_ACTION = 56,
2070 MDS_HSM_PROGRESS = 57,
2071 MDS_HSM_REQUEST = 58,
2072 MDS_HSM_CT_REGISTER = 59,
2073 MDS_HSM_CT_UNREGISTER = 60,
2074 MDS_SWAP_LAYOUTS = 61,
2078 #define MDS_FIRST_OPC MDS_GETATTR
2081 /* opcodes for object update */
2087 #define UPDATE_FIRST_OPC UPDATE_OBJ
2104 } mds_reint_t, mdt_reint_t;
2106 extern void lustre_swab_generic_32s (__u32 *val);
2108 /* the disposition of the intent outlines what was executed */
2109 #define DISP_IT_EXECD 0x00000001
2110 #define DISP_LOOKUP_EXECD 0x00000002
2111 #define DISP_LOOKUP_NEG 0x00000004
2112 #define DISP_LOOKUP_POS 0x00000008
2113 #define DISP_OPEN_CREATE 0x00000010
2114 #define DISP_OPEN_OPEN 0x00000020
2115 #define DISP_ENQ_COMPLETE 0x00400000
2116 #define DISP_ENQ_OPEN_REF 0x00800000
2117 #define DISP_ENQ_CREATE_REF 0x01000000
2118 #define DISP_OPEN_LOCK 0x02000000
2120 /* INODE LOCK PARTS */
2121 #define MDS_INODELOCK_LOOKUP 0x000001 /* dentry, mode, owner, group */
2122 #define MDS_INODELOCK_UPDATE 0x000002 /* size, links, timestamps */
2123 #define MDS_INODELOCK_OPEN 0x000004 /* For opened files */
2124 #define MDS_INODELOCK_LAYOUT 0x000008 /* for layout */
2125 #define MDS_INODELOCK_PERM 0x000010 /* for permission */
2127 #define MDS_INODELOCK_MAXSHIFT 4
2128 /* This FULL lock is useful to take on unlink sort of operations */
2129 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
2131 extern void lustre_swab_ll_fid (struct ll_fid *fid);
2133 /* NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
2134 * but was moved into name[1] along with the OID to avoid consuming the
2135 * name[2,3] fields that need to be used for the quota id (also a FID). */
2137 LUSTRE_RES_ID_SEQ_OFF = 0,
2138 LUSTRE_RES_ID_VER_OID_OFF = 1,
2139 LUSTRE_RES_ID_WAS_VER_OFF = 2, /* see note above */
2140 LUSTRE_RES_ID_QUOTA_SEQ_OFF = 2,
2141 LUSTRE_RES_ID_QUOTA_VER_OID_OFF = 3,
2142 LUSTRE_RES_ID_HSH_OFF = 3
2145 #define MDS_STATUS_CONN 1
2146 #define MDS_STATUS_LOV 2
2148 /* mdt_thread_info.mti_flags. */
2150 /* The flag indicates Size-on-MDS attributes are changed. */
2151 MF_SOM_CHANGE = (1 << 0),
2152 /* Flags indicates an epoch opens or closes. */
2153 MF_EPOCH_OPEN = (1 << 1),
2154 MF_EPOCH_CLOSE = (1 << 2),
2155 MF_MDC_CANCEL_FID1 = (1 << 3),
2156 MF_MDC_CANCEL_FID2 = (1 << 4),
2157 MF_MDC_CANCEL_FID3 = (1 << 5),
2158 MF_MDC_CANCEL_FID4 = (1 << 6),
2159 /* There is a pending attribute update. */
2160 MF_SOM_AU = (1 << 7),
2161 /* Cancel OST locks while getattr OST attributes. */
2162 MF_GETATTR_LOCK = (1 << 8),
2163 MF_GET_MDT_IDX = (1 << 9),
2166 #define MF_SOM_LOCAL_FLAGS (MF_SOM_CHANGE | MF_EPOCH_OPEN | MF_EPOCH_CLOSE)
2168 #define LUSTRE_BFLAG_UNCOMMITTED_WRITES 0x1
2170 /* these should be identical to their EXT4_*_FL counterparts, they are
2171 * redefined here only to avoid dragging in fs/ext4/ext4.h */
2172 #define LUSTRE_SYNC_FL 0x00000008 /* Synchronous updates */
2173 #define LUSTRE_IMMUTABLE_FL 0x00000010 /* Immutable file */
2174 #define LUSTRE_APPEND_FL 0x00000020 /* writes to file may only append */
2175 #define LUSTRE_NOATIME_FL 0x00000080 /* do not update atime */
2176 #define LUSTRE_DIRSYNC_FL 0x00010000 /* dirsync behaviour (dir only) */
2179 /* Convert wire LUSTRE_*_FL to corresponding client local VFS S_* values
2180 * for the client inode i_flags. The LUSTRE_*_FL are the Lustre wire
2181 * protocol equivalents of LDISKFS_*_FL values stored on disk, while
2182 * the S_* flags are kernel-internal values that change between kernel
2183 * versions. These flags are set/cleared via FSFILT_IOC_{GET,SET}_FLAGS.
2184 * See b=16526 for a full history. */
2185 static inline int ll_ext_to_inode_flags(int flags)
2187 return (((flags & LUSTRE_SYNC_FL) ? S_SYNC : 0) |
2188 ((flags & LUSTRE_NOATIME_FL) ? S_NOATIME : 0) |
2189 ((flags & LUSTRE_APPEND_FL) ? S_APPEND : 0) |
2190 #if defined(S_DIRSYNC)
2191 ((flags & LUSTRE_DIRSYNC_FL) ? S_DIRSYNC : 0) |
2193 ((flags & LUSTRE_IMMUTABLE_FL) ? S_IMMUTABLE : 0));
2196 static inline int ll_inode_to_ext_flags(int iflags)
2198 return (((iflags & S_SYNC) ? LUSTRE_SYNC_FL : 0) |
2199 ((iflags & S_NOATIME) ? LUSTRE_NOATIME_FL : 0) |
2200 ((iflags & S_APPEND) ? LUSTRE_APPEND_FL : 0) |
2201 #if defined(S_DIRSYNC)
2202 ((iflags & S_DIRSYNC) ? LUSTRE_DIRSYNC_FL : 0) |
2204 ((iflags & S_IMMUTABLE) ? LUSTRE_IMMUTABLE_FL : 0));
2211 struct lustre_handle handle;
2213 __u64 size; /* Offset, in the case of MDS_READPAGE */
2217 __u64 blocks; /* XID, in the case of MDS_READPAGE */
2219 __u64 unused1; /* was "ino" until 2.4.0 */
2226 __u32 flags; /* from vfs for pin/unpin, LUSTRE_BFLAG close */
2228 __u32 nlink; /* #bytes to read in the case of MDS_READPAGE */
2229 __u32 unused2; /* was "generation" until 2.4.0 */
2234 __u32 max_cookiesize;
2235 __u32 uid_h; /* high 32-bits of uid, for FUID */
2236 __u32 gid_h; /* high 32-bits of gid, for FUID */
2237 __u32 padding_5; /* also fix lustre_swab_mdt_body */
2245 extern void lustre_swab_mdt_body (struct mdt_body *b);
2247 struct mdt_ioepoch {
2248 struct lustre_handle handle;
2254 extern void lustre_swab_mdt_ioepoch (struct mdt_ioepoch *b);
2256 /* permissions for md_perm.mp_perm */
2258 CFS_SETUID_PERM = 0x01,
2259 CFS_SETGID_PERM = 0x02,
2260 CFS_SETGRP_PERM = 0x04,
2261 CFS_RMTACL_PERM = 0x08,
2262 CFS_RMTOWN_PERM = 0x10
2265 /* inode access permission for remote user, the inode info are omitted,
2266 * for client knows them. */
2267 struct mdt_remote_perm {
2274 __u32 rp_access_perm; /* MAY_READ/WRITE/EXEC */
2278 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
2280 struct mdt_rec_setattr {
2290 __u32 sa_padding_1_h;
2291 struct lu_fid sa_fid;
2300 __u32 sa_attr_flags;
2302 __u32 sa_bias; /* some operation flags */
2308 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
2311 * Attribute flags used in mdt_rec_setattr::sa_valid.
2312 * The kernel's #defines for ATTR_* should not be used over the network
2313 * since the client and MDS may run different kernels (see bug 13828)
2314 * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
2316 #define MDS_ATTR_MODE 0x1ULL /* = 1 */
2317 #define MDS_ATTR_UID 0x2ULL /* = 2 */
2318 #define MDS_ATTR_GID 0x4ULL /* = 4 */
2319 #define MDS_ATTR_SIZE 0x8ULL /* = 8 */
2320 #define MDS_ATTR_ATIME 0x10ULL /* = 16 */
2321 #define MDS_ATTR_MTIME 0x20ULL /* = 32 */
2322 #define MDS_ATTR_CTIME 0x40ULL /* = 64 */
2323 #define MDS_ATTR_ATIME_SET 0x80ULL /* = 128 */
2324 #define MDS_ATTR_MTIME_SET 0x100ULL /* = 256 */
2325 #define MDS_ATTR_FORCE 0x200ULL /* = 512, Not a change, but a change it */
2326 #define MDS_ATTR_ATTR_FLAG 0x400ULL /* = 1024 */
2327 #define MDS_ATTR_KILL_SUID 0x800ULL /* = 2048 */
2328 #define MDS_ATTR_KILL_SGID 0x1000ULL /* = 4096 */
2329 #define MDS_ATTR_CTIME_SET 0x2000ULL /* = 8192 */
2330 #define MDS_ATTR_FROM_OPEN 0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
2331 #define MDS_ATTR_BLOCKS 0x8000ULL /* = 32768 */
2334 #define FMODE_READ 00000001
2335 #define FMODE_WRITE 00000002
2338 #define MDS_FMODE_CLOSED 00000000
2339 #define MDS_FMODE_EXEC 00000004
2340 /* IO Epoch is opened on a closed file. */
2341 #define MDS_FMODE_EPOCH 01000000
2342 /* IO Epoch is opened on a file truncate. */
2343 #define MDS_FMODE_TRUNC 02000000
2344 /* Size-on-MDS Attribute Update is pending. */
2345 #define MDS_FMODE_SOM 04000000
2347 #define MDS_OPEN_CREATED 00000010
2348 #define MDS_OPEN_CROSS 00000020
2350 #define MDS_OPEN_CREAT 00000100
2351 #define MDS_OPEN_EXCL 00000200
2352 #define MDS_OPEN_TRUNC 00001000
2353 #define MDS_OPEN_APPEND 00002000
2354 #define MDS_OPEN_SYNC 00010000
2355 #define MDS_OPEN_DIRECTORY 00200000
2357 #define MDS_OPEN_BY_FID 040000000 /* open_by_fid for known object */
2358 #define MDS_OPEN_DELAY_CREATE 0100000000 /* delay initial object create */
2359 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
2360 #define MDS_OPEN_JOIN_FILE 0400000000 /* open for join file.
2361 * We do not support JOIN FILE
2362 * anymore, reserve this flags
2363 * just for preventing such bit
2366 #define MDS_OPEN_LOCK 04000000000 /* This open requires open lock */
2367 #define MDS_OPEN_HAS_EA 010000000000 /* specify object create pattern */
2368 #define MDS_OPEN_HAS_OBJS 020000000000 /* Just set the EA the obj exist */
2369 #define MDS_OPEN_NORESTORE 0100000000000ULL /* Do not restore file at open */
2370 #define MDS_OPEN_NEWSTRIPE 0200000000000ULL /* New stripe needed (restripe or
2372 #define MDS_OPEN_VOLATILE 0400000000000ULL /* File is volatile = created
2375 /* permission for create non-directory file */
2376 #define MAY_CREATE (1 << 7)
2377 /* permission for create directory file */
2378 #define MAY_LINK (1 << 8)
2379 /* permission for delete from the directory */
2380 #define MAY_UNLINK (1 << 9)
2381 /* source's permission for rename */
2382 #define MAY_RENAME_SRC (1 << 10)
2383 /* target's permission for rename */
2384 #define MAY_RENAME_TAR (1 << 11)
2385 /* part (parent's) VTX permission check */
2386 #define MAY_VTX_PART (1 << 12)
2387 /* full VTX permission check */
2388 #define MAY_VTX_FULL (1 << 13)
2389 /* lfs rgetfacl permission check */
2390 #define MAY_RGETFACL (1 << 14)
2393 MDS_CHECK_SPLIT = 1 << 0,
2394 MDS_CROSS_REF = 1 << 1,
2395 MDS_VTX_BYPASS = 1 << 2,
2396 MDS_PERM_BYPASS = 1 << 3,
2398 MDS_QUOTA_IGNORE = 1 << 5,
2399 MDS_CLOSE_CLEANUP = 1 << 6,
2400 MDS_KEEP_ORPHAN = 1 << 7,
2401 MDS_RECOV_OPEN = 1 << 8,
2402 MDS_DATA_MODIFIED = 1 << 9,
2403 MDS_CREATE_VOLATILE = 1 << 10,
2404 MDS_OWNEROVERRIDE = 1 << 11,
2407 /* instance of mdt_reint_rec */
2408 struct mdt_rec_create {
2416 __u32 cr_suppgid1_h;
2418 __u32 cr_suppgid2_h;
2419 struct lu_fid cr_fid1;
2420 struct lu_fid cr_fid2;
2421 struct lustre_handle cr_old_handle; /* handle in case of open replay */
2425 __u64 cr_padding_1; /* rr_blocks */
2428 /* use of helpers set/get_mrc_cr_flags() is needed to access
2429 * 64 bits cr_flags [cr_flags_l, cr_flags_h], this is done to
2430 * extend cr_flags size without breaking 1.8 compat */
2431 __u32 cr_flags_l; /* for use with open, low 32 bits */
2432 __u32 cr_flags_h; /* for use with open, high 32 bits */
2433 __u32 cr_umask; /* umask for create */
2434 __u32 cr_padding_4; /* rr_padding_4 */
2437 static inline void set_mrc_cr_flags(struct mdt_rec_create *mrc, __u64 flags)
2439 mrc->cr_flags_l = (__u32)(flags & 0xFFFFFFFFUll);
2440 mrc->cr_flags_h = (__u32)(flags >> 32);
2443 static inline __u64 get_mrc_cr_flags(struct mdt_rec_create *mrc)
2445 return ((__u64)(mrc->cr_flags_l) | ((__u64)mrc->cr_flags_h << 32));
2448 /* instance of mdt_reint_rec */
2449 struct mdt_rec_link {
2457 __u32 lk_suppgid1_h;
2459 __u32 lk_suppgid2_h;
2460 struct lu_fid lk_fid1;
2461 struct lu_fid lk_fid2;
2463 __u64 lk_padding_1; /* rr_atime */
2464 __u64 lk_padding_2; /* rr_ctime */
2465 __u64 lk_padding_3; /* rr_size */
2466 __u64 lk_padding_4; /* rr_blocks */
2468 __u32 lk_padding_5; /* rr_mode */
2469 __u32 lk_padding_6; /* rr_flags */
2470 __u32 lk_padding_7; /* rr_padding_2 */
2471 __u32 lk_padding_8; /* rr_padding_3 */
2472 __u32 lk_padding_9; /* rr_padding_4 */
2475 /* instance of mdt_reint_rec */
2476 struct mdt_rec_unlink {
2484 __u32 ul_suppgid1_h;
2486 __u32 ul_suppgid2_h;
2487 struct lu_fid ul_fid1;
2488 struct lu_fid ul_fid2;
2490 __u64 ul_padding_2; /* rr_atime */
2491 __u64 ul_padding_3; /* rr_ctime */
2492 __u64 ul_padding_4; /* rr_size */
2493 __u64 ul_padding_5; /* rr_blocks */
2496 __u32 ul_padding_6; /* rr_flags */
2497 __u32 ul_padding_7; /* rr_padding_2 */
2498 __u32 ul_padding_8; /* rr_padding_3 */
2499 __u32 ul_padding_9; /* rr_padding_4 */
2502 /* instance of mdt_reint_rec */
2503 struct mdt_rec_rename {
2511 __u32 rn_suppgid1_h;
2513 __u32 rn_suppgid2_h;
2514 struct lu_fid rn_fid1;
2515 struct lu_fid rn_fid2;
2517 __u64 rn_padding_1; /* rr_atime */
2518 __u64 rn_padding_2; /* rr_ctime */
2519 __u64 rn_padding_3; /* rr_size */
2520 __u64 rn_padding_4; /* rr_blocks */
2521 __u32 rn_bias; /* some operation flags */
2522 __u32 rn_mode; /* cross-ref rename has mode */
2523 __u32 rn_padding_5; /* rr_flags */
2524 __u32 rn_padding_6; /* rr_padding_2 */
2525 __u32 rn_padding_7; /* rr_padding_3 */
2526 __u32 rn_padding_8; /* rr_padding_4 */
2529 /* instance of mdt_reint_rec */
2530 struct mdt_rec_setxattr {
2538 __u32 sx_suppgid1_h;
2540 __u32 sx_suppgid2_h;
2541 struct lu_fid sx_fid;
2542 __u64 sx_padding_1; /* These three are rr_fid2 */
2547 __u64 sx_padding_5; /* rr_ctime */
2548 __u64 sx_padding_6; /* rr_size */
2549 __u64 sx_padding_7; /* rr_blocks */
2552 __u32 sx_padding_8; /* rr_flags */
2553 __u32 sx_padding_9; /* rr_padding_2 */
2554 __u32 sx_padding_10; /* rr_padding_3 */
2555 __u32 sx_padding_11; /* rr_padding_4 */
2559 * mdt_rec_reint is the template for all mdt_reint_xxx structures.
2560 * Do NOT change the size of various members, otherwise the value
2561 * will be broken in lustre_swab_mdt_rec_reint().
2563 * If you add new members in other mdt_reint_xxx structres and need to use the
2564 * rr_padding_x fields, then update lustre_swab_mdt_rec_reint() also.
2566 struct mdt_rec_reint {
2574 __u32 rr_suppgid1_h;
2576 __u32 rr_suppgid2_h;
2577 struct lu_fid rr_fid1;
2578 struct lu_fid rr_fid2;
2589 __u32 rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
2592 extern void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
2595 __u32 ld_tgt_count; /* how many MDS's */
2596 __u32 ld_active_tgt_count; /* how many active */
2597 __u32 ld_default_stripe_count; /* how many objects are used */
2598 __u32 ld_pattern; /* default MEA_MAGIC_* */
2599 __u64 ld_default_hash_size;
2600 __u64 ld_padding_1; /* also fix lustre_swab_lmv_desc */
2601 __u32 ld_padding_2; /* also fix lustre_swab_lmv_desc */
2602 __u32 ld_qos_maxage; /* in second */
2603 __u32 ld_padding_3; /* also fix lustre_swab_lmv_desc */
2604 __u32 ld_padding_4; /* also fix lustre_swab_lmv_desc */
2605 struct obd_uuid ld_uuid;
2608 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
2610 /* TODO: lmv_stripe_md should contain mds capabilities for all slave fids */
2611 struct lmv_stripe_md {
2616 char mea_pool_name[LOV_MAXPOOLNAME];
2617 struct lu_fid mea_ids[0];
2620 extern void lustre_swab_lmv_stripe_md(struct lmv_stripe_md *mea);
2622 /* lmv structures */
2623 #define MEA_MAGIC_LAST_CHAR 0xb2221ca1
2624 #define MEA_MAGIC_ALL_CHARS 0xb222a11c
2625 #define MEA_MAGIC_HASH_SEGMENT 0xb222a11b
2627 #define MAX_HASH_SIZE_32 0x7fffffffUL
2628 #define MAX_HASH_SIZE 0x7fffffffffffffffULL
2629 #define MAX_HASH_HIGHEST_BIT 0x1000000000000000ULL
2634 FLD_FIRST_OPC = FLD_QUERY
2640 SEQ_FIRST_OPC = SEQ_QUERY
2644 SEQ_ALLOC_SUPER = 0,
2649 * LOV data structures
2652 #define LOV_MAX_UUID_BUFFER_SIZE 8192
2653 /* The size of the buffer the lov/mdc reserves for the
2654 * array of UUIDs returned by the MDS. With the current
2655 * protocol, this will limit the max number of OSTs per LOV */
2657 #define LOV_DESC_MAGIC 0xB0CCDE5C
2659 /* LOV settings descriptor (should only contain static info) */
2661 __u32 ld_tgt_count; /* how many OBD's */
2662 __u32 ld_active_tgt_count; /* how many active */
2663 __u32 ld_default_stripe_count; /* how many objects are used */
2664 __u32 ld_pattern; /* default PATTERN_RAID0 */
2665 __u64 ld_default_stripe_size; /* in bytes */
2666 __u64 ld_default_stripe_offset; /* in bytes */
2667 __u32 ld_padding_0; /* unused */
2668 __u32 ld_qos_maxage; /* in second */
2669 __u32 ld_padding_1; /* also fix lustre_swab_lov_desc */
2670 __u32 ld_padding_2; /* also fix lustre_swab_lov_desc */
2671 struct obd_uuid ld_uuid;
2674 #define ld_magic ld_active_tgt_count /* for swabbing from llogs */
2676 extern void lustre_swab_lov_desc (struct lov_desc *ld);
2681 /* opcodes -- MUST be distinct from OST/MDS opcodes */
2686 LDLM_BL_CALLBACK = 104,
2687 LDLM_CP_CALLBACK = 105,
2688 LDLM_GL_CALLBACK = 106,
2689 LDLM_SET_INFO = 107,
2692 #define LDLM_FIRST_OPC LDLM_ENQUEUE
2694 #define RES_NAME_SIZE 4
2695 struct ldlm_res_id {
2696 __u64 name[RES_NAME_SIZE];
2699 #define DLDLMRES "["LPX64":"LPX64":"LPX64"]."LPX64i
2700 #define PLDLMRES(res) (res)->lr_name.name[0], (res)->lr_name.name[1], \
2701 (res)->lr_name.name[2], (res)->lr_name.name[3]
2703 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
2705 static inline int ldlm_res_eq(const struct ldlm_res_id *res0,
2706 const struct ldlm_res_id *res1)
2708 return !memcmp(res0, res1, sizeof(*res0));
2725 #define LCK_MODE_NUM 8
2735 #define LDLM_MIN_TYPE LDLM_PLAIN
2737 struct ldlm_extent {
2743 static inline int ldlm_extent_overlap(struct ldlm_extent *ex1,
2744 struct ldlm_extent *ex2)
2746 return (ex1->start <= ex2->end) && (ex2->start <= ex1->end);
2749 /* check if @ex1 contains @ex2 */
2750 static inline int ldlm_extent_contain(struct ldlm_extent *ex1,
2751 struct ldlm_extent *ex2)
2753 return (ex1->start <= ex2->start) && (ex1->end >= ex2->end);
2756 struct ldlm_inodebits {
2760 struct ldlm_flock_wire {
2768 /* it's important that the fields of the ldlm_extent structure match
2769 * the first fields of the ldlm_flock structure because there is only
2770 * one ldlm_swab routine to process the ldlm_policy_data_t union. if
2771 * this ever changes we will need to swab the union differently based
2772 * on the resource type. */
2775 struct ldlm_extent l_extent;
2776 struct ldlm_flock_wire l_flock;
2777 struct ldlm_inodebits l_inodebits;
2778 } ldlm_wire_policy_data_t;
2780 extern void lustre_swab_ldlm_policy_data (ldlm_wire_policy_data_t *d);
2782 union ldlm_gl_desc {
2783 struct ldlm_gl_lquota_desc lquota_desc;
2786 extern void lustre_swab_gl_desc(union ldlm_gl_desc *);
2788 struct ldlm_intent {
2792 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
2794 struct ldlm_resource_desc {
2795 ldlm_type_t lr_type;
2796 __u32 lr_padding; /* also fix lustre_swab_ldlm_resource_desc */
2797 struct ldlm_res_id lr_name;
2800 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
2802 struct ldlm_lock_desc {
2803 struct ldlm_resource_desc l_resource;
2804 ldlm_mode_t l_req_mode;
2805 ldlm_mode_t l_granted_mode;
2806 ldlm_wire_policy_data_t l_policy_data;
2809 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
2811 #define LDLM_LOCKREQ_HANDLES 2
2812 #define LDLM_ENQUEUE_CANCEL_OFF 1
2814 struct ldlm_request {
2817 struct ldlm_lock_desc lock_desc;
2818 struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
2821 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
2823 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
2824 * Otherwise, 2 are available. */
2825 #define ldlm_request_bufsize(count,type) \
2827 int _avail = LDLM_LOCKREQ_HANDLES; \
2828 _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
2829 sizeof(struct ldlm_request) + \
2830 (count > _avail ? count - _avail : 0) * \
2831 sizeof(struct lustre_handle); \
2836 __u32 lock_padding; /* also fix lustre_swab_ldlm_reply */
2837 struct ldlm_lock_desc lock_desc;
2838 struct lustre_handle lock_handle;
2839 __u64 lock_policy_res1;
2840 __u64 lock_policy_res2;
2843 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
2845 #define ldlm_flags_to_wire(flags) ((__u32)(flags))
2846 #define ldlm_flags_from_wire(flags) ((__u64)(flags))
2849 * Opcodes for mountconf (mgs and mgc)
2854 MGS_EXCEPTION, /* node died, etc. */
2855 MGS_TARGET_REG, /* whenever target starts up */
2861 #define MGS_FIRST_OPC MGS_CONNECT
2863 #define MGS_PARAM_MAXLEN 1024
2864 #define KEY_SET_INFO "set_info"
2866 struct mgs_send_param {
2867 char mgs_param[MGS_PARAM_MAXLEN];
2870 /* We pass this info to the MGS so it can write config logs */
2871 #define MTI_NAME_MAXLEN 64
2872 #define MTI_PARAM_MAXLEN 4096
2873 #define MTI_NIDS_MAX 32
2874 struct mgs_target_info {
2875 __u32 mti_lustre_ver;
2876 __u32 mti_stripe_index;
2877 __u32 mti_config_ver;
2879 __u32 mti_nid_count;
2880 __u32 mti_instance; /* Running instance of target */
2881 char mti_fsname[MTI_NAME_MAXLEN];
2882 char mti_svname[MTI_NAME_MAXLEN];
2883 char mti_uuid[sizeof(struct obd_uuid)];
2884 __u64 mti_nids[MTI_NIDS_MAX]; /* host nids (lnet_nid_t)*/
2885 char mti_params[MTI_PARAM_MAXLEN];
2887 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
2889 struct mgs_nidtbl_entry {
2890 __u64 mne_version; /* table version of this entry */
2891 __u32 mne_instance; /* target instance # */
2892 __u32 mne_index; /* target index */
2893 __u32 mne_length; /* length of this entry - by bytes */
2894 __u8 mne_type; /* target type LDD_F_SV_TYPE_OST/MDT */
2895 __u8 mne_nid_type; /* type of nid(mbz). for ipv6. */
2896 __u8 mne_nid_size; /* size of each NID, by bytes */
2897 __u8 mne_nid_count; /* # of NIDs in buffer */
2899 lnet_nid_t nids[0]; /* variable size buffer for NIDs. */
2902 extern void lustre_swab_mgs_nidtbl_entry(struct mgs_nidtbl_entry *oinfo);
2904 struct mgs_config_body {
2905 char mcb_name[MTI_NAME_MAXLEN]; /* logname */
2906 __u64 mcb_offset; /* next index of config log to request */
2907 __u16 mcb_type; /* type of log: CONFIG_T_[CONFIG|RECOVER] */
2909 __u8 mcb_bits; /* bits unit size of config log */
2910 __u32 mcb_units; /* # of units for bulk transfer */
2912 extern void lustre_swab_mgs_config_body(struct mgs_config_body *body);
2914 struct mgs_config_res {
2915 __u64 mcr_offset; /* index of last config log */
2916 __u64 mcr_size; /* size of the log */
2918 extern void lustre_swab_mgs_config_res(struct mgs_config_res *body);
2920 /* Config marker flags (in config log) */
2921 #define CM_START 0x01
2923 #define CM_SKIP 0x04
2924 #define CM_UPGRADE146 0x08
2925 #define CM_EXCLUDE 0x10
2926 #define CM_START_SKIP (CM_START | CM_SKIP)
2929 __u32 cm_step; /* aka config version */
2931 __u32 cm_vers; /* lustre release version number */
2932 __u32 cm_padding; /* 64 bit align */
2933 obd_time cm_createtime; /*when this record was first created */
2934 obd_time cm_canceltime; /*when this record is no longer valid*/
2935 char cm_tgtname[MTI_NAME_MAXLEN];
2936 char cm_comment[MTI_NAME_MAXLEN];
2939 extern void lustre_swab_cfg_marker(struct cfg_marker *marker,
2940 int swab, int size);
2943 * Opcodes for multiple servers.
2953 #define OBD_FIRST_OPC OBD_PING
2955 /* catalog of log objects */
2957 /** Identifier for a single log object */
2959 struct ost_id lgl_oi;
2961 } __attribute__((packed));
2963 /** Records written to the CATALOGS list */
2964 #define CATLIST "CATALOGS"
2966 struct llog_logid lci_logid;
2970 } __attribute__((packed));
2972 /* Log data record types - there is no specific reason that these need to
2973 * be related to the RPC opcodes, but no reason not to (may be handy later?)
2975 #define LLOG_OP_MAGIC 0x10600000
2976 #define LLOG_OP_MASK 0xfff00000
2979 LLOG_PAD_MAGIC = LLOG_OP_MAGIC | 0x00000,
2980 OST_SZ_REC = LLOG_OP_MAGIC | 0x00f00,
2981 /* OST_RAID1_REC = LLOG_OP_MAGIC | 0x01000, never used */
2982 MDS_UNLINK_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) |
2983 REINT_UNLINK, /* obsolete after 2.5.0 */
2984 MDS_UNLINK64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2986 /* MDS_SETATTR_REC = LLOG_OP_MAGIC | 0x12401, obsolete 1.8.0 */
2987 MDS_SETATTR64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2989 OBD_CFG_REC = LLOG_OP_MAGIC | 0x20000,
2990 /* PTL_CFG_REC = LLOG_OP_MAGIC | 0x30000, obsolete 1.4.0 */
2991 LLOG_GEN_REC = LLOG_OP_MAGIC | 0x40000,
2992 /* LLOG_JOIN_REC = LLOG_OP_MAGIC | 0x50000, obsolete 1.8.0 */
2993 CHANGELOG_REC = LLOG_OP_MAGIC | 0x60000,
2994 CHANGELOG_USER_REC = LLOG_OP_MAGIC | 0x70000,
2995 LLOG_HDR_MAGIC = LLOG_OP_MAGIC | 0x45539,
2996 LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
2999 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
3000 (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == __swab32(LLOG_OP_MAGIC))
3002 /** Log record header - stored in little endian order.
3003 * Each record must start with this struct, end with a llog_rec_tail,
3004 * and be a multiple of 256 bits in size.
3006 struct llog_rec_hdr {
3013 struct llog_rec_tail {
3018 /* Where data follow just after header */
3019 #define REC_DATA(ptr) \
3020 ((void *)((char *)ptr + sizeof(struct llog_rec_hdr)))
3022 #define REC_DATA_LEN(rec) \
3023 (rec->lrh_len - sizeof(struct llog_rec_hdr) - \
3024 sizeof(struct llog_rec_tail))
3026 struct llog_logid_rec {
3027 struct llog_rec_hdr lid_hdr;
3028 struct llog_logid lid_id;
3032 struct llog_rec_tail lid_tail;
3033 } __attribute__((packed));
3035 struct llog_unlink_rec {
3036 struct llog_rec_hdr lur_hdr;
3039 obd_count lur_count;
3040 struct llog_rec_tail lur_tail;
3041 } __attribute__((packed));
3043 struct llog_unlink64_rec {
3044 struct llog_rec_hdr lur_hdr;
3045 struct lu_fid lur_fid;
3046 obd_count lur_count; /* to destroy the lost precreated */
3050 struct llog_rec_tail lur_tail;
3051 } __attribute__((packed));
3053 struct llog_setattr64_rec {
3054 struct llog_rec_hdr lsr_hdr;
3055 struct ost_id lsr_oi;
3061 struct llog_rec_tail lsr_tail;
3062 } __attribute__((packed));
3064 struct llog_size_change_rec {
3065 struct llog_rec_hdr lsc_hdr;
3066 struct ll_fid lsc_fid;
3071 struct llog_rec_tail lsc_tail;
3072 } __attribute__((packed));
3074 #define CHANGELOG_MAGIC 0xca103000
3076 /** \a changelog_rec_type's that can't be masked */
3077 #define CHANGELOG_MINMASK (1 << CL_MARK)
3078 /** bits covering all \a changelog_rec_type's */
3079 #define CHANGELOG_ALLMASK 0XFFFFFFFF
3080 /** default \a changelog_rec_type mask */
3081 #define CHANGELOG_DEFMASK CHANGELOG_ALLMASK & ~(1 << CL_ATIME | 1 << CL_CLOSE)
3083 /* changelog llog name, needed by client replicators */
3084 #define CHANGELOG_CATALOG "changelog_catalog"
3086 struct changelog_setinfo {
3089 } __attribute__((packed));
3091 /** changelog record */
3092 struct llog_changelog_rec {
3093 struct llog_rec_hdr cr_hdr;
3094 struct changelog_rec cr;
3095 struct llog_rec_tail cr_tail; /**< for_sizezof_only */
3096 } __attribute__((packed));
3098 struct llog_changelog_ext_rec {
3099 struct llog_rec_hdr cr_hdr;
3100 struct changelog_ext_rec cr;
3101 struct llog_rec_tail cr_tail; /**< for_sizezof_only */
3102 } __attribute__((packed));
3104 #define CHANGELOG_USER_PREFIX "cl"
3106 struct llog_changelog_user_rec {
3107 struct llog_rec_hdr cur_hdr;
3111 struct llog_rec_tail cur_tail;
3112 } __attribute__((packed));
3114 /* Old llog gen for compatibility */
3118 } __attribute__((packed));
3120 struct llog_gen_rec {
3121 struct llog_rec_hdr lgr_hdr;
3122 struct llog_gen lgr_gen;
3126 struct llog_rec_tail lgr_tail;
3129 /* On-disk header structure of each log object, stored in little endian order */
3130 #define LLOG_CHUNK_SIZE 8192
3131 #define LLOG_HEADER_SIZE (96)
3132 #define LLOG_BITMAP_BYTES (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
3134 #define LLOG_MIN_REC_SIZE (24) /* round(llog_rec_hdr + llog_rec_tail) */
3136 /* flags for the logs */
3138 LLOG_F_ZAP_WHEN_EMPTY = 0x1,
3139 LLOG_F_IS_CAT = 0x2,
3140 LLOG_F_IS_PLAIN = 0x4,
3143 struct llog_log_hdr {
3144 struct llog_rec_hdr llh_hdr;
3145 obd_time llh_timestamp;
3147 __u32 llh_bitmap_offset;
3151 /* for a catalog the first plain slot is next to it */
3152 struct obd_uuid llh_tgtuuid;
3153 __u32 llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
3154 __u32 llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
3155 struct llog_rec_tail llh_tail;
3156 } __attribute__((packed));
3158 #define LLOG_BITMAP_SIZE(llh) (__u32)((llh->llh_hdr.lrh_len - \
3159 llh->llh_bitmap_offset - \
3160 sizeof(llh->llh_tail)) * 8)
3162 /** log cookies are used to reference a specific log file and a record therein */
3163 struct llog_cookie {
3164 struct llog_logid lgc_lgl;
3168 } __attribute__((packed));
3170 /** llog protocol */
3171 enum llogd_rpc_ops {
3172 LLOG_ORIGIN_HANDLE_CREATE = 501,
3173 LLOG_ORIGIN_HANDLE_NEXT_BLOCK = 502,
3174 LLOG_ORIGIN_HANDLE_READ_HEADER = 503,
3175 LLOG_ORIGIN_HANDLE_WRITE_REC = 504,
3176 LLOG_ORIGIN_HANDLE_CLOSE = 505,
3177 LLOG_ORIGIN_CONNECT = 506,
3178 LLOG_CATINFO = 507, /* deprecated */
3179 LLOG_ORIGIN_HANDLE_PREV_BLOCK = 508,
3180 LLOG_ORIGIN_HANDLE_DESTROY = 509, /* for destroy llog object*/
3182 LLOG_FIRST_OPC = LLOG_ORIGIN_HANDLE_CREATE
3186 struct llog_logid lgd_logid;
3188 __u32 lgd_llh_flags;
3190 __u32 lgd_saved_index;
3192 __u64 lgd_cur_offset;
3193 } __attribute__((packed));
3195 struct llogd_conn_body {
3196 struct llog_gen lgdc_gen;
3197 struct llog_logid lgdc_logid;
3198 __u32 lgdc_ctxt_idx;
3199 } __attribute__((packed));
3201 /* Note: 64-bit types are 64-bit aligned in structure */
3203 obd_valid o_valid; /* hot fields in this obdo */
3205 obd_id o_parent_seq;
3206 obd_size o_size; /* o_size-o_blocks == ost_lvb */
3210 obd_blocks o_blocks; /* brw: cli sent cached bytes */
3213 /* 32-bit fields start here: keep an even number of them via padding */
3214 obd_blksize o_blksize; /* optimal IO blocksize */
3215 obd_mode o_mode; /* brw: cli sent cache remain */
3219 obd_count o_nlink; /* brw: checksum */
3220 obd_count o_parent_oid;
3221 obd_count o_misc; /* brw: o_dropped */
3223 __u64 o_ioepoch; /* epoch in ost writes */
3224 __u32 o_stripe_idx; /* holds stripe idx */
3226 struct lustre_handle o_handle; /* brw: lock handle to prolong
3228 struct llog_cookie o_lcookie; /* destroy: unlink cookie from
3233 __u64 o_data_version; /* getattr: sum of iversion for
3235 * brw: grant space consumed on
3236 * the client for the write */
3242 #define o_dirty o_blocks
3243 #define o_undirty o_mode
3244 #define o_dropped o_misc
3245 #define o_cksum o_nlink
3246 #define o_grant_used o_data_version
3248 static inline void lustre_set_wire_obdo(struct obd_connect_data *ocd,
3249 struct obdo *wobdo, struct obdo *lobdo)
3251 memcpy(wobdo, lobdo, sizeof(*lobdo));
3252 wobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
3256 if (unlikely(!(ocd->ocd_connect_flags & OBD_CONNECT_FID)) &&
3257 fid_seq_is_echo(ostid_seq(&lobdo->o_oi))) {
3258 /* Currently OBD_FL_OSTID will only be used when 2.4 echo
3259 * client communicate with pre-2.4 server */
3260 wobdo->o_oi.oi.oi_id = fid_oid(&lobdo->o_oi.oi_fid);
3261 wobdo->o_oi.oi.oi_seq = fid_seq(&lobdo->o_oi.oi_fid);
3265 static inline void lustre_get_wire_obdo(struct obd_connect_data *ocd,
3266 struct obdo *lobdo, struct obdo *wobdo)
3268 obd_flag local_flags = 0;
3270 if (lobdo->o_valid & OBD_MD_FLFLAGS)
3271 local_flags = lobdo->o_flags & OBD_FL_LOCAL_MASK;
3273 LASSERT(!(wobdo->o_flags & OBD_FL_LOCAL_MASK));
3275 memcpy(lobdo, wobdo, sizeof(*lobdo));
3276 if (local_flags != 0) {
3277 lobdo->o_valid |= OBD_MD_FLFLAGS;
3278 lobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
3279 lobdo->o_flags |= local_flags;
3284 if (unlikely(!(ocd->ocd_connect_flags & OBD_CONNECT_FID)) &&
3285 fid_seq_is_echo(wobdo->o_oi.oi.oi_seq)) {
3287 lobdo->o_oi.oi_fid.f_seq = wobdo->o_oi.oi.oi_seq;
3288 lobdo->o_oi.oi_fid.f_oid = wobdo->o_oi.oi.oi_id;
3289 lobdo->o_oi.oi_fid.f_ver = 0;
3293 extern void lustre_swab_obdo (struct obdo *o);
3295 /* request structure for OST's */
3300 /* Key for FIEMAP to be used in get_info calls */
3301 struct ll_fiemap_info_key {
3304 struct ll_user_fiemap fiemap;
3307 extern void lustre_swab_ost_body (struct ost_body *b);
3308 extern void lustre_swab_ost_last_id(obd_id *id);
3309 extern void lustre_swab_fiemap(struct ll_user_fiemap *fiemap);
3311 extern void lustre_swab_lov_user_md_v1(struct lov_user_md_v1 *lum);
3312 extern void lustre_swab_lov_user_md_v3(struct lov_user_md_v3 *lum);
3313 extern void lustre_swab_lov_user_md_objects(struct lov_user_ost_data *lod,
3315 extern void lustre_swab_lov_mds_md(struct lov_mds_md *lmm);
3318 extern void lustre_swab_llogd_body (struct llogd_body *d);
3319 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
3320 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
3321 extern void lustre_swab_llog_rec(struct llog_rec_hdr *rec);
3322 extern void lustre_swab_llog_id(struct llog_logid *lid);
3325 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
3327 /* Functions for dumping PTLRPC fields */
3328 void dump_rniobuf(struct niobuf_remote *rnb);
3329 void dump_ioo(struct obd_ioobj *nb);
3330 void dump_obdo(struct obdo *oa);
3331 void dump_ost_body(struct ost_body *ob);
3332 void dump_rcs(__u32 *rc);
3334 #define IDX_INFO_MAGIC 0x3D37CC37
3336 /* Index file transfer through the network. The server serializes the index into
3337 * a byte stream which is sent to the client via a bulk transfer */
3341 /* reply: see idx_info_flags below */
3344 /* request & reply: number of lu_idxpage (to be) transferred */
3348 /* request: requested attributes passed down to the iterator API */
3351 /* request & reply: index file identifier (FID) */
3352 struct lu_fid ii_fid;
3354 /* reply: version of the index file before starting to walk the index.
3355 * Please note that the version can be modified at any time during the
3359 /* request: hash to start with:
3360 * reply: hash of the first entry of the first lu_idxpage and hash
3361 * of the entry to read next if any */
3362 __u64 ii_hash_start;
3365 /* reply: size of keys in lu_idxpages, minimal one if II_FL_VARKEY is
3369 /* reply: size of records in lu_idxpages, minimal one if II_FL_VARREC
3377 extern void lustre_swab_idx_info(struct idx_info *ii);
3379 #define II_END_OFF MDS_DIR_END_OFF /* all entries have been read */
3381 /* List of flags used in idx_info::ii_flags */
3382 enum idx_info_flags {
3383 II_FL_NOHASH = 1 << 0, /* client doesn't care about hash value */
3384 II_FL_VARKEY = 1 << 1, /* keys can be of variable size */
3385 II_FL_VARREC = 1 << 2, /* records can be of variable size */
3386 II_FL_NONUNQ = 1 << 3, /* index supports non-unique keys */
3389 #define LIP_MAGIC 0x8A6D6B6C
3391 /* 4KB (= LU_PAGE_SIZE) container gathering key/record pairs */
3393 /* 16-byte header */
3396 __u16 lip_nr; /* number of entries in the container */
3397 __u64 lip_pad0; /* additional padding for future use */
3399 /* key/record pairs are stored in the remaining 4080 bytes.
3400 * depending upon the flags in idx_info::ii_flags, each key/record
3401 * pair might be preceded by:
3403 * - the key size (II_FL_VARKEY is set)
3404 * - the record size (II_FL_VARREC is set)
3406 * For the time being, we only support fixed-size key & record. */
3407 char lip_entries[0];
3409 extern void lustre_swab_lip_header(struct lu_idxpage *lip);
3411 #define LIP_HDR_SIZE (offsetof(struct lu_idxpage, lip_entries))
3413 /* Gather all possible type associated with a 4KB container */
3415 struct lu_dirpage lp_dir; /* for MDS_READPAGE */
3416 struct lu_idxpage lp_idx; /* for OBD_IDX_READ */
3417 char lp_array[LU_PAGE_SIZE];
3420 /* security opcodes */
3423 SEC_CTX_INIT_CONT = 802,
3426 SEC_FIRST_OPC = SEC_CTX_INIT
3430 * capa related definitions
3432 #define CAPA_HMAC_MAX_LEN 64
3433 #define CAPA_HMAC_KEY_MAX_LEN 56
3435 /* NB take care when changing the sequence of elements this struct,
3436 * because the offset info is used in find_capa() */
3437 struct lustre_capa {
3438 struct lu_fid lc_fid; /** fid */
3439 __u64 lc_opc; /** operations allowed */
3440 __u64 lc_uid; /** file owner */
3441 __u64 lc_gid; /** file group */
3442 __u32 lc_flags; /** HMAC algorithm & flags */
3443 __u32 lc_keyid; /** key# used for the capability */
3444 __u32 lc_timeout; /** capa timeout value (sec) */
3445 __u32 lc_expiry; /** expiry time (sec) */
3446 __u8 lc_hmac[CAPA_HMAC_MAX_LEN]; /** HMAC */
3447 } __attribute__((packed));
3449 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
3451 /** lustre_capa::lc_opc */
3453 CAPA_OPC_BODY_WRITE = 1<<0, /**< write object data */
3454 CAPA_OPC_BODY_READ = 1<<1, /**< read object data */
3455 CAPA_OPC_INDEX_LOOKUP = 1<<2, /**< lookup object fid */
3456 CAPA_OPC_INDEX_INSERT = 1<<3, /**< insert object fid */
3457 CAPA_OPC_INDEX_DELETE = 1<<4, /**< delete object fid */
3458 CAPA_OPC_OSS_WRITE = 1<<5, /**< write oss object data */
3459 CAPA_OPC_OSS_READ = 1<<6, /**< read oss object data */
3460 CAPA_OPC_OSS_TRUNC = 1<<7, /**< truncate oss object */
3461 CAPA_OPC_OSS_DESTROY = 1<<8, /**< destroy oss object */
3462 CAPA_OPC_META_WRITE = 1<<9, /**< write object meta data */
3463 CAPA_OPC_META_READ = 1<<10, /**< read object meta data */
3466 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
3467 #define CAPA_OPC_MDS_ONLY \
3468 (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
3469 CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
3470 #define CAPA_OPC_OSS_ONLY \
3471 (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC | \
3472 CAPA_OPC_OSS_DESTROY)
3473 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
3474 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
3476 /* MDS capability covers object capability for operations of body r/w
3477 * (dir readpage/sendpage), index lookup/insert/delete and meta data r/w,
3478 * while OSS capability only covers object capability for operations of
3479 * oss data(file content) r/w/truncate.
3481 static inline int capa_for_mds(struct lustre_capa *c)
3483 return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) != 0;
3486 static inline int capa_for_oss(struct lustre_capa *c)
3488 return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) == 0;
3491 /* lustre_capa::lc_hmac_alg */
3493 CAPA_HMAC_ALG_SHA1 = 1, /**< sha1 algorithm */
3497 #define CAPA_FL_MASK 0x00ffffff
3498 #define CAPA_HMAC_ALG_MASK 0xff000000
3500 struct lustre_capa_key {
3501 __u64 lk_seq; /**< mds# */
3502 __u32 lk_keyid; /**< key# */
3504 __u8 lk_key[CAPA_HMAC_KEY_MAX_LEN]; /**< key */
3505 } __attribute__((packed));
3507 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
3509 /** The link ea holds 1 \a link_ea_entry for each hardlink */
3510 #define LINK_EA_MAGIC 0x11EAF1DFUL
3511 struct link_ea_header {
3514 __u64 leh_len; /* total size */
3520 /** Hardlink data is name and parent fid.
3521 * Stored in this crazy struct for maximum packing and endian-neutrality
3523 struct link_ea_entry {
3524 /** __u16 stored big-endian, unaligned */
3525 unsigned char lee_reclen[2];
3526 unsigned char lee_parent_fid[sizeof(struct lu_fid)];
3528 }__attribute__((packed));
3530 /** fid2path request/reply structure */
3531 struct getinfo_fid2path {
3532 struct lu_fid gf_fid;
3537 } __attribute__((packed));
3539 void lustre_swab_fid2path (struct getinfo_fid2path *gf);
3542 LAYOUT_INTENT_ACCESS = 0,
3543 LAYOUT_INTENT_READ = 1,
3544 LAYOUT_INTENT_WRITE = 2,
3545 LAYOUT_INTENT_GLIMPSE = 3,
3546 LAYOUT_INTENT_TRUNC = 4,
3547 LAYOUT_INTENT_RELEASE = 5,
3548 LAYOUT_INTENT_RESTORE = 6
3551 /* enqueue layout lock with intent */
3552 struct layout_intent {
3553 __u32 li_opc; /* intent operation for enqueue, read, write etc */
3559 void lustre_swab_layout_intent(struct layout_intent *li);
3562 * On the wire version of hsm_progress structure.
3564 * Contains the userspace hsm_progress and some internal fields.
3566 struct hsm_progress_kernel {
3567 /* Field taken from struct hsm_progress */
3570 struct hsm_extent hpk_extent;
3572 __u16 hpk_errval; /* positive val */
3574 /* Additional fields */
3575 __u64 hpk_data_version;
3577 } __attribute__((packed));
3579 extern void lustre_swab_hsm_user_state(struct hsm_user_state *hus);
3580 extern void lustre_swab_hsm_current_action(struct hsm_current_action *action);
3581 extern void lustre_swab_hsm_progress_kernel(struct hsm_progress_kernel *hpk);
3582 extern void lustre_swab_hsm_user_state(struct hsm_user_state *hus);
3583 extern void lustre_swab_hsm_user_item(struct hsm_user_item *hui);
3584 extern void lustre_swab_hsm_request(struct hsm_request *hr);
3587 * These are object update opcode under UPDATE_OBJ, which is currently
3588 * being used by cross-ref operations between MDT.
3590 * During the cross-ref operation, the Master MDT, which the client send the
3591 * request to, will disassembly the operation into object updates, then OSP
3592 * will send these updates to the remote MDT to be executed.
3594 * Update request format
3595 * magic: UPDATE_BUFFER_MAGIC_V1
3596 * Count: How many updates in the req.
3597 * bufs[0] : following are packets of object.
3599 * type: object_update_op, the op code of update
3600 * fid: The object fid of the update.
3601 * lens/bufs: other parameters of the update.
3603 * type: object_update_op, the op code of update
3604 * fid: The object fid of the update.
3605 * lens/bufs: other parameters of the update.
3607 * update[7]: type: object_update_op, the op code of update
3608 * fid: The object fid of the update.
3609 * lens/bufs: other parameters of the update.
3610 * Current 8 maxim updates per object update request.
3612 *******************************************************************
3613 * update reply format:
3615 * ur_version: UPDATE_REPLY_V1
3616 * ur_count: The count of the reply, which is usually equal
3617 * to the number of updates in the request.
3618 * ur_lens: The reply lengths of each object update.
3620 * replies: 1st update reply [4bytes_ret: other body]
3621 * 2nd update reply [4bytes_ret: other body]
3623 * nth update reply [4bytes_ret: other body]
3625 * For each reply of the update, the format would be
3626 * result(4 bytes):Other stuff
3629 #define UPDATE_MAX_OPS 10
3630 #define UPDATE_BUFFER_MAGIC_V1 0xBDDE0001
3631 #define UPDATE_BUFFER_MAGIC UPDATE_BUFFER_MAGIC_V1
3632 #define UPDATE_BUF_COUNT 8
3633 enum object_update_op {
3642 OBJ_INDEX_LOOKUP = 9,
3643 OBJ_INDEX_INSERT = 10,
3644 OBJ_INDEX_DELETE = 11,
3651 struct lu_fid u_fid;
3652 __u32 u_lens[UPDATE_BUF_COUNT];
3662 #define UPDATE_REPLY_V1 0x00BD0001
3663 struct update_reply {
3669 void lustre_swab_update_buf(struct update_buf *ub);
3670 void lustre_swab_update_reply_buf(struct update_reply *ur);
3672 /** layout swap request structure
3673 * fid1 and fid2 are in mdt_body
3675 struct mdc_swap_layouts {
3679 void lustre_swab_swap_layouts(struct mdc_swap_layouts *msl);