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 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
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 #include <libcfs/libcfs.h>
96 /* Defn's shared with user-space. */
97 #include <lustre/lustre_user.h>
98 #include <lustre/ll_fiemap.h>
103 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
104 * FOO_REPLY_PORTAL is for incoming replies on the FOO
105 * FOO_BULK_PORTAL is for incoming bulk on the FOO
108 #define CONNMGR_REQUEST_PORTAL 1
109 #define CONNMGR_REPLY_PORTAL 2
110 //#define OSC_REQUEST_PORTAL 3
111 #define OSC_REPLY_PORTAL 4
112 //#define OSC_BULK_PORTAL 5
113 #define OST_IO_PORTAL 6
114 #define OST_CREATE_PORTAL 7
115 #define OST_BULK_PORTAL 8
116 //#define MDC_REQUEST_PORTAL 9
117 #define MDC_REPLY_PORTAL 10
118 //#define MDC_BULK_PORTAL 11
119 #define MDS_REQUEST_PORTAL 12
120 //#define MDS_REPLY_PORTAL 13
121 #define MDS_BULK_PORTAL 14
122 #define LDLM_CB_REQUEST_PORTAL 15
123 #define LDLM_CB_REPLY_PORTAL 16
124 #define LDLM_CANCEL_REQUEST_PORTAL 17
125 #define LDLM_CANCEL_REPLY_PORTAL 18
126 //#define PTLBD_REQUEST_PORTAL 19
127 //#define PTLBD_REPLY_PORTAL 20
128 //#define PTLBD_BULK_PORTAL 21
129 #define MDS_SETATTR_PORTAL 22
130 #define MDS_READPAGE_PORTAL 23
131 #define MDS_MDS_PORTAL 24
133 #define MGC_REPLY_PORTAL 25
134 #define MGS_REQUEST_PORTAL 26
135 #define MGS_REPLY_PORTAL 27
136 #define OST_REQUEST_PORTAL 28
137 #define FLD_REQUEST_PORTAL 29
138 #define SEQ_METADATA_PORTAL 30
139 #define SEQ_DATA_PORTAL 31
140 #define SEQ_CONTROLLER_PORTAL 32
142 /* Portal 63 is reserved for the Cray Inc DVS - nic@cray.com, roe@cray.com, n8851@cray.com */
147 #define SVC_RUNNING 8
148 #define SVC_STOPPING 16
149 #define SVC_STOPPED 32
152 #define PTL_RPC_MSG_REQUEST 4711
153 #define PTL_RPC_MSG_ERR 4712
154 #define PTL_RPC_MSG_REPLY 4713
156 /* DON'T use swabbed values of MAGIC as magic! */
157 #define LUSTRE_MSG_MAGIC_V1 0x0BD00BD0
158 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
160 #define LUSTRE_MSG_MAGIC_V1_SWABBED 0xD00BD00B
161 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
163 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
165 #define PTLRPC_MSG_VERSION 0x00000003
166 #define LUSTRE_VERSION_MASK 0xffff0000
167 #define LUSTRE_OBD_VERSION 0x00010000
168 #define LUSTRE_MDS_VERSION 0x00020000
169 #define LUSTRE_OST_VERSION 0x00030000
170 #define LUSTRE_DLM_VERSION 0x00040000
171 #define LUSTRE_LOG_VERSION 0x00050000
172 #define LUSTRE_MGS_VERSION 0x00060000
174 typedef __u32 mdsno_t;
175 typedef __u64 seqno_t;
178 * Describes a range of sequence, lsr_start is included but lsr_end is
180 * Same structure is used in fld module where lsr_mdt field holds mdt id
184 struct lu_seq_range {
192 * returns width of given range \a r
195 static inline __u64 range_space(const struct lu_seq_range *range)
197 return range->lsr_end - range->lsr_start;
201 * initialize range to zero
204 static inline void range_init(struct lu_seq_range *range)
206 range->lsr_start = range->lsr_end = range->lsr_mdt = 0;
210 * check if given seq id \a s is within given range \a r
213 static inline int range_within(const struct lu_seq_range *range,
216 return s >= range->lsr_start && s < range->lsr_end;
220 * allocate \a w units of sequence from range \a from.
222 static inline void range_alloc(struct lu_seq_range *to,
223 struct lu_seq_range *from,
226 to->lsr_start = from->lsr_start;
227 to->lsr_end = from->lsr_start + width;
228 from->lsr_start += width;
231 static inline int range_is_sane(const struct lu_seq_range *range)
233 return (range->lsr_end >= range->lsr_start);
236 static inline int range_is_zero(const struct lu_seq_range *range)
238 return (range->lsr_start == 0 && range->lsr_end == 0);
241 static inline int range_is_exhausted(const struct lu_seq_range *range)
244 return range_space(range) == 0;
247 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x):%x"
249 #define PRANGE(range) \
250 (range)->lsr_start, \
254 /** \defgroup lu_fid lu_fid
258 * Flags for lustre_mdt_attrs::lma_compat and lustre_mdt_attrs::lma_incompat.
261 LMAC_HSM = 0x00000001,
262 LMAC_SOM = 0x00000002,
266 * Masks for all features that should be supported by a Lustre version to
267 * access a specific file.
268 * This information is stored in lustre_mdt_attrs::lma_incompat.
270 * NOTE: No incompat feature should be added before bug #17670 is landed.
272 #define LMA_INCOMPAT_SUPP 0x0
275 * Following struct for MDT attributes, that will be kept inode's EA.
276 * Introduced in 2.0 release (please see b15993, for details)
278 struct lustre_mdt_attrs {
280 * Bitfield for supported data in this structure. From enum lma_compat.
281 * lma_self_fid and lma_flags are always available.
285 * Per-file incompat feature list. Lustre version should support all
286 * flags set in this field. The supported feature mask is available in
290 /** FID of this inode */
291 struct lu_fid lma_self_fid;
292 /** mdt/ost type, others */
294 /* IO Epoch SOM attributes belongs to */
296 /** total file size in objects */
298 /** total fs blocks in objects */
299 __u64 lma_som_blocks;
300 /** mds mount id the size is valid for */
301 __u64 lma_som_mountid;
305 * Fill \a lma with its first content.
306 * Only fid is stored.
308 static inline void lustre_lma_init(struct lustre_mdt_attrs *lma,
309 const struct lu_fid *fid)
312 lma->lma_incompat = 0;
313 memcpy(&lma->lma_self_fid, fid, sizeof(*fid));
315 lma->lma_ioepoch = 0;
316 lma->lma_som_size = 0;
317 lma->lma_som_blocks = 0;
318 lma->lma_som_mountid = 0;
320 /* If a field is added in struct lustre_mdt_attrs, zero it explicitly
321 * and change the test below. */
322 LASSERT(sizeof(*lma) ==
323 (offsetof(struct lustre_mdt_attrs, lma_som_mountid) +
324 sizeof(lma->lma_som_mountid)));
327 extern void lustre_swab_lu_fid(struct lu_fid *fid);
330 * Swab, if needed, lustre_mdt_attr struct to on-disk format.
331 * Otherwise, do not touch it.
333 static inline void lustre_lma_swab(struct lustre_mdt_attrs *lma)
335 /* Use LUSTRE_MSG_MAGIC to detect local endianess. */
336 if (LUSTRE_MSG_MAGIC != cpu_to_le32(LUSTRE_MSG_MAGIC)) {
337 __swab32s(&lma->lma_compat);
338 __swab32s(&lma->lma_incompat);
339 lustre_swab_lu_fid(&lma->lma_self_fid);
340 __swab64s(&lma->lma_flags);
341 __swab64s(&lma->lma_ioepoch);
342 __swab64s(&lma->lma_som_size);
343 __swab64s(&lma->lma_som_blocks);
344 __swab64s(&lma->lma_som_mountid);
353 /** initial fid id value */
354 LUSTRE_FID_INIT_OID = 1UL
357 /** returns fid object sequence */
358 static inline __u64 fid_seq(const struct lu_fid *fid)
363 /** returns fid object id */
364 static inline __u32 fid_oid(const struct lu_fid *fid)
369 /** returns fid object version */
370 static inline __u32 fid_ver(const struct lu_fid *fid)
375 static inline void fid_zero(struct lu_fid *fid)
377 memset(fid, 0, sizeof(*fid));
380 /* Normal FID sequence starts from this value, i.e. 1<<33 */
381 #define FID_SEQ_START 0x200000000ULL
383 /* IDIF sequence starts from this value, i.e. 1<<32 */
384 #define IDIF_SEQ_START 0x100000000ULL
387 * Check if a fid is igif or not.
388 * \param fid the fid to be tested.
389 * \return true if the fid is a igif; otherwise false.
391 static inline int fid_is_igif(const struct lu_fid *fid)
393 return fid_seq(fid) > 0 && fid_seq(fid) < IDIF_SEQ_START;
397 * Check if a fid is idif or not.
398 * \param fid the fid to be tested.
399 * \return true if the fid is a idif; otherwise false.
401 static inline int fid_is_idif(const struct lu_fid *fid)
403 return fid_seq(fid) >= IDIF_SEQ_START && fid_seq(fid) < FID_SEQ_START;
407 * Get inode number from a igif.
408 * \param fid a igif to get inode number from.
409 * \return inode number for the igif.
411 static inline ino_t lu_igif_ino(const struct lu_fid *fid)
417 * Get inode generation from a igif.
418 * \param fid a igif to get inode generation from.
419 * \return inode generation for the igif.
421 static inline __u32 lu_igif_gen(const struct lu_fid *fid)
427 * Fids are transmitted across network (in the sender byte-ordering),
428 * and stored on disk in big-endian order.
430 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
432 /* check that all fields are converted */
433 CLASSERT(sizeof *src ==
434 sizeof fid_seq(src) +
435 sizeof fid_oid(src) + sizeof fid_ver(src));
436 LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
437 dst->f_seq = cpu_to_le64(fid_seq(src));
438 dst->f_oid = cpu_to_le32(fid_oid(src));
439 dst->f_ver = cpu_to_le32(fid_ver(src));
442 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
444 /* check that all fields are converted */
445 CLASSERT(sizeof *src ==
446 sizeof fid_seq(src) +
447 sizeof fid_oid(src) + sizeof fid_ver(src));
448 dst->f_seq = le64_to_cpu(fid_seq(src));
449 dst->f_oid = le32_to_cpu(fid_oid(src));
450 dst->f_ver = le32_to_cpu(fid_ver(src));
451 LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
454 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
456 /* check that all fields are converted */
457 CLASSERT(sizeof *src ==
458 sizeof fid_seq(src) +
459 sizeof fid_oid(src) + sizeof fid_ver(src));
460 LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
461 dst->f_seq = cpu_to_be64(fid_seq(src));
462 dst->f_oid = cpu_to_be32(fid_oid(src));
463 dst->f_ver = cpu_to_be32(fid_ver(src));
466 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
468 /* check that all fields are converted */
469 CLASSERT(sizeof *src ==
470 sizeof fid_seq(src) +
471 sizeof fid_oid(src) + sizeof fid_ver(src));
472 dst->f_seq = be64_to_cpu(fid_seq(src));
473 dst->f_oid = be32_to_cpu(fid_oid(src));
474 dst->f_ver = be32_to_cpu(fid_ver(src));
475 LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
478 static inline int fid_is_sane(const struct lu_fid *fid)
482 ((fid_seq(fid) >= FID_SEQ_START && fid_oid(fid) != 0
483 && fid_ver(fid) == 0) ||
487 static inline int fid_is_zero(const struct lu_fid *fid)
489 return fid_seq(fid) == 0 && fid_oid(fid) == 0;
492 extern void lustre_swab_lu_fid(struct lu_fid *fid);
493 extern void lustre_swab_lu_seq_range(struct lu_seq_range *range);
495 static inline int lu_fid_eq(const struct lu_fid *f0,
496 const struct lu_fid *f1)
498 /* Check that there is no alignment padding. */
499 CLASSERT(sizeof *f0 ==
500 sizeof f0->f_seq + sizeof f0->f_oid + sizeof f0->f_ver);
501 LASSERTF(fid_is_igif(f0) || fid_ver(f0) == 0, DFID, PFID(f0));
502 LASSERTF(fid_is_igif(f1) || fid_ver(f1) == 0, DFID, PFID(f1));
503 return memcmp(f0, f1, sizeof *f0) == 0;
506 #define __diff_normalize(val0, val1) \
508 typeof(val0) __val0 = (val0); \
509 typeof(val1) __val1 = (val1); \
511 (__val0 == __val1 ? 0 : __val0 > __val1 ? +1 : -1); \
514 static inline int lu_fid_cmp(const struct lu_fid *f0,
515 const struct lu_fid *f1)
518 __diff_normalize(fid_seq(f0), fid_seq(f1)) ?:
519 __diff_normalize(fid_oid(f0), fid_oid(f1)) ?:
520 __diff_normalize(fid_ver(f0), fid_ver(f1));
525 /** \defgroup lu_dir lu_dir
529 * Enumeration of possible directory entry attributes.
531 * Attributes follow directory entry header in the order they appear in this
534 enum lu_dirent_attrs {
540 * Layout of readdir pages, as transmitted on wire.
543 /** valid if LUDA_FID is set. */
544 struct lu_fid lde_fid;
545 /** a unique entry identifier: a hash or an offset. */
547 /** total record length, including all attributes. */
551 /** optional variable size attributes following this entry.
552 * taken from enum lu_dirent_attrs.
555 /** name is followed by the attributes indicated in ->ldp_attrs, in
556 * their natural order. After the last attribute, padding bytes are
557 * added to make ->lde_reclen a multiple of 8.
563 * Definitions of optional directory entry attributes formats.
565 * Individual attributes do not have their length encoded in a generic way. It
566 * is assumed that consumer of an attribute knows its format. This means that
567 * it is impossible to skip over an unknown attribute, except by skipping over all
568 * remaining attributes (by using ->lde_reclen), which is not too
569 * constraining, because new server versions will append new attributes at
570 * the end of an entry.
574 * Fid directory attribute: a fid of an object referenced by the entry. This
575 * will be almost always requested by the client and supplied by the server.
577 * Aligned to 8 bytes.
579 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
584 * Aligned to 2 bytes.
591 __u64 ldp_hash_start;
595 struct lu_dirent ldp_entries[0];
598 enum lu_dirpage_flags {
602 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
604 if (le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
607 return dp->ldp_entries;
610 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
612 struct lu_dirent *next;
614 if (le16_to_cpu(ent->lde_reclen) != 0)
615 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
622 static inline int lu_dirent_calc_size(int namelen, __u16 attr)
626 if (attr & LUDA_TYPE) {
627 const unsigned align = sizeof(struct luda_type) - 1;
628 size = (sizeof(struct lu_dirent) + namelen + align) & ~align;
629 size += sizeof(struct luda_type);
631 size = sizeof(struct lu_dirent) + namelen;
633 return (size + 7) & ~7;
636 static inline int lu_dirent_size(struct lu_dirent *ent)
638 if (le16_to_cpu(ent->lde_reclen) == 0) {
639 return lu_dirent_calc_size(le16_to_cpu(ent->lde_namelen),
640 le32_to_cpu(ent->lde_attrs));
642 return le16_to_cpu(ent->lde_reclen);
645 #define DIR_END_OFF 0xfffffffffffffffeULL
649 struct lustre_handle {
652 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
654 static inline int lustre_handle_is_used(struct lustre_handle *lh)
656 return lh->cookie != 0ull;
659 static inline int lustre_handle_equal(struct lustre_handle *lh1,
660 struct lustre_handle *lh2)
662 return lh1->cookie == lh2->cookie;
665 static inline void lustre_handle_copy(struct lustre_handle *tgt,
666 struct lustre_handle *src)
668 tgt->cookie = src->cookie;
671 /* flags for lm_flags */
672 #define MSGHDR_AT_SUPPORT 0x1
674 #define lustre_msg lustre_msg_v2
675 /* we depend on this structure to be 8-byte aligned */
676 /* this type is only endian-adjusted in lustre_unpack_msg() */
677 struct lustre_msg_v2 {
689 /* without gss, ptlrpc_body is put at the first buffer. */
690 #define PTLRPC_NUM_VERSIONS 4
692 struct lustre_handle pb_handle;
699 __u64 pb_last_committed;
704 __u32 pb_timeout; /* for req, the deadline, for rep, the service est */
705 __u32 pb_service_time; /* for rep, actual service time */
708 /* VBR: pre-versions */
709 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
710 /* padding for future needs */
714 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
716 /* message body offset for lustre_msg_v2 */
717 /* ptlrpc body offset in all request/reply messages */
718 #define MSG_PTLRPC_BODY_OFF 0
720 /* normal request/reply message record offset */
721 #define REQ_REC_OFF 1
722 #define REPLY_REC_OFF 1
724 /* ldlm request message body offset */
725 #define DLM_LOCKREQ_OFF 1 /* lockreq offset */
726 #define DLM_REQ_REC_OFF 2 /* normal dlm request record offset */
728 /* ldlm intent lock message body offset */
729 #define DLM_INTENT_IT_OFF 2 /* intent lock it offset */
730 #define DLM_INTENT_REC_OFF 3 /* intent lock record offset */
732 /* ldlm reply message body offset */
733 #define DLM_LOCKREPLY_OFF 1 /* lockrep offset */
734 #define DLM_REPLY_REC_OFF 2 /* reply record offset */
736 /** only use in req->rq_{req,rep}_swab_mask */
737 #define MSG_PTLRPC_HEADER_OFF 31
739 /* Flags that are operation-specific go in the top 16 bits. */
740 #define MSG_OP_FLAG_MASK 0xffff0000
741 #define MSG_OP_FLAG_SHIFT 16
743 /* Flags that apply to all requests are in the bottom 16 bits */
744 #define MSG_GEN_FLAG_MASK 0x0000ffff
745 #define MSG_LAST_REPLAY 0x0001
746 #define MSG_RESENT 0x0002
747 #define MSG_REPLAY 0x0004
748 /* #define MSG_AT_SUPPORT 0x0008
749 * This was used in early prototypes of adaptive timeouts, and while there
750 * shouldn't be any users of that code there also isn't a need for using this
751 * bits. Defer usage until at least 1.10 to avoid potential conflict. */
752 #define MSG_DELAY_REPLAY 0x0010
753 #define MSG_VERSION_REPLAY 0x0020
754 #define MSG_REQ_REPLAY_DONE 0x0040
755 #define MSG_LOCK_REPLAY_DONE 0x0080
758 * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
761 #define MSG_CONNECT_RECOVERING 0x00000001
762 #define MSG_CONNECT_RECONNECT 0x00000002
763 #define MSG_CONNECT_REPLAYABLE 0x00000004
764 //#define MSG_CONNECT_PEER 0x8
765 #define MSG_CONNECT_LIBCLIENT 0x00000010
766 #define MSG_CONNECT_INITIAL 0x00000020
767 #define MSG_CONNECT_ASYNC 0x00000040
768 #define MSG_CONNECT_NEXT_VER 0x00000080 /* use next version of lustre_msg */
769 #define MSG_CONNECT_TRANSNO 0x00000100 /* report transno */
772 #define OBD_CONNECT_RDONLY 0x1ULL /*client has read-only access*/
773 #define OBD_CONNECT_INDEX 0x2ULL /*connect specific LOV idx */
774 #define OBD_CONNECT_MDS 0x4ULL /*connect from MDT to OST */
775 #define OBD_CONNECT_GRANT 0x8ULL /*OSC gets grant at connect */
776 #define OBD_CONNECT_SRVLOCK 0x10ULL /*server takes locks for cli */
777 #define OBD_CONNECT_VERSION 0x20ULL /*Lustre versions in ocd */
778 #define OBD_CONNECT_REQPORTAL 0x40ULL /*Separate non-IO req portal */
779 #define OBD_CONNECT_ACL 0x80ULL /*access control lists */
780 #define OBD_CONNECT_XATTR 0x100ULL /*client use extended attr */
781 #define OBD_CONNECT_CROW 0x200ULL /*MDS+OST create obj on write*/
782 #define OBD_CONNECT_TRUNCLOCK 0x400ULL /*locks on server for punch */
783 #define OBD_CONNECT_TRANSNO 0x800ULL /*replay sends init transno */
784 #define OBD_CONNECT_IBITS 0x1000ULL /*support for inodebits locks*/
785 #define OBD_CONNECT_JOIN 0x2000ULL /*files can be concatenated.
786 *We do not support JOIN FILE
787 *anymore, reserve this flags
788 *just for preventing such bit
790 #define OBD_CONNECT_ATTRFID 0x4000ULL /*Server can GetAttr By Fid*/
791 #define OBD_CONNECT_NODEVOH 0x8000ULL /*No open hndl on specl nodes*/
792 #define OBD_CONNECT_RMT_CLIENT 0x10000ULL /*Remote client */
793 #define OBD_CONNECT_RMT_CLIENT_FORCE 0x20000ULL /*Remote client by force */
794 #define OBD_CONNECT_BRW_SIZE 0x40000ULL /*Max bytes per rpc */
795 #define OBD_CONNECT_QUOTA64 0x80000ULL /*64bit qunit_data.qd_count */
796 #define OBD_CONNECT_MDS_CAPA 0x100000ULL /*MDS capability */
797 #define OBD_CONNECT_OSS_CAPA 0x200000ULL /*OSS capability */
798 #define OBD_CONNECT_CANCELSET 0x400000ULL /*Early batched cancels. */
799 #define OBD_CONNECT_SOM 0x800000ULL /*Size on MDS */
800 #define OBD_CONNECT_AT 0x1000000ULL /*client uses AT */
801 #define OBD_CONNECT_LRU_RESIZE 0x2000000ULL /*LRU resize feature. */
802 #define OBD_CONNECT_MDS_MDS 0x4000000ULL /*MDS-MDS connection */
803 #define OBD_CONNECT_REAL 0x8000000ULL /*real connection */
804 #define OBD_CONNECT_CHANGE_QS 0x10000000ULL /*shrink/enlarge qunit */
805 #define OBD_CONNECT_CKSUM 0x20000000ULL /*support several cksum algos*/
806 #define OBD_CONNECT_FID 0x40000000ULL /*FID is supported by server */
807 #define OBD_CONNECT_VBR 0x80000000ULL /*version based recovery */
808 #define OBD_CONNECT_LOV_V3 0x100000000ULL /*client supports LOV v3 EA */
809 #define OBD_CONNECT_GRANT_SHRINK 0x200000000ULL /* support grant shrink */
810 #define OBD_CONNECT_SKIP_ORPHAN 0x400000000ULL /* don't reuse orphan objids */
811 /* also update obd_connect_names[] for lprocfs_rd_connect_flags()
812 * and lustre/utils/wirecheck.c */
814 #ifdef HAVE_LRU_RESIZE_SUPPORT
815 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
817 #define LRU_RESIZE_CONNECT_FLAG 0
820 #define MDT_CONNECT_SUPPORTED (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
821 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
822 OBD_CONNECT_IBITS | OBD_CONNECT_JOIN | \
823 OBD_CONNECT_NODEVOH |/* OBD_CONNECT_ATTRFID |*/\
824 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
825 OBD_CONNECT_RMT_CLIENT | \
826 OBD_CONNECT_RMT_CLIENT_FORCE | \
827 OBD_CONNECT_MDS_CAPA | OBD_CONNECT_OSS_CAPA | \
828 OBD_CONNECT_MDS_MDS | OBD_CONNECT_FID | \
829 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_VBR | \
830 OBD_CONNECT_LOV_V3 | OBD_CONNECT_SOM)
831 #define OST_CONNECT_SUPPORTED (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
832 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
833 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
834 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_QUOTA64 | \
835 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
836 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_CKSUM | \
837 OBD_CONNECT_CHANGE_QS | \
838 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_RMT_CLIENT | \
839 OBD_CONNECT_RMT_CLIENT_FORCE | OBD_CONNECT_VBR | \
840 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
841 OBD_CONNECT_GRANT_SHRINK)
842 #define ECHO_CONNECT_SUPPORTED (0)
843 #define MGS_CONNECT_SUPPORTED (OBD_CONNECT_VERSION | OBD_CONNECT_AT)
845 #define OBD_OCD_VERSION(major,minor,patch,fix) (((major)<<24) + ((minor)<<16) +\
846 ((patch)<<8) + (fix))
847 #define OBD_OCD_VERSION_MAJOR(version) ((int)((version)>>24)&255)
848 #define OBD_OCD_VERSION_MINOR(version) ((int)((version)>>16)&255)
849 #define OBD_OCD_VERSION_PATCH(version) ((int)((version)>>8)&255)
850 #define OBD_OCD_VERSION_FIX(version) ((int)(version)&255)
852 /* This structure is used for both request and reply.
854 * If we eventually have separate connect data for different types, which we
855 * almost certainly will, then perhaps we stick a union in here. */
856 struct obd_connect_data {
857 __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
858 __u32 ocd_version; /* lustre release version number */
859 __u32 ocd_grant; /* initial cache grant amount (bytes) */
860 __u32 ocd_index; /* LOV index to connect to */
861 __u32 ocd_brw_size; /* Maximum BRW size in bytes */
862 __u64 ocd_ibits_known; /* inode bits this client understands */
863 __u32 ocd_nllu; /* non-local-lustre-user */
864 __u32 ocd_nllg; /* non-local-lustre-group */
865 __u64 ocd_transno; /* first transno from client to be replayed */
866 __u32 ocd_group; /* MDS group on OST */
867 __u32 ocd_cksum_types; /* supported checksum algorithms */
868 __u64 padding1; /* also fix lustre_swab_connect */
869 __u64 padding2; /* also fix lustre_swab_connect */
872 extern void lustre_swab_connect(struct obd_connect_data *ocd);
875 * Supported checksum algorithms. Up to 32 checksum types are supported.
876 * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
877 * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
878 * algorithm and also the OBD_FL_CKSUM* flags.
881 OBD_CKSUM_CRC32 = 0x00000001,
882 OBD_CKSUM_ADLER = 0x00000002,
886 * OST requests: OBDO & OBD request records
891 OST_REPLY = 0, /* reply ? */
909 OST_QUOTA_ADJUST_QUNIT = 20,
912 #define OST_FIRST_OPC OST_REPLY
914 typedef __u64 obd_id;
915 typedef __u64 obd_gr;
916 typedef __u64 obd_time;
917 typedef __u64 obd_size;
918 typedef __u64 obd_off;
919 typedef __u64 obd_blocks;
920 typedef __u64 obd_valid;
921 typedef __u32 obd_blksize;
922 typedef __u32 obd_mode;
923 typedef __u32 obd_uid;
924 typedef __u32 obd_gid;
925 typedef __u32 obd_flag;
926 typedef __u32 obd_count;
929 OBD_FL_INLINEDATA = 0x00000001,
930 OBD_FL_OBDMDEXISTS = 0x00000002,
931 OBD_FL_DELORPHAN = 0x00000004, /* if set in o_flags delete orphans */
932 OBD_FL_NORPC = 0x00000008, /* set in o_flags do in OSC not OST */
933 OBD_FL_IDONLY = 0x00000010, /* set in o_flags only adjust obj id*/
934 OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
935 OBD_FL_DEBUG_CHECK = 0x00000040, /* echo client/server debug check */
936 OBD_FL_NO_USRQUOTA = 0x00000100, /* the object's owner is over quota */
937 OBD_FL_NO_GRPQUOTA = 0x00000200, /* the object's group is over quota */
938 OBD_FL_CREATE_CROW = 0x00000400, /* object should be create on write */
939 OBD_FL_SRVLOCK = 0x00000800, /* delegate DLM locking to server */
940 OBD_FL_CKSUM_CRC32 = 0x00001000, /* CRC32 checksum type */
941 OBD_FL_CKSUM_ADLER = 0x00002000, /* ADLER checksum type */
942 OBD_FL_CKSUM_RSVD1 = 0x00004000, /* for future cksum types */
943 OBD_FL_CKSUM_RSVD2 = 0x00008000, /* for future cksum types */
944 OBD_FL_CKSUM_RSVD3 = 0x00010000, /* for future cksum types */
945 OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
947 OBD_FL_CKSUM_ALL = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER,
949 /* mask for local-only flag, which won't be sent over network */
950 OBD_FL_LOCAL_MASK = 0xF0000000,
951 /* temporary OBDO used by osc_brw_async (see bug 18364) */
952 OBD_FL_TEMPORARY = 0x10000000,
955 #define LOV_MAGIC_V1 0x0BD10BD0
956 #define LOV_MAGIC LOV_MAGIC_V1
957 #define LOV_MAGIC_JOIN_V1 0x0BD20BD0
958 #define LOV_MAGIC_V3 0x0BD30BD0
960 #define LOV_PATTERN_RAID0 0x001 /* stripes are used round-robin */
961 #define LOV_PATTERN_RAID1 0x002 /* stripes are mirrors of each other */
962 #define LOV_PATTERN_FIRST 0x100 /* first stripe is not in round-robin */
963 #define LOV_PATTERN_CMOBD 0x200
965 #define LOV_OBJECT_GROUP_DEFAULT ~0ULL
966 #define LOV_OBJECT_GROUP_CLEAR 0ULL
968 #define lov_ost_data lov_ost_data_v1
969 struct lov_ost_data_v1 { /* per-stripe data structure (little-endian)*/
970 __u64 l_object_id; /* OST object ID */
971 __u64 l_object_gr; /* OST object group (creating MDS number) */
972 __u32 l_ost_gen; /* generation of this l_ost_idx */
973 __u32 l_ost_idx; /* OST index in LOV (lov_tgt_desc->tgts) */
976 #define lov_mds_md lov_mds_md_v1
977 struct lov_mds_md_v1 { /* LOV EA mds/wire data (little-endian) */
978 __u32 lmm_magic; /* magic number = LOV_MAGIC_V1 */
979 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
980 __u64 lmm_object_id; /* LOV object ID */
981 __u64 lmm_object_gr; /* LOV object group */
982 __u32 lmm_stripe_size; /* size of stripe in bytes */
983 __u32 lmm_stripe_count; /* num stripes in use for this object */
984 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
987 /* extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm); */
989 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
990 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
992 #define XATTR_NAME_ACL_ACCESS "system.posix_acl_access"
993 #define XATTR_NAME_ACL_DEFAULT "system.posix_acl_default"
994 #define XATTR_USER_PREFIX "user."
995 #define XATTR_TRUSTED_PREFIX "trusted."
996 #define XATTR_SECURITY_PREFIX "security."
997 #define XATTR_LUSTRE_PREFIX "lustre."
999 #define XATTR_NAME_LOV "trusted.lov"
1000 #define XATTR_NAME_LMA "trusted.lma"
1001 #define XATTR_NAME_LMV "trusted.lmv"
1002 #define XATTR_NAME_LINK "trusted.link"
1005 struct lov_mds_md_v3 { /* LOV EA mds/wire data (little-endian) */
1006 __u32 lmm_magic; /* magic number = LOV_MAGIC_V3 */
1007 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1008 __u64 lmm_object_id; /* LOV object ID */
1009 __u64 lmm_object_gr; /* LOV object group */
1010 __u32 lmm_stripe_size; /* size of stripe in bytes */
1011 __u32 lmm_stripe_count; /* num stripes in use for this object */
1012 char lmm_pool_name[LOV_MAXPOOLNAME]; /* must be 32bit aligned */
1013 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1017 #define OBD_MD_FLID (0x00000001ULL) /* object ID */
1018 #define OBD_MD_FLATIME (0x00000002ULL) /* access time */
1019 #define OBD_MD_FLMTIME (0x00000004ULL) /* data modification time */
1020 #define OBD_MD_FLCTIME (0x00000008ULL) /* change time */
1021 #define OBD_MD_FLSIZE (0x00000010ULL) /* size */
1022 #define OBD_MD_FLBLOCKS (0x00000020ULL) /* allocated blocks count */
1023 #define OBD_MD_FLBLKSZ (0x00000040ULL) /* block size */
1024 #define OBD_MD_FLMODE (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1025 #define OBD_MD_FLTYPE (0x00000100ULL) /* object type (mode & S_IFMT) */
1026 #define OBD_MD_FLUID (0x00000200ULL) /* user ID */
1027 #define OBD_MD_FLGID (0x00000400ULL) /* group ID */
1028 #define OBD_MD_FLFLAGS (0x00000800ULL) /* flags word */
1029 #define OBD_MD_FLNLINK (0x00002000ULL) /* link count */
1030 #define OBD_MD_FLGENER (0x00004000ULL) /* generation number */
1031 /*#define OBD_MD_FLINLINE (0x00008000ULL) inline data. used until 1.6.5 */
1032 #define OBD_MD_FLRDEV (0x00010000ULL) /* device number */
1033 #define OBD_MD_FLEASIZE (0x00020000ULL) /* extended attribute data */
1034 #define OBD_MD_LINKNAME (0x00040000ULL) /* symbolic link target */
1035 #define OBD_MD_FLHANDLE (0x00080000ULL) /* file/lock handle */
1036 #define OBD_MD_FLCKSUM (0x00100000ULL) /* bulk data checksum */
1037 #define OBD_MD_FLQOS (0x00200000ULL) /* quality of service stats */
1038 /*#define OBD_MD_FLOSCOPQ (0x00400000ULL) osc opaque data, never used */
1039 #define OBD_MD_FLCOOKIE (0x00800000ULL) /* log cancellation cookie */
1040 #define OBD_MD_FLGROUP (0x01000000ULL) /* group */
1041 #define OBD_MD_FLFID (0x02000000ULL) /* ->ost write inline fid */
1042 #define OBD_MD_FLEPOCH (0x04000000ULL) /* ->ost write with ioepoch */
1043 /* ->mds if epoch opens or closes */
1044 #define OBD_MD_FLGRANT (0x08000000ULL) /* ost preallocation space grant */
1045 #define OBD_MD_FLDIREA (0x10000000ULL) /* dir's extended attribute data */
1046 #define OBD_MD_FLUSRQUOTA (0x20000000ULL) /* over quota flags sent from ost */
1047 #define OBD_MD_FLGRPQUOTA (0x40000000ULL) /* over quota flags sent from ost */
1048 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1050 #define OBD_MD_MDS (0x0000000100000000ULL) /* where an inode lives on */
1051 #define OBD_MD_REINT (0x0000000200000000ULL) /* reintegrate oa */
1052 #define OBD_MD_MEA (0x0000000400000000ULL) /* CMD split EA */
1053 #define OBD_MD_MDTIDX (0x0000000800000000ULL) /* Get MDT index */
1055 #define OBD_MD_FLXATTR (0x0000001000000000ULL) /* xattr */
1056 #define OBD_MD_FLXATTRLS (0x0000002000000000ULL) /* xattr list */
1057 #define OBD_MD_FLXATTRRM (0x0000004000000000ULL) /* xattr remove */
1058 #define OBD_MD_FLACL (0x0000008000000000ULL) /* ACL */
1059 #define OBD_MD_FLRMTPERM (0x0000010000000000ULL) /* remote permission */
1060 #define OBD_MD_FLMDSCAPA (0x0000020000000000ULL) /* MDS capability */
1061 #define OBD_MD_FLOSSCAPA (0x0000040000000000ULL) /* OSS capability */
1062 #define OBD_MD_FLCKSPLIT (0x0000080000000000ULL) /* Check split on server */
1063 #define OBD_MD_FLCROSSREF (0x0000100000000000ULL) /* Cross-ref case */
1064 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1066 #define OBD_FL_TRUNC (0x0000200000000000ULL) /* for filter_truncate */
1068 #define OBD_MD_FLRMTLSETFACL (0x0001000000000000ULL) /* lfs lsetfacl case */
1069 #define OBD_MD_FLRMTLGETFACL (0x0002000000000000ULL) /* lfs lgetfacl case */
1070 #define OBD_MD_FLRMTRSETFACL (0x0004000000000000ULL) /* lfs rsetfacl case */
1071 #define OBD_MD_FLRMTRGETFACL (0x0008000000000000ULL) /* lfs rgetfacl case */
1073 #define OBD_MD_FLGETATTR (OBD_MD_FLID | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1074 OBD_MD_FLCTIME | OBD_MD_FLSIZE | OBD_MD_FLBLKSZ | \
1075 OBD_MD_FLMODE | OBD_MD_FLTYPE | OBD_MD_FLUID | \
1076 OBD_MD_FLGID | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1077 OBD_MD_FLGENER | OBD_MD_FLRDEV | OBD_MD_FLGROUP)
1079 /* don't forget obdo_fid which is way down at the bottom so it can
1080 * come after the definition of llog_cookie */
1083 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
1084 #define OBD_STATFS_NODELAY 0x0001 /* requests should be send without delay
1085 * and resends for avoid deadlocks */
1086 #define OBD_STATFS_FROM_CACHE 0x0002 /* the statfs callback should not update
1088 #define OBD_STATFS_PTLRPCD 0x0004 /* requests will be sent via ptlrpcd
1089 * instead of a specific set. This
1090 * means that we cannot rely on the set
1091 * interpret routine to be called.
1092 * lov_statfs_fini() must thus be called
1093 * by the request interpret routine */
1095 /* ost_body.data values for OST_BRW */
1097 #define OBD_BRW_READ 0x01
1098 #define OBD_BRW_WRITE 0x02
1099 #define OBD_BRW_RWMASK (OBD_BRW_READ | OBD_BRW_WRITE)
1100 #define OBD_BRW_SYNC 0x08 /* this page is a part of synchronous
1101 * transfer and is not accounted in
1103 #define OBD_BRW_CHECK 0x10
1104 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
1105 #define OBD_BRW_GRANTED 0x40 /* the ost manages this */
1106 #define OBD_BRW_NOCACHE 0x80 /* this page is a part of non-cached IO */
1107 #define OBD_BRW_NOQUOTA 0x100
1108 #define OBD_BRW_SRVLOCK 0x200 /* Client holds no lock over this page */
1109 #define OBD_BRW_MEMALLOC 0x800 /* Client runs in the "kswapd" context */
1111 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
1113 #define OST_MIN_PRECREATE 32
1114 #define OST_MAX_PRECREATE 20000
1123 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
1125 /* multiple of 8 bytes => can array */
1126 struct niobuf_remote {
1132 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
1134 /* lock value block communicated between the filter and llite */
1136 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1137 * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1138 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1139 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1140 #define OST_LVB_IS_ERR(blocks) \
1141 ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1142 #define OST_LVB_SET_ERR(blocks, rc) \
1143 do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1144 #define OST_LVB_GET_ERR(blocks) (int)(blocks - OST_LVB_ERR_INIT)
1154 extern void lustre_swab_ost_lvb(struct ost_lvb *);
1163 MDS_GETATTR_NAME = 34,
1168 MDS_DISCONNECT = 39,
1174 MDS_DONE_WRITING = 45,
1176 MDS_QUOTACHECK = 47,
1179 MDS_SETXATTR = 50, /* obsolete, now it's MDS_REINT op */
1186 #define MDS_FIRST_OPC MDS_GETATTR
1203 } mds_reint_t, mdt_reint_t;
1205 extern void lustre_swab_generic_32s (__u32 *val);
1207 /* the disposition of the intent outlines what was executed */
1208 #define DISP_IT_EXECD 0x00000001
1209 #define DISP_LOOKUP_EXECD 0x00000002
1210 #define DISP_LOOKUP_NEG 0x00000004
1211 #define DISP_LOOKUP_POS 0x00000008
1212 #define DISP_OPEN_CREATE 0x00000010
1213 #define DISP_OPEN_OPEN 0x00000020
1214 #define DISP_ENQ_COMPLETE 0x00400000
1215 #define DISP_ENQ_OPEN_REF 0x00800000
1216 #define DISP_ENQ_CREATE_REF 0x01000000
1217 #define DISP_OPEN_LOCK 0x02000000
1219 /* INODE LOCK PARTS */
1220 #define MDS_INODELOCK_LOOKUP 0x000001 /* dentry, mode, owner, group */
1221 #define MDS_INODELOCK_UPDATE 0x000002 /* size, links, timestamps */
1222 #define MDS_INODELOCK_OPEN 0x000004 /* For opened files */
1224 /* Do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits */
1225 #define MDS_INODELOCK_MAXSHIFT 2
1226 /* This FULL lock is useful to take on unlink sort of operations */
1227 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
1229 extern void lustre_swab_ll_fid (struct ll_fid *fid);
1231 #define MDS_STATUS_CONN 1
1232 #define MDS_STATUS_LOV 2
1234 struct mds_status_req {
1239 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
1241 /* mdt_thread_info.mti_flags. */
1243 /* The flag indicates Size-on-MDS attributes are changed. */
1244 MF_SOM_CHANGE = (1 << 0),
1245 /* Flags indicates an epoch opens or closes. */
1246 MF_EPOCH_OPEN = (1 << 1),
1247 MF_EPOCH_CLOSE = (1 << 2),
1248 MF_MDC_CANCEL_FID1 = (1 << 3),
1249 MF_MDC_CANCEL_FID2 = (1 << 4),
1250 MF_MDC_CANCEL_FID3 = (1 << 5),
1251 MF_MDC_CANCEL_FID4 = (1 << 6),
1252 /* There is a pending attribute update. */
1253 MF_SOM_AU = (1 << 7),
1254 /* Cancel OST locks while getattr OST attributes. */
1255 MF_GETATTR_LOCK = (1 << 8),
1258 #define MF_SOM_LOCAL_FLAGS (MF_SOM_CHANGE | MF_EPOCH_OPEN | MF_EPOCH_CLOSE)
1260 #define MDS_BFLAG_UNCOMMITTED_WRITES 0x1
1262 /* these should be identical to their EXT3_*_FL counterparts, and are
1263 * redefined here only to avoid dragging in ext3_fs.h */
1264 #define MDS_SYNC_FL 0x00000008 /* Synchronous updates */
1265 #define MDS_IMMUTABLE_FL 0x00000010 /* Immutable file */
1266 #define MDS_APPEND_FL 0x00000020 /* writes to file may only append */
1267 #define MDS_NOATIME_FL 0x00000080 /* do not update atime */
1268 #define MDS_DIRSYNC_FL 0x00010000 /* dirsync behaviour (dir only) */
1271 /* Convert wire MDS_*_FL to corresponding client local VFS S_* values
1272 * for the client inode i_flags. The MDS_*_FL are the Lustre wire
1273 * protocol equivalents of LDISKFS_*_FL values stored on disk, while
1274 * the S_* flags are kernel-internal values that change between kernel
1275 * versions. These flags are set/cleared via FSFILT_IOC_{GET,SET}_FLAGS.
1276 * See b=16526 for a full history. */
1277 static inline int ll_ext_to_inode_flags(int flags)
1279 return (((flags & MDS_SYNC_FL) ? S_SYNC : 0) |
1280 ((flags & MDS_NOATIME_FL) ? S_NOATIME : 0) |
1281 ((flags & MDS_APPEND_FL) ? S_APPEND : 0) |
1282 #if defined(S_DIRSYNC)
1283 ((flags & MDS_DIRSYNC_FL) ? S_DIRSYNC : 0) |
1285 ((flags & MDS_IMMUTABLE_FL) ? S_IMMUTABLE : 0));
1288 static inline int ll_inode_to_ext_flags(int iflags)
1290 return (((iflags & S_SYNC) ? MDS_SYNC_FL : 0) |
1291 ((iflags & S_NOATIME) ? MDS_NOATIME_FL : 0) |
1292 ((iflags & S_APPEND) ? MDS_APPEND_FL : 0) |
1293 #if defined(S_DIRSYNC)
1294 ((iflags & S_DIRSYNC) ? MDS_DIRSYNC_FL : 0) |
1296 ((iflags & S_IMMUTABLE) ? MDS_IMMUTABLE_FL : 0));
1301 * while mds_body is to interact with 1.6, mdt_body is to interact with 2.0.
1302 * both of them should have the same fields layout, because at client side
1303 * one could be dynamically cast to the other.
1305 * mdt_body has large size than mds_body, with unused padding (48 bytes)
1306 * at the end. client always use size of mdt_body to prepare request/reply
1307 * buffers, and actual data could be interepeted as mdt_body or mds_body
1313 struct lustre_handle handle;
1315 __u64 size; /* Offset, in the case of MDS_READPAGE */
1319 __u64 blocks; /* XID, in the case of MDS_READPAGE */
1328 __u32 flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1330 __u32 nlink; /* #bytes to read in the case of MDS_READPAGE */
1336 __u32 max_cookiesize;
1337 __u32 padding_4; /* also fix lustre_swab_mds_body */
1340 extern void lustre_swab_mds_body (struct mds_body *b);
1345 struct lustre_handle handle;
1347 __u64 size; /* Offset, in the case of MDS_READPAGE */
1351 __u64 blocks; /* XID, in the case of MDS_READPAGE */
1353 __u64 ino; /* for 1.6 compatibility */
1360 __u32 flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1362 __u32 nlink; /* #bytes to read in the case of MDS_READPAGE */
1363 __u32 generation; /* for 1.6 compatibility */
1368 __u32 max_cookiesize;
1369 __u32 padding_4; /* also fix lustre_swab_mdt_body */
1378 extern void lustre_swab_mdt_body (struct mdt_body *b);
1380 struct mdt_ioepoch {
1381 struct lustre_handle handle;
1387 extern void lustre_swab_mdt_ioepoch (struct mdt_ioepoch *b);
1389 #define Q_QUOTACHECK 0x800100
1390 #define Q_INITQUOTA 0x800101 /* init slave limits */
1391 #define Q_GETOINFO 0x800102 /* get obd quota info */
1392 #define Q_GETOQUOTA 0x800103 /* get obd quotas */
1393 #define Q_FINVALIDATE 0x800104 /* invalidate operational quotas */
1395 #define Q_TYPEMATCH(id, type) \
1396 ((id) == (type) || (id) == UGQUOTA)
1398 #define Q_TYPESET(oqc, type) Q_TYPEMATCH((oqc)->qc_type, type)
1400 #define Q_GETOCMD(oqc) \
1401 ((oqc)->qc_cmd == Q_GETOINFO || (oqc)->qc_cmd == Q_GETOQUOTA)
1403 #define QCTL_COPY(out, in) \
1405 Q_COPY(out, in, qc_cmd); \
1406 Q_COPY(out, in, qc_type); \
1407 Q_COPY(out, in, qc_id); \
1408 Q_COPY(out, in, qc_stat); \
1409 Q_COPY(out, in, qc_dqinfo); \
1410 Q_COPY(out, in, qc_dqblk); \
1413 struct obd_quotactl {
1418 struct obd_dqinfo qc_dqinfo;
1419 struct obd_dqblk qc_dqblk;
1422 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1424 struct quota_adjust_qunit {
1431 extern void lustre_swab_quota_adjust_qunit(struct quota_adjust_qunit *q);
1433 /* flags is shared among quota structures */
1434 #define LQUOTA_FLAGS_GRP 1UL /* 0 is user, 1 is group */
1435 #define LQUOTA_FLAGS_BLK 2UL /* 0 is inode, 1 is block */
1436 #define LQUOTA_FLAGS_ADJBLK 4UL /* adjust the block qunit size */
1437 #define LQUOTA_FLAGS_ADJINO 8UL /* adjust the inode qunit size */
1438 #define LQUOTA_FLAGS_CHG_QS 16UL /* indicate whether it has capability of
1439 * OBD_CONNECT_CHANGE_QS */
1441 /* flags is specific for quota_adjust_qunit */
1442 #define LQUOTA_QAQ_CREATE_LQS (1 << 31) /* when it is set, need create lqs */
1444 /* the status of lqs_flags in struct lustre_qunit_size */
1445 #define LQUOTA_QUNIT_FLAGS (LQUOTA_FLAGS_GRP | LQUOTA_FLAGS_BLK)
1447 #define QAQ_IS_GRP(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_GRP)
1448 #define QAQ_IS_ADJBLK(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_ADJBLK)
1449 #define QAQ_IS_ADJINO(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_ADJINO)
1450 #define QAQ_IS_CREATE_LQS(qaq) ((qaq)->qaq_flags & LQUOTA_QAQ_CREATE_LQS)
1452 #define QAQ_SET_GRP(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_GRP)
1453 #define QAQ_SET_ADJBLK(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_ADJBLK)
1454 #define QAQ_SET_ADJINO(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_ADJINO)
1455 #define QAQ_SET_CREATE_LQS(qaq) ((qaq)->qaq_flags |= LQUOTA_QAQ_CREATE_LQS)
1457 /* inode access permission for remote user, the inode info are omitted,
1458 * for client knows them. */
1459 struct mds_remote_perm {
1464 __u32 rp_access_perm; /* MAY_READ/WRITE/EXEC */
1467 /* permissions for md_perm.mp_perm */
1469 CFS_SETUID_PERM = 0x01,
1470 CFS_SETGID_PERM = 0x02,
1471 CFS_SETGRP_PERM = 0x04,
1472 CFS_RMTACL_PERM = 0x08,
1473 CFS_RMTOWN_PERM = 0x10
1476 extern void lustre_swab_mds_remote_perm(struct mds_remote_perm *p);
1478 struct mdt_remote_perm {
1483 __u32 rp_access_perm; /* MAY_READ/WRITE/EXEC */
1486 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
1488 struct mdt_rec_setattr {
1498 __u32 sa_padding_1_h;
1499 struct lu_fid sa_fid;
1508 __u32 sa_attr_flags;
1516 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
1519 * Attribute flags used in mdt_rec_setattr::sa_valid.
1520 * The kernel's #defines for ATTR_* should not be used over the network
1521 * since the client and MDS may run different kernels (see bug 13828)
1522 * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1524 #define MDS_ATTR_MODE 0x1ULL /* = 1 */
1525 #define MDS_ATTR_UID 0x2ULL /* = 2 */
1526 #define MDS_ATTR_GID 0x4ULL /* = 4 */
1527 #define MDS_ATTR_SIZE 0x8ULL /* = 8 */
1528 #define MDS_ATTR_ATIME 0x10ULL /* = 16 */
1529 #define MDS_ATTR_MTIME 0x20ULL /* = 32 */
1530 #define MDS_ATTR_CTIME 0x40ULL /* = 64 */
1531 #define MDS_ATTR_ATIME_SET 0x80ULL /* = 128 */
1532 #define MDS_ATTR_MTIME_SET 0x100ULL /* = 256 */
1533 #define MDS_ATTR_FORCE 0x200ULL /* = 512, Not a change, but a change it */
1534 #define MDS_ATTR_ATTR_FLAG 0x400ULL /* = 1024 */
1535 #define MDS_ATTR_KILL_SUID 0x800ULL /* = 2048 */
1536 #define MDS_ATTR_KILL_SGID 0x1000ULL /* = 4096 */
1537 #define MDS_ATTR_CTIME_SET 0x2000ULL /* = 8192 */
1538 #define MDS_ATTR_FROM_OPEN 0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
1539 #define MDS_ATTR_BLOCKS 0x8000ULL /* = 32768 */
1542 #define FMODE_READ 00000001
1543 #define FMODE_WRITE 00000002
1546 /* IO Epoch is opened on a closed file. */
1547 #define FMODE_EPOCH 01000000
1548 /* IO Epoch is opened on a file truncate. */
1549 #define FMODE_TRUNC 02000000
1550 /* Size-on-MDS Attribute Update is pending. */
1551 #define FMODE_SOM 04000000
1552 #define FMODE_CLOSED 0
1554 #define MDS_OPEN_CREATED 00000010
1555 #define MDS_OPEN_CROSS 00000020
1557 #define MDS_FMODE_EXEC 00000004
1558 #define MDS_OPEN_CREAT 00000100
1559 #define MDS_OPEN_EXCL 00000200
1560 #define MDS_OPEN_TRUNC 00001000
1561 #define MDS_OPEN_APPEND 00002000
1562 #define MDS_OPEN_SYNC 00010000
1563 #define MDS_OPEN_DIRECTORY 00200000
1565 #define MDS_OPEN_DELAY_CREATE 0100000000 /* delay initial object create */
1566 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1567 #define MDS_OPEN_JOIN_FILE 0400000000 /* open for join file.
1568 * We do not support JOIN FILE
1569 * anymore, reserve this flags
1570 * just for preventing such bit
1572 #define MDS_CREATE_RMT_ACL 01000000000 /* indicate create on remote server
1573 * with default ACL */
1574 #define MDS_CREATE_SLAVE_OBJ 02000000000 /* indicate create slave object
1575 * actually, this is for create, not
1576 * conflict with other open flags */
1577 #define MDS_OPEN_LOCK 04000000000 /* This open requires open lock */
1578 #define MDS_OPEN_HAS_EA 010000000000 /* specify object create pattern */
1579 #define MDS_OPEN_HAS_OBJS 020000000000 /* Just set the EA the obj exist */
1581 /* permission for create non-directory file */
1582 #define MAY_CREATE (1 << 7)
1583 /* permission for create directory file */
1584 #define MAY_LINK (1 << 8)
1585 /* permission for delete from the directory */
1586 #define MAY_UNLINK (1 << 9)
1587 /* source's permission for rename */
1588 #define MAY_RENAME_SRC (1 << 10)
1589 /* target's permission for rename */
1590 #define MAY_RENAME_TAR (1 << 11)
1591 /* part (parent's) VTX permission check */
1592 #define MAY_VTX_PART (1 << 12)
1593 /* full VTX permission check */
1594 #define MAY_VTX_FULL (1 << 13)
1595 /* lfs rgetfacl permission check */
1596 #define MAY_RGETFACL (1 << 14)
1599 MDS_CHECK_SPLIT = 1 << 0,
1600 MDS_CROSS_REF = 1 << 1,
1601 MDS_VTX_BYPASS = 1 << 2,
1602 MDS_PERM_BYPASS = 1 << 3,
1604 MDS_QUOTA_IGNORE = 1 << 5,
1605 MDS_CLOSE_CLEANUP = 1 << 6
1608 struct mdt_rec_create {
1616 __u32 cr_suppgid1_h;
1618 __u32 cr_suppgid2_h;
1619 struct lu_fid cr_fid1;
1620 struct lu_fid cr_fid2;
1621 struct lustre_handle cr_old_handle; /* handle in case of open replay */
1625 __u64 cr_padding_1; /* pad for 64 bits*/
1628 __u32 cr_flags; /* for use with open */
1634 struct mdt_rec_link {
1642 __u32 lk_suppgid1_h;
1644 __u32 lk_suppgid2_h;
1645 struct lu_fid lk_fid1;
1646 struct lu_fid lk_fid2;
1660 struct mdt_rec_unlink {
1668 __u32 ul_suppgid1_h;
1670 __u32 ul_suppgid2_h;
1671 struct lu_fid ul_fid1;
1672 struct lu_fid ul_fid2;
1686 struct mdt_rec_rename {
1694 __u32 rn_suppgid1_h;
1696 __u32 rn_suppgid2_h;
1697 struct lu_fid rn_fid1;
1698 struct lu_fid rn_fid2;
1704 __u32 rn_bias; /* some operation flags */
1705 __u32 rn_mode; /* cross-ref rename has mode */
1712 struct mdt_rec_setxattr {
1720 __u32 sx_suppgid1_h;
1722 __u32 sx_suppgid2_h;
1723 struct lu_fid sx_fid;
1724 __u64 sx_padding_1; /* These three members are lu_fid size */
1736 __u32 sx_padding_10;
1737 __u32 sx_padding_11;
1740 struct mdt_rec_reint {
1748 __u32 rr_suppgid1_h;
1750 __u32 rr_suppgid2_h;
1751 struct lu_fid rr_fid1;
1752 struct lu_fid rr_fid2;
1760 __u32 rr_padding_1; /* also fix lustre_swab_mdt_rec_reint */
1761 __u32 rr_padding_2; /* also fix lustre_swab_mdt_rec_reint */
1762 __u32 rr_padding_3; /* also fix lustre_swab_mdt_rec_reint */
1763 __u32 rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
1766 extern void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
1769 __u32 ld_tgt_count; /* how many MDS's */
1770 __u32 ld_active_tgt_count; /* how many active */
1771 __u32 ld_default_stripe_count; /* how many objects are used */
1772 __u32 ld_pattern; /* default MEA_MAGIC_* */
1773 __u64 ld_default_hash_size;
1774 __u64 ld_padding_1; /* also fix lustre_swab_lmv_desc */
1775 __u32 ld_padding_2; /* also fix lustre_swab_lmv_desc */
1776 __u32 ld_qos_maxage; /* in second */
1777 __u32 ld_padding_3; /* also fix lustre_swab_lmv_desc */
1778 __u32 ld_padding_4; /* also fix lustre_swab_lmv_desc */
1779 struct obd_uuid ld_uuid;
1782 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
1784 /* TODO: lmv_stripe_md should contain mds capabilities for all slave fids */
1785 struct lmv_stripe_md {
1790 char mea_pool_name[LOV_MAXPOOLNAME];
1791 struct lu_fid mea_ids[0];
1794 extern void lustre_swab_lmv_stripe_md(struct lmv_stripe_md *mea);
1796 /* lmv structures */
1797 #define MEA_MAGIC_LAST_CHAR 0xb2221ca1
1798 #define MEA_MAGIC_ALL_CHARS 0xb222a11c
1799 #define MEA_MAGIC_HASH_SEGMENT 0xb222a11b
1801 #define MAX_HASH_SIZE_32 0x7fffffffUL
1802 #define MAX_HASH_SIZE 0x7fffffffffffffffULL
1803 #define MAX_HASH_HIGHEST_BIT 0x1000000000000000ULL
1810 extern void lustre_swab_md_fld (struct md_fld *mf);
1815 FLD_FIRST_OPC = FLD_QUERY
1821 SEQ_FIRST_OPC = SEQ_QUERY
1825 SEQ_ALLOC_SUPER = 0,
1830 * LOV data structures
1833 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
1834 #define LOV_MIN_STRIPE_SIZE (1<<LOV_MIN_STRIPE_BITS)
1835 #define LOV_MAX_STRIPE_COUNT 160 /* until bug 4424 is fixed */
1836 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
1838 #define LOV_MAX_UUID_BUFFER_SIZE 8192
1839 /* The size of the buffer the lov/mdc reserves for the
1840 * array of UUIDs returned by the MDS. With the current
1841 * protocol, this will limit the max number of OSTs per LOV */
1843 #define LOV_DESC_MAGIC 0xB0CCDE5C
1845 /* LOV settings descriptor (should only contain static info) */
1847 __u32 ld_tgt_count; /* how many OBD's */
1848 __u32 ld_active_tgt_count; /* how many active */
1849 __u32 ld_default_stripe_count; /* how many objects are used */
1850 __u32 ld_pattern; /* default PATTERN_RAID0 */
1851 __u64 ld_default_stripe_size; /* in bytes */
1852 __u64 ld_default_stripe_offset; /* in bytes */
1853 __u32 ld_padding_0; /* unused */
1854 __u32 ld_qos_maxage; /* in second */
1855 __u32 ld_padding_1; /* also fix lustre_swab_lov_desc */
1856 __u32 ld_padding_2; /* also fix lustre_swab_lov_desc */
1857 struct obd_uuid ld_uuid;
1860 #define ld_magic ld_active_tgt_count /* for swabbing from llogs */
1862 extern void lustre_swab_lov_desc (struct lov_desc *ld);
1867 /* opcodes -- MUST be distinct from OST/MDS opcodes */
1872 LDLM_BL_CALLBACK = 104,
1873 LDLM_CP_CALLBACK = 105,
1874 LDLM_GL_CALLBACK = 106,
1875 LDLM_SET_INFO = 107,
1878 #define LDLM_FIRST_OPC LDLM_ENQUEUE
1880 #define RES_NAME_SIZE 4
1881 struct ldlm_res_id {
1882 __u64 name[RES_NAME_SIZE];
1885 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
1901 #define LCK_MODE_NUM 8
1911 #define LDLM_MIN_TYPE LDLM_PLAIN
1913 struct ldlm_extent {
1919 static inline int ldlm_extent_overlap(struct ldlm_extent *ex1,
1920 struct ldlm_extent *ex2)
1922 return (ex1->start <= ex2->end) && (ex2->start <= ex1->end);
1925 struct ldlm_inodebits {
1932 __u64 blocking_export; /* not actually used over the wire */
1933 __u32 blocking_pid; /* not actually used over the wire */
1937 /* it's important that the fields of the ldlm_extent structure match
1938 * the first fields of the ldlm_flock structure because there is only
1939 * one ldlm_swab routine to process the ldlm_policy_data_t union. if
1940 * this ever changes we will need to swab the union differently based
1941 * on the resource type. */
1944 struct ldlm_extent l_extent;
1945 struct ldlm_flock l_flock;
1946 struct ldlm_inodebits l_inodebits;
1947 } ldlm_policy_data_t;
1949 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
1951 struct ldlm_intent {
1955 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
1957 struct ldlm_resource_desc {
1958 ldlm_type_t lr_type;
1959 __u32 lr_padding; /* also fix lustre_swab_ldlm_resource_desc */
1960 struct ldlm_res_id lr_name;
1963 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
1965 struct ldlm_lock_desc {
1966 struct ldlm_resource_desc l_resource;
1967 ldlm_mode_t l_req_mode;
1968 ldlm_mode_t l_granted_mode;
1969 ldlm_policy_data_t l_policy_data;
1972 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
1974 #define LDLM_LOCKREQ_HANDLES 2
1975 #define LDLM_ENQUEUE_CANCEL_OFF 1
1977 struct ldlm_request {
1980 struct ldlm_lock_desc lock_desc;
1981 struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
1984 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
1986 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
1987 * Otherwise, 2 are available. */
1988 #define ldlm_request_bufsize(count,type) \
1990 int _avail = LDLM_LOCKREQ_HANDLES; \
1991 _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
1992 sizeof(struct ldlm_request) + \
1993 (count > _avail ? count - _avail : 0) * \
1994 sizeof(struct lustre_handle); \
1999 __u32 lock_padding; /* also fix lustre_swab_ldlm_reply */
2000 struct ldlm_lock_desc lock_desc;
2001 struct lustre_handle lock_handle;
2002 __u64 lock_policy_res1;
2003 __u64 lock_policy_res2;
2006 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
2009 * Opcodes for mountconf (mgs and mgc)
2014 MGS_EXCEPTION, /* node died, etc. */
2015 MGS_TARGET_REG, /* whenever target starts up */
2020 #define MGS_FIRST_OPC MGS_CONNECT
2022 #define MGS_PARAM_MAXLEN 1024
2023 #define KEY_SET_INFO "set_info"
2025 struct mgs_send_param {
2026 char mgs_param[MGS_PARAM_MAXLEN];
2029 /* We pass this info to the MGS so it can write config logs */
2030 #define MTI_NAME_MAXLEN 64
2031 #define MTI_PARAM_MAXLEN 4096
2032 #define MTI_NIDS_MAX 32
2033 struct mgs_target_info {
2034 __u32 mti_lustre_ver;
2035 __u32 mti_stripe_index;
2036 __u32 mti_config_ver;
2038 __u32 mti_nid_count;
2039 __u32 padding; /* 64 bit align */
2040 char mti_fsname[MTI_NAME_MAXLEN];
2041 char mti_svname[MTI_NAME_MAXLEN];
2042 char mti_uuid[sizeof(struct obd_uuid)];
2043 __u64 mti_nids[MTI_NIDS_MAX]; /* host nids (lnet_nid_t)*/
2044 char mti_params[MTI_PARAM_MAXLEN];
2047 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
2049 /* Config marker flags (in config log) */
2050 #define CM_START 0x01
2052 #define CM_SKIP 0x04
2053 #define CM_UPGRADE146 0x08
2054 #define CM_EXCLUDE 0x10
2055 #define CM_START_SKIP (CM_START | CM_SKIP)
2058 __u32 cm_step; /* aka config version */
2060 __u32 cm_vers; /* lustre release version number */
2061 __u32 padding; /* 64 bit align */
2062 __u64 cm_createtime; /*when this record was first created */
2063 __u64 cm_canceltime; /*when this record is no longer valid*/
2064 char cm_tgtname[MTI_NAME_MAXLEN];
2065 char cm_comment[MTI_NAME_MAXLEN];
2068 extern void lustre_swab_cfg_marker(struct cfg_marker *marker,
2069 int swab, int size);
2072 * Opcodes for multiple servers.
2081 #define OBD_FIRST_OPC OBD_PING
2083 /* catalog of log objects */
2085 /** Identifier for a single log object */
2090 } __attribute__((packed));
2092 /** Records written to the CATALOGS list */
2093 #define CATLIST "CATALOGS"
2095 struct llog_logid lci_logid;
2099 } __attribute__((packed));
2101 /* Log data record types - there is no specific reason that these need to
2102 * be related to the RPC opcodes, but no reason not to (may be handy later?)
2104 #define LLOG_OP_MAGIC 0x10600000
2105 #define LLOG_OP_MASK 0xfff00000
2108 LLOG_PAD_MAGIC = LLOG_OP_MAGIC | 0x00000,
2109 OST_SZ_REC = LLOG_OP_MAGIC | 0x00f00,
2110 OST_RAID1_REC = LLOG_OP_MAGIC | 0x01000,
2111 MDS_UNLINK_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_UNLINK,
2112 MDS_SETATTR_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_SETATTR,
2113 MDS_SETATTR64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) | REINT_SETATTR,
2114 OBD_CFG_REC = LLOG_OP_MAGIC | 0x20000,
2115 PTL_CFG_REC = LLOG_OP_MAGIC | 0x30000, /* obsolete */
2116 LLOG_GEN_REC = LLOG_OP_MAGIC | 0x40000,
2117 LLOG_JOIN_REC = LLOG_OP_MAGIC | 0x50000, /* obsolete */
2118 CHANGELOG_REC = LLOG_OP_MAGIC | 0x60000,
2119 CHANGELOG_USER_REC = LLOG_OP_MAGIC | 0x70000,
2120 LLOG_HDR_MAGIC = LLOG_OP_MAGIC | 0x45539,
2121 LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
2125 * for now, continue to support old pad records which have 0 for their
2126 * type but still need to be swabbed for their length
2128 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
2129 (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == \
2130 __swab32(LLOG_OP_MAGIC) || \
2131 (((r)->lrh_type == 0) && ((r)->lrh_len > LLOG_CHUNK_SIZE)))
2133 /** Log record header - stored in little endian order.
2134 * Each record must start with this struct, end with a llog_rec_tail,
2135 * and be a multiple of 256 bits in size.
2137 struct llog_rec_hdr {
2144 struct llog_rec_tail {
2149 struct llog_logid_rec {
2150 struct llog_rec_hdr lid_hdr;
2151 struct llog_logid lid_id;
2157 struct llog_rec_tail lid_tail;
2158 } __attribute__((packed));
2160 struct llog_create_rec {
2161 struct llog_rec_hdr lcr_hdr;
2162 struct ll_fid lcr_fid;
2166 struct llog_rec_tail lcr_tail;
2167 } __attribute__((packed));
2169 struct llog_orphan_rec {
2170 struct llog_rec_hdr lor_hdr;
2174 struct llog_rec_tail lor_tail;
2175 } __attribute__((packed));
2177 struct llog_unlink_rec {
2178 struct llog_rec_hdr lur_hdr;
2181 obd_count lur_count;
2182 struct llog_rec_tail lur_tail;
2183 } __attribute__((packed));
2185 struct llog_setattr_rec {
2186 struct llog_rec_hdr lsr_hdr;
2192 struct llog_rec_tail lsr_tail;
2193 } __attribute__((packed));
2195 struct llog_setattr64_rec {
2196 struct llog_rec_hdr lsr_hdr;
2204 struct llog_rec_tail lsr_tail;
2205 } __attribute__((packed));
2207 struct llog_size_change_rec {
2208 struct llog_rec_hdr lsc_hdr;
2209 struct ll_fid lsc_fid;
2212 struct llog_rec_tail lsc_tail;
2213 } __attribute__((packed));
2215 #define CHANGELOG_MAGIC 0xca103000
2217 /** \a changelog_rec_type's that can't be masked */
2218 #define CHANGELOG_MINMASK (1 << CL_MARK)
2219 /** bits covering all \a changelog_rec_type's */
2220 #define CHANGELOG_ALLMASK 0XFFFFFFFF
2221 /** default \a changelog_rec_type mask */
2222 #define CHANGELOG_DEFMASK CHANGELOG_ALLMASK
2224 /* changelog llog name, needed by client replicators */
2225 #define CHANGELOG_CATALOG "changelog_catalog"
2227 struct changelog_setinfo {
2230 } __attribute__((packed));
2232 /** changelog record */
2233 struct llog_changelog_rec {
2234 struct llog_rec_hdr cr_hdr;
2235 struct changelog_rec cr;
2236 struct llog_rec_tail cr_tail; /**< for_sizezof_only */
2237 } __attribute__((packed));
2239 #define CHANGELOG_USER_PREFIX "cl"
2241 struct llog_changelog_user_rec {
2242 struct llog_rec_hdr cur_hdr;
2246 struct llog_rec_tail cur_tail;
2247 } __attribute__((packed));
2252 } __attribute__((packed));
2254 struct llog_gen_rec {
2255 struct llog_rec_hdr lgr_hdr;
2256 struct llog_gen lgr_gen;
2257 struct llog_rec_tail lgr_tail;
2259 /* On-disk header structure of each log object, stored in little endian order */
2260 #define LLOG_CHUNK_SIZE 8192
2261 #define LLOG_HEADER_SIZE (96)
2262 #define LLOG_BITMAP_BYTES (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
2264 #define LLOG_MIN_REC_SIZE (24) /* round(llog_rec_hdr + llog_rec_tail) */
2266 /* flags for the logs */
2267 #define LLOG_F_ZAP_WHEN_EMPTY 0x1
2268 #define LLOG_F_IS_CAT 0x2
2269 #define LLOG_F_IS_PLAIN 0x4
2271 struct llog_log_hdr {
2272 struct llog_rec_hdr llh_hdr;
2273 __u64 llh_timestamp;
2275 __u32 llh_bitmap_offset;
2279 /* for a catalog the first plain slot is next to it */
2280 struct obd_uuid llh_tgtuuid;
2281 __u32 llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
2282 __u32 llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
2283 struct llog_rec_tail llh_tail;
2284 } __attribute__((packed));
2286 #define LLOG_BITMAP_SIZE(llh) ((llh->llh_hdr.lrh_len - \
2287 llh->llh_bitmap_offset - \
2288 sizeof(llh->llh_tail)) * 8)
2290 /** log cookies are used to reference a specific log file and a record therein */
2291 struct llog_cookie {
2292 struct llog_logid lgc_lgl;
2296 } __attribute__((packed));
2298 /** llog protocol */
2299 enum llogd_rpc_ops {
2300 LLOG_ORIGIN_HANDLE_CREATE = 501,
2301 LLOG_ORIGIN_HANDLE_NEXT_BLOCK = 502,
2302 LLOG_ORIGIN_HANDLE_READ_HEADER = 503,
2303 LLOG_ORIGIN_HANDLE_WRITE_REC = 504,
2304 LLOG_ORIGIN_HANDLE_CLOSE = 505,
2305 LLOG_ORIGIN_CONNECT = 506,
2306 LLOG_CATINFO = 507, /* for lfs catinfo */
2307 LLOG_ORIGIN_HANDLE_PREV_BLOCK = 508,
2308 LLOG_ORIGIN_HANDLE_DESTROY = 509, /* for destroy llog object*/
2310 LLOG_FIRST_OPC = LLOG_ORIGIN_HANDLE_CREATE
2314 struct llog_logid lgd_logid;
2316 __u32 lgd_llh_flags;
2318 __u32 lgd_saved_index;
2320 __u64 lgd_cur_offset;
2321 } __attribute__((packed));
2323 struct llogd_conn_body {
2324 struct llog_gen lgdc_gen;
2325 struct llog_logid lgdc_logid;
2326 __u32 lgdc_ctxt_idx;
2327 } __attribute__((packed));
2329 /* Note: 64-bit types are 64-bit aligned in structure */
2331 obd_valid o_valid; /* hot fields in this obdo */
2335 obd_size o_size; /* o_size-o_blocks == ost_lvb */
2339 obd_blocks o_blocks; /* brw: cli sent cached bytes */
2342 /* 32-bit fields start here: keep an even number of them via padding */
2343 obd_blksize o_blksize; /* optimal IO blocksize */
2344 obd_mode o_mode; /* brw: cli sent cache remain */
2348 obd_count o_nlink; /* brw: checksum */
2349 obd_count o_generation;
2350 obd_count o_misc; /* brw: o_dropped */
2351 __u64 o_ioepoch; /* epoch in ost writes */
2352 __u32 o_stripe_idx; /* holds stripe idx */
2354 struct lustre_handle o_handle; /* brw: lock handle to prolong locks */
2355 struct llog_cookie o_lcookie; /* destroy: unlink cookie from MDS */
2364 #define o_dirty o_blocks
2365 #define o_undirty o_mode
2366 #define o_dropped o_misc
2367 #define o_cksum o_nlink
2369 static inline void lustre_set_wire_obdo(struct obdo *wobdo, struct obdo *lobdo)
2371 memcpy(wobdo, lobdo, sizeof(*lobdo));
2372 wobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
2375 static inline void lustre_get_wire_obdo(struct obdo *lobdo, struct obdo *wobdo)
2377 obd_flag local_flags = lobdo->o_flags & OBD_FL_LOCAL_MASK;
2379 LASSERT(!(wobdo->o_flags & OBD_FL_LOCAL_MASK));
2381 memcpy(lobdo, wobdo, sizeof(*lobdo));
2382 lobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
2383 lobdo->o_flags |= local_flags;
2386 extern void lustre_swab_obdo (struct obdo *o);
2388 /* request structure for OST's */
2393 /* Key for FIEMAP to be used in get_info calls */
2394 struct ll_fiemap_info_key {
2397 struct ll_user_fiemap fiemap;
2400 extern void lustre_swab_ost_body (struct ost_body *b);
2401 extern void lustre_swab_ost_last_id(obd_id *id);
2402 extern void lustre_swab_fiemap(struct ll_user_fiemap *fiemap);
2404 extern void lustre_swab_lov_user_md_v1(struct lov_user_md_v1 *lum);
2405 extern void lustre_swab_lov_user_md_v3(struct lov_user_md_v3 *lum);
2406 extern void lustre_swab_lov_user_md_objects(struct lov_user_ost_data *lod,
2408 extern void lustre_swab_lov_mds_md(struct lov_mds_md *lmm);
2411 extern void lustre_swab_llogd_body (struct llogd_body *d);
2412 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
2413 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
2414 extern void lustre_swab_llog_rec(struct llog_rec_hdr *rec,
2415 struct llog_rec_tail *tail);
2418 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
2420 /* Functions for dumping PTLRPC fields */
2421 void dump_rniobuf(struct niobuf_remote *rnb);
2422 void dump_ioo(struct obd_ioobj *nb);
2423 void dump_obdo(struct obdo *oa);
2424 void dump_ost_body(struct ost_body *ob);
2425 void dump_rcs(__u32 *rc);
2427 /* this will be used when OBD_CONNECT_CHANGE_QS is set */
2430 * ID appiles to (uid, gid)
2434 * LQUOTA_FLAGS_* affect the responding bits
2438 * acquire/release count (bytes for block quota)
2442 * when a master returns the reply to a slave, it will
2443 * contain the current corresponding qunit size
2449 #define QDATA_IS_GRP(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_GRP)
2450 #define QDATA_IS_BLK(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_BLK)
2451 #define QDATA_IS_ADJBLK(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_ADJBLK)
2452 #define QDATA_IS_ADJINO(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_ADJINO)
2453 #define QDATA_IS_CHANGE_QS(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_CHG_QS)
2455 #define QDATA_SET_GRP(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_GRP)
2456 #define QDATA_SET_BLK(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_BLK)
2457 #define QDATA_SET_ADJBLK(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_ADJBLK)
2458 #define QDATA_SET_ADJINO(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_ADJINO)
2459 #define QDATA_SET_CHANGE_QS(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_CHG_QS)
2461 #define QDATA_CLR_GRP(qdata) ((qdata)->qd_flags &= ~LQUOTA_FLAGS_GRP)
2462 #define QDATA_CLR_CHANGE_QS(qdata) ((qdata)->qd_flags &= ~LQUOTA_FLAGS_CHG_QS)
2464 extern void lustre_swab_qdata(struct qunit_data *d);
2465 extern struct qunit_data *quota_get_qdata(void *req, int is_req, int is_exp);
2466 extern int quota_copy_qdata(void *request, struct qunit_data *qdata,
2467 int is_req, int is_exp);
2474 #define QUOTA_FIRST_OPC QUOTA_DQACQ
2476 #define QUOTA_REQUEST 1
2477 #define QUOTA_REPLY 0
2478 #define QUOTA_EXPORT 1
2479 #define QUOTA_IMPORT 0
2481 /* quota check function */
2482 #define QUOTA_RET_OK 0 /**< return successfully */
2483 #define QUOTA_RET_NOQUOTA 1 /**< not support quota */
2484 #define QUOTA_RET_NOLIMIT 2 /**< quota limit isn't set */
2485 #define QUOTA_RET_ACQUOTA 4 /**< need to acquire extra quota */
2488 /* security opcodes */
2491 SEC_CTX_INIT_CONT = 802,
2494 SEC_FIRST_OPC = SEC_CTX_INIT
2498 * capa related definitions
2500 #define CAPA_HMAC_MAX_LEN 64
2501 #define CAPA_HMAC_KEY_MAX_LEN 56
2503 /* NB take care when changing the sequence of elements this struct,
2504 * because the offset info is used in find_capa() */
2505 struct lustre_capa {
2506 struct lu_fid lc_fid; /** fid */
2507 __u64 lc_opc; /** operations allowed */
2508 __u64 lc_uid; /** file owner */
2509 __u64 lc_gid; /** file group */
2510 __u32 lc_flags; /** HMAC algorithm & flags */
2511 __u32 lc_keyid; /** key# used for the capability */
2512 __u32 lc_timeout; /** capa timeout value (sec) */
2513 __u32 lc_expiry; /** expiry time (sec) */
2514 __u8 lc_hmac[CAPA_HMAC_MAX_LEN]; /** HMAC */
2515 } __attribute__((packed));
2517 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
2519 /** lustre_capa::lc_opc */
2521 CAPA_OPC_BODY_WRITE = 1<<0, /**< write object data */
2522 CAPA_OPC_BODY_READ = 1<<1, /**< read object data */
2523 CAPA_OPC_INDEX_LOOKUP = 1<<2, /**< lookup object fid */
2524 CAPA_OPC_INDEX_INSERT = 1<<3, /**< insert object fid */
2525 CAPA_OPC_INDEX_DELETE = 1<<4, /**< delete object fid */
2526 CAPA_OPC_OSS_WRITE = 1<<5, /**< write oss object data */
2527 CAPA_OPC_OSS_READ = 1<<6, /**< read oss object data */
2528 CAPA_OPC_OSS_TRUNC = 1<<7, /**< truncate oss object */
2529 CAPA_OPC_OSS_DESTROY = 1<<8, /**< destroy oss object */
2530 CAPA_OPC_META_WRITE = 1<<9, /**< write object meta data */
2531 CAPA_OPC_META_READ = 1<<10, /**< read object meta data */
2534 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
2535 #define CAPA_OPC_MDS_ONLY \
2536 (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
2537 CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
2538 #define CAPA_OPC_OSS_ONLY \
2539 (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC | \
2540 CAPA_OPC_OSS_DESTROY)
2541 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
2542 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
2544 /* MDS capability covers object capability for operations of body r/w
2545 * (dir readpage/sendpage), index lookup/insert/delete and meta data r/w,
2546 * while OSS capability only covers object capability for operations of
2547 * oss data(file content) r/w/truncate.
2549 static inline int capa_for_mds(struct lustre_capa *c)
2551 return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) != 0;
2554 static inline int capa_for_oss(struct lustre_capa *c)
2556 return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) == 0;
2559 /* lustre_capa::lc_hmac_alg */
2561 CAPA_HMAC_ALG_SHA1 = 1, /**< sha1 algorithm */
2565 #define CAPA_FL_MASK 0x00ffffff
2566 #define CAPA_HMAC_ALG_MASK 0xff000000
2568 struct lustre_capa_key {
2569 __u64 lk_mdsid; /**< mds# */
2570 __u32 lk_keyid; /**< key# */
2572 __u8 lk_key[CAPA_HMAC_KEY_MAX_LEN]; /**< key */
2573 } __attribute__((packed));
2575 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
2577 /** The link ea holds 1 \a link_ea_entry for each hardlink */
2578 #define LINK_EA_MAGIC 0x11EAF1DFUL
2579 struct link_ea_header {
2582 __u64 leh_len; /* total size */
2588 /** Hardlink data is name and parent fid.
2589 * Stored in this crazy struct for maximum packing and endian-neutrality
2591 struct link_ea_entry {
2592 /** __u16 stored big-endian, unaligned */
2593 unsigned char lee_reclen[2];
2594 unsigned char lee_parent_fid[sizeof(struct lu_fid)];
2596 }__attribute__((packed));
2598 /** fid2path request/reply structure */
2599 struct getinfo_fid2path {
2600 struct lu_fid gf_fid;
2605 } __attribute__((packed));
2607 void lustre_swab_fid2path (struct getinfo_fid2path *gf);
2609 extern void lustre_swab_kuch(struct kuc_hdr *);