1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
33 * Copyright (c) 2011 Whamcloud, Inc.
36 * This file is part of Lustre, http://www.lustre.org/
37 * Lustre is a trademark of Sun Microsystems, Inc.
39 * lustre/include/lustre/lustre_idl.h
41 * Lustre wire protocol definitions.
44 /** \defgroup lustreidl lustreidl
46 * Lustre wire protocol definitions.
48 * ALL structs passing over the wire should be declared here. Structs
49 * that are used in interfaces with userspace should go in lustre_user.h.
51 * All structs being declared here should be built from simple fixed-size
52 * types (__u8, __u16, __u32, __u64) or be built from other types or
53 * structs also declared in this file. Similarly, all flags and magic
54 * values in those structs should also be declared here. This ensures
55 * that the Lustre wire protocol is not influenced by external dependencies.
57 * The only other acceptable items in this file are VERY SIMPLE accessor
58 * functions to avoid callers grubbing inside the structures, and the
59 * prototypes of the swabber functions for each struct. Nothing that
60 * depends on external functions or definitions should be in here.
62 * Structs must be properly aligned to put 64-bit values on an 8-byte
63 * boundary. Any structs being added here must also be added to
64 * utils/wirecheck.c and "make newwiretest" run to regenerate the
65 * utils/wiretest.c sources. This allows us to verify that wire structs
66 * have the proper alignment/size on all architectures.
68 * DO NOT CHANGE any of the structs, flags, values declared here and used
69 * in released Lustre versions. Some structs may have padding fields that
70 * can be used. Some structs might allow addition at the end (verify this
71 * in the code to ensure that new/old clients that see this larger struct
72 * do not fail, otherwise you need to implement protocol compatibility).
74 * We assume all nodes are either little-endian or big-endian, and we
75 * always send messages in the sender's native format. The receiver
76 * detects the message format by checking the 'magic' field of the message
77 * (see lustre_msg_swabbed() below).
79 * Each wire type has corresponding 'lustre_swab_xxxtypexxx()' routines,
80 * implemented either here, inline (trivial implementations) or in
81 * ptlrpc/pack_generic.c. These 'swabbers' convert the type from "other"
82 * endian, in-place in the message buffer.
84 * A swabber takes a single pointer argument. The caller must already have
85 * verified that the length of the message buffer >= sizeof (type).
87 * For variable length types, a second 'lustre_swab_v_xxxtypexxx()' routine
88 * may be defined that swabs just the variable part, after the caller has
89 * verified that the message buffer is large enough.
94 #ifndef _LUSTRE_IDL_H_
95 #define _LUSTRE_IDL_H_
97 #if !defined(LASSERT) && !defined(LPU64)
98 #include <libcfs/libcfs.h> /* for LASSERT, LPUX64, etc */
101 /* Defn's shared with user-space. */
102 #include <lustre/lustre_user.h>
107 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
108 * FOO_REPLY_PORTAL is for incoming replies on the FOO
109 * FOO_BULK_PORTAL is for incoming bulk on the FOO
112 #define CONNMGR_REQUEST_PORTAL 1
113 #define CONNMGR_REPLY_PORTAL 2
114 //#define OSC_REQUEST_PORTAL 3
115 #define OSC_REPLY_PORTAL 4
116 //#define OSC_BULK_PORTAL 5
117 #define OST_IO_PORTAL 6
118 #define OST_CREATE_PORTAL 7
119 #define OST_BULK_PORTAL 8
120 //#define MDC_REQUEST_PORTAL 9
121 #define MDC_REPLY_PORTAL 10
122 //#define MDC_BULK_PORTAL 11
123 #define MDS_REQUEST_PORTAL 12
124 //#define MDS_REPLY_PORTAL 13
125 #define MDS_BULK_PORTAL 14
126 #define LDLM_CB_REQUEST_PORTAL 15
127 #define LDLM_CB_REPLY_PORTAL 16
128 #define LDLM_CANCEL_REQUEST_PORTAL 17
129 #define LDLM_CANCEL_REPLY_PORTAL 18
130 //#define PTLBD_REQUEST_PORTAL 19
131 //#define PTLBD_REPLY_PORTAL 20
132 //#define PTLBD_BULK_PORTAL 21
133 #define MDS_SETATTR_PORTAL 22
134 #define MDS_READPAGE_PORTAL 23
135 #define MDS_MDS_PORTAL 24
137 #define MGC_REPLY_PORTAL 25
138 #define MGS_REQUEST_PORTAL 26
139 #define MGS_REPLY_PORTAL 27
140 #define OST_REQUEST_PORTAL 28
141 #define FLD_REQUEST_PORTAL 29
142 #define SEQ_METADATA_PORTAL 30
143 #define SEQ_DATA_PORTAL 31
144 #define SEQ_CONTROLLER_PORTAL 32
145 #define MGS_BULK_PORTAL 33
147 /* Portal 63 is reserved for the Cray Inc DVS - nic@cray.com, roe@cray.com, n8851@cray.com */
150 #define PTL_RPC_MSG_REQUEST 4711
151 #define PTL_RPC_MSG_ERR 4712
152 #define PTL_RPC_MSG_REPLY 4713
154 /* DON'T use swabbed values of MAGIC as magic! */
155 #define LUSTRE_MSG_MAGIC_V1 0x0BD00BD0
156 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
158 #define LUSTRE_MSG_MAGIC_V1_SWABBED 0xD00BD00B
159 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
161 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
163 #define PTLRPC_MSG_VERSION 0x00000003
164 #define LUSTRE_VERSION_MASK 0xffff0000
165 #define LUSTRE_OBD_VERSION 0x00010000
166 #define LUSTRE_MDS_VERSION 0x00020000
167 #define LUSTRE_OST_VERSION 0x00030000
168 #define LUSTRE_DLM_VERSION 0x00040000
169 #define LUSTRE_LOG_VERSION 0x00050000
170 #define LUSTRE_MGS_VERSION 0x00060000
172 typedef __u32 mdsno_t;
173 typedef __u64 seqno_t;
174 typedef __u64 obd_id;
175 typedef __u64 obd_seq;
176 typedef __s64 obd_time;
177 typedef __u64 obd_size;
178 typedef __u64 obd_off;
179 typedef __u64 obd_blocks;
180 typedef __u64 obd_valid;
181 typedef __u32 obd_blksize;
182 typedef __u32 obd_mode;
183 typedef __u32 obd_uid;
184 typedef __u32 obd_gid;
185 typedef __u32 obd_flag;
186 typedef __u32 obd_count;
189 * Describes a range of sequence, lsr_start is included but lsr_end is
191 * Same structure is used in fld module where lsr_index field holds mdt id
195 #define LU_SEQ_RANGE_MDT 0x0
196 #define LU_SEQ_RANGE_OST 0x1
198 struct lu_seq_range {
206 * returns width of given range \a r
209 static inline __u64 range_space(const struct lu_seq_range *range)
211 return range->lsr_end - range->lsr_start;
215 * initialize range to zero
218 static inline void range_init(struct lu_seq_range *range)
220 range->lsr_start = range->lsr_end = range->lsr_index = 0;
224 * check if given seq id \a s is within given range \a r
227 static inline int range_within(const struct lu_seq_range *range,
230 return s >= range->lsr_start && s < range->lsr_end;
233 static inline int range_is_sane(const struct lu_seq_range *range)
235 return (range->lsr_end >= range->lsr_start);
238 static inline int range_is_zero(const struct lu_seq_range *range)
240 return (range->lsr_start == 0 && range->lsr_end == 0);
243 static inline int range_is_exhausted(const struct lu_seq_range *range)
246 return range_space(range) == 0;
249 /* return 0 if two range have the same location */
250 static inline int range_compare_loc(const struct lu_seq_range *r1,
251 const struct lu_seq_range *r2)
253 return r1->lsr_index != r2->lsr_index ||
254 r1->lsr_flags != r2->lsr_flags;
257 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x):%x:%x"
259 #define PRANGE(range) \
260 (range)->lsr_start, \
262 (range)->lsr_index, \
265 /** \defgroup lu_fid lu_fid
269 * Flags for lustre_mdt_attrs::lma_compat and lustre_mdt_attrs::lma_incompat.
272 LMAC_HSM = 0x00000001,
273 LMAC_SOM = 0x00000002,
277 * Masks for all features that should be supported by a Lustre version to
278 * access a specific file.
279 * This information is stored in lustre_mdt_attrs::lma_incompat.
281 * NOTE: No incompat feature should be added before bug #17670 is landed.
283 #define LMA_INCOMPAT_SUPP 0x0
286 * Following struct for MDT attributes, that will be kept inode's EA.
287 * Introduced in 2.0 release (please see b15993, for details)
289 struct lustre_mdt_attrs {
291 * Bitfield for supported data in this structure. From enum lma_compat.
292 * lma_self_fid and lma_flags are always available.
296 * Per-file incompat feature list. Lustre version should support all
297 * flags set in this field. The supported feature mask is available in
301 /** FID of this inode */
302 struct lu_fid lma_self_fid;
303 /** mdt/ost type, others */
305 /* IO Epoch SOM attributes belongs to */
307 /** total file size in objects */
309 /** total fs blocks in objects */
310 __u64 lma_som_blocks;
311 /** mds mount id the size is valid for */
312 __u64 lma_som_mountid;
316 * Fill \a lma with its first content.
317 * Only fid is stored.
319 static inline void lustre_lma_init(struct lustre_mdt_attrs *lma,
320 const struct lu_fid *fid)
323 lma->lma_incompat = 0;
324 memcpy(&lma->lma_self_fid, fid, sizeof(*fid));
326 lma->lma_ioepoch = 0;
327 lma->lma_som_size = 0;
328 lma->lma_som_blocks = 0;
329 lma->lma_som_mountid = 0;
331 /* If a field is added in struct lustre_mdt_attrs, zero it explicitly
332 * and change the test below. */
333 LASSERT(sizeof(*lma) ==
334 (offsetof(struct lustre_mdt_attrs, lma_som_mountid) +
335 sizeof(lma->lma_som_mountid)));
338 extern void lustre_swab_lu_fid(struct lu_fid *fid);
341 * Swab, if needed, lustre_mdt_attr struct to on-disk format.
342 * Otherwise, do not touch it.
344 static inline void lustre_lma_swab(struct lustre_mdt_attrs *lma)
346 /* Use LUSTRE_MSG_MAGIC to detect local endianess. */
347 if (LUSTRE_MSG_MAGIC != cpu_to_le32(LUSTRE_MSG_MAGIC)) {
348 __swab32s(&lma->lma_compat);
349 __swab32s(&lma->lma_incompat);
350 lustre_swab_lu_fid(&lma->lma_self_fid);
351 __swab64s(&lma->lma_flags);
352 __swab64s(&lma->lma_ioepoch);
353 __swab64s(&lma->lma_som_size);
354 __swab64s(&lma->lma_som_blocks);
355 __swab64s(&lma->lma_som_mountid);
359 /* This is the maximum number of MDTs allowed in CMD testing until such
360 * a time that FID-on-OST is implemented. This is due to the limitations
361 * of packing non-0-MDT numbers into the FID SEQ namespace. Once FID-on-OST
362 * is implemented this limit will be virtually unlimited. */
363 #define MAX_MDT_COUNT 8
370 /** initial fid id value */
371 LUSTRE_FID_INIT_OID = 1UL
374 /** returns fid object sequence */
375 static inline __u64 fid_seq(const struct lu_fid *fid)
380 /** returns fid object id */
381 static inline __u32 fid_oid(const struct lu_fid *fid)
386 /** returns fid object version */
387 static inline __u32 fid_ver(const struct lu_fid *fid)
392 static inline void fid_zero(struct lu_fid *fid)
394 memset(fid, 0, sizeof(*fid));
397 static inline obd_id fid_ver_oid(const struct lu_fid *fid)
399 return ((__u64)fid_ver(fid) << 32 | fid_oid(fid));
403 * Note that reserved SEQ numbers below 12 will conflict with ldiskfs
404 * inodes in the IGIF namespace, so these reserved SEQ numbers can be
405 * used for other purposes and not risk collisions with existing inodes.
407 * Different FID Format
408 * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs#NEW.0
411 FID_SEQ_OST_MDT0 = 0,
414 FID_SEQ_OST_MDT1 = 3,
415 FID_SEQ_OST_MAX = 9, /* Max MDT count before OST_on_FID */
418 FID_SEQ_IGIF_MAX = 0x0ffffffffULL,
419 FID_SEQ_IDIF = 0x100000000ULL,
420 FID_SEQ_IDIF_MAX = 0x1ffffffffULL,
421 /* Normal FID sequence starts from this value, i.e. 1<<33 */
422 FID_SEQ_START = 0x200000000ULL,
423 FID_SEQ_LOCAL_FILE = 0x200000001ULL,
424 FID_SEQ_DOT_LUSTRE = 0x200000002ULL,
425 FID_SEQ_NORMAL = 0x200000400ULL,
426 FID_SEQ_LOV_DEFAULT= 0xffffffffffffffffULL
429 #define OBIF_OID_MAX_BITS 32
430 #define OBIF_MAX_OID (1ULL << OBIF_OID_MAX_BITS)
431 #define OBIF_OID_MASK ((1ULL << OBIF_OID_MAX_BITS) - 1)
432 #define IDIF_OID_MAX_BITS 48
433 #define IDIF_MAX_OID (1ULL << IDIF_OID_MAX_BITS)
434 #define IDIF_OID_MASK ((1ULL << IDIF_OID_MAX_BITS) - 1)
437 static inline int fid_seq_is_mdt0(obd_seq seq)
439 return (seq == FID_SEQ_OST_MDT0);
442 static inline int fid_seq_is_cmd(const __u64 seq)
444 return (seq >= FID_SEQ_OST_MDT1 && seq <= FID_SEQ_OST_MAX);
447 static inline int fid_seq_is_mdt(const __u64 seq)
449 return seq == FID_SEQ_OST_MDT0 ||
450 (seq >= FID_SEQ_OST_MDT1 && seq <= FID_SEQ_OST_MAX);
453 static inline int fid_seq_is_rsvd(const __u64 seq)
455 return seq <= FID_SEQ_RSVD;
458 static inline int fid_is_mdt0(const struct lu_fid *fid)
460 return fid_seq_is_mdt0(fid_seq(fid));
464 * Check if a fid is igif or not.
465 * \param fid the fid to be tested.
466 * \return true if the fid is a igif; otherwise false.
468 static inline int fid_seq_is_igif(const __u64 seq)
470 return seq >= FID_SEQ_IGIF && seq <= FID_SEQ_IGIF_MAX;
473 static inline int fid_is_igif(const struct lu_fid *fid)
475 return fid_seq_is_igif(fid_seq(fid));
479 * Check if a fid is idif or not.
480 * \param fid the fid to be tested.
481 * \return true if the fid is a idif; otherwise false.
483 static inline int fid_seq_is_idif(const __u64 seq)
485 return seq >= FID_SEQ_IDIF && seq <= FID_SEQ_IDIF_MAX;
488 static inline int fid_is_idif(const struct lu_fid *fid)
490 return fid_seq_is_idif(fid_seq(fid));
498 static inline int fid_seq_is_norm(const __u64 seq)
500 return (seq >= FID_SEQ_NORMAL);
503 static inline int fid_is_norm(const struct lu_fid *fid)
505 return fid_seq_is_norm(fid_seq(fid));
508 /* convert an OST objid into an IDIF FID SEQ number */
509 static inline obd_seq fid_idif_seq(obd_id id, __u32 ost_idx)
511 return FID_SEQ_IDIF | (ost_idx << 16) | ((id >> 32) & 0xffff);
514 /* convert a packed IDIF FID into an OST objid */
515 static inline obd_id fid_idif_id(obd_seq seq, __u32 oid, __u32 ver)
517 return ((__u64)ver << 48) | ((seq & 0xffff) << 32) | oid;
520 /* unpack an ostid (id/seq) from a wire/disk structure into an IDIF FID */
521 static inline void ostid_idif_unpack(struct ost_id *ostid,
522 struct lu_fid *fid, __u32 ost_idx)
524 fid->f_seq = fid_idif_seq(ostid->oi_id, ost_idx);
525 fid->f_oid = ostid->oi_id; /* truncate to 32 bits by assignment */
526 fid->f_ver = ostid->oi_id >> 48; /* in theory, not currently used */
529 /* unpack an ostid (id/seq) from a wire/disk structure into a non-IDIF FID */
530 static inline void ostid_fid_unpack(struct ost_id *ostid, struct lu_fid *fid)
532 fid->f_seq = ostid->oi_seq;
533 fid->f_oid = ostid->oi_id; /* truncate to 32 bits by assignment */
534 fid->f_ver = ostid->oi_id >> 32; /* in theory, not currently used */
537 /* Unpack an OST object id/seq (group) into a FID. This is needed for
538 * converting all obdo, lmm, lsm, etc. 64-bit id/seq pairs into proper
539 * FIDs. Note that if an id/seq is already in FID/IDIF format it will
540 * be passed through unchanged. Only legacy OST objects in "group 0"
541 * will be mapped into the IDIF namespace so that they can fit into the
542 * struct lu_fid fields without loss. For reference see:
543 * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs
545 static inline int fid_ostid_unpack(struct lu_fid *fid, struct ost_id *ostid,
548 if (ost_idx > 0xffff) {
549 CERROR("bad ost_idx, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
550 ostid->oi_seq, ostid->oi_id, ost_idx);
554 if (fid_seq_is_mdt0(ostid->oi_seq)) {
555 /* This is a "legacy" (old 1.x/2.early) OST object in "group 0"
556 * that we map into the IDIF namespace. It allows up to 2^48
557 * objects per OST, as this is the object namespace that has
558 * been in production for years. This can handle create rates
559 * of 1M objects/s/OST for 9 years, or combinations thereof. */
560 if (ostid->oi_id >= IDIF_MAX_OID) {
561 CERROR("bad MDT0 id, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
562 ostid->oi_seq, ostid->oi_id, ost_idx);
565 ostid_idif_unpack(ostid, fid, ost_idx);
567 } else if (fid_seq_is_rsvd(ostid->oi_seq)) {
568 /* These are legacy OST objects for LLOG/ECHO and CMD testing.
569 * We only support 2^32 objects in these groups, and cannot
570 * uniquely identify them in the system (i.e. they are the
571 * duplicated on all OSTs), but this is not strictly required
572 * for the old object protocol, which has a separate ost_idx. */
573 if (ostid->oi_id >= 0xffffffffULL) {
574 CERROR("bad RSVD id, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
575 ostid->oi_seq, ostid->oi_id, ost_idx);
578 ostid_fid_unpack(ostid, fid);
580 } else if (unlikely(fid_seq_is_igif(ostid->oi_seq))) {
581 /* This is an MDT inode number, which should never collide with
582 * proper OST object IDs, and is probably a broken filesystem */
583 CERROR("bad IGIF, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
584 ostid->oi_seq, ostid->oi_id, ost_idx);
587 } else /* if (fid_seq_is_idif(seq) || fid_seq_is_norm(seq)) */ {
588 /* This is either an IDIF object, which identifies objects across
589 * all OSTs, or a regular FID. The IDIF namespace maps legacy
590 * OST objects into the FID namespace. In both cases, we just
591 * pass the FID through, no conversion needed. */
592 ostid_fid_unpack(ostid, fid);
598 /* pack an IDIF FID into an ostid (id/seq) for the wire/disk */
599 static inline void ostid_idif_pack(struct lu_fid *fid, struct ost_id *ostid)
601 ostid->oi_seq = FID_SEQ_OST_MDT0;
602 ostid->oi_id = fid_idif_id(fid->f_seq, fid->f_oid, fid->f_ver);
605 /* pack a non-IDIF FID into an ostid (id/seq) for the wire/disk */
606 static inline void ostid_fid_pack(struct lu_fid *fid, struct ost_id *ostid)
608 ostid->oi_seq = fid_seq(fid);
609 ostid->oi_id = fid_ver_oid(fid);
612 /* pack any OST FID into an ostid (id/seq) for the wire/disk */
613 static inline int fid_ostid_pack(struct lu_fid *fid, struct ost_id *ostid)
615 if (unlikely(fid_seq_is_igif(fid->f_seq))) {
616 CERROR("bad IGIF, "DFID"\n", PFID(fid));
620 if (fid_is_idif(fid))
621 ostid_idif_pack(fid, ostid);
623 ostid_fid_pack(fid, ostid);
628 /* extract OST sequence (group) from a wire ost_id (id/seq) pair */
629 static inline obd_seq ostid_seq(struct ost_id *ostid)
631 if (unlikely(fid_seq_is_igif(ostid->oi_seq)))
632 CWARN("bad IGIF, oi_seq: "LPU64" oi_id: "LPX64"\n",
633 ostid->oi_seq, ostid->oi_id);
635 if (unlikely(fid_seq_is_idif(ostid->oi_seq)))
636 return FID_SEQ_OST_MDT0;
638 return ostid->oi_seq;
641 /* extract OST objid from a wire ost_id (id/seq) pair */
642 static inline obd_id ostid_id(struct ost_id *ostid)
644 if (ostid->oi_seq == FID_SEQ_OST_MDT0)
645 return ostid->oi_id & IDIF_OID_MASK;
647 if (fid_seq_is_rsvd(ostid->oi_seq))
648 return ostid->oi_id & OBIF_OID_MASK;
650 if (fid_seq_is_idif(ostid->oi_seq))
651 return fid_idif_id(ostid->oi_seq, ostid->oi_id, 0);
657 * Get inode number from a igif.
658 * \param fid a igif to get inode number from.
659 * \return inode number for the igif.
661 static inline ino_t lu_igif_ino(const struct lu_fid *fid)
667 * Build igif from the inode number/generation.
669 #define LU_IGIF_BUILD(fid, ino, gen) \
675 static inline void lu_igif_build(struct lu_fid *fid, __u32 ino, __u32 gen)
677 LU_IGIF_BUILD(fid, ino, gen);
678 LASSERT(fid_is_igif(fid));
682 * Get inode generation from a igif.
683 * \param fid a igif to get inode generation from.
684 * \return inode generation for the igif.
686 static inline __u32 lu_igif_gen(const struct lu_fid *fid)
692 * Fids are transmitted across network (in the sender byte-ordering),
693 * and stored on disk in big-endian order.
695 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
697 /* check that all fields are converted */
698 CLASSERT(sizeof *src ==
699 sizeof fid_seq(src) +
700 sizeof fid_oid(src) + sizeof fid_ver(src));
701 LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
702 dst->f_seq = cpu_to_le64(fid_seq(src));
703 dst->f_oid = cpu_to_le32(fid_oid(src));
704 dst->f_ver = cpu_to_le32(fid_ver(src));
707 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
709 /* check that all fields are converted */
710 CLASSERT(sizeof *src ==
711 sizeof fid_seq(src) +
712 sizeof fid_oid(src) + sizeof fid_ver(src));
713 dst->f_seq = le64_to_cpu(fid_seq(src));
714 dst->f_oid = le32_to_cpu(fid_oid(src));
715 dst->f_ver = le32_to_cpu(fid_ver(src));
716 LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
719 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
721 /* check that all fields are converted */
722 CLASSERT(sizeof *src ==
723 sizeof fid_seq(src) +
724 sizeof fid_oid(src) + sizeof fid_ver(src));
725 LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
726 dst->f_seq = cpu_to_be64(fid_seq(src));
727 dst->f_oid = cpu_to_be32(fid_oid(src));
728 dst->f_ver = cpu_to_be32(fid_ver(src));
731 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
733 /* check that all fields are converted */
734 CLASSERT(sizeof *src ==
735 sizeof fid_seq(src) +
736 sizeof fid_oid(src) + sizeof fid_ver(src));
737 dst->f_seq = be64_to_cpu(fid_seq(src));
738 dst->f_oid = be32_to_cpu(fid_oid(src));
739 dst->f_ver = be32_to_cpu(fid_ver(src));
740 LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
743 static inline int fid_is_sane(const struct lu_fid *fid)
747 ((fid_seq(fid) >= FID_SEQ_START && fid_oid(fid) != 0
748 && fid_ver(fid) == 0) ||
752 static inline int fid_is_zero(const struct lu_fid *fid)
754 return fid_seq(fid) == 0 && fid_oid(fid) == 0;
757 extern void lustre_swab_lu_fid(struct lu_fid *fid);
758 extern void lustre_swab_lu_seq_range(struct lu_seq_range *range);
760 static inline int lu_fid_eq(const struct lu_fid *f0,
761 const struct lu_fid *f1)
763 /* Check that there is no alignment padding. */
764 CLASSERT(sizeof *f0 ==
765 sizeof f0->f_seq + sizeof f0->f_oid + sizeof f0->f_ver);
766 LASSERTF(fid_is_igif(f0) || fid_ver(f0) == 0, DFID, PFID(f0));
767 LASSERTF(fid_is_igif(f1) || fid_ver(f1) == 0, DFID, PFID(f1));
768 return memcmp(f0, f1, sizeof *f0) == 0;
771 #define __diff_normalize(val0, val1) \
773 typeof(val0) __val0 = (val0); \
774 typeof(val1) __val1 = (val1); \
776 (__val0 == __val1 ? 0 : __val0 > __val1 ? +1 : -1); \
779 static inline int lu_fid_cmp(const struct lu_fid *f0,
780 const struct lu_fid *f1)
783 __diff_normalize(fid_seq(f0), fid_seq(f1)) ?:
784 __diff_normalize(fid_oid(f0), fid_oid(f1)) ?:
785 __diff_normalize(fid_ver(f0), fid_ver(f1));
790 /** \defgroup lu_dir lu_dir
794 * Enumeration of possible directory entry attributes.
796 * Attributes follow directory entry header in the order they appear in this
799 enum lu_dirent_attrs {
802 LUDA_64BITHASH = 0x0004,
806 * Layout of readdir pages, as transmitted on wire.
809 /** valid if LUDA_FID is set. */
810 struct lu_fid lde_fid;
811 /** a unique entry identifier: a hash or an offset. */
813 /** total record length, including all attributes. */
817 /** optional variable size attributes following this entry.
818 * taken from enum lu_dirent_attrs.
821 /** name is followed by the attributes indicated in ->ldp_attrs, in
822 * their natural order. After the last attribute, padding bytes are
823 * added to make ->lde_reclen a multiple of 8.
829 * Definitions of optional directory entry attributes formats.
831 * Individual attributes do not have their length encoded in a generic way. It
832 * is assumed that consumer of an attribute knows its format. This means that
833 * it is impossible to skip over an unknown attribute, except by skipping over all
834 * remaining attributes (by using ->lde_reclen), which is not too
835 * constraining, because new server versions will append new attributes at
836 * the end of an entry.
840 * Fid directory attribute: a fid of an object referenced by the entry. This
841 * will be almost always requested by the client and supplied by the server.
843 * Aligned to 8 bytes.
845 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
850 * Aligned to 2 bytes.
857 __u64 ldp_hash_start;
861 struct lu_dirent ldp_entries[0];
864 enum lu_dirpage_flags {
866 * dirpage contains no entry.
870 * last entry's lde_hash equals ldp_hash_end.
875 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
877 if (le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
880 return dp->ldp_entries;
883 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
885 struct lu_dirent *next;
887 if (le16_to_cpu(ent->lde_reclen) != 0)
888 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
895 static inline int lu_dirent_calc_size(int namelen, __u16 attr)
899 if (attr & LUDA_TYPE) {
900 const unsigned align = sizeof(struct luda_type) - 1;
901 size = (sizeof(struct lu_dirent) + namelen + align) & ~align;
902 size += sizeof(struct luda_type);
904 size = sizeof(struct lu_dirent) + namelen;
906 return (size + 7) & ~7;
909 static inline int lu_dirent_size(struct lu_dirent *ent)
911 if (le16_to_cpu(ent->lde_reclen) == 0) {
912 return lu_dirent_calc_size(le16_to_cpu(ent->lde_namelen),
913 le32_to_cpu(ent->lde_attrs));
915 return le16_to_cpu(ent->lde_reclen);
918 #define MDS_DIR_END_OFF 0xfffffffffffffffeULL
921 * MDS_READPAGE page size
923 * This is the directory page size packed in MDS_READPAGE RPC.
924 * It's different than CFS_PAGE_SIZE because the client needs to
925 * access the struct lu_dirpage header packed at the beginning of
926 * the "page" and without this there isn't any way to know find the
927 * lu_dirpage header is if client and server CFS_PAGE_SIZE differ.
929 #define LU_PAGE_SHIFT 12
930 #define LU_PAGE_SIZE (1UL << LU_PAGE_SHIFT)
931 #define LU_PAGE_MASK (~(LU_PAGE_SIZE - 1))
933 #define LU_PAGE_COUNT 1 << (CFS_PAGE_SHIFT - LU_PAGE_SHIFT)
937 struct lustre_handle {
940 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
942 static inline int lustre_handle_is_used(struct lustre_handle *lh)
944 return lh->cookie != 0ull;
947 static inline int lustre_handle_equal(const struct lustre_handle *lh1,
948 const struct lustre_handle *lh2)
950 return lh1->cookie == lh2->cookie;
953 static inline void lustre_handle_copy(struct lustre_handle *tgt,
954 struct lustre_handle *src)
956 tgt->cookie = src->cookie;
959 /* flags for lm_flags */
960 #define MSGHDR_AT_SUPPORT 0x1
961 #define MSGHDR_CKSUM_INCOMPAT18 0x2
963 #define lustre_msg lustre_msg_v2
964 /* we depend on this structure to be 8-byte aligned */
965 /* this type is only endian-adjusted in lustre_unpack_msg() */
966 struct lustre_msg_v2 {
978 /* without gss, ptlrpc_body is put at the first buffer. */
979 #define PTLRPC_NUM_VERSIONS 4
981 struct lustre_handle pb_handle;
988 __u64 pb_last_committed;
993 __u32 pb_timeout; /* for req, the deadline, for rep, the service est */
994 __u32 pb_service_time; /* for rep, actual service time, also used for
995 net_latency of req */
998 /* VBR: pre-versions */
999 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1000 /* padding for future needs */
1001 __u64 pb_padding[4];
1004 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
1006 /* message body offset for lustre_msg_v2 */
1007 /* ptlrpc body offset in all request/reply messages */
1008 #define MSG_PTLRPC_BODY_OFF 0
1010 /* normal request/reply message record offset */
1011 #define REQ_REC_OFF 1
1012 #define REPLY_REC_OFF 1
1014 /* ldlm request message body offset */
1015 #define DLM_LOCKREQ_OFF 1 /* lockreq offset */
1016 #define DLM_REQ_REC_OFF 2 /* normal dlm request record offset */
1018 /* ldlm intent lock message body offset */
1019 #define DLM_INTENT_IT_OFF 2 /* intent lock it offset */
1020 #define DLM_INTENT_REC_OFF 3 /* intent lock record offset */
1022 /* ldlm reply message body offset */
1023 #define DLM_LOCKREPLY_OFF 1 /* lockrep offset */
1024 #define DLM_REPLY_REC_OFF 2 /* reply record offset */
1026 /** only use in req->rq_{req,rep}_swab_mask */
1027 #define MSG_PTLRPC_HEADER_OFF 31
1029 /* Flags that are operation-specific go in the top 16 bits. */
1030 #define MSG_OP_FLAG_MASK 0xffff0000
1031 #define MSG_OP_FLAG_SHIFT 16
1033 /* Flags that apply to all requests are in the bottom 16 bits */
1034 #define MSG_GEN_FLAG_MASK 0x0000ffff
1035 #define MSG_LAST_REPLAY 0x0001
1036 #define MSG_RESENT 0x0002
1037 #define MSG_REPLAY 0x0004
1038 /* #define MSG_AT_SUPPORT 0x0008
1039 * This was used in early prototypes of adaptive timeouts, and while there
1040 * shouldn't be any users of that code there also isn't a need for using this
1041 * bits. Defer usage until at least 1.10 to avoid potential conflict. */
1042 #define MSG_DELAY_REPLAY 0x0010
1043 #define MSG_VERSION_REPLAY 0x0020
1044 #define MSG_REQ_REPLAY_DONE 0x0040
1045 #define MSG_LOCK_REPLAY_DONE 0x0080
1048 * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
1051 #define MSG_CONNECT_RECOVERING 0x00000001
1052 #define MSG_CONNECT_RECONNECT 0x00000002
1053 #define MSG_CONNECT_REPLAYABLE 0x00000004
1054 //#define MSG_CONNECT_PEER 0x8
1055 #define MSG_CONNECT_LIBCLIENT 0x00000010
1056 #define MSG_CONNECT_INITIAL 0x00000020
1057 #define MSG_CONNECT_ASYNC 0x00000040
1058 #define MSG_CONNECT_NEXT_VER 0x00000080 /* use next version of lustre_msg */
1059 #define MSG_CONNECT_TRANSNO 0x00000100 /* report transno */
1062 #define OBD_CONNECT_RDONLY 0x1ULL /*client has read-only access*/
1063 #define OBD_CONNECT_INDEX 0x2ULL /*connect specific LOV idx */
1064 #define OBD_CONNECT_MDS 0x4ULL /*connect from MDT to OST */
1065 #define OBD_CONNECT_GRANT 0x8ULL /*OSC gets grant at connect */
1066 #define OBD_CONNECT_SRVLOCK 0x10ULL /*server takes locks for cli */
1067 #define OBD_CONNECT_VERSION 0x20ULL /*Lustre versions in ocd */
1068 #define OBD_CONNECT_REQPORTAL 0x40ULL /*Separate non-IO req portal */
1069 #define OBD_CONNECT_ACL 0x80ULL /*access control lists */
1070 #define OBD_CONNECT_XATTR 0x100ULL /*client use extended attr */
1071 #define OBD_CONNECT_CROW 0x200ULL /*MDS+OST create obj on write*/
1072 #define OBD_CONNECT_TRUNCLOCK 0x400ULL /*locks on server for punch */
1073 #define OBD_CONNECT_TRANSNO 0x800ULL /*replay sends init transno */
1074 #define OBD_CONNECT_IBITS 0x1000ULL /*support for inodebits locks*/
1075 #define OBD_CONNECT_JOIN 0x2000ULL /*files can be concatenated.
1076 *We do not support JOIN FILE
1077 *anymore, reserve this flags
1078 *just for preventing such bit
1080 #define OBD_CONNECT_ATTRFID 0x4000ULL /*Server can GetAttr By Fid*/
1081 #define OBD_CONNECT_NODEVOH 0x8000ULL /*No open hndl on specl nodes*/
1082 #define OBD_CONNECT_RMT_CLIENT 0x10000ULL /*Remote client */
1083 #define OBD_CONNECT_RMT_CLIENT_FORCE 0x20000ULL /*Remote client by force */
1084 #define OBD_CONNECT_BRW_SIZE 0x40000ULL /*Max bytes per rpc */
1085 #define OBD_CONNECT_QUOTA64 0x80000ULL /*64bit qunit_data.qd_count */
1086 #define OBD_CONNECT_MDS_CAPA 0x100000ULL /*MDS capability */
1087 #define OBD_CONNECT_OSS_CAPA 0x200000ULL /*OSS capability */
1088 #define OBD_CONNECT_CANCELSET 0x400000ULL /*Early batched cancels. */
1089 #define OBD_CONNECT_SOM 0x800000ULL /*Size on MDS */
1090 #define OBD_CONNECT_AT 0x1000000ULL /*client uses AT */
1091 #define OBD_CONNECT_LRU_RESIZE 0x2000000ULL /*LRU resize feature. */
1092 #define OBD_CONNECT_MDS_MDS 0x4000000ULL /*MDS-MDS connection */
1093 #define OBD_CONNECT_REAL 0x8000000ULL /*real connection */
1094 #define OBD_CONNECT_CHANGE_QS 0x10000000ULL /*shrink/enlarge qunit */
1095 #define OBD_CONNECT_CKSUM 0x20000000ULL /*support several cksum algos*/
1096 #define OBD_CONNECT_FID 0x40000000ULL /*FID is supported by server */
1097 #define OBD_CONNECT_VBR 0x80000000ULL /*version based recovery */
1098 #define OBD_CONNECT_LOV_V3 0x100000000ULL /*client supports LOV v3 EA */
1099 #define OBD_CONNECT_GRANT_SHRINK 0x200000000ULL /* support grant shrink */
1100 #define OBD_CONNECT_SKIP_ORPHAN 0x400000000ULL /* don't reuse orphan objids */
1101 #define OBD_CONNECT_MAX_EASIZE 0x800000000ULL /* preserved for large EA */
1102 #define OBD_CONNECT_FULL20 0x1000000000ULL /* it is 2.0 client */
1103 #define OBD_CONNECT_LAYOUTLOCK 0x2000000000ULL /* client supports layout lock */
1104 #define OBD_CONNECT_64BITHASH 0x4000000000ULL /* client supports 64-bits
1106 #define OBD_CONNECT_MAXBYTES 0x8000000000ULL /* max stripe size */
1107 #define OBD_CONNECT_IMP_RECOV 0x10000000000ULL /* imp recovery support */
1109 #define OCD_HAS_FLAG(ocd, flg) \
1110 (!!((ocd)->ocd_connect_flags & OBD_CONNECT_##flg))
1112 /* also update obd_connect_names[] for lprocfs_rd_connect_flags()
1113 * and lustre/utils/wirecheck.c */
1115 #ifdef HAVE_LRU_RESIZE_SUPPORT
1116 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
1118 #define LRU_RESIZE_CONNECT_FLAG 0
1121 #define MDT_CONNECT_SUPPORTED (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
1122 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
1123 OBD_CONNECT_IBITS | \
1124 OBD_CONNECT_NODEVOH | OBD_CONNECT_ATTRFID | \
1125 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1126 OBD_CONNECT_RMT_CLIENT | \
1127 OBD_CONNECT_RMT_CLIENT_FORCE | \
1128 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_MDS_CAPA | \
1129 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_MDS_MDS | \
1130 OBD_CONNECT_FID | LRU_RESIZE_CONNECT_FLAG | \
1131 OBD_CONNECT_VBR | OBD_CONNECT_LOV_V3 | \
1132 OBD_CONNECT_SOM | OBD_CONNECT_FULL20 | \
1133 OBD_CONNECT_64BITHASH)
1134 #define OST_CONNECT_SUPPORTED (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
1135 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
1136 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
1137 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_QUOTA64 | \
1138 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1139 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_CKSUM | \
1140 OBD_CONNECT_CHANGE_QS | \
1141 OBD_CONNECT_OSS_CAPA | \
1142 OBD_CONNECT_RMT_CLIENT | \
1143 OBD_CONNECT_RMT_CLIENT_FORCE | OBD_CONNECT_VBR | \
1144 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
1145 OBD_CONNECT_GRANT_SHRINK | OBD_CONNECT_FULL20 | \
1146 OBD_CONNECT_64BITHASH | OBD_CONNECT_MAXBYTES | \
1147 OBD_CONNECT_MAX_EASIZE)
1148 #define ECHO_CONNECT_SUPPORTED (0)
1149 #define MGS_CONNECT_SUPPORTED (OBD_CONNECT_VERSION | OBD_CONNECT_AT | \
1150 OBD_CONNECT_FULL20 | OBD_CONNECT_IMP_RECOV)
1152 /* Features required for this version of the client to work with server */
1153 #define CLIENT_CONNECT_MDT_REQD (OBD_CONNECT_IBITS | OBD_CONNECT_FID | \
1156 #define OBD_OCD_VERSION(major,minor,patch,fix) (((major)<<24) + ((minor)<<16) +\
1157 ((patch)<<8) + (fix))
1158 #define OBD_OCD_VERSION_MAJOR(version) ((int)((version)>>24)&255)
1159 #define OBD_OCD_VERSION_MINOR(version) ((int)((version)>>16)&255)
1160 #define OBD_OCD_VERSION_PATCH(version) ((int)((version)>>8)&255)
1161 #define OBD_OCD_VERSION_FIX(version) ((int)(version)&255)
1163 /* This structure is used for both request and reply.
1165 * If we eventually have separate connect data for different types, which we
1166 * almost certainly will, then perhaps we stick a union in here. */
1167 struct obd_connect_data_v1 {
1168 __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1169 __u32 ocd_version; /* lustre release version number */
1170 __u32 ocd_grant; /* initial cache grant amount (bytes) */
1171 __u32 ocd_index; /* LOV index to connect to */
1172 __u32 ocd_brw_size; /* Maximum BRW size in bytes */
1173 __u64 ocd_ibits_known; /* inode bits this client understands */
1174 __u32 ocd_nllu; /* non-local-lustre-user */
1175 __u32 ocd_nllg; /* non-local-lustre-group */
1176 __u64 ocd_transno; /* first transno from client to be replayed */
1177 __u32 ocd_group; /* MDS group on OST */
1178 __u32 ocd_cksum_types; /* supported checksum algorithms */
1179 __u32 ocd_max_easize; /* How big LOV EA can be on MDS */
1180 __u32 ocd_instance; /* also fix lustre_swab_connect */
1181 __u64 ocd_maxbytes; /* Maximum stripe size in bytes */
1184 struct obd_connect_data {
1185 __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1186 __u32 ocd_version; /* lustre release version number */
1187 __u32 ocd_grant; /* initial cache grant amount (bytes) */
1188 __u32 ocd_index; /* LOV index to connect to */
1189 __u32 ocd_brw_size; /* Maximum BRW size in bytes */
1190 __u64 ocd_ibits_known; /* inode bits this client understands */
1191 __u32 ocd_nllu; /* non-local-lustre-user */
1192 __u32 ocd_nllg; /* non-local-lustre-group */
1193 __u64 ocd_transno; /* first transno from client to be replayed */
1194 __u32 ocd_group; /* MDS group on OST */
1195 __u32 ocd_cksum_types; /* supported checksum algorithms */
1196 __u32 ocd_max_easize; /* How big LOV EA can be on MDS */
1197 __u32 ocd_instance; /* instance # of this target */
1198 __u64 ocd_maxbytes; /* Maximum stripe size in bytes */
1199 /* Fields after ocd_maxbytes are only accessible by the receiver
1200 * if the corresponding flag in ocd_connect_flags is set. Accessing
1201 * any field after ocd_maxbytes on the receiver without a valid flag
1202 * may result in out-of-bound memory access and kernel oops. */
1203 __u64 padding1; /* added 2.1.0. also fix lustre_swab_connect */
1204 __u64 padding2; /* added 2.1.0. also fix lustre_swab_connect */
1205 __u64 padding3; /* added 2.1.0. also fix lustre_swab_connect */
1206 __u64 padding4; /* added 2.1.0. also fix lustre_swab_connect */
1207 __u64 padding5; /* added 2.1.0. also fix lustre_swab_connect */
1208 __u64 padding6; /* added 2.1.0. also fix lustre_swab_connect */
1209 __u64 padding7; /* added 2.1.0. also fix lustre_swab_connect */
1210 __u64 padding8; /* added 2.1.0. also fix lustre_swab_connect */
1211 __u64 padding9; /* added 2.1.0. also fix lustre_swab_connect */
1212 __u64 paddingA; /* added 2.1.0. also fix lustre_swab_connect */
1213 __u64 paddingB; /* added 2.1.0. also fix lustre_swab_connect */
1214 __u64 paddingC; /* added 2.1.0. also fix lustre_swab_connect */
1215 __u64 paddingD; /* added 2.1.0. also fix lustre_swab_connect */
1216 __u64 paddingE; /* added 2.1.0. also fix lustre_swab_connect */
1217 __u64 paddingF; /* added 2.1.0. also fix lustre_swab_connect */
1221 extern void lustre_swab_connect(struct obd_connect_data *ocd);
1224 * Supported checksum algorithms. Up to 32 checksum types are supported.
1225 * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
1226 * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
1227 * algorithm and also the OBD_FL_CKSUM* flags.
1230 OBD_CKSUM_CRC32 = 0x00000001,
1231 OBD_CKSUM_ADLER = 0x00000002,
1232 OBD_CKSUM_CRC32C= 0x00000004,
1236 * OST requests: OBDO & OBD request records
1241 OST_REPLY = 0, /* reply ? */
1257 OST_QUOTACHECK = 18,
1259 OST_QUOTA_ADJUST_QUNIT = 20,
1262 #define OST_FIRST_OPC OST_REPLY
1265 OBD_FL_INLINEDATA = 0x00000001,
1266 OBD_FL_OBDMDEXISTS = 0x00000002,
1267 OBD_FL_DELORPHAN = 0x00000004, /* if set in o_flags delete orphans */
1268 OBD_FL_NORPC = 0x00000008, /* set in o_flags do in OSC not OST */
1269 OBD_FL_IDONLY = 0x00000010, /* set in o_flags only adjust obj id*/
1270 OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
1271 OBD_FL_DEBUG_CHECK = 0x00000040, /* echo client/server debug check */
1272 OBD_FL_NO_USRQUOTA = 0x00000100, /* the object's owner is over quota */
1273 OBD_FL_NO_GRPQUOTA = 0x00000200, /* the object's group is over quota */
1274 OBD_FL_CREATE_CROW = 0x00000400, /* object should be create on write */
1275 OBD_FL_SRVLOCK = 0x00000800, /* delegate DLM locking to server */
1276 OBD_FL_CKSUM_CRC32 = 0x00001000, /* CRC32 checksum type */
1277 OBD_FL_CKSUM_ADLER = 0x00002000, /* ADLER checksum type */
1278 OBD_FL_CKSUM_CRC32C = 0x00004000, /* CRC32C checksum type */
1279 OBD_FL_CKSUM_RSVD2 = 0x00008000, /* for future cksum types */
1280 OBD_FL_CKSUM_RSVD3 = 0x00010000, /* for future cksum types */
1281 OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
1282 OBD_FL_MMAP = 0x00040000, /* object is mmapped on the client.
1283 * XXX: obsoleted - reserved for old
1284 * clients prior than 2.2 */
1285 OBD_FL_RECOV_RESEND = 0x00080000, /* recoverable resent */
1286 OBD_FL_NOSPC_BLK = 0x00100000, /* no more block space on OST */
1288 /* Note that while these checksum values are currently separate bits,
1289 * in 2.x we can actually allow all values from 1-31 if we wanted. */
1290 OBD_FL_CKSUM_ALL = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER |
1291 OBD_FL_CKSUM_CRC32C,
1293 /* mask for local-only flag, which won't be sent over network */
1294 OBD_FL_LOCAL_MASK = 0xF0000000,
1297 #define LOV_MAGIC_V1 0x0BD10BD0
1298 #define LOV_MAGIC LOV_MAGIC_V1
1299 #define LOV_MAGIC_JOIN_V1 0x0BD20BD0
1300 #define LOV_MAGIC_V3 0x0BD30BD0
1302 #define LOV_PATTERN_RAID0 0x001 /* stripes are used round-robin */
1303 #define LOV_PATTERN_RAID1 0x002 /* stripes are mirrors of each other */
1304 #define LOV_PATTERN_FIRST 0x100 /* first stripe is not in round-robin */
1305 #define LOV_PATTERN_CMOBD 0x200
1307 #define lov_ost_data lov_ost_data_v1
1308 struct lov_ost_data_v1 { /* per-stripe data structure (little-endian)*/
1309 __u64 l_object_id; /* OST object ID */
1310 __u64 l_object_seq; /* OST object seq number */
1311 __u32 l_ost_gen; /* generation of this l_ost_idx */
1312 __u32 l_ost_idx; /* OST index in LOV (lov_tgt_desc->tgts) */
1315 #define lov_mds_md lov_mds_md_v1
1316 struct lov_mds_md_v1 { /* LOV EA mds/wire data (little-endian) */
1317 __u32 lmm_magic; /* magic number = LOV_MAGIC_V1 */
1318 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1319 __u64 lmm_object_id; /* LOV object ID */
1320 __u64 lmm_object_seq; /* LOV object seq number */
1321 __u32 lmm_stripe_size; /* size of stripe in bytes */
1322 /* lmm_stripe_count used to be __u32 */
1323 __u16 lmm_stripe_count; /* num stripes in use for this object */
1324 __u16 lmm_layout_gen; /* layout generation number */
1325 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1328 /* extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm); */
1330 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
1331 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
1333 #define XATTR_NAME_ACL_ACCESS "system.posix_acl_access"
1334 #define XATTR_NAME_ACL_DEFAULT "system.posix_acl_default"
1335 #define XATTR_USER_PREFIX "user."
1336 #define XATTR_TRUSTED_PREFIX "trusted."
1337 #define XATTR_SECURITY_PREFIX "security."
1338 #define XATTR_LUSTRE_PREFIX "lustre."
1340 #define XATTR_NAME_LOV "trusted.lov"
1341 #define XATTR_NAME_LMA "trusted.lma"
1342 #define XATTR_NAME_LMV "trusted.lmv"
1343 #define XATTR_NAME_LINK "trusted.link"
1344 #define XATTR_NAME_VERSION "trusted.version"
1347 struct lov_mds_md_v3 { /* LOV EA mds/wire data (little-endian) */
1348 __u32 lmm_magic; /* magic number = LOV_MAGIC_V3 */
1349 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1350 __u64 lmm_object_id; /* LOV object ID */
1351 __u64 lmm_object_seq; /* LOV object seq number */
1352 __u32 lmm_stripe_size; /* size of stripe in bytes */
1353 /* lmm_stripe_count used to be __u32 */
1354 __u16 lmm_stripe_count; /* num stripes in use for this object */
1355 __u16 lmm_layout_gen; /* layout generation number */
1356 char lmm_pool_name[LOV_MAXPOOLNAME]; /* must be 32bit aligned */
1357 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1361 #define OBD_MD_FLID (0x00000001ULL) /* object ID */
1362 #define OBD_MD_FLATIME (0x00000002ULL) /* access time */
1363 #define OBD_MD_FLMTIME (0x00000004ULL) /* data modification time */
1364 #define OBD_MD_FLCTIME (0x00000008ULL) /* change time */
1365 #define OBD_MD_FLSIZE (0x00000010ULL) /* size */
1366 #define OBD_MD_FLBLOCKS (0x00000020ULL) /* allocated blocks count */
1367 #define OBD_MD_FLBLKSZ (0x00000040ULL) /* block size */
1368 #define OBD_MD_FLMODE (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1369 #define OBD_MD_FLTYPE (0x00000100ULL) /* object type (mode & S_IFMT) */
1370 #define OBD_MD_FLUID (0x00000200ULL) /* user ID */
1371 #define OBD_MD_FLGID (0x00000400ULL) /* group ID */
1372 #define OBD_MD_FLFLAGS (0x00000800ULL) /* flags word */
1373 #define OBD_MD_FLNLINK (0x00002000ULL) /* link count */
1374 #define OBD_MD_FLGENER (0x00004000ULL) /* generation number */
1375 /*#define OBD_MD_FLINLINE (0x00008000ULL) inline data. used until 1.6.5 */
1376 #define OBD_MD_FLRDEV (0x00010000ULL) /* device number */
1377 #define OBD_MD_FLEASIZE (0x00020000ULL) /* extended attribute data */
1378 #define OBD_MD_LINKNAME (0x00040000ULL) /* symbolic link target */
1379 #define OBD_MD_FLHANDLE (0x00080000ULL) /* file/lock handle */
1380 #define OBD_MD_FLCKSUM (0x00100000ULL) /* bulk data checksum */
1381 #define OBD_MD_FLQOS (0x00200000ULL) /* quality of service stats */
1382 /*#define OBD_MD_FLOSCOPQ (0x00400000ULL) osc opaque data, never used */
1383 #define OBD_MD_FLCOOKIE (0x00800000ULL) /* log cancellation cookie */
1384 #define OBD_MD_FLGROUP (0x01000000ULL) /* group */
1385 #define OBD_MD_FLFID (0x02000000ULL) /* ->ost write inline fid */
1386 #define OBD_MD_FLEPOCH (0x04000000ULL) /* ->ost write with ioepoch */
1387 /* ->mds if epoch opens or closes */
1388 #define OBD_MD_FLGRANT (0x08000000ULL) /* ost preallocation space grant */
1389 #define OBD_MD_FLDIREA (0x10000000ULL) /* dir's extended attribute data */
1390 #define OBD_MD_FLUSRQUOTA (0x20000000ULL) /* over quota flags sent from ost */
1391 #define OBD_MD_FLGRPQUOTA (0x40000000ULL) /* over quota flags sent from ost */
1392 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1394 #define OBD_MD_MDS (0x0000000100000000ULL) /* where an inode lives on */
1395 #define OBD_MD_REINT (0x0000000200000000ULL) /* reintegrate oa */
1396 #define OBD_MD_MEA (0x0000000400000000ULL) /* CMD split EA */
1397 #define OBD_MD_MDTIDX (0x0000000800000000ULL) /* Get MDT index */
1399 #define OBD_MD_FLXATTR (0x0000001000000000ULL) /* xattr */
1400 #define OBD_MD_FLXATTRLS (0x0000002000000000ULL) /* xattr list */
1401 #define OBD_MD_FLXATTRRM (0x0000004000000000ULL) /* xattr remove */
1402 #define OBD_MD_FLACL (0x0000008000000000ULL) /* ACL */
1403 #define OBD_MD_FLRMTPERM (0x0000010000000000ULL) /* remote permission */
1404 #define OBD_MD_FLMDSCAPA (0x0000020000000000ULL) /* MDS capability */
1405 #define OBD_MD_FLOSSCAPA (0x0000040000000000ULL) /* OSS capability */
1406 #define OBD_MD_FLCKSPLIT (0x0000080000000000ULL) /* Check split on server */
1407 #define OBD_MD_FLCROSSREF (0x0000100000000000ULL) /* Cross-ref case */
1408 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1411 #define OBD_MD_FLRMTLSETFACL (0x0001000000000000ULL) /* lfs lsetfacl case */
1412 #define OBD_MD_FLRMTLGETFACL (0x0002000000000000ULL) /* lfs lgetfacl case */
1413 #define OBD_MD_FLRMTRSETFACL (0x0004000000000000ULL) /* lfs rsetfacl case */
1414 #define OBD_MD_FLRMTRGETFACL (0x0008000000000000ULL) /* lfs rgetfacl case */
1416 #define OBD_MD_FLGETATTR (OBD_MD_FLID | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1417 OBD_MD_FLCTIME | OBD_MD_FLSIZE | OBD_MD_FLBLKSZ | \
1418 OBD_MD_FLMODE | OBD_MD_FLTYPE | OBD_MD_FLUID | \
1419 OBD_MD_FLGID | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1420 OBD_MD_FLGENER | OBD_MD_FLRDEV | OBD_MD_FLGROUP)
1422 /* don't forget obdo_fid which is way down at the bottom so it can
1423 * come after the definition of llog_cookie */
1426 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
1428 /* ost_body.data values for OST_BRW */
1430 #define OBD_BRW_READ 0x01
1431 #define OBD_BRW_WRITE 0x02
1432 #define OBD_BRW_RWMASK (OBD_BRW_READ | OBD_BRW_WRITE)
1433 #define OBD_BRW_SYNC 0x08 /* this page is a part of synchronous
1434 * transfer and is not accounted in
1436 #define OBD_BRW_CHECK 0x10
1437 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
1438 #define OBD_BRW_GRANTED 0x40 /* the ost manages this */
1439 #define OBD_BRW_NOCACHE 0x80 /* this page is a part of non-cached IO */
1440 #define OBD_BRW_NOQUOTA 0x100
1441 #define OBD_BRW_SRVLOCK 0x200 /* Client holds no lock over this page */
1442 #define OBD_BRW_ASYNC 0x400 /* Server may delay commit to disk */
1443 #define OBD_BRW_MEMALLOC 0x800 /* Client runs in the "kswapd" context */
1445 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
1447 #define OST_MIN_PRECREATE 32
1448 #define OST_MAX_PRECREATE 20000
1457 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
1459 /* multiple of 8 bytes => can array */
1460 struct niobuf_remote {
1466 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
1468 /* lock value block communicated between the filter and llite */
1470 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1471 * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1472 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1473 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1474 #define OST_LVB_IS_ERR(blocks) \
1475 ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1476 #define OST_LVB_SET_ERR(blocks, rc) \
1477 do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1478 #define OST_LVB_GET_ERR(blocks) (int)(blocks - OST_LVB_ERR_INIT)
1488 extern void lustre_swab_ost_lvb(struct ost_lvb *);
1497 MDS_GETATTR_NAME = 34,
1502 MDS_DISCONNECT = 39,
1508 MDS_DONE_WRITING = 45,
1510 MDS_QUOTACHECK = 47,
1513 MDS_SETXATTR = 50, /* obsolete, now it's MDS_REINT op */
1520 #define MDS_FIRST_OPC MDS_GETATTR
1537 } mds_reint_t, mdt_reint_t;
1539 extern void lustre_swab_generic_32s (__u32 *val);
1541 /* the disposition of the intent outlines what was executed */
1542 #define DISP_IT_EXECD 0x00000001
1543 #define DISP_LOOKUP_EXECD 0x00000002
1544 #define DISP_LOOKUP_NEG 0x00000004
1545 #define DISP_LOOKUP_POS 0x00000008
1546 #define DISP_OPEN_CREATE 0x00000010
1547 #define DISP_OPEN_OPEN 0x00000020
1548 #define DISP_ENQ_COMPLETE 0x00400000
1549 #define DISP_ENQ_OPEN_REF 0x00800000
1550 #define DISP_ENQ_CREATE_REF 0x01000000
1551 #define DISP_OPEN_LOCK 0x02000000
1553 /* INODE LOCK PARTS */
1554 #define MDS_INODELOCK_LOOKUP 0x000001 /* dentry, mode, owner, group */
1555 #define MDS_INODELOCK_UPDATE 0x000002 /* size, links, timestamps */
1556 #define MDS_INODELOCK_OPEN 0x000004 /* For opened files */
1557 #define MDS_INODELOCK_LAYOUT 0x000008 /* for layout */
1559 /* Do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits
1560 * XXX: MDS_INODELOCK_MAXSHIFT should be increased to 3 once the layout lock is
1562 #define MDS_INODELOCK_MAXSHIFT 2
1563 /* This FULL lock is useful to take on unlink sort of operations */
1564 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
1566 extern void lustre_swab_ll_fid (struct ll_fid *fid);
1568 #define MDS_STATUS_CONN 1
1569 #define MDS_STATUS_LOV 2
1571 /* mdt_thread_info.mti_flags. */
1573 /* The flag indicates Size-on-MDS attributes are changed. */
1574 MF_SOM_CHANGE = (1 << 0),
1575 /* Flags indicates an epoch opens or closes. */
1576 MF_EPOCH_OPEN = (1 << 1),
1577 MF_EPOCH_CLOSE = (1 << 2),
1578 MF_MDC_CANCEL_FID1 = (1 << 3),
1579 MF_MDC_CANCEL_FID2 = (1 << 4),
1580 MF_MDC_CANCEL_FID3 = (1 << 5),
1581 MF_MDC_CANCEL_FID4 = (1 << 6),
1582 /* There is a pending attribute update. */
1583 MF_SOM_AU = (1 << 7),
1584 /* Cancel OST locks while getattr OST attributes. */
1585 MF_GETATTR_LOCK = (1 << 8),
1588 #define MF_SOM_LOCAL_FLAGS (MF_SOM_CHANGE | MF_EPOCH_OPEN | MF_EPOCH_CLOSE)
1590 #define LUSTRE_BFLAG_UNCOMMITTED_WRITES 0x1
1592 /* these should be identical to their EXT4_*_FL counterparts, they are
1593 * redefined here only to avoid dragging in fs/ext4/ext4.h */
1594 #define LUSTRE_SYNC_FL 0x00000008 /* Synchronous updates */
1595 #define LUSTRE_IMMUTABLE_FL 0x00000010 /* Immutable file */
1596 #define LUSTRE_APPEND_FL 0x00000020 /* writes to file may only append */
1597 #define LUSTRE_NOATIME_FL 0x00000080 /* do not update atime */
1598 #define LUSTRE_DIRSYNC_FL 0x00010000 /* dirsync behaviour (dir only) */
1601 /* Convert wire LUSTRE_*_FL to corresponding client local VFS S_* values
1602 * for the client inode i_flags. The LUSTRE_*_FL are the Lustre wire
1603 * protocol equivalents of LDISKFS_*_FL values stored on disk, while
1604 * the S_* flags are kernel-internal values that change between kernel
1605 * versions. These flags are set/cleared via FSFILT_IOC_{GET,SET}_FLAGS.
1606 * See b=16526 for a full history. */
1607 static inline int ll_ext_to_inode_flags(int flags)
1609 return (((flags & LUSTRE_SYNC_FL) ? S_SYNC : 0) |
1610 ((flags & LUSTRE_NOATIME_FL) ? S_NOATIME : 0) |
1611 ((flags & LUSTRE_APPEND_FL) ? S_APPEND : 0) |
1612 #if defined(S_DIRSYNC)
1613 ((flags & LUSTRE_DIRSYNC_FL) ? S_DIRSYNC : 0) |
1615 ((flags & LUSTRE_IMMUTABLE_FL) ? S_IMMUTABLE : 0));
1618 static inline int ll_inode_to_ext_flags(int iflags)
1620 return (((iflags & S_SYNC) ? LUSTRE_SYNC_FL : 0) |
1621 ((iflags & S_NOATIME) ? LUSTRE_NOATIME_FL : 0) |
1622 ((iflags & S_APPEND) ? LUSTRE_APPEND_FL : 0) |
1623 #if defined(S_DIRSYNC)
1624 ((iflags & S_DIRSYNC) ? LUSTRE_DIRSYNC_FL : 0) |
1626 ((iflags & S_IMMUTABLE) ? LUSTRE_IMMUTABLE_FL : 0));
1633 struct lustre_handle handle;
1635 __u64 size; /* Offset, in the case of MDS_READPAGE */
1639 __u64 blocks; /* XID, in the case of MDS_READPAGE */
1648 __u32 flags; /* from vfs for pin/unpin, LUSTRE_BFLAG close */
1650 __u32 nlink; /* #bytes to read in the case of MDS_READPAGE */
1656 __u32 max_cookiesize;
1657 __u32 uid_h; /* high 32-bits of uid, for FUID */
1658 __u32 gid_h; /* high 32-bits of gid, for FUID */
1659 __u32 padding_5; /* also fix lustre_swab_mdt_body */
1667 extern void lustre_swab_mdt_body (struct mdt_body *b);
1669 struct mdt_ioepoch {
1670 struct lustre_handle handle;
1676 extern void lustre_swab_mdt_ioepoch (struct mdt_ioepoch *b);
1678 #define Q_QUOTACHECK 0x800100
1679 #define Q_INITQUOTA 0x800101 /* init slave limits */
1680 #define Q_GETOINFO 0x800102 /* get obd quota info */
1681 #define Q_GETOQUOTA 0x800103 /* get obd quotas */
1682 #define Q_FINVALIDATE 0x800104 /* invalidate operational quotas */
1684 #define Q_TYPEMATCH(id, type) \
1685 ((id) == (type) || (id) == UGQUOTA)
1687 #define Q_TYPESET(oqc, type) Q_TYPEMATCH((oqc)->qc_type, type)
1689 #define Q_GETOCMD(oqc) \
1690 ((oqc)->qc_cmd == Q_GETOINFO || (oqc)->qc_cmd == Q_GETOQUOTA)
1692 #define QCTL_COPY(out, in) \
1694 Q_COPY(out, in, qc_cmd); \
1695 Q_COPY(out, in, qc_type); \
1696 Q_COPY(out, in, qc_id); \
1697 Q_COPY(out, in, qc_stat); \
1698 Q_COPY(out, in, qc_dqinfo); \
1699 Q_COPY(out, in, qc_dqblk); \
1702 struct obd_quotactl {
1707 struct obd_dqinfo qc_dqinfo;
1708 struct obd_dqblk qc_dqblk;
1711 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1713 struct quota_adjust_qunit {
1720 extern void lustre_swab_quota_adjust_qunit(struct quota_adjust_qunit *q);
1722 /* flags is shared among quota structures */
1723 #define LQUOTA_FLAGS_GRP 1UL /* 0 is user, 1 is group */
1724 #define LQUOTA_FLAGS_BLK 2UL /* 0 is inode, 1 is block */
1725 #define LQUOTA_FLAGS_ADJBLK 4UL /* adjust the block qunit size */
1726 #define LQUOTA_FLAGS_ADJINO 8UL /* adjust the inode qunit size */
1727 #define LQUOTA_FLAGS_CHG_QS 16UL /* indicate whether it has capability of
1728 * OBD_CONNECT_CHANGE_QS */
1729 #define LQUOTA_FLAGS_RECOVERY 32UL /* recovery is going on a uid/gid */
1730 #define LQUOTA_FLAGS_SETQUOTA 64UL /* being setquota on a uid/gid */
1732 /* flags is specific for quota_adjust_qunit */
1733 #define LQUOTA_QAQ_CREATE_LQS (1UL << 31) /* when it is set, need create lqs */
1735 /* the status of lqs_flags in struct lustre_qunit_size */
1736 #define LQUOTA_QUNIT_FLAGS (LQUOTA_FLAGS_GRP | LQUOTA_FLAGS_BLK)
1738 #define QAQ_IS_GRP(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_GRP)
1739 #define QAQ_IS_ADJBLK(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_ADJBLK)
1740 #define QAQ_IS_ADJINO(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_ADJINO)
1741 #define QAQ_IS_CREATE_LQS(qaq) ((qaq)->qaq_flags & LQUOTA_QAQ_CREATE_LQS)
1743 #define QAQ_SET_GRP(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_GRP)
1744 #define QAQ_SET_ADJBLK(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_ADJBLK)
1745 #define QAQ_SET_ADJINO(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_ADJINO)
1746 #define QAQ_SET_CREATE_LQS(qaq) ((qaq)->qaq_flags |= LQUOTA_QAQ_CREATE_LQS)
1748 /* permissions for md_perm.mp_perm */
1750 CFS_SETUID_PERM = 0x01,
1751 CFS_SETGID_PERM = 0x02,
1752 CFS_SETGRP_PERM = 0x04,
1753 CFS_RMTACL_PERM = 0x08,
1754 CFS_RMTOWN_PERM = 0x10
1757 /* inode access permission for remote user, the inode info are omitted,
1758 * for client knows them. */
1759 struct mdt_remote_perm {
1766 __u32 rp_access_perm; /* MAY_READ/WRITE/EXEC */
1770 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
1772 struct mdt_rec_setattr {
1782 __u32 sa_padding_1_h;
1783 struct lu_fid sa_fid;
1792 __u32 sa_attr_flags;
1800 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
1803 * Attribute flags used in mdt_rec_setattr::sa_valid.
1804 * The kernel's #defines for ATTR_* should not be used over the network
1805 * since the client and MDS may run different kernels (see bug 13828)
1806 * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1808 #define MDS_ATTR_MODE 0x1ULL /* = 1 */
1809 #define MDS_ATTR_UID 0x2ULL /* = 2 */
1810 #define MDS_ATTR_GID 0x4ULL /* = 4 */
1811 #define MDS_ATTR_SIZE 0x8ULL /* = 8 */
1812 #define MDS_ATTR_ATIME 0x10ULL /* = 16 */
1813 #define MDS_ATTR_MTIME 0x20ULL /* = 32 */
1814 #define MDS_ATTR_CTIME 0x40ULL /* = 64 */
1815 #define MDS_ATTR_ATIME_SET 0x80ULL /* = 128 */
1816 #define MDS_ATTR_MTIME_SET 0x100ULL /* = 256 */
1817 #define MDS_ATTR_FORCE 0x200ULL /* = 512, Not a change, but a change it */
1818 #define MDS_ATTR_ATTR_FLAG 0x400ULL /* = 1024 */
1819 #define MDS_ATTR_KILL_SUID 0x800ULL /* = 2048 */
1820 #define MDS_ATTR_KILL_SGID 0x1000ULL /* = 4096 */
1821 #define MDS_ATTR_CTIME_SET 0x2000ULL /* = 8192 */
1822 #define MDS_ATTR_FROM_OPEN 0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
1823 #define MDS_ATTR_BLOCKS 0x8000ULL /* = 32768 */
1826 #define FMODE_READ 00000001
1827 #define FMODE_WRITE 00000002
1830 #define MDS_FMODE_CLOSED 00000000
1831 #define MDS_FMODE_EXEC 00000004
1832 /* IO Epoch is opened on a closed file. */
1833 #define MDS_FMODE_EPOCH 01000000
1834 /* IO Epoch is opened on a file truncate. */
1835 #define MDS_FMODE_TRUNC 02000000
1836 /* Size-on-MDS Attribute Update is pending. */
1837 #define MDS_FMODE_SOM 04000000
1839 #define MDS_OPEN_CREATED 00000010
1840 #define MDS_OPEN_CROSS 00000020
1842 #define MDS_OPEN_CREAT 00000100
1843 #define MDS_OPEN_EXCL 00000200
1844 #define MDS_OPEN_TRUNC 00001000
1845 #define MDS_OPEN_APPEND 00002000
1846 #define MDS_OPEN_SYNC 00010000
1847 #define MDS_OPEN_DIRECTORY 00200000
1849 #define MDS_OPEN_DELAY_CREATE 0100000000 /* delay initial object create */
1850 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1851 #define MDS_OPEN_JOIN_FILE 0400000000 /* open for join file.
1852 * We do not support JOIN FILE
1853 * anymore, reserve this flags
1854 * just for preventing such bit
1856 #define MDS_CREATE_RMT_ACL 01000000000 /* indicate create on remote server
1857 * with default ACL */
1858 #define MDS_CREATE_SLAVE_OBJ 02000000000 /* indicate create slave object
1859 * actually, this is for create, not
1860 * conflict with other open flags */
1861 #define MDS_OPEN_LOCK 04000000000 /* This open requires open lock */
1862 #define MDS_OPEN_HAS_EA 010000000000 /* specify object create pattern */
1863 #define MDS_OPEN_HAS_OBJS 020000000000 /* Just set the EA the obj exist */
1864 #define MDS_OPEN_NORESTORE 0100000000000ULL /* Do not restore file at open */
1865 #define MDS_OPEN_NEWSTRIPE 0200000000000ULL /* New stripe needed (restripe or
1868 /* permission for create non-directory file */
1869 #define MAY_CREATE (1 << 7)
1870 /* permission for create directory file */
1871 #define MAY_LINK (1 << 8)
1872 /* permission for delete from the directory */
1873 #define MAY_UNLINK (1 << 9)
1874 /* source's permission for rename */
1875 #define MAY_RENAME_SRC (1 << 10)
1876 /* target's permission for rename */
1877 #define MAY_RENAME_TAR (1 << 11)
1878 /* part (parent's) VTX permission check */
1879 #define MAY_VTX_PART (1 << 12)
1880 /* full VTX permission check */
1881 #define MAY_VTX_FULL (1 << 13)
1882 /* lfs rgetfacl permission check */
1883 #define MAY_RGETFACL (1 << 14)
1886 MDS_CHECK_SPLIT = 1 << 0,
1887 MDS_CROSS_REF = 1 << 1,
1888 MDS_VTX_BYPASS = 1 << 2,
1889 MDS_PERM_BYPASS = 1 << 3,
1891 MDS_QUOTA_IGNORE = 1 << 5,
1892 MDS_CLOSE_CLEANUP = 1 << 6,
1893 MDS_KEEP_ORPHAN = 1 << 7,
1894 MDS_RECOV_OPEN = 1 << 8,
1897 /* instance of mdt_reint_rec */
1898 struct mdt_rec_create {
1906 __u32 cr_suppgid1_h;
1908 __u32 cr_suppgid2_h;
1909 struct lu_fid cr_fid1;
1910 struct lu_fid cr_fid2;
1911 struct lustre_handle cr_old_handle; /* handle in case of open replay */
1915 __u64 cr_padding_1; /* rr_blocks */
1918 /* use of helpers set/get_mrc_cr_flags() is needed to access
1919 * 64 bits cr_flags [cr_flags_l, cr_flags_h], this is done to
1920 * extend cr_flags size without breaking 1.8 compat */
1921 __u32 cr_flags_l; /* for use with open, low 32 bits */
1922 __u32 cr_flags_h; /* for use with open, high 32 bits */
1923 __u32 cr_padding_3; /* rr_padding_3 */
1924 __u32 cr_padding_4; /* rr_padding_4 */
1927 static inline void set_mrc_cr_flags(struct mdt_rec_create *mrc, __u64 flags)
1929 mrc->cr_flags_l = (__u32)(flags & 0xFFFFFFFFUll);
1930 mrc->cr_flags_h = (__u32)(flags >> 32);
1933 static inline __u64 get_mrc_cr_flags(struct mdt_rec_create *mrc)
1935 return ((__u64)(mrc->cr_flags_l) | ((__u64)mrc->cr_flags_h << 32));
1938 /* instance of mdt_reint_rec */
1939 struct mdt_rec_link {
1947 __u32 lk_suppgid1_h;
1949 __u32 lk_suppgid2_h;
1950 struct lu_fid lk_fid1;
1951 struct lu_fid lk_fid2;
1953 __u64 lk_padding_1; /* rr_atime */
1954 __u64 lk_padding_2; /* rr_ctime */
1955 __u64 lk_padding_3; /* rr_size */
1956 __u64 lk_padding_4; /* rr_blocks */
1958 __u32 lk_padding_5; /* rr_mode */
1959 __u32 lk_padding_6; /* rr_flags */
1960 __u32 lk_padding_7; /* rr_padding_2 */
1961 __u32 lk_padding_8; /* rr_padding_3 */
1962 __u32 lk_padding_9; /* rr_padding_4 */
1965 /* instance of mdt_reint_rec */
1966 struct mdt_rec_unlink {
1974 __u32 ul_suppgid1_h;
1976 __u32 ul_suppgid2_h;
1977 struct lu_fid ul_fid1;
1978 struct lu_fid ul_fid2;
1980 __u64 ul_padding_2; /* rr_atime */
1981 __u64 ul_padding_3; /* rr_ctime */
1982 __u64 ul_padding_4; /* rr_size */
1983 __u64 ul_padding_5; /* rr_blocks */
1986 __u32 ul_padding_6; /* rr_flags */
1987 __u32 ul_padding_7; /* rr_padding_2 */
1988 __u32 ul_padding_8; /* rr_padding_3 */
1989 __u32 ul_padding_9; /* rr_padding_4 */
1992 /* instance of mdt_reint_rec */
1993 struct mdt_rec_rename {
2001 __u32 rn_suppgid1_h;
2003 __u32 rn_suppgid2_h;
2004 struct lu_fid rn_fid1;
2005 struct lu_fid rn_fid2;
2007 __u64 rn_padding_1; /* rr_atime */
2008 __u64 rn_padding_2; /* rr_ctime */
2009 __u64 rn_padding_3; /* rr_size */
2010 __u64 rn_padding_4; /* rr_blocks */
2011 __u32 rn_bias; /* some operation flags */
2012 __u32 rn_mode; /* cross-ref rename has mode */
2013 __u32 rn_padding_5; /* rr_flags */
2014 __u32 rn_padding_6; /* rr_padding_2 */
2015 __u32 rn_padding_7; /* rr_padding_3 */
2016 __u32 rn_padding_8; /* rr_padding_4 */
2019 /* instance of mdt_reint_rec */
2020 struct mdt_rec_setxattr {
2028 __u32 sx_suppgid1_h;
2030 __u32 sx_suppgid2_h;
2031 struct lu_fid sx_fid;
2032 __u64 sx_padding_1; /* These three are rr_fid2 */
2037 __u64 sx_padding_5; /* rr_ctime */
2038 __u64 sx_padding_6; /* rr_size */
2039 __u64 sx_padding_7; /* rr_blocks */
2042 __u32 sx_padding_8; /* rr_flags */
2043 __u32 sx_padding_9; /* rr_padding_2 */
2044 __u32 sx_padding_10; /* rr_padding_3 */
2045 __u32 sx_padding_11; /* rr_padding_4 */
2049 * mdt_rec_reint is the template for all mdt_reint_xxx structures.
2050 * Do NOT change the size of various members, otherwise the value
2051 * will be broken in lustre_swab_mdt_rec_reint().
2053 * If you add new members in other mdt_reint_xxx structres and need to use the
2054 * rr_padding_x fields, then update lustre_swab_mdt_rec_reint() also.
2056 struct mdt_rec_reint {
2064 __u32 rr_suppgid1_h;
2066 __u32 rr_suppgid2_h;
2067 struct lu_fid rr_fid1;
2068 struct lu_fid rr_fid2;
2077 __u32 rr_padding_2; /* also fix lustre_swab_mdt_rec_reint */
2078 __u32 rr_padding_3; /* also fix lustre_swab_mdt_rec_reint */
2079 __u32 rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
2082 extern void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
2085 __u32 ld_tgt_count; /* how many MDS's */
2086 __u32 ld_active_tgt_count; /* how many active */
2087 __u32 ld_default_stripe_count; /* how many objects are used */
2088 __u32 ld_pattern; /* default MEA_MAGIC_* */
2089 __u64 ld_default_hash_size;
2090 __u64 ld_padding_1; /* also fix lustre_swab_lmv_desc */
2091 __u32 ld_padding_2; /* also fix lustre_swab_lmv_desc */
2092 __u32 ld_qos_maxage; /* in second */
2093 __u32 ld_padding_3; /* also fix lustre_swab_lmv_desc */
2094 __u32 ld_padding_4; /* also fix lustre_swab_lmv_desc */
2095 struct obd_uuid ld_uuid;
2098 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
2100 /* TODO: lmv_stripe_md should contain mds capabilities for all slave fids */
2101 struct lmv_stripe_md {
2106 char mea_pool_name[LOV_MAXPOOLNAME];
2107 struct lu_fid mea_ids[0];
2110 extern void lustre_swab_lmv_stripe_md(struct lmv_stripe_md *mea);
2112 /* lmv structures */
2113 #define MEA_MAGIC_LAST_CHAR 0xb2221ca1
2114 #define MEA_MAGIC_ALL_CHARS 0xb222a11c
2115 #define MEA_MAGIC_HASH_SEGMENT 0xb222a11b
2117 #define MAX_HASH_SIZE_32 0x7fffffffUL
2118 #define MAX_HASH_SIZE 0x7fffffffffffffffULL
2119 #define MAX_HASH_HIGHEST_BIT 0x1000000000000000ULL
2124 FLD_FIRST_OPC = FLD_QUERY
2130 SEQ_FIRST_OPC = SEQ_QUERY
2134 SEQ_ALLOC_SUPER = 0,
2139 * LOV data structures
2142 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
2143 #define LOV_MIN_STRIPE_SIZE (1<<LOV_MIN_STRIPE_BITS)
2144 #define LOV_MAX_STRIPE_COUNT_OLD 160
2145 /* This calculation is crafted so that input of 4096 will result in 160
2146 * which in turn is equal to old maximal stripe count.
2147 * XXX: In fact this is too simpified for now, what it also need is to get
2148 * ea_type argument to clearly know how much space each stripe consumes.
2150 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
2151 * allocation that is sufficient for the current generation of systems.
2153 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
2154 #define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */
2155 #define LOV_ALL_STRIPES 0xffff /* only valid for directories */
2156 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
2158 #define LOV_MAX_UUID_BUFFER_SIZE 8192
2159 /* The size of the buffer the lov/mdc reserves for the
2160 * array of UUIDs returned by the MDS. With the current
2161 * protocol, this will limit the max number of OSTs per LOV */
2163 #define LOV_DESC_MAGIC 0xB0CCDE5C
2165 /* LOV settings descriptor (should only contain static info) */
2167 __u32 ld_tgt_count; /* how many OBD's */
2168 __u32 ld_active_tgt_count; /* how many active */
2169 __u32 ld_default_stripe_count; /* how many objects are used */
2170 __u32 ld_pattern; /* default PATTERN_RAID0 */
2171 __u64 ld_default_stripe_size; /* in bytes */
2172 __u64 ld_default_stripe_offset; /* in bytes */
2173 __u32 ld_padding_0; /* unused */
2174 __u32 ld_qos_maxage; /* in second */
2175 __u32 ld_padding_1; /* also fix lustre_swab_lov_desc */
2176 __u32 ld_padding_2; /* also fix lustre_swab_lov_desc */
2177 struct obd_uuid ld_uuid;
2180 #define ld_magic ld_active_tgt_count /* for swabbing from llogs */
2182 extern void lustre_swab_lov_desc (struct lov_desc *ld);
2187 /* opcodes -- MUST be distinct from OST/MDS opcodes */
2192 LDLM_BL_CALLBACK = 104,
2193 LDLM_CP_CALLBACK = 105,
2194 LDLM_GL_CALLBACK = 106,
2195 LDLM_SET_INFO = 107,
2198 #define LDLM_FIRST_OPC LDLM_ENQUEUE
2200 #define RES_NAME_SIZE 4
2201 struct ldlm_res_id {
2202 __u64 name[RES_NAME_SIZE];
2205 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
2207 static inline int ldlm_res_eq(const struct ldlm_res_id *res0,
2208 const struct ldlm_res_id *res1)
2210 return !memcmp(res0, res1, sizeof(*res0));
2227 #define LCK_MODE_NUM 8
2237 #define LDLM_MIN_TYPE LDLM_PLAIN
2239 struct ldlm_extent {
2245 static inline int ldlm_extent_overlap(struct ldlm_extent *ex1,
2246 struct ldlm_extent *ex2)
2248 return (ex1->start <= ex2->end) && (ex2->start <= ex1->end);
2251 /* check if @ex1 contains @ex2 */
2252 static inline int ldlm_extent_contain(struct ldlm_extent *ex1,
2253 struct ldlm_extent *ex2)
2255 return (ex1->start <= ex2->start) && (ex1->end >= ex2->end);
2258 struct ldlm_inodebits {
2262 struct ldlm_flock_wire {
2270 /* it's important that the fields of the ldlm_extent structure match
2271 * the first fields of the ldlm_flock structure because there is only
2272 * one ldlm_swab routine to process the ldlm_policy_data_t union. if
2273 * this ever changes we will need to swab the union differently based
2274 * on the resource type. */
2277 struct ldlm_extent l_extent;
2278 struct ldlm_flock_wire l_flock;
2279 struct ldlm_inodebits l_inodebits;
2280 } ldlm_wire_policy_data_t;
2282 extern void lustre_swab_ldlm_policy_data (ldlm_wire_policy_data_t *d);
2284 struct ldlm_intent {
2288 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
2290 struct ldlm_resource_desc {
2291 ldlm_type_t lr_type;
2292 __u32 lr_padding; /* also fix lustre_swab_ldlm_resource_desc */
2293 struct ldlm_res_id lr_name;
2296 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
2298 struct ldlm_lock_desc {
2299 struct ldlm_resource_desc l_resource;
2300 ldlm_mode_t l_req_mode;
2301 ldlm_mode_t l_granted_mode;
2302 ldlm_wire_policy_data_t l_policy_data;
2305 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
2307 #define LDLM_LOCKREQ_HANDLES 2
2308 #define LDLM_ENQUEUE_CANCEL_OFF 1
2310 struct ldlm_request {
2313 struct ldlm_lock_desc lock_desc;
2314 struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
2317 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
2319 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
2320 * Otherwise, 2 are available. */
2321 #define ldlm_request_bufsize(count,type) \
2323 int _avail = LDLM_LOCKREQ_HANDLES; \
2324 _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
2325 sizeof(struct ldlm_request) + \
2326 (count > _avail ? count - _avail : 0) * \
2327 sizeof(struct lustre_handle); \
2332 __u32 lock_padding; /* also fix lustre_swab_ldlm_reply */
2333 struct ldlm_lock_desc lock_desc;
2334 struct lustre_handle lock_handle;
2335 __u64 lock_policy_res1;
2336 __u64 lock_policy_res2;
2339 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
2342 * Opcodes for mountconf (mgs and mgc)
2347 MGS_EXCEPTION, /* node died, etc. */
2348 MGS_TARGET_REG, /* whenever target starts up */
2354 #define MGS_FIRST_OPC MGS_CONNECT
2356 #define MGS_PARAM_MAXLEN 1024
2357 #define KEY_SET_INFO "set_info"
2359 struct mgs_send_param {
2360 char mgs_param[MGS_PARAM_MAXLEN];
2363 /* We pass this info to the MGS so it can write config logs */
2364 #define MTI_NAME_MAXLEN 64
2365 #define MTI_PARAM_MAXLEN 4096
2366 #define MTI_NIDS_MAX 32
2367 struct mgs_target_info {
2368 __u32 mti_lustre_ver;
2369 __u32 mti_stripe_index;
2370 __u32 mti_config_ver;
2372 __u32 mti_nid_count;
2373 __u32 mti_instance; /* Running instance of target */
2374 char mti_fsname[MTI_NAME_MAXLEN];
2375 char mti_svname[MTI_NAME_MAXLEN];
2376 char mti_uuid[sizeof(struct obd_uuid)];
2377 __u64 mti_nids[MTI_NIDS_MAX]; /* host nids (lnet_nid_t)*/
2378 char mti_params[MTI_PARAM_MAXLEN];
2380 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
2382 struct mgs_nidtbl_entry {
2383 __u64 mne_version; /* table version of this entry */
2384 __u32 mne_instance; /* target instance # */
2385 __u32 mne_index; /* target index */
2386 __u32 mne_length; /* length of this entry - by bytes */
2387 __u8 mne_type; /* target type LDD_F_SV_TYPE_OST/MDT */
2388 __u8 mne_nid_type; /* type of nid(mbz). for ipv6. */
2389 __u8 mne_nid_size; /* size of each NID, by bytes */
2390 __u8 mne_nid_count; /* # of NIDs in buffer */
2392 lnet_nid_t nids[0]; /* variable size buffer for NIDs. */
2395 extern void lustre_swab_mgs_nidtbl_entry(struct mgs_nidtbl_entry *oinfo);
2397 struct mgs_config_body {
2398 char mcb_name[MTI_NAME_MAXLEN]; /* logname */
2399 __u64 mcb_offset; /* next index of config log to request */
2400 __u16 mcb_type; /* type of log: CONFIG_T_[CONFIG|RECOVER] */
2402 __u8 mcb_bits; /* bits unit size of config log */
2403 __u32 mcb_units; /* # of units for bulk transfer */
2405 extern void lustre_swab_mgs_config_body(struct mgs_config_body *body);
2407 struct mgs_config_res {
2408 __u64 mcr_offset; /* index of last config log */
2409 __u64 mcr_size; /* size of the log */
2411 extern void lustre_swab_mgs_config_res(struct mgs_config_res *body);
2413 /* Config marker flags (in config log) */
2414 #define CM_START 0x01
2416 #define CM_SKIP 0x04
2417 #define CM_UPGRADE146 0x08
2418 #define CM_EXCLUDE 0x10
2419 #define CM_START_SKIP (CM_START | CM_SKIP)
2422 __u32 cm_step; /* aka config version */
2424 __u32 cm_vers; /* lustre release version number */
2425 __u32 cm_padding; /* 64 bit align */
2426 obd_time cm_createtime; /*when this record was first created */
2427 obd_time cm_canceltime; /*when this record is no longer valid*/
2428 char cm_tgtname[MTI_NAME_MAXLEN];
2429 char cm_comment[MTI_NAME_MAXLEN];
2432 extern void lustre_swab_cfg_marker(struct cfg_marker *marker,
2433 int swab, int size);
2436 * Opcodes for multiple servers.
2445 #define OBD_FIRST_OPC OBD_PING
2447 /* catalog of log objects */
2449 /** Identifier for a single log object */
2454 } __attribute__((packed));
2456 /** Records written to the CATALOGS list */
2457 #define CATLIST "CATALOGS"
2459 struct llog_logid lci_logid;
2463 } __attribute__((packed));
2465 /* Log data record types - there is no specific reason that these need to
2466 * be related to the RPC opcodes, but no reason not to (may be handy later?)
2468 #define LLOG_OP_MAGIC 0x10600000
2469 #define LLOG_OP_MASK 0xfff00000
2472 LLOG_PAD_MAGIC = LLOG_OP_MAGIC | 0x00000,
2473 OST_SZ_REC = LLOG_OP_MAGIC | 0x00f00,
2474 OST_RAID1_REC = LLOG_OP_MAGIC | 0x01000,
2475 MDS_UNLINK_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_UNLINK,
2476 MDS_SETATTR_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_SETATTR,
2477 MDS_SETATTR64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) | REINT_SETATTR,
2478 OBD_CFG_REC = LLOG_OP_MAGIC | 0x20000,
2479 PTL_CFG_REC = LLOG_OP_MAGIC | 0x30000, /* obsolete */
2480 LLOG_GEN_REC = LLOG_OP_MAGIC | 0x40000,
2481 LLOG_JOIN_REC = LLOG_OP_MAGIC | 0x50000, /* obsolete */
2482 CHANGELOG_REC = LLOG_OP_MAGIC | 0x60000,
2483 CHANGELOG_USER_REC = LLOG_OP_MAGIC | 0x70000,
2484 LLOG_HDR_MAGIC = LLOG_OP_MAGIC | 0x45539,
2485 LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
2489 * for now, continue to support old pad records which have 0 for their
2490 * type but still need to be swabbed for their length
2492 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
2493 (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == \
2494 __swab32(LLOG_OP_MAGIC) || \
2495 (((r)->lrh_type == 0) && ((r)->lrh_len > LLOG_CHUNK_SIZE)))
2497 /** Log record header - stored in little endian order.
2498 * Each record must start with this struct, end with a llog_rec_tail,
2499 * and be a multiple of 256 bits in size.
2501 struct llog_rec_hdr {
2508 struct llog_rec_tail {
2513 struct llog_logid_rec {
2514 struct llog_rec_hdr lid_hdr;
2515 struct llog_logid lid_id;
2521 struct llog_rec_tail lid_tail;
2522 } __attribute__((packed));
2524 struct llog_create_rec {
2525 struct llog_rec_hdr lcr_hdr;
2526 struct ll_fid lcr_fid;
2530 struct llog_rec_tail lcr_tail;
2531 } __attribute__((packed));
2533 struct llog_orphan_rec {
2534 struct llog_rec_hdr lor_hdr;
2538 struct llog_rec_tail lor_tail;
2539 } __attribute__((packed));
2541 struct llog_unlink_rec {
2542 struct llog_rec_hdr lur_hdr;
2545 obd_count lur_count;
2546 struct llog_rec_tail lur_tail;
2547 } __attribute__((packed));
2549 struct llog_setattr_rec {
2550 struct llog_rec_hdr lsr_hdr;
2556 struct llog_rec_tail lsr_tail;
2557 } __attribute__((packed));
2559 struct llog_setattr64_rec {
2560 struct llog_rec_hdr lsr_hdr;
2568 struct llog_rec_tail lsr_tail;
2569 } __attribute__((packed));
2571 struct llog_size_change_rec {
2572 struct llog_rec_hdr lsc_hdr;
2573 struct ll_fid lsc_fid;
2576 struct llog_rec_tail lsc_tail;
2577 } __attribute__((packed));
2579 #define CHANGELOG_MAGIC 0xca103000
2581 /** \a changelog_rec_type's that can't be masked */
2582 #define CHANGELOG_MINMASK (1 << CL_MARK)
2583 /** bits covering all \a changelog_rec_type's */
2584 #define CHANGELOG_ALLMASK 0XFFFFFFFF
2585 /** default \a changelog_rec_type mask */
2586 #define CHANGELOG_DEFMASK CHANGELOG_ALLMASK & ~(1 << CL_ATIME | 1 << CL_CLOSE)
2588 /* changelog llog name, needed by client replicators */
2589 #define CHANGELOG_CATALOG "changelog_catalog"
2591 struct changelog_setinfo {
2594 } __attribute__((packed));
2596 /** changelog record */
2597 struct llog_changelog_rec {
2598 struct llog_rec_hdr cr_hdr;
2599 struct changelog_rec cr;
2600 struct llog_rec_tail cr_tail; /**< for_sizezof_only */
2601 } __attribute__((packed));
2603 #define CHANGELOG_USER_PREFIX "cl"
2605 struct llog_changelog_user_rec {
2606 struct llog_rec_hdr cur_hdr;
2610 struct llog_rec_tail cur_tail;
2611 } __attribute__((packed));
2616 } __attribute__((packed));
2618 struct llog_gen_rec {
2619 struct llog_rec_hdr lgr_hdr;
2620 struct llog_gen lgr_gen;
2621 struct llog_rec_tail lgr_tail;
2623 /* On-disk header structure of each log object, stored in little endian order */
2624 #define LLOG_CHUNK_SIZE 8192
2625 #define LLOG_HEADER_SIZE (96)
2626 #define LLOG_BITMAP_BYTES (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
2628 #define LLOG_MIN_REC_SIZE (24) /* round(llog_rec_hdr + llog_rec_tail) */
2630 /* flags for the logs */
2631 #define LLOG_F_ZAP_WHEN_EMPTY 0x1
2632 #define LLOG_F_IS_CAT 0x2
2633 #define LLOG_F_IS_PLAIN 0x4
2635 struct llog_log_hdr {
2636 struct llog_rec_hdr llh_hdr;
2637 obd_time llh_timestamp;
2639 __u32 llh_bitmap_offset;
2643 /* for a catalog the first plain slot is next to it */
2644 struct obd_uuid llh_tgtuuid;
2645 __u32 llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
2646 __u32 llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
2647 struct llog_rec_tail llh_tail;
2648 } __attribute__((packed));
2650 #define LLOG_BITMAP_SIZE(llh) ((llh->llh_hdr.lrh_len - \
2651 llh->llh_bitmap_offset - \
2652 sizeof(llh->llh_tail)) * 8)
2654 /** log cookies are used to reference a specific log file and a record therein */
2655 struct llog_cookie {
2656 struct llog_logid lgc_lgl;
2660 } __attribute__((packed));
2662 /** llog protocol */
2663 enum llogd_rpc_ops {
2664 LLOG_ORIGIN_HANDLE_CREATE = 501,
2665 LLOG_ORIGIN_HANDLE_NEXT_BLOCK = 502,
2666 LLOG_ORIGIN_HANDLE_READ_HEADER = 503,
2667 LLOG_ORIGIN_HANDLE_WRITE_REC = 504,
2668 LLOG_ORIGIN_HANDLE_CLOSE = 505,
2669 LLOG_ORIGIN_CONNECT = 506,
2670 LLOG_CATINFO = 507, /* for lfs catinfo */
2671 LLOG_ORIGIN_HANDLE_PREV_BLOCK = 508,
2672 LLOG_ORIGIN_HANDLE_DESTROY = 509, /* for destroy llog object*/
2674 LLOG_FIRST_OPC = LLOG_ORIGIN_HANDLE_CREATE
2678 struct llog_logid lgd_logid;
2680 __u32 lgd_llh_flags;
2682 __u32 lgd_saved_index;
2684 __u64 lgd_cur_offset;
2685 } __attribute__((packed));
2687 struct llogd_conn_body {
2688 struct llog_gen lgdc_gen;
2689 struct llog_logid lgdc_logid;
2690 __u32 lgdc_ctxt_idx;
2691 } __attribute__((packed));
2693 /* Note: 64-bit types are 64-bit aligned in structure */
2695 obd_valid o_valid; /* hot fields in this obdo */
2697 obd_id o_parent_seq;
2698 obd_size o_size; /* o_size-o_blocks == ost_lvb */
2702 obd_blocks o_blocks; /* brw: cli sent cached bytes */
2705 /* 32-bit fields start here: keep an even number of them via padding */
2706 obd_blksize o_blksize; /* optimal IO blocksize */
2707 obd_mode o_mode; /* brw: cli sent cache remain */
2711 obd_count o_nlink; /* brw: checksum */
2712 obd_count o_parent_oid;
2713 obd_count o_misc; /* brw: o_dropped */
2714 __u64 o_ioepoch; /* epoch in ost writes */
2715 __u32 o_stripe_idx; /* holds stripe idx */
2717 struct lustre_handle o_handle; /* brw: lock handle to prolong locks */
2718 struct llog_cookie o_lcookie; /* destroy: unlink cookie from MDS */
2728 #define o_id o_oi.oi_id
2729 #define o_seq o_oi.oi_seq
2730 #define o_dirty o_blocks
2731 #define o_undirty o_mode
2732 #define o_dropped o_misc
2733 #define o_cksum o_nlink
2735 static inline void lustre_set_wire_obdo(struct obdo *wobdo, struct obdo *lobdo)
2737 memcpy(wobdo, lobdo, sizeof(*lobdo));
2738 wobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
2741 static inline void lustre_get_wire_obdo(struct obdo *lobdo, struct obdo *wobdo)
2743 obd_flag local_flags = 0;
2745 if (lobdo->o_valid & OBD_MD_FLFLAGS)
2746 local_flags = lobdo->o_flags & OBD_FL_LOCAL_MASK;
2748 LASSERT(!(wobdo->o_flags & OBD_FL_LOCAL_MASK));
2750 memcpy(lobdo, wobdo, sizeof(*lobdo));
2751 if (local_flags != 0) {
2752 lobdo->o_valid |= OBD_MD_FLFLAGS;
2753 lobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
2754 lobdo->o_flags |= local_flags;
2758 extern void lustre_swab_obdo (struct obdo *o);
2760 /* request structure for OST's */
2765 /* Key for FIEMAP to be used in get_info calls */
2766 struct ll_fiemap_info_key {
2769 struct ll_user_fiemap fiemap;
2772 extern void lustre_swab_ost_body (struct ost_body *b);
2773 extern void lustre_swab_ost_last_id(obd_id *id);
2774 extern void lustre_swab_fiemap(struct ll_user_fiemap *fiemap);
2776 extern void lustre_swab_lov_user_md_v1(struct lov_user_md_v1 *lum);
2777 extern void lustre_swab_lov_user_md_v3(struct lov_user_md_v3 *lum);
2778 extern void lustre_swab_lov_user_md_objects(struct lov_user_ost_data *lod,
2780 extern void lustre_swab_lov_mds_md(struct lov_mds_md *lmm);
2783 extern void lustre_swab_llogd_body (struct llogd_body *d);
2784 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
2785 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
2786 extern void lustre_swab_llog_rec(struct llog_rec_hdr *rec,
2787 struct llog_rec_tail *tail);
2790 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
2792 /* Functions for dumping PTLRPC fields */
2793 void dump_rniobuf(struct niobuf_remote *rnb);
2794 void dump_ioo(struct obd_ioobj *nb);
2795 void dump_obdo(struct obdo *oa);
2796 void dump_ost_body(struct ost_body *ob);
2797 void dump_rcs(__u32 *rc);
2799 /* this will be used when OBD_CONNECT_CHANGE_QS is set */
2802 * ID appiles to (uid, gid)
2806 * LQUOTA_FLAGS_* affect the responding bits
2810 * acquire/release count (bytes for block quota)
2814 * when a master returns the reply to a slave, it will
2815 * contain the current corresponding qunit size
2821 #define QDATA_IS_GRP(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_GRP)
2822 #define QDATA_IS_BLK(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_BLK)
2823 #define QDATA_IS_ADJBLK(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_ADJBLK)
2824 #define QDATA_IS_ADJINO(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_ADJINO)
2825 #define QDATA_IS_CHANGE_QS(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_CHG_QS)
2827 #define QDATA_SET_GRP(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_GRP)
2828 #define QDATA_SET_BLK(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_BLK)
2829 #define QDATA_SET_ADJBLK(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_ADJBLK)
2830 #define QDATA_SET_ADJINO(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_ADJINO)
2831 #define QDATA_SET_CHANGE_QS(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_CHG_QS)
2833 #define QDATA_CLR_GRP(qdata) ((qdata)->qd_flags &= ~LQUOTA_FLAGS_GRP)
2834 #define QDATA_CLR_CHANGE_QS(qdata) ((qdata)->qd_flags &= ~LQUOTA_FLAGS_CHG_QS)
2836 extern void lustre_swab_qdata(struct qunit_data *d);
2837 extern struct qunit_data *quota_get_qdata(void *req, int is_req, int is_exp);
2838 extern int quota_copy_qdata(void *request, struct qunit_data *qdata,
2839 int is_req, int is_exp);
2846 #define QUOTA_FIRST_OPC QUOTA_DQACQ
2848 #define QUOTA_REQUEST 1
2849 #define QUOTA_REPLY 0
2850 #define QUOTA_EXPORT 1
2851 #define QUOTA_IMPORT 0
2853 /* quota check function */
2854 #define QUOTA_RET_OK 0 /**< return successfully */
2855 #define QUOTA_RET_NOQUOTA 1 /**< not support quota */
2856 #define QUOTA_RET_NOLIMIT 2 /**< quota limit isn't set */
2857 #define QUOTA_RET_ACQUOTA 4 /**< need to acquire extra quota */
2860 /* security opcodes */
2863 SEC_CTX_INIT_CONT = 802,
2866 SEC_FIRST_OPC = SEC_CTX_INIT
2870 * capa related definitions
2872 #define CAPA_HMAC_MAX_LEN 64
2873 #define CAPA_HMAC_KEY_MAX_LEN 56
2875 /* NB take care when changing the sequence of elements this struct,
2876 * because the offset info is used in find_capa() */
2877 struct lustre_capa {
2878 struct lu_fid lc_fid; /** fid */
2879 __u64 lc_opc; /** operations allowed */
2880 __u64 lc_uid; /** file owner */
2881 __u64 lc_gid; /** file group */
2882 __u32 lc_flags; /** HMAC algorithm & flags */
2883 __u32 lc_keyid; /** key# used for the capability */
2884 __u32 lc_timeout; /** capa timeout value (sec) */
2885 __u32 lc_expiry; /** expiry time (sec) */
2886 __u8 lc_hmac[CAPA_HMAC_MAX_LEN]; /** HMAC */
2887 } __attribute__((packed));
2889 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
2891 /** lustre_capa::lc_opc */
2893 CAPA_OPC_BODY_WRITE = 1<<0, /**< write object data */
2894 CAPA_OPC_BODY_READ = 1<<1, /**< read object data */
2895 CAPA_OPC_INDEX_LOOKUP = 1<<2, /**< lookup object fid */
2896 CAPA_OPC_INDEX_INSERT = 1<<3, /**< insert object fid */
2897 CAPA_OPC_INDEX_DELETE = 1<<4, /**< delete object fid */
2898 CAPA_OPC_OSS_WRITE = 1<<5, /**< write oss object data */
2899 CAPA_OPC_OSS_READ = 1<<6, /**< read oss object data */
2900 CAPA_OPC_OSS_TRUNC = 1<<7, /**< truncate oss object */
2901 CAPA_OPC_OSS_DESTROY = 1<<8, /**< destroy oss object */
2902 CAPA_OPC_META_WRITE = 1<<9, /**< write object meta data */
2903 CAPA_OPC_META_READ = 1<<10, /**< read object meta data */
2906 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
2907 #define CAPA_OPC_MDS_ONLY \
2908 (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
2909 CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
2910 #define CAPA_OPC_OSS_ONLY \
2911 (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC | \
2912 CAPA_OPC_OSS_DESTROY)
2913 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
2914 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
2916 /* MDS capability covers object capability for operations of body r/w
2917 * (dir readpage/sendpage), index lookup/insert/delete and meta data r/w,
2918 * while OSS capability only covers object capability for operations of
2919 * oss data(file content) r/w/truncate.
2921 static inline int capa_for_mds(struct lustre_capa *c)
2923 return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) != 0;
2926 static inline int capa_for_oss(struct lustre_capa *c)
2928 return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) == 0;
2931 /* lustre_capa::lc_hmac_alg */
2933 CAPA_HMAC_ALG_SHA1 = 1, /**< sha1 algorithm */
2937 #define CAPA_FL_MASK 0x00ffffff
2938 #define CAPA_HMAC_ALG_MASK 0xff000000
2940 struct lustre_capa_key {
2941 __u64 lk_seq; /**< mds# */
2942 __u32 lk_keyid; /**< key# */
2944 __u8 lk_key[CAPA_HMAC_KEY_MAX_LEN]; /**< key */
2945 } __attribute__((packed));
2947 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
2949 /** The link ea holds 1 \a link_ea_entry for each hardlink */
2950 #define LINK_EA_MAGIC 0x11EAF1DFUL
2951 struct link_ea_header {
2954 __u64 leh_len; /* total size */
2960 /** Hardlink data is name and parent fid.
2961 * Stored in this crazy struct for maximum packing and endian-neutrality
2963 struct link_ea_entry {
2964 /** __u16 stored big-endian, unaligned */
2965 unsigned char lee_reclen[2];
2966 unsigned char lee_parent_fid[sizeof(struct lu_fid)];
2968 }__attribute__((packed));
2970 /** fid2path request/reply structure */
2971 struct getinfo_fid2path {
2972 struct lu_fid gf_fid;
2977 } __attribute__((packed));
2979 void lustre_swab_fid2path (struct getinfo_fid2path *gf);