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
145 #define SVC_RUNNING 8
146 #define SVC_STOPPING 16
147 #define SVC_STOPPED 32
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;
176 * Describes a range of sequence, lsr_start is included but lsr_end is
178 * Same structure is used in fld module where lsr_mdt field holds mdt id
182 struct lu_seq_range {
190 * returns width of given range \a r
193 static inline __u64 range_space(const struct lu_seq_range *range)
195 return range->lsr_end - range->lsr_start;
199 * initialize range to zero
202 static inline void range_init(struct lu_seq_range *range)
204 range->lsr_start = range->lsr_end = range->lsr_mdt = 0;
208 * check if given seq id \a s is within given range \a r
211 static inline int range_within(const struct lu_seq_range *range,
214 return s >= range->lsr_start && s < range->lsr_end;
218 * allocate \a w units of sequence from range \a from.
220 static inline void range_alloc(struct lu_seq_range *to,
221 struct lu_seq_range *from,
224 to->lsr_start = from->lsr_start;
225 to->lsr_end = from->lsr_start + width;
226 from->lsr_start += width;
229 static inline int range_is_sane(const struct lu_seq_range *range)
231 return (range->lsr_end >= range->lsr_start);
234 static inline int range_is_zero(const struct lu_seq_range *range)
236 return (range->lsr_start == 0 && range->lsr_end == 0);
239 static inline int range_is_exhausted(const struct lu_seq_range *range)
242 return range_space(range) == 0;
245 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x):%x"
247 #define PRANGE(range) \
248 (range)->lsr_start, \
252 /** \defgroup lu_fid lu_fid
256 * Flags for lustre_mdt_attrs::lma_compat and lustre_mdt_attrs::lma_incompat.
259 LMAC_HSM = 0x00000001,
260 LMAC_SOM = 0x00000002,
264 * Masks for all features that should be supported by a Lustre version to
265 * access a specific file.
266 * This information is stored in lustre_mdt_attrs::lma_incompat.
268 * NOTE: No incompat feature should be added before bug #17670 is landed.
270 #define LMA_INCOMPAT_SUPP 0x0
273 * Following struct for MDT attributes, that will be kept inode's EA.
274 * Introduced in 2.0 release (please see b15993, for details)
276 struct lustre_mdt_attrs {
278 * Bitfield for supported data in this structure. From enum lma_compat.
279 * lma_self_fid and lma_flags are always available.
283 * Per-file incompat feature list. Lustre version should support all
284 * flags set in this field. The supported feature mask is available in
288 /** FID of this inode */
289 struct lu_fid lma_self_fid;
290 /** SOM state, mdt/ost type, others */
292 /** total sectors in objects */
293 __u64 lma_som_sectors;
300 /** initial fid id value */
301 LUSTRE_FID_INIT_OID = 1UL
304 /** returns fid object sequence */
305 static inline __u64 fid_seq(const struct lu_fid *fid)
310 /** returns fid object id */
311 static inline __u32 fid_oid(const struct lu_fid *fid)
316 /** returns fid object version */
317 static inline __u32 fid_ver(const struct lu_fid *fid)
322 static inline void fid_zero(struct lu_fid *fid)
324 memset(fid, 0, sizeof(*fid));
327 /* Normal FID sequence starts from this value, i.e. 1<<33 */
328 #define FID_SEQ_START 0x200000000ULL
330 /* IDIF sequence starts from this value, i.e. 1<<32 */
331 #define IDIF_SEQ_START 0x100000000ULL
334 * Check if a fid is igif or not.
335 * \param fid the fid to be tested.
336 * \return true if the fid is a igif; otherwise false.
338 static inline int fid_is_igif(const struct lu_fid *fid)
340 return fid_seq(fid) > 0 && fid_seq(fid) < IDIF_SEQ_START;
344 * Check if a fid is idif or not.
345 * \param fid the fid to be tested.
346 * \return true if the fid is a idif; otherwise false.
348 static inline int fid_is_idif(const struct lu_fid *fid)
350 return fid_seq(fid) >= IDIF_SEQ_START && fid_seq(fid) < FID_SEQ_START;
354 * Get inode number from a igif.
355 * \param fid a igif to get inode number from.
356 * \return inode number for the igif.
358 static inline ino_t lu_igif_ino(const struct lu_fid *fid)
364 * Get inode generation from a igif.
365 * \param fid a igif to get inode generation from.
366 * \return inode generation for the igif.
368 static inline __u32 lu_igif_gen(const struct lu_fid *fid)
374 * Fids are transmitted across network (in the sender byte-ordering),
375 * and stored on disk in big-endian order.
377 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
379 /* check that all fields are converted */
380 CLASSERT(sizeof *src ==
381 sizeof fid_seq(src) +
382 sizeof fid_oid(src) + sizeof fid_ver(src));
383 LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
384 dst->f_seq = cpu_to_le64(fid_seq(src));
385 dst->f_oid = cpu_to_le32(fid_oid(src));
386 dst->f_ver = cpu_to_le32(fid_ver(src));
389 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
391 /* check that all fields are converted */
392 CLASSERT(sizeof *src ==
393 sizeof fid_seq(src) +
394 sizeof fid_oid(src) + sizeof fid_ver(src));
395 dst->f_seq = le64_to_cpu(fid_seq(src));
396 dst->f_oid = le32_to_cpu(fid_oid(src));
397 dst->f_ver = le32_to_cpu(fid_ver(src));
398 LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
401 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
403 /* check that all fields are converted */
404 CLASSERT(sizeof *src ==
405 sizeof fid_seq(src) +
406 sizeof fid_oid(src) + sizeof fid_ver(src));
407 LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
408 dst->f_seq = cpu_to_be64(fid_seq(src));
409 dst->f_oid = cpu_to_be32(fid_oid(src));
410 dst->f_ver = cpu_to_be32(fid_ver(src));
413 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
415 /* check that all fields are converted */
416 CLASSERT(sizeof *src ==
417 sizeof fid_seq(src) +
418 sizeof fid_oid(src) + sizeof fid_ver(src));
419 dst->f_seq = be64_to_cpu(fid_seq(src));
420 dst->f_oid = be32_to_cpu(fid_oid(src));
421 dst->f_ver = be32_to_cpu(fid_ver(src));
422 LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
425 static inline int fid_is_sane(const struct lu_fid *fid)
429 ((fid_seq(fid) >= FID_SEQ_START && fid_oid(fid) != 0
430 && fid_ver(fid) == 0) ||
434 static inline int fid_is_zero(const struct lu_fid *fid)
436 return fid_seq(fid) == 0 && fid_oid(fid) == 0;
439 extern void lustre_swab_lu_fid(struct lu_fid *fid);
440 extern void lustre_swab_lu_seq_range(struct lu_seq_range *range);
442 static inline int lu_fid_eq(const struct lu_fid *f0,
443 const struct lu_fid *f1)
445 /* Check that there is no alignment padding. */
446 CLASSERT(sizeof *f0 ==
447 sizeof f0->f_seq + sizeof f0->f_oid + sizeof f0->f_ver);
448 LASSERTF(fid_is_igif(f0) || fid_ver(f0) == 0, DFID, PFID(f0));
449 LASSERTF(fid_is_igif(f1) || fid_ver(f1) == 0, DFID, PFID(f1));
450 return memcmp(f0, f1, sizeof *f0) == 0;
453 #define __diff_normalize(val0, val1) \
455 typeof(val0) __val0 = (val0); \
456 typeof(val1) __val1 = (val1); \
458 (__val0 == __val1 ? 0 : __val0 > __val1 ? +1 : -1); \
461 static inline int lu_fid_cmp(const struct lu_fid *f0,
462 const struct lu_fid *f1)
465 __diff_normalize(fid_seq(f0), fid_seq(f1)) ?:
466 __diff_normalize(fid_oid(f0), fid_oid(f1)) ?:
467 __diff_normalize(fid_ver(f0), fid_ver(f1));
472 /** \defgroup lu_dir lu_dir
476 * Enumeration of possible directory entry attributes.
478 * Attributes follow directory entry header in the order they appear in this
481 enum lu_dirent_attrs {
487 * Layout of readdir pages, as transmitted on wire.
490 /** valid if LUDA_FID is set. */
491 struct lu_fid lde_fid;
492 /** a unique entry identifier: a hash or an offset. */
494 /** total record length, including all attributes. */
498 /** optional variable size attributes following this entry.
499 * taken from enum lu_dirent_attrs.
502 /** name is followed by the attributes indicated in ->ldp_attrs, in
503 * their natural order. After the last attribute, padding bytes are
504 * added to make ->lde_reclen a multiple of 8.
510 * Definitions of optional directory entry attributes formats.
512 * Individual attributes do not have their length encoded in a generic way. It
513 * is assumed that consumer of an attribute knows its format. This means that
514 * it is impossible to skip over an unknown attribute, except by skipping over all
515 * remaining attributes (by using ->lde_reclen), which is not too
516 * constraining, because new server versions will append new attributes at
517 * the end of an entry.
521 * Fid directory attribute: a fid of an object referenced by the entry. This
522 * will be almost always requested by the client and supplied by the server.
524 * Aligned to 8 bytes.
526 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
531 * Aligned to 2 bytes.
538 __u64 ldp_hash_start;
542 struct lu_dirent ldp_entries[0];
545 enum lu_dirpage_flags {
549 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
551 if (le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
554 return dp->ldp_entries;
557 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
559 struct lu_dirent *next;
561 if (le16_to_cpu(ent->lde_reclen) != 0)
562 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
569 static inline int lu_dirent_calc_size(int namelen, __u16 attr)
573 if (attr & LUDA_TYPE) {
574 const unsigned align = sizeof(struct luda_type) - 1;
575 size = (sizeof(struct lu_dirent) + namelen + align) & ~align;
576 size += sizeof(struct luda_type);
578 size = sizeof(struct lu_dirent) + namelen;
580 return (size + 7) & ~7;
583 static inline int lu_dirent_size(struct lu_dirent *ent)
585 if (le16_to_cpu(ent->lde_reclen) == 0) {
586 return lu_dirent_calc_size(le16_to_cpu(ent->lde_namelen),
587 le32_to_cpu(ent->lde_attrs));
589 return le16_to_cpu(ent->lde_reclen);
592 #define DIR_END_OFF 0xfffffffffffffffeULL
596 struct lustre_handle {
599 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
601 static inline int lustre_handle_is_used(struct lustre_handle *lh)
603 return lh->cookie != 0ull;
606 static inline int lustre_handle_equal(struct lustre_handle *lh1,
607 struct lustre_handle *lh2)
609 return lh1->cookie == lh2->cookie;
612 static inline void lustre_handle_copy(struct lustre_handle *tgt,
613 struct lustre_handle *src)
615 tgt->cookie = src->cookie;
618 /* flags for lm_flags */
619 #define MSGHDR_AT_SUPPORT 0x1
621 #define lustre_msg lustre_msg_v2
622 /* we depend on this structure to be 8-byte aligned */
623 /* this type is only endian-adjusted in lustre_unpack_msg() */
624 struct lustre_msg_v2 {
636 /* without gss, ptlrpc_body is put at the first buffer. */
637 #define PTLRPC_NUM_VERSIONS 4
639 struct lustre_handle pb_handle;
646 __u64 pb_last_committed;
651 __u32 pb_timeout; /* for req, the deadline, for rep, the service est */
652 __u32 pb_service_time; /* for rep, actual service time */
655 /* VBR: pre-versions */
656 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
657 /* padding for future needs */
661 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
663 /* message body offset for lustre_msg_v2 */
664 /* ptlrpc body offset in all request/reply messages */
665 #define MSG_PTLRPC_BODY_OFF 0
667 /* normal request/reply message record offset */
668 #define REQ_REC_OFF 1
669 #define REPLY_REC_OFF 1
671 /* ldlm request message body offset */
672 #define DLM_LOCKREQ_OFF 1 /* lockreq offset */
673 #define DLM_REQ_REC_OFF 2 /* normal dlm request record offset */
675 /* ldlm intent lock message body offset */
676 #define DLM_INTENT_IT_OFF 2 /* intent lock it offset */
677 #define DLM_INTENT_REC_OFF 3 /* intent lock record offset */
679 /* ldlm reply message body offset */
680 #define DLM_LOCKREPLY_OFF 1 /* lockrep offset */
681 #define DLM_REPLY_REC_OFF 2 /* reply record offset */
683 /** only use in req->rq_{req,rep}_swab_mask */
684 #define MSG_PTLRPC_HEADER_OFF 31
686 /* Flags that are operation-specific go in the top 16 bits. */
687 #define MSG_OP_FLAG_MASK 0xffff0000
688 #define MSG_OP_FLAG_SHIFT 16
690 /* Flags that apply to all requests are in the bottom 16 bits */
691 #define MSG_GEN_FLAG_MASK 0x0000ffff
692 #define MSG_LAST_REPLAY 0x0001
693 #define MSG_RESENT 0x0002
694 #define MSG_REPLAY 0x0004
695 /* #define MSG_AT_SUPPORT 0x0008
696 * This was used in early prototypes of adaptive timeouts, and while there
697 * shouldn't be any users of that code there also isn't a need for using this
698 * bits. Defer usage until at least 1.10 to avoid potential conflict. */
699 #define MSG_DELAY_REPLAY 0x0010
700 #define MSG_VERSION_REPLAY 0x0020
701 #define MSG_REQ_REPLAY_DONE 0x0040
702 #define MSG_LOCK_REPLAY_DONE 0x0080
705 * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
708 #define MSG_CONNECT_RECOVERING 0x00000001
709 #define MSG_CONNECT_RECONNECT 0x00000002
710 #define MSG_CONNECT_REPLAYABLE 0x00000004
711 //#define MSG_CONNECT_PEER 0x8
712 #define MSG_CONNECT_LIBCLIENT 0x00000010
713 #define MSG_CONNECT_INITIAL 0x00000020
714 #define MSG_CONNECT_ASYNC 0x00000040
715 #define MSG_CONNECT_NEXT_VER 0x00000080 /* use next version of lustre_msg */
716 #define MSG_CONNECT_TRANSNO 0x00000100 /* report transno */
719 #define OBD_CONNECT_RDONLY 0x1ULL /*client has read-only access*/
720 #define OBD_CONNECT_INDEX 0x2ULL /*connect specific LOV idx */
721 #define OBD_CONNECT_MDS 0x4ULL /*connect from MDT to OST */
722 #define OBD_CONNECT_GRANT 0x8ULL /*OSC gets grant at connect */
723 #define OBD_CONNECT_SRVLOCK 0x10ULL /*server takes locks for cli */
724 #define OBD_CONNECT_VERSION 0x20ULL /*Lustre versions in ocd */
725 #define OBD_CONNECT_REQPORTAL 0x40ULL /*Separate non-IO req portal */
726 #define OBD_CONNECT_ACL 0x80ULL /*access control lists */
727 #define OBD_CONNECT_XATTR 0x100ULL /*client use extended attr */
728 #define OBD_CONNECT_CROW 0x200ULL /*MDS+OST create obj on write*/
729 #define OBD_CONNECT_TRUNCLOCK 0x400ULL /*locks on server for punch */
730 #define OBD_CONNECT_TRANSNO 0x800ULL /*replay sends init transno */
731 #define OBD_CONNECT_IBITS 0x1000ULL /*support for inodebits locks*/
732 #define OBD_CONNECT_JOIN 0x2000ULL /*files can be concatenated */
733 #define OBD_CONNECT_ATTRFID 0x4000ULL /*Server can GetAttr By Fid*/
734 #define OBD_CONNECT_NODEVOH 0x8000ULL /*No open hndl on specl nodes*/
735 #define OBD_CONNECT_RMT_CLIENT 0x10000ULL /*Remote client */
736 #define OBD_CONNECT_RMT_CLIENT_FORCE 0x20000ULL /*Remote client by force */
737 #define OBD_CONNECT_BRW_SIZE 0x40000ULL /*Max bytes per rpc */
738 #define OBD_CONNECT_QUOTA64 0x80000ULL /*64bit qunit_data.qd_count */
739 #define OBD_CONNECT_MDS_CAPA 0x100000ULL /*MDS capability */
740 #define OBD_CONNECT_OSS_CAPA 0x200000ULL /*OSS capability */
741 #define OBD_CONNECT_CANCELSET 0x400000ULL /*Early batched cancels. */
742 #define OBD_CONNECT_SOM 0x800000ULL /*Size on MDS */
743 #define OBD_CONNECT_AT 0x1000000ULL /*client uses AT */
744 #define OBD_CONNECT_LRU_RESIZE 0x2000000ULL /*LRU resize feature. */
745 #define OBD_CONNECT_MDS_MDS 0x4000000ULL /*MDS-MDS connection */
746 #define OBD_CONNECT_REAL 0x8000000ULL /*real connection */
747 #define OBD_CONNECT_CHANGE_QS 0x10000000ULL /*shrink/enlarge qunit */
748 #define OBD_CONNECT_CKSUM 0x20000000ULL /*support several cksum algos*/
749 #define OBD_CONNECT_FID 0x40000000ULL /*FID is supported by server */
750 #define OBD_CONNECT_VBR 0x80000000ULL /*version based recovery */
751 #define OBD_CONNECT_LOV_V3 0x100000000ULL /*client supports LOV v3 EA */
752 #define OBD_CONNECT_GRANT_SHRINK 0x200000000ULL /* support grant shrink */
753 #define OBD_CONNECT_SKIP_ORPHAN 0x400000000ULL /* don't reuse orphan objids */
754 /* also update obd_connect_names[] for lprocfs_rd_connect_flags()
755 * and lustre/utils/wirecheck.c */
757 #ifdef HAVE_LRU_RESIZE_SUPPORT
758 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
760 #define LRU_RESIZE_CONNECT_FLAG 0
763 #define MDT_CONNECT_SUPPORTED (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
764 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
765 OBD_CONNECT_IBITS | OBD_CONNECT_JOIN | \
766 OBD_CONNECT_NODEVOH |/* OBD_CONNECT_ATTRFID |*/\
767 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
768 OBD_CONNECT_RMT_CLIENT | \
769 OBD_CONNECT_RMT_CLIENT_FORCE | \
770 OBD_CONNECT_MDS_CAPA | OBD_CONNECT_OSS_CAPA | \
771 OBD_CONNECT_MDS_MDS | OBD_CONNECT_FID | \
772 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_VBR | \
773 OBD_CONNECT_LOV_V3 | OBD_CONNECT_SOM)
774 #define OST_CONNECT_SUPPORTED (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
775 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
776 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
777 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_QUOTA64 | \
778 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
779 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_CKSUM | \
780 OBD_CONNECT_CHANGE_QS | \
781 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_RMT_CLIENT | \
782 OBD_CONNECT_RMT_CLIENT_FORCE | OBD_CONNECT_VBR | \
783 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
784 OBD_CONNECT_GRANT_SHRINK)
785 #define ECHO_CONNECT_SUPPORTED (0)
786 #define MGS_CONNECT_SUPPORTED (OBD_CONNECT_VERSION | OBD_CONNECT_AT)
788 #define OBD_OCD_VERSION(major,minor,patch,fix) (((major)<<24) + ((minor)<<16) +\
789 ((patch)<<8) + (fix))
790 #define OBD_OCD_VERSION_MAJOR(version) ((int)((version)>>24)&255)
791 #define OBD_OCD_VERSION_MINOR(version) ((int)((version)>>16)&255)
792 #define OBD_OCD_VERSION_PATCH(version) ((int)((version)>>8)&255)
793 #define OBD_OCD_VERSION_FIX(version) ((int)(version)&255)
795 /* This structure is used for both request and reply.
797 * If we eventually have separate connect data for different types, which we
798 * almost certainly will, then perhaps we stick a union in here. */
799 struct obd_connect_data {
800 __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
801 __u32 ocd_version; /* lustre release version number */
802 __u32 ocd_grant; /* initial cache grant amount (bytes) */
803 __u32 ocd_index; /* LOV index to connect to */
804 __u32 ocd_brw_size; /* Maximum BRW size in bytes */
805 __u64 ocd_ibits_known; /* inode bits this client understands */
806 __u32 ocd_nllu; /* non-local-lustre-user */
807 __u32 ocd_nllg; /* non-local-lustre-group */
808 __u64 ocd_transno; /* first transno from client to be replayed */
809 __u32 ocd_group; /* MDS group on OST */
810 __u32 ocd_cksum_types; /* supported checksum algorithms */
811 __u64 padding1; /* also fix lustre_swab_connect */
812 __u64 padding2; /* also fix lustre_swab_connect */
815 extern void lustre_swab_connect(struct obd_connect_data *ocd);
818 * Supported checksum algorithms. Up to 32 checksum types are supported.
819 * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
820 * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
821 * algorithm and also the OBD_FL_CKSUM* flags.
824 OBD_CKSUM_CRC32 = 0x00000001,
825 OBD_CKSUM_ADLER = 0x00000002,
829 * OST requests: OBDO & OBD request records
834 OST_REPLY = 0, /* reply ? */
852 OST_QUOTA_ADJUST_QUNIT = 20,
855 #define OST_FIRST_OPC OST_REPLY
857 typedef __u64 obd_id;
858 typedef __u64 obd_gr;
859 typedef __u64 obd_time;
860 typedef __u64 obd_size;
861 typedef __u64 obd_off;
862 typedef __u64 obd_blocks;
863 typedef __u64 obd_valid;
864 typedef __u32 obd_blksize;
865 typedef __u32 obd_mode;
866 typedef __u32 obd_uid;
867 typedef __u32 obd_gid;
868 typedef __u32 obd_flag;
869 typedef __u32 obd_count;
872 OBD_FL_INLINEDATA = 0x00000001,
873 OBD_FL_OBDMDEXISTS = 0x00000002,
874 OBD_FL_DELORPHAN = 0x00000004, /* if set in o_flags delete orphans */
875 OBD_FL_NORPC = 0x00000008, /* set in o_flags do in OSC not OST */
876 OBD_FL_IDONLY = 0x00000010, /* set in o_flags only adjust obj id*/
877 OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
878 OBD_FL_DEBUG_CHECK = 0x00000040, /* echo client/server debug check */
879 OBD_FL_NO_USRQUOTA = 0x00000100, /* the object's owner is over quota */
880 OBD_FL_NO_GRPQUOTA = 0x00000200, /* the object's group is over quota */
881 OBD_FL_CREATE_CROW = 0x00000400, /* object should be create on write */
882 OBD_FL_TRUNCLOCK = 0x00000800, /* delegate DLM locking during punch*/
883 OBD_FL_CKSUM_CRC32 = 0x00001000, /* CRC32 checksum type */
884 OBD_FL_CKSUM_ADLER = 0x00002000, /* ADLER checksum type */
885 OBD_FL_CKSUM_RSVD1 = 0x00004000, /* for future cksum types */
886 OBD_FL_CKSUM_RSVD2 = 0x00008000, /* for future cksum types */
887 OBD_FL_CKSUM_RSVD3 = 0x00010000, /* for future cksum types */
888 OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
890 OBD_FL_CKSUM_ALL = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER,
892 /* mask for local-only flag, which won't be sent over network */
893 OBD_FL_LOCAL_MASK = 0xF0000000,
894 /* temporary OBDO used by osc_brw_async (see bug 18364) */
895 OBD_FL_TEMPORARY = 0x10000000,
898 #define LOV_MAGIC_V1 0x0BD10BD0
899 #define LOV_MAGIC LOV_MAGIC_V1
900 #define LOV_MAGIC_JOIN 0x0BD20BD0
901 #define LOV_MAGIC_V3 0x0BD30BD0
903 #define LOV_PATTERN_RAID0 0x001 /* stripes are used round-robin */
904 #define LOV_PATTERN_RAID1 0x002 /* stripes are mirrors of each other */
905 #define LOV_PATTERN_FIRST 0x100 /* first stripe is not in round-robin */
906 #define LOV_PATTERN_CMOBD 0x200
908 #define LOV_OBJECT_GROUP_DEFAULT ~0ULL
909 #define LOV_OBJECT_GROUP_CLEAR 0ULL
911 #define lov_ost_data lov_ost_data_v1
912 struct lov_ost_data_v1 { /* per-stripe data structure (little-endian)*/
913 __u64 l_object_id; /* OST object ID */
914 __u64 l_object_gr; /* OST object group (creating MDS number) */
915 __u32 l_ost_gen; /* generation of this l_ost_idx */
916 __u32 l_ost_idx; /* OST index in LOV (lov_tgt_desc->tgts) */
919 #define lov_mds_md lov_mds_md_v1
920 struct lov_mds_md_v1 { /* LOV EA mds/wire data (little-endian) */
921 __u32 lmm_magic; /* magic number = LOV_MAGIC_V1 */
922 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
923 __u64 lmm_object_id; /* LOV object ID */
924 __u64 lmm_object_gr; /* LOV object group */
925 __u32 lmm_stripe_size; /* size of stripe in bytes */
926 __u32 lmm_stripe_count; /* num stripes in use for this object */
927 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
930 /* extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm); */
932 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
933 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
935 #define XATTR_NAME_ACL_ACCESS "system.posix_acl_access"
936 #define XATTR_NAME_ACL_DEFAULT "system.posix_acl_default"
937 #define XATTR_USER_PREFIX "user."
938 #define XATTR_TRUSTED_PREFIX "trusted."
939 #define XATTR_SECURITY_PREFIX "security."
940 #define XATTR_LUSTRE_PREFIX "lustre."
942 #define XATTR_NAME_LOV "trusted.lov"
943 #define XATTR_NAME_LMA "trusted.lma"
944 #define XATTR_NAME_LMV "trusted.lmv"
945 #define XATTR_NAME_LINK "trusted.link"
948 struct lov_mds_md_v3 { /* LOV EA mds/wire data (little-endian) */
949 __u32 lmm_magic; /* magic number = LOV_MAGIC_V3 */
950 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
951 __u64 lmm_object_id; /* LOV object ID */
952 __u64 lmm_object_gr; /* LOV object group */
953 __u32 lmm_stripe_size; /* size of stripe in bytes */
954 __u32 lmm_stripe_count; /* num stripes in use for this object */
955 char lmm_pool_name[LOV_MAXPOOLNAME]; /* must be 32bit aligned */
956 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
960 #define OBD_MD_FLID (0x00000001ULL) /* object ID */
961 #define OBD_MD_FLATIME (0x00000002ULL) /* access time */
962 #define OBD_MD_FLMTIME (0x00000004ULL) /* data modification time */
963 #define OBD_MD_FLCTIME (0x00000008ULL) /* change time */
964 #define OBD_MD_FLSIZE (0x00000010ULL) /* size */
965 #define OBD_MD_FLBLOCKS (0x00000020ULL) /* allocated blocks count */
966 #define OBD_MD_FLBLKSZ (0x00000040ULL) /* block size */
967 #define OBD_MD_FLMODE (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
968 #define OBD_MD_FLTYPE (0x00000100ULL) /* object type (mode & S_IFMT) */
969 #define OBD_MD_FLUID (0x00000200ULL) /* user ID */
970 #define OBD_MD_FLGID (0x00000400ULL) /* group ID */
971 #define OBD_MD_FLFLAGS (0x00000800ULL) /* flags word */
972 #define OBD_MD_FLNLINK (0x00002000ULL) /* link count */
973 #define OBD_MD_FLGENER (0x00004000ULL) /* generation number */
974 /*#define OBD_MD_FLINLINE (0x00008000ULL) inline data. used until 1.6.5 */
975 #define OBD_MD_FLRDEV (0x00010000ULL) /* device number */
976 #define OBD_MD_FLEASIZE (0x00020000ULL) /* extended attribute data */
977 #define OBD_MD_LINKNAME (0x00040000ULL) /* symbolic link target */
978 #define OBD_MD_FLHANDLE (0x00080000ULL) /* file/lock handle */
979 #define OBD_MD_FLCKSUM (0x00100000ULL) /* bulk data checksum */
980 #define OBD_MD_FLQOS (0x00200000ULL) /* quality of service stats */
981 /*#define OBD_MD_FLOSCOPQ (0x00400000ULL) osc opaque data, never used */
982 #define OBD_MD_FLCOOKIE (0x00800000ULL) /* log cancellation cookie */
983 #define OBD_MD_FLGROUP (0x01000000ULL) /* group */
984 #define OBD_MD_FLFID (0x02000000ULL) /* ->ost write inline fid */
985 #define OBD_MD_FLEPOCH (0x04000000ULL) /* ->ost write easize is epoch */
986 /* ->mds if epoch opens or closes */
987 #define OBD_MD_FLGRANT (0x08000000ULL) /* ost preallocation space grant */
988 #define OBD_MD_FLDIREA (0x10000000ULL) /* dir's extended attribute data */
989 #define OBD_MD_FLUSRQUOTA (0x20000000ULL) /* over quota flags sent from ost */
990 #define OBD_MD_FLGRPQUOTA (0x40000000ULL) /* over quota flags sent from ost */
991 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
993 #define OBD_MD_MDS (0x0000000100000000ULL) /* where an inode lives on */
994 #define OBD_MD_REINT (0x0000000200000000ULL) /* reintegrate oa */
995 #define OBD_MD_MEA (0x0000000400000000ULL) /* CMD split EA */
997 #define OBD_MD_FLXATTR (0x0000001000000000ULL) /* xattr */
998 #define OBD_MD_FLXATTRLS (0x0000002000000000ULL) /* xattr list */
999 #define OBD_MD_FLXATTRRM (0x0000004000000000ULL) /* xattr remove */
1000 #define OBD_MD_FLACL (0x0000008000000000ULL) /* ACL */
1001 #define OBD_MD_FLRMTPERM (0x0000010000000000ULL) /* remote permission */
1002 #define OBD_MD_FLMDSCAPA (0x0000020000000000ULL) /* MDS capability */
1003 #define OBD_MD_FLOSSCAPA (0x0000040000000000ULL) /* OSS capability */
1004 #define OBD_MD_FLCKSPLIT (0x0000080000000000ULL) /* Check split on server */
1005 #define OBD_MD_FLCROSSREF (0x0000100000000000ULL) /* Cross-ref case */
1007 #define OBD_FL_TRUNC (0x0000200000000000ULL) /* for filter_truncate */
1009 #define OBD_MD_FLRMTLSETFACL (0x0001000000000000ULL) /* lfs lsetfacl case */
1010 #define OBD_MD_FLRMTLGETFACL (0x0002000000000000ULL) /* lfs lgetfacl case */
1011 #define OBD_MD_FLRMTRSETFACL (0x0004000000000000ULL) /* lfs rsetfacl case */
1012 #define OBD_MD_FLRMTRGETFACL (0x0008000000000000ULL) /* lfs rgetfacl case */
1014 #define OBD_MD_FLGETATTR (OBD_MD_FLID | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1015 OBD_MD_FLCTIME | OBD_MD_FLSIZE | OBD_MD_FLBLKSZ | \
1016 OBD_MD_FLMODE | OBD_MD_FLTYPE | OBD_MD_FLUID | \
1017 OBD_MD_FLGID | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1018 OBD_MD_FLGENER | OBD_MD_FLRDEV | OBD_MD_FLGROUP)
1020 /* don't forget obdo_fid which is way down at the bottom so it can
1021 * come after the definition of llog_cookie */
1024 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
1025 #define OBD_STATFS_NODELAY 0x0001 /* requests should be send without delay
1026 * and resends for avoid deadlocks */
1027 #define OBD_STATFS_FROM_CACHE 0x0002 /* the statfs callback should not update
1029 #define OBD_STATFS_PTLRPCD 0x0004 /* requests will be sent via ptlrpcd
1030 * instead of a specific set. This
1031 * means that we cannot rely on the set
1032 * interpret routine to be called.
1033 * lov_statfs_fini() must thus be called
1034 * by the request interpret routine */
1036 /* ost_body.data values for OST_BRW */
1038 #define OBD_BRW_READ 0x01
1039 #define OBD_BRW_WRITE 0x02
1040 #define OBD_BRW_RWMASK (OBD_BRW_READ | OBD_BRW_WRITE)
1041 #define OBD_BRW_SYNC 0x08 /* this page is a part of synchronous
1042 * transfer and is not accounted in
1044 #define OBD_BRW_CHECK 0x10
1045 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
1046 #define OBD_BRW_GRANTED 0x40 /* the ost manages this */
1047 #define OBD_BRW_NOCACHE 0x80 /* this page is a part of non-cached IO */
1048 #define OBD_BRW_NOQUOTA 0x100
1049 #define OBD_BRW_SRVLOCK 0x200 /* Client holds no lock over this page */
1050 #define OBD_BRW_MEMALLOC 0x800 /* Client runs in the "kswapd" context */
1052 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
1054 #define OST_MIN_PRECREATE 32
1055 #define OST_MAX_PRECREATE 20000
1064 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
1066 /* multiple of 8 bytes => can array */
1067 struct niobuf_remote {
1073 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
1075 /* lock value block communicated between the filter and llite */
1077 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1078 * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1079 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1080 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1081 #define OST_LVB_IS_ERR(blocks) \
1082 ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1083 #define OST_LVB_SET_ERR(blocks, rc) \
1084 do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1085 #define OST_LVB_GET_ERR(blocks) (int)(blocks - OST_LVB_ERR_INIT)
1095 extern void lustre_swab_ost_lvb(struct ost_lvb *);
1104 MDS_GETATTR_NAME = 34,
1109 MDS_DISCONNECT = 39,
1115 MDS_DONE_WRITING = 45,
1117 MDS_QUOTACHECK = 47,
1120 MDS_SETXATTR = 50, /* obsolete, now it's MDS_REINT op */
1127 #define MDS_FIRST_OPC MDS_GETATTR
1144 } mds_reint_t, mdt_reint_t;
1146 extern void lustre_swab_generic_32s (__u32 *val);
1148 /* the disposition of the intent outlines what was executed */
1149 #define DISP_IT_EXECD 0x00000001
1150 #define DISP_LOOKUP_EXECD 0x00000002
1151 #define DISP_LOOKUP_NEG 0x00000004
1152 #define DISP_LOOKUP_POS 0x00000008
1153 #define DISP_OPEN_CREATE 0x00000010
1154 #define DISP_OPEN_OPEN 0x00000020
1155 #define DISP_ENQ_COMPLETE 0x00400000
1156 #define DISP_ENQ_OPEN_REF 0x00800000
1157 #define DISP_ENQ_CREATE_REF 0x01000000
1158 #define DISP_OPEN_LOCK 0x02000000
1160 /* INODE LOCK PARTS */
1161 #define MDS_INODELOCK_LOOKUP 0x000001 /* dentry, mode, owner, group */
1162 #define MDS_INODELOCK_UPDATE 0x000002 /* size, links, timestamps */
1163 #define MDS_INODELOCK_OPEN 0x000004 /* For opened files */
1165 /* Do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits */
1166 #define MDS_INODELOCK_MAXSHIFT 2
1167 /* This FULL lock is useful to take on unlink sort of operations */
1168 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
1170 extern void lustre_swab_ll_fid (struct ll_fid *fid);
1172 #define MDS_STATUS_CONN 1
1173 #define MDS_STATUS_LOV 2
1175 struct mds_status_req {
1180 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
1182 /* mdt_thread_info.mti_flags. */
1184 /* The flag indicates Size-on-MDS attributes are changed. */
1185 MF_SOM_CHANGE = (1 << 0),
1186 /* Flags indicates an epoch opens or closes. */
1187 MF_EPOCH_OPEN = (1 << 1),
1188 MF_EPOCH_CLOSE = (1 << 2),
1189 MF_MDC_CANCEL_FID1 = (1 << 3),
1190 MF_MDC_CANCEL_FID2 = (1 << 4),
1191 MF_MDC_CANCEL_FID3 = (1 << 5),
1192 MF_MDC_CANCEL_FID4 = (1 << 6),
1195 #define MF_SOM_LOCAL_FLAGS (MF_MDC_CANCEL_FID1 | MF_MDC_CANCEL_FID2 | \
1196 MF_MDC_CANCEL_FID3 | MF_MDC_CANCEL_FID4)
1198 #define MDS_BFLAG_UNCOMMITTED_WRITES 0x1
1199 #define MDS_BFLAG_EXT_FLAGS 0x80000000 /* == EXT3_RESERVED_FL */
1201 /* these should be identical to their EXT3_*_FL counterparts, and are
1202 * redefined here only to avoid dragging in ext3_fs.h */
1203 #define MDS_SYNC_FL 0x00000008 /* Synchronous updates */
1204 #define MDS_IMMUTABLE_FL 0x00000010 /* Immutable file */
1205 #define MDS_APPEND_FL 0x00000020 /* writes to file may only append */
1206 #define MDS_NOATIME_FL 0x00000080 /* do not update atime */
1207 #define MDS_DIRSYNC_FL 0x00010000 /* dirsync behaviour (dir only) */
1210 /* If MDS_BFLAG_IOC_FLAGS is set it means we requested EXT3_*_FL inode flags
1211 * and we need to decode these into local S_* flags in the inode. Otherwise
1212 * we pass flags straight through (see bug 9486). */
1213 static inline int ll_ext_to_inode_flags(int flags)
1215 return (flags & MDS_BFLAG_EXT_FLAGS) ?
1216 (((flags & MDS_SYNC_FL) ? S_SYNC : 0) |
1217 ((flags & MDS_NOATIME_FL) ? S_NOATIME : 0) |
1218 ((flags & MDS_APPEND_FL) ? S_APPEND : 0) |
1219 #if defined(S_DIRSYNC)
1220 ((flags & MDS_DIRSYNC_FL) ? S_DIRSYNC : 0) |
1222 ((flags & MDS_IMMUTABLE_FL) ? S_IMMUTABLE : 0)) :
1223 (flags & ~MDS_BFLAG_EXT_FLAGS);
1226 /* If MDS_BFLAG_EXT_FLAGS is set it means we requested EXT3_*_FL inode flags
1227 * and we pass these straight through. Otherwise we need to convert from
1228 * S_* flags to their EXT3_*_FL equivalents (see bug 9486). */
1229 static inline int ll_inode_to_ext_flags(int oflags, int iflags)
1231 return (oflags & MDS_BFLAG_EXT_FLAGS) ? (oflags & ~MDS_BFLAG_EXT_FLAGS):
1232 (((iflags & S_SYNC) ? MDS_SYNC_FL : 0) |
1233 ((iflags & S_NOATIME) ? MDS_NOATIME_FL : 0) |
1234 ((iflags & S_APPEND) ? MDS_APPEND_FL : 0) |
1235 #if defined(S_DIRSYNC)
1236 ((iflags & S_DIRSYNC) ? MDS_DIRSYNC_FL : 0) |
1238 ((iflags & S_IMMUTABLE) ? MDS_IMMUTABLE_FL : 0));
1243 * while mds_body is to interact with 1.6, mdt_body is to interact with 2.0.
1244 * both of them should have the same fields layout, because at client side
1245 * one could be dynamically cast to the other.
1247 * mdt_body has large size than mds_body, with unused padding (48 bytes)
1248 * at the end. client always use size of mdt_body to prepare request/reply
1249 * buffers, and actual data could be interepeted as mdt_body or mds_body
1255 struct lustre_handle handle;
1257 __u64 size; /* Offset, in the case of MDS_READPAGE */
1261 __u64 blocks; /* XID, in the case of MDS_READPAGE */
1270 __u32 flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1272 __u32 nlink; /* #bytes to read in the case of MDS_READPAGE */
1278 __u32 max_cookiesize;
1279 __u32 padding_4; /* also fix lustre_swab_mds_body */
1282 extern void lustre_swab_mds_body (struct mds_body *b);
1287 struct lustre_handle handle;
1289 __u64 size; /* Offset, in the case of MDS_READPAGE */
1293 __u64 blocks; /* XID, in the case of MDS_READPAGE */
1295 __u64 ino; /* for 1.6 compatibility */
1302 __u32 flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1304 __u32 nlink; /* #bytes to read in the case of MDS_READPAGE */
1305 __u32 generation; /* for 1.6 compatibility */
1310 __u32 max_cookiesize;
1311 __u32 padding_4; /* also fix lustre_swab_mdt_body */
1320 extern void lustre_swab_mdt_body (struct mdt_body *b);
1323 struct lustre_handle handle;
1329 extern void lustre_swab_mdt_epoch (struct mdt_epoch *b);
1331 #define Q_QUOTACHECK 0x800100
1332 #define Q_INITQUOTA 0x800101 /* init slave limits */
1333 #define Q_GETOINFO 0x800102 /* get obd quota info */
1334 #define Q_GETOQUOTA 0x800103 /* get obd quotas */
1335 #define Q_FINVALIDATE 0x800104 /* invalidate operational quotas */
1337 #define Q_TYPEMATCH(id, type) \
1338 ((id) == (type) || (id) == UGQUOTA)
1340 #define Q_TYPESET(oqc, type) Q_TYPEMATCH((oqc)->qc_type, type)
1342 #define Q_GETOCMD(oqc) \
1343 ((oqc)->qc_cmd == Q_GETOINFO || (oqc)->qc_cmd == Q_GETOQUOTA)
1345 #define QCTL_COPY(out, in) \
1347 Q_COPY(out, in, qc_cmd); \
1348 Q_COPY(out, in, qc_type); \
1349 Q_COPY(out, in, qc_id); \
1350 Q_COPY(out, in, qc_stat); \
1351 Q_COPY(out, in, qc_dqinfo); \
1352 Q_COPY(out, in, qc_dqblk); \
1355 struct obd_quotactl {
1360 struct obd_dqinfo qc_dqinfo;
1361 struct obd_dqblk qc_dqblk;
1364 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1366 struct quota_adjust_qunit {
1373 extern void lustre_swab_quota_adjust_qunit(struct quota_adjust_qunit *q);
1375 /* flags is shared among quota structures */
1376 #define LQUOTA_FLAGS_GRP 1UL /* 0 is user, 1 is group */
1377 #define LQUOTA_FLAGS_BLK 2UL /* 0 is inode, 1 is block */
1378 #define LQUOTA_FLAGS_ADJBLK 4UL /* adjust the block qunit size */
1379 #define LQUOTA_FLAGS_ADJINO 8UL /* adjust the inode qunit size */
1380 #define LQUOTA_FLAGS_CHG_QS 16UL /* indicate whether it has capability of
1381 * OBD_CONNECT_CHANGE_QS */
1383 /* flags is specific for quota_adjust_qunit */
1384 #define LQUOTA_QAQ_CREATE_LQS (1 << 31) /* when it is set, need create lqs */
1386 /* the status of lqs_flags in struct lustre_qunit_size */
1387 #define LQUOTA_QUNIT_FLAGS (LQUOTA_FLAGS_GRP | LQUOTA_FLAGS_BLK)
1389 #define QAQ_IS_GRP(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_GRP)
1390 #define QAQ_IS_ADJBLK(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_ADJBLK)
1391 #define QAQ_IS_ADJINO(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_ADJINO)
1392 #define QAQ_IS_CREATE_LQS(qaq) ((qaq)->qaq_flags & LQUOTA_QAQ_CREATE_LQS)
1394 #define QAQ_SET_GRP(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_GRP)
1395 #define QAQ_SET_ADJBLK(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_ADJBLK)
1396 #define QAQ_SET_ADJINO(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_ADJINO)
1397 #define QAQ_SET_CREATE_LQS(qaq) ((qaq)->qaq_flags |= LQUOTA_QAQ_CREATE_LQS)
1399 /* inode access permission for remote user, the inode info are omitted,
1400 * for client knows them. */
1401 struct mds_remote_perm {
1406 __u32 rp_access_perm; /* MAY_READ/WRITE/EXEC */
1409 /* permissions for md_perm.mp_perm */
1411 CFS_SETUID_PERM = 0x01,
1412 CFS_SETGID_PERM = 0x02,
1413 CFS_SETGRP_PERM = 0x04,
1414 CFS_RMTACL_PERM = 0x08,
1415 CFS_RMTOWN_PERM = 0x10
1418 extern void lustre_swab_mds_remote_perm(struct mds_remote_perm *p);
1420 struct mdt_remote_perm {
1425 __u32 rp_access_perm; /* MAY_READ/WRITE/EXEC */
1428 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
1430 struct mds_rec_setattr {
1437 struct ll_fid sa_fid;
1438 __u64 sa_valid; /* MDS_ATTR_* attributes */
1445 __u32 sa_attr_flags;
1446 __u32 sa_padding; /* also fix lustre_swab_mds_rec_setattr */
1449 extern void lustre_swab_mds_rec_setattr (struct mds_rec_setattr *sa);
1451 struct mdt_rec_setattr {
1461 __u32 sa_padding_1_h;
1462 struct lu_fid sa_fid;
1471 __u32 sa_attr_flags;
1479 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
1482 * Attribute flags used in mds_rec_setattr::sa_valid.
1483 * The kernel's #defines for ATTR_* should not be used over the network
1484 * since the client and MDS may run different kernels (see bug 13828)
1485 * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1487 #define MDS_ATTR_MODE 0x1ULL /* = 1 */
1488 #define MDS_ATTR_UID 0x2ULL /* = 2 */
1489 #define MDS_ATTR_GID 0x4ULL /* = 4 */
1490 #define MDS_ATTR_SIZE 0x8ULL /* = 8 */
1491 #define MDS_ATTR_ATIME 0x10ULL /* = 16 */
1492 #define MDS_ATTR_MTIME 0x20ULL /* = 32 */
1493 #define MDS_ATTR_CTIME 0x40ULL /* = 64 */
1494 #define MDS_ATTR_ATIME_SET 0x80ULL /* = 128 */
1495 #define MDS_ATTR_MTIME_SET 0x100ULL /* = 256 */
1496 #define MDS_ATTR_FORCE 0x200ULL /* = 512, Not a change, but a change it */
1497 #define MDS_ATTR_ATTR_FLAG 0x400ULL /* = 1024 */
1498 #define MDS_ATTR_KILL_SUID 0x800ULL /* = 2048 */
1499 #define MDS_ATTR_KILL_SGID 0x1000ULL /* = 4096 */
1500 #define MDS_ATTR_CTIME_SET 0x2000ULL /* = 8192 */
1501 #define MDS_ATTR_FROM_OPEN 0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
1502 #define MDS_ATTR_BLOCKS 0x8000ULL /* = 32768 */
1505 #define FMODE_READ 00000001
1506 #define FMODE_WRITE 00000002
1509 #define FMODE_EPOCH 01000000
1510 #define FMODE_EPOCHLCK 02000000
1511 #define FMODE_SOM 04000000
1512 #define FMODE_CLOSED 0
1514 #define MDS_OPEN_CREATED 00000010
1515 #define MDS_OPEN_CROSS 00000020
1517 #define MDS_FMODE_EXEC 00000004
1518 #define MDS_OPEN_CREAT 00000100
1519 #define MDS_OPEN_EXCL 00000200
1520 #define MDS_OPEN_TRUNC 00001000
1521 #define MDS_OPEN_APPEND 00002000
1522 #define MDS_OPEN_SYNC 00010000
1523 #define MDS_OPEN_DIRECTORY 00200000
1525 #define MDS_OPEN_DELAY_CREATE 0100000000 /* delay initial object create */
1526 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1527 #define MDS_OPEN_JOIN_FILE 0400000000 /* open for join file*/
1528 #define MDS_CREATE_RMT_ACL 01000000000 /* indicate create on remote server
1529 * with default ACL */
1530 #define MDS_CREATE_SLAVE_OBJ 02000000000 /* indicate create slave object
1531 * actually, this is for create, not
1532 * conflict with other open flags */
1533 #define MDS_OPEN_LOCK 04000000000 /* This open requires open lock */
1534 #define MDS_OPEN_HAS_EA 010000000000 /* specify object create pattern */
1535 #define MDS_OPEN_HAS_OBJS 020000000000 /* Just set the EA the obj exist */
1537 /* permission for create non-directory file */
1538 #define MAY_CREATE (1 << 7)
1539 /* permission for create directory file */
1540 #define MAY_LINK (1 << 8)
1541 /* permission for delete from the directory */
1542 #define MAY_UNLINK (1 << 9)
1543 /* source's permission for rename */
1544 #define MAY_RENAME_SRC (1 << 10)
1545 /* target's permission for rename */
1546 #define MAY_RENAME_TAR (1 << 11)
1547 /* part (parent's) VTX permission check */
1548 #define MAY_VTX_PART (1 << 12)
1549 /* full VTX permission check */
1550 #define MAY_VTX_FULL (1 << 13)
1551 /* lfs rgetfacl permission check */
1552 #define MAY_RGETFACL (1 << 14)
1555 MDS_CHECK_SPLIT = 1 << 0,
1556 MDS_CROSS_REF = 1 << 1,
1557 MDS_VTX_BYPASS = 1 << 2,
1558 MDS_PERM_BYPASS = 1 << 3,
1560 MDS_QUOTA_IGNORE = 1 << 5,
1561 MDS_CLOSE_CLEANUP = 1 << 6
1564 struct mds_rec_create {
1569 __u32 cr_flags; /* for use with open */
1571 struct ll_fid cr_fid;
1572 struct ll_fid cr_replayfid;
1576 __u32 cr_padding_1; /* also fix lustre_swab_mds_rec_create */
1577 __u32 cr_padding_2; /* also fix lustre_swab_mds_rec_create */
1578 __u32 cr_padding_3; /* also fix lustre_swab_mds_rec_create */
1579 __u32 cr_padding_4; /* also fix lustre_swab_mds_rec_create */
1580 __u32 cr_padding_5; /* also fix lustre_swab_mds_rec_create */
1583 extern void lustre_swab_mds_rec_create (struct mds_rec_create *cr);
1585 struct mdt_rec_create {
1593 __u32 cr_suppgid1_h;
1595 __u32 cr_suppgid2_h;
1596 struct lu_fid cr_fid1;
1597 struct lu_fid cr_fid2;
1598 struct lustre_handle cr_old_handle; /* handle in case of open replay */
1602 __u64 cr_padding_1; /* pad for 64 bits*/
1605 __u32 cr_flags; /* for use with open */
1611 extern void lustre_swab_mdt_rec_create (struct mdt_rec_create *cr);
1613 struct mds_rec_join {
1614 struct ll_fid jr_fid;
1618 extern void lustre_swab_mds_rec_join (struct mds_rec_join *jr);
1620 struct mdt_rec_join {
1621 struct lu_fid jr_fid;
1625 extern void lustre_swab_mdt_rec_join (struct mdt_rec_join *jr);
1627 struct mds_rec_link {
1634 struct ll_fid lk_fid1;
1635 struct ll_fid lk_fid2;
1637 __u32 lk_padding_1; /* also fix lustre_swab_mds_rec_link */
1638 __u32 lk_padding_2; /* also fix lustre_swab_mds_rec_link */
1639 __u32 lk_padding_3; /* also fix lustre_swab_mds_rec_link */
1640 __u32 lk_padding_4; /* also fix lustre_swab_mds_rec_link */
1643 extern void lustre_swab_mds_rec_link (struct mds_rec_link *lk);
1645 struct mdt_rec_link {
1653 __u32 lk_suppgid1_h;
1655 __u32 lk_suppgid2_h;
1656 struct lu_fid lk_fid1;
1657 struct lu_fid lk_fid2;
1671 struct mds_rec_unlink {
1678 struct ll_fid ul_fid1;
1679 struct ll_fid ul_fid2;
1681 __u32 ul_padding_1; /* also fix lustre_swab_mds_rec_unlink */
1682 __u32 ul_padding_2; /* also fix lustre_swab_mds_rec_unlink */
1683 __u32 ul_padding_3; /* also fix lustre_swab_mds_rec_unlink */
1684 __u32 ul_padding_4; /* also fix lustre_swab_mds_rec_unlink */
1687 extern void lustre_swab_mds_rec_unlink (struct mds_rec_unlink *ul);
1689 struct mdt_rec_unlink {
1697 __u32 ul_suppgid1_h;
1699 __u32 ul_suppgid2_h;
1700 struct lu_fid ul_fid1;
1701 struct lu_fid ul_fid2;
1715 struct mds_rec_rename {
1722 struct ll_fid rn_fid1;
1723 struct ll_fid rn_fid2;
1725 __u32 rn_padding_1; /* also fix lustre_swab_mds_rec_rename */
1726 __u32 rn_padding_2; /* also fix lustre_swab_mds_rec_rename */
1727 __u32 rn_padding_3; /* also fix lustre_swab_mds_rec_rename */
1728 __u32 rn_padding_4; /* also fix lustre_swab_mds_rec_rename */
1731 extern void lustre_swab_mds_rec_rename (struct mds_rec_rename *rn);
1733 struct mdt_rec_rename {
1741 __u32 rn_suppgid1_h;
1743 __u32 rn_suppgid2_h;
1744 struct lu_fid rn_fid1;
1745 struct lu_fid rn_fid2;
1751 __u32 rn_bias; /* some operation flags */
1752 __u32 rn_mode; /* cross-ref rename has mode */
1759 struct mdt_rec_setxattr {
1767 __u32 sx_suppgid1_h;
1769 __u32 sx_suppgid2_h;
1770 struct lu_fid sx_fid;
1771 __u64 sx_padding_1; /* These three members are lu_fid size */
1783 __u32 sx_padding_10;
1784 __u32 sx_padding_11;
1787 struct mdt_rec_reint {
1795 __u32 rr_suppgid1_h;
1797 __u32 rr_suppgid2_h;
1798 struct lu_fid rr_fid1;
1799 struct lu_fid rr_fid2;
1807 __u32 rr_padding_1; /* also fix lustre_swab_mdt_rec_reint */
1808 __u32 rr_padding_2; /* also fix lustre_swab_mdt_rec_reint */
1809 __u32 rr_padding_3; /* also fix lustre_swab_mdt_rec_reint */
1810 __u32 rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
1813 extern void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
1816 __u32 ld_tgt_count; /* how many MDS's */
1817 __u32 ld_active_tgt_count; /* how many active */
1818 __u32 ld_default_stripe_count; /* how many objects are used */
1819 __u32 ld_pattern; /* default MEA_MAGIC_* */
1820 __u64 ld_default_hash_size;
1821 __u64 ld_padding_1; /* also fix lustre_swab_lmv_desc */
1822 __u32 ld_padding_2; /* also fix lustre_swab_lmv_desc */
1823 __u32 ld_qos_maxage; /* in second */
1824 __u32 ld_padding_3; /* also fix lustre_swab_lmv_desc */
1825 __u32 ld_padding_4; /* also fix lustre_swab_lmv_desc */
1826 struct obd_uuid ld_uuid;
1829 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
1831 /* TODO: lmv_stripe_md should contain mds capabilities for all slave fids */
1832 struct lmv_stripe_md {
1837 char mea_pool_name[LOV_MAXPOOLNAME];
1838 struct lu_fid mea_ids[0];
1841 extern void lustre_swab_lmv_stripe_md(struct lmv_stripe_md *mea);
1843 /* lmv structures */
1844 #define MEA_MAGIC_LAST_CHAR 0xb2221ca1
1845 #define MEA_MAGIC_ALL_CHARS 0xb222a11c
1846 #define MEA_MAGIC_HASH_SEGMENT 0xb222a11b
1848 #define MAX_HASH_SIZE_32 0x7fffffffUL
1849 #define MAX_HASH_SIZE 0x7fffffffffffffffULL
1850 #define MAX_HASH_HIGHEST_BIT 0x1000000000000000ULL
1857 extern void lustre_swab_md_fld (struct md_fld *mf);
1862 FLD_FIRST_OPC = FLD_QUERY
1868 SEQ_FIRST_OPC = SEQ_QUERY
1872 SEQ_ALLOC_SUPER = 0,
1877 * LOV data structures
1880 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
1881 #define LOV_MIN_STRIPE_SIZE (1<<LOV_MIN_STRIPE_BITS)
1882 #define LOV_MAX_STRIPE_COUNT 160 /* until bug 4424 is fixed */
1883 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
1885 #define LOV_MAX_UUID_BUFFER_SIZE 8192
1886 /* The size of the buffer the lov/mdc reserves for the
1887 * array of UUIDs returned by the MDS. With the current
1888 * protocol, this will limit the max number of OSTs per LOV */
1890 #define LOV_DESC_MAGIC 0xB0CCDE5C
1892 /* LOV settings descriptor (should only contain static info) */
1894 __u32 ld_tgt_count; /* how many OBD's */
1895 __u32 ld_active_tgt_count; /* how many active */
1896 __u32 ld_default_stripe_count; /* how many objects are used */
1897 __u32 ld_pattern; /* default PATTERN_RAID0 */
1898 __u64 ld_default_stripe_size; /* in bytes */
1899 __u64 ld_default_stripe_offset; /* in bytes */
1900 __u32 ld_padding_0; /* unused */
1901 __u32 ld_qos_maxage; /* in second */
1902 __u32 ld_padding_1; /* also fix lustre_swab_lov_desc */
1903 __u32 ld_padding_2; /* also fix lustre_swab_lov_desc */
1904 struct obd_uuid ld_uuid;
1907 #define ld_magic ld_active_tgt_count /* for swabbing from llogs */
1909 extern void lustre_swab_lov_desc (struct lov_desc *ld);
1914 /* opcodes -- MUST be distinct from OST/MDS opcodes */
1919 LDLM_BL_CALLBACK = 104,
1920 LDLM_CP_CALLBACK = 105,
1921 LDLM_GL_CALLBACK = 106,
1922 LDLM_SET_INFO = 107,
1925 #define LDLM_FIRST_OPC LDLM_ENQUEUE
1927 #define RES_NAME_SIZE 4
1928 struct ldlm_res_id {
1929 __u64 name[RES_NAME_SIZE];
1932 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
1948 #define LCK_MODE_NUM 8
1958 #define LDLM_MIN_TYPE LDLM_PLAIN
1960 struct ldlm_extent {
1966 static inline int ldlm_extent_overlap(struct ldlm_extent *ex1,
1967 struct ldlm_extent *ex2)
1969 return (ex1->start <= ex2->end) && (ex2->start <= ex1->end);
1972 struct ldlm_inodebits {
1979 __u64 blocking_export; /* not actually used over the wire */
1980 __u32 blocking_pid; /* not actually used over the wire */
1984 /* it's important that the fields of the ldlm_extent structure match
1985 * the first fields of the ldlm_flock structure because there is only
1986 * one ldlm_swab routine to process the ldlm_policy_data_t union. if
1987 * this ever changes we will need to swab the union differently based
1988 * on the resource type. */
1991 struct ldlm_extent l_extent;
1992 struct ldlm_flock l_flock;
1993 struct ldlm_inodebits l_inodebits;
1994 } ldlm_policy_data_t;
1996 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
1998 struct ldlm_intent {
2002 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
2004 struct ldlm_resource_desc {
2005 ldlm_type_t lr_type;
2006 __u32 lr_padding; /* also fix lustre_swab_ldlm_resource_desc */
2007 struct ldlm_res_id lr_name;
2010 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
2012 struct ldlm_lock_desc {
2013 struct ldlm_resource_desc l_resource;
2014 ldlm_mode_t l_req_mode;
2015 ldlm_mode_t l_granted_mode;
2016 ldlm_policy_data_t l_policy_data;
2019 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
2021 #define LDLM_LOCKREQ_HANDLES 2
2022 #define LDLM_ENQUEUE_CANCEL_OFF 1
2024 struct ldlm_request {
2027 struct ldlm_lock_desc lock_desc;
2028 struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
2031 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
2033 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
2034 * Otherwise, 2 are available. */
2035 #define ldlm_request_bufsize(count,type) \
2037 int _avail = LDLM_LOCKREQ_HANDLES; \
2038 _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
2039 sizeof(struct ldlm_request) + \
2040 (count > _avail ? count - _avail : 0) * \
2041 sizeof(struct lustre_handle); \
2046 __u32 lock_padding; /* also fix lustre_swab_ldlm_reply */
2047 struct ldlm_lock_desc lock_desc;
2048 struct lustre_handle lock_handle;
2049 __u64 lock_policy_res1;
2050 __u64 lock_policy_res2;
2053 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
2056 * Opcodes for mountconf (mgs and mgc)
2061 MGS_EXCEPTION, /* node died, etc. */
2062 MGS_TARGET_REG, /* whenever target starts up */
2067 #define MGS_FIRST_OPC MGS_CONNECT
2069 #define MGS_PARAM_MAXLEN 1024
2070 #define KEY_SET_INFO "set_info"
2072 struct mgs_send_param {
2073 char mgs_param[MGS_PARAM_MAXLEN];
2076 /* We pass this info to the MGS so it can write config logs */
2077 #define MTI_NAME_MAXLEN 64
2078 #define MTI_PARAM_MAXLEN 4096
2079 #define MTI_NIDS_MAX 32
2080 struct mgs_target_info {
2081 __u32 mti_lustre_ver;
2082 __u32 mti_stripe_index;
2083 __u32 mti_config_ver;
2085 __u32 mti_nid_count;
2086 __u32 padding; /* 64 bit align */
2087 char mti_fsname[MTI_NAME_MAXLEN];
2088 char mti_svname[MTI_NAME_MAXLEN];
2089 char mti_uuid[sizeof(struct obd_uuid)];
2090 __u64 mti_nids[MTI_NIDS_MAX]; /* host nids (lnet_nid_t)*/
2091 char mti_params[MTI_PARAM_MAXLEN];
2094 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
2096 /* Config marker flags (in config log) */
2097 #define CM_START 0x01
2099 #define CM_SKIP 0x04
2100 #define CM_UPGRADE146 0x08
2101 #define CM_EXCLUDE 0x10
2102 #define CM_START_SKIP (CM_START | CM_SKIP)
2105 __u32 cm_step; /* aka config version */
2107 __u32 cm_vers; /* lustre release version number */
2108 __u32 padding; /* 64 bit align */
2109 __u64 cm_createtime; /*when this record was first created */
2110 __u64 cm_canceltime; /*when this record is no longer valid*/
2111 char cm_tgtname[MTI_NAME_MAXLEN];
2112 char cm_comment[MTI_NAME_MAXLEN];
2115 extern void lustre_swab_cfg_marker(struct cfg_marker *marker,
2116 int swab, int size);
2119 * Opcodes for multiple servers.
2128 #define OBD_FIRST_OPC OBD_PING
2130 /* catalog of log objects */
2132 /** Identifier for a single log object */
2137 } __attribute__((packed));
2139 /** Records written to the CATALOGS list */
2140 #define CATLIST "CATALOGS"
2142 struct llog_logid lci_logid;
2146 } __attribute__((packed));
2148 /** join file lov mds md*/
2149 struct lov_mds_md_join {
2150 struct lov_mds_md lmmj_md;
2151 /*join private info*/
2152 struct llog_logid lmmj_array_id; /*array object id*/
2153 __u32 lmmj_extent_count; /*array extent count*/
2156 /* Log data record types - there is no specific reason that these need to
2157 * be related to the RPC opcodes, but no reason not to (may be handy later?)
2159 #define LLOG_OP_MAGIC 0x10600000
2160 #define LLOG_OP_MASK 0xfff00000
2163 LLOG_PAD_MAGIC = LLOG_OP_MAGIC | 0x00000,
2164 OST_SZ_REC = LLOG_OP_MAGIC | 0x00f00,
2165 OST_RAID1_REC = LLOG_OP_MAGIC | 0x01000,
2166 MDS_UNLINK_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_UNLINK,
2167 MDS_SETATTR_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_SETATTR,
2168 MDS_SETATTR64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) | REINT_SETATTR,
2169 OBD_CFG_REC = LLOG_OP_MAGIC | 0x20000,
2170 PTL_CFG_REC = LLOG_OP_MAGIC | 0x30000, /* obsolete */
2171 LLOG_GEN_REC = LLOG_OP_MAGIC | 0x40000,
2172 LLOG_JOIN_REC = LLOG_OP_MAGIC | 0x50000,
2173 CHANGELOG_REC = LLOG_OP_MAGIC | 0x60000,
2174 CHANGELOG_USER_REC = LLOG_OP_MAGIC | 0x70000,
2175 LLOG_HDR_MAGIC = LLOG_OP_MAGIC | 0x45539,
2176 LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
2180 * for now, continue to support old pad records which have 0 for their
2181 * type but still need to be swabbed for their length
2183 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
2184 (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == \
2185 __swab32(LLOG_OP_MAGIC) || \
2186 (((r)->lrh_type == 0) && ((r)->lrh_len > LLOG_CHUNK_SIZE)))
2188 /** Log record header - stored in little endian order.
2189 * Each record must start with this struct, end with a llog_rec_tail,
2190 * and be a multiple of 256 bits in size.
2192 struct llog_rec_hdr {
2199 struct llog_rec_tail {
2204 struct llog_logid_rec {
2205 struct llog_rec_hdr lid_hdr;
2206 struct llog_logid lid_id;
2212 struct llog_rec_tail lid_tail;
2213 } __attribute__((packed));
2215 /** MDS extent description
2216 * It is for joined file extent info, each extent info for joined file
2217 * just like (start, end, lmm).
2219 struct mds_extent_desc {
2220 __u64 med_start; /* extent start */
2221 __u64 med_len; /* extent length */
2222 struct lov_mds_md med_lmm; /* extent's lmm */
2225 /** Joined file array extent log record*/
2226 struct llog_array_rec {
2227 struct llog_rec_hdr lmr_hdr;
2228 struct mds_extent_desc lmr_med;
2229 struct llog_rec_tail lmr_tail;
2232 struct llog_create_rec {
2233 struct llog_rec_hdr lcr_hdr;
2234 struct ll_fid lcr_fid;
2238 struct llog_rec_tail lcr_tail;
2239 } __attribute__((packed));
2241 struct llog_orphan_rec {
2242 struct llog_rec_hdr lor_hdr;
2246 struct llog_rec_tail lor_tail;
2247 } __attribute__((packed));
2249 struct llog_unlink_rec {
2250 struct llog_rec_hdr lur_hdr;
2253 obd_count lur_count;
2254 struct llog_rec_tail lur_tail;
2255 } __attribute__((packed));
2257 struct llog_setattr_rec {
2258 struct llog_rec_hdr lsr_hdr;
2264 struct llog_rec_tail lsr_tail;
2265 } __attribute__((packed));
2267 struct llog_setattr64_rec {
2268 struct llog_rec_hdr lsr_hdr;
2276 struct llog_rec_tail lsr_tail;
2277 } __attribute__((packed));
2279 struct llog_size_change_rec {
2280 struct llog_rec_hdr lsc_hdr;
2281 struct ll_fid lsc_fid;
2284 struct llog_rec_tail lsc_tail;
2285 } __attribute__((packed));
2287 #define CHANGELOG_MAGIC 0xca103000
2289 /** \a changelog_rec_type's that can't be masked */
2290 #define CHANGELOG_MINMASK (1 << CL_MARK)
2291 /** bits covering all \a changelog_rec_type's */
2292 #define CHANGELOG_ALLMASK 0XFFFFFFFF
2293 /** default \a changelog_rec_type mask */
2294 #define CHANGELOG_DEFMASK CHANGELOG_ALLMASK
2296 /* changelog llog name, needed by client replicators */
2297 #define CHANGELOG_CATALOG "changelog_catalog"
2299 struct changelog_setinfo {
2302 } __attribute__((packed));
2304 struct changelog_show {
2308 } __attribute__((packed));
2310 /** changelog record */
2311 struct llog_changelog_rec {
2312 struct llog_rec_hdr cr_hdr;
2313 struct changelog_rec cr;
2314 struct llog_rec_tail cr_tail; /**< for_sizezof_only */
2315 } __attribute__((packed));
2317 #define CHANGELOG_USER_PREFIX "cl"
2319 struct llog_changelog_user_rec {
2320 struct llog_rec_hdr cur_hdr;
2324 struct llog_rec_tail cur_tail;
2325 } __attribute__((packed));
2330 } __attribute__((packed));
2332 struct llog_gen_rec {
2333 struct llog_rec_hdr lgr_hdr;
2334 struct llog_gen lgr_gen;
2335 struct llog_rec_tail lgr_tail;
2337 /* On-disk header structure of each log object, stored in little endian order */
2338 #define LLOG_CHUNK_SIZE 8192
2339 #define LLOG_HEADER_SIZE (96)
2340 #define LLOG_BITMAP_BYTES (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
2342 #define LLOG_MIN_REC_SIZE (24) /* round(llog_rec_hdr + llog_rec_tail) */
2344 /* flags for the logs */
2345 #define LLOG_F_ZAP_WHEN_EMPTY 0x1
2346 #define LLOG_F_IS_CAT 0x2
2347 #define LLOG_F_IS_PLAIN 0x4
2349 struct llog_log_hdr {
2350 struct llog_rec_hdr llh_hdr;
2351 __u64 llh_timestamp;
2353 __u32 llh_bitmap_offset;
2357 /* for a catalog the first plain slot is next to it */
2358 struct obd_uuid llh_tgtuuid;
2359 __u32 llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
2360 __u32 llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
2361 struct llog_rec_tail llh_tail;
2362 } __attribute__((packed));
2364 #define LLOG_BITMAP_SIZE(llh) ((llh->llh_hdr.lrh_len - \
2365 llh->llh_bitmap_offset - \
2366 sizeof(llh->llh_tail)) * 8)
2368 /** log cookies are used to reference a specific log file and a record therein */
2369 struct llog_cookie {
2370 struct llog_logid lgc_lgl;
2374 } __attribute__((packed));
2376 /** llog protocol */
2377 enum llogd_rpc_ops {
2378 LLOG_ORIGIN_HANDLE_CREATE = 501,
2379 LLOG_ORIGIN_HANDLE_NEXT_BLOCK = 502,
2380 LLOG_ORIGIN_HANDLE_READ_HEADER = 503,
2381 LLOG_ORIGIN_HANDLE_WRITE_REC = 504,
2382 LLOG_ORIGIN_HANDLE_CLOSE = 505,
2383 LLOG_ORIGIN_CONNECT = 506,
2384 LLOG_CATINFO = 507, /* for lfs catinfo */
2385 LLOG_ORIGIN_HANDLE_PREV_BLOCK = 508,
2386 LLOG_ORIGIN_HANDLE_DESTROY = 509, /* for destroy llog object*/
2388 LLOG_FIRST_OPC = LLOG_ORIGIN_HANDLE_CREATE
2392 struct llog_logid lgd_logid;
2394 __u32 lgd_llh_flags;
2396 __u32 lgd_saved_index;
2398 __u64 lgd_cur_offset;
2399 } __attribute__((packed));
2401 struct llogd_conn_body {
2402 struct llog_gen lgdc_gen;
2403 struct llog_logid lgdc_logid;
2404 __u32 lgdc_ctxt_idx;
2405 } __attribute__((packed));
2407 struct lov_user_ost_data_join { /* per-stripe data structure */
2408 __u64 l_extent_start; /* extent start*/
2409 __u64 l_extent_end; /* extent end*/
2410 __u64 l_object_id; /* OST object ID */
2411 __u64 l_object_gr; /* OST object group (creating MDS number) */
2412 __u32 l_ost_gen; /* generation of this OST index */
2413 __u32 l_ost_idx; /* OST index in LOV */
2414 } __attribute__((packed));
2416 struct lov_user_md_join { /* LOV EA user data (host-endian) */
2417 __u32 lmm_magic; /* magic number = LOV_MAGIC_JOIN */
2418 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
2419 __u64 lmm_object_id; /* LOV object ID */
2420 __u64 lmm_object_gr; /* LOV object group */
2421 __u32 lmm_stripe_size; /* size of stripe in bytes */
2422 __u32 lmm_stripe_count; /* num stripes in use for this object */
2423 __u32 lmm_extent_count; /* extent count of lmm*/
2424 __u64 lmm_tree_id; /* mds tree object id */
2425 __u64 lmm_tree_gen; /* mds tree object gen */
2426 struct llog_logid lmm_array_id; /* mds extent desc llog object id */
2427 struct lov_user_ost_data_join lmm_objects[0]; /* per-stripe data */
2428 } __attribute__((packed));
2430 /* Note: 64-bit types are 64-bit aligned in structure */
2432 obd_valid o_valid; /* hot fields in this obdo */
2436 obd_size o_size; /* o_size-o_blocks == ost_lvb */
2440 obd_blocks o_blocks; /* brw: cli sent cached bytes */
2443 /* 32-bit fields start here: keep an even number of them via padding */
2444 obd_blksize o_blksize; /* optimal IO blocksize */
2445 obd_mode o_mode; /* brw: cli sent cache remain */
2449 obd_count o_nlink; /* brw: checksum */
2450 obd_count o_generation;
2451 obd_count o_misc; /* brw: o_dropped */
2452 __u32 o_easize; /* epoch in ost writes */
2454 __u32 o_stripe_idx; /* holds stripe idx */
2456 struct lustre_handle o_handle; /* brw: lock handle to prolong locks */
2457 struct llog_cookie o_lcookie; /* destroy: unlink cookie from MDS */
2466 #define o_dirty o_blocks
2467 #define o_undirty o_mode
2468 #define o_dropped o_misc
2469 #define o_cksum o_nlink
2471 static inline void lustre_set_wire_obdo(struct obdo *wobdo, struct obdo *lobdo)
2473 memcpy(wobdo, lobdo, sizeof(*lobdo));
2474 wobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
2477 static inline void lustre_get_wire_obdo(struct obdo *lobdo, struct obdo *wobdo)
2479 obd_flag local_flags = lobdo->o_flags & OBD_FL_LOCAL_MASK;
2481 LASSERT(!(wobdo->o_flags & OBD_FL_LOCAL_MASK));
2483 memcpy(lobdo, wobdo, sizeof(*lobdo));
2484 lobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
2485 lobdo->o_flags |= local_flags;
2488 extern void lustre_swab_obdo (struct obdo *o);
2490 /* request structure for OST's */
2495 /* Key for FIEMAP to be used in get_info calls */
2496 struct ll_fiemap_info_key {
2499 struct ll_user_fiemap fiemap;
2502 extern void lustre_swab_ost_body (struct ost_body *b);
2503 extern void lustre_swab_ost_last_id(obd_id *id);
2504 extern void lustre_swab_fiemap(struct ll_user_fiemap *fiemap);
2506 extern void lustre_swab_lov_user_md_v1(struct lov_user_md_v1 *lum);
2507 extern void lustre_swab_lov_user_md_v3(struct lov_user_md_v3 *lum);
2508 extern void lustre_swab_lov_user_md_objects(struct lov_user_ost_data *lod,
2510 extern void lustre_swab_lov_user_md_join(struct lov_user_md_join *lumj);
2511 extern void lustre_swab_lov_mds_md(struct lov_mds_md *lmm);
2514 extern void lustre_swab_llogd_body (struct llogd_body *d);
2515 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
2516 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
2517 extern void lustre_swab_llog_rec(struct llog_rec_hdr *rec,
2518 struct llog_rec_tail *tail);
2521 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
2523 /* this will be used when OBD_CONNECT_CHANGE_QS is set */
2526 * ID appiles to (uid, gid)
2530 * LQUOTA_FLAGS_* affect the responding bits
2534 * acquire/release count (bytes for block quota)
2538 * when a master returns the reply to a slave, it will
2539 * contain the current corresponding qunit size
2545 #define QDATA_IS_GRP(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_GRP)
2546 #define QDATA_IS_BLK(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_BLK)
2547 #define QDATA_IS_ADJBLK(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_ADJBLK)
2548 #define QDATA_IS_ADJINO(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_ADJINO)
2549 #define QDATA_IS_CHANGE_QS(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_CHG_QS)
2551 #define QDATA_SET_GRP(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_GRP)
2552 #define QDATA_SET_BLK(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_BLK)
2553 #define QDATA_SET_ADJBLK(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_ADJBLK)
2554 #define QDATA_SET_ADJINO(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_ADJINO)
2555 #define QDATA_SET_CHANGE_QS(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_CHG_QS)
2557 #define QDATA_CLR_GRP(qdata) ((qdata)->qd_flags &= ~LQUOTA_FLAGS_GRP)
2558 #define QDATA_CLR_CHANGE_QS(qdata) ((qdata)->qd_flags &= ~LQUOTA_FLAGS_CHG_QS)
2560 extern void lustre_swab_qdata(struct qunit_data *d);
2561 extern struct qunit_data *quota_get_qdata(void*req, int is_req, int is_exp);
2562 extern int quota_copy_qdata(void *request, struct qunit_data *qdata,
2563 int is_req, int is_exp);
2570 #define QUOTA_FIRST_OPC QUOTA_DQACQ
2572 #define JOIN_FILE_ALIGN 4096
2574 #define QUOTA_REQUEST 1
2575 #define QUOTA_REPLY 0
2576 #define QUOTA_EXPORT 1
2577 #define QUOTA_IMPORT 0
2579 /* quota check function */
2580 #define QUOTA_RET_OK 0 /**< return successfully */
2581 #define QUOTA_RET_NOQUOTA 1 /**< not support quota */
2582 #define QUOTA_RET_NOLIMIT 2 /**< quota limit isn't set */
2583 #define QUOTA_RET_ACQUOTA 4 /**< need to acquire extra quota */
2586 /* security opcodes */
2589 SEC_CTX_INIT_CONT = 802,
2592 SEC_FIRST_OPC = SEC_CTX_INIT
2596 * capa related definitions
2598 #define CAPA_HMAC_MAX_LEN 64
2599 #define CAPA_HMAC_KEY_MAX_LEN 56
2601 /* NB take care when changing the sequence of elements this struct,
2602 * because the offset info is used in find_capa() */
2603 struct lustre_capa {
2604 struct lu_fid lc_fid; /** fid */
2605 __u64 lc_opc; /** operations allowed */
2606 __u64 lc_uid; /** file owner */
2607 __u64 lc_gid; /** file group */
2608 __u32 lc_flags; /** HMAC algorithm & flags */
2609 __u32 lc_keyid; /** key# used for the capability */
2610 __u32 lc_timeout; /** capa timeout value (sec) */
2611 __u32 lc_expiry; /** expiry time (sec) */
2612 __u8 lc_hmac[CAPA_HMAC_MAX_LEN]; /** HMAC */
2613 } __attribute__((packed));
2615 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
2617 /** lustre_capa::lc_opc */
2619 CAPA_OPC_BODY_WRITE = 1<<0, /**< write object data */
2620 CAPA_OPC_BODY_READ = 1<<1, /**< read object data */
2621 CAPA_OPC_INDEX_LOOKUP = 1<<2, /**< lookup object fid */
2622 CAPA_OPC_INDEX_INSERT = 1<<3, /**< insert object fid */
2623 CAPA_OPC_INDEX_DELETE = 1<<4, /**< delete object fid */
2624 CAPA_OPC_OSS_WRITE = 1<<5, /**< write oss object data */
2625 CAPA_OPC_OSS_READ = 1<<6, /**< read oss object data */
2626 CAPA_OPC_OSS_TRUNC = 1<<7, /**< truncate oss object */
2627 CAPA_OPC_OSS_DESTROY = 1<<8, /**< destroy oss object */
2628 CAPA_OPC_META_WRITE = 1<<9, /**< write object meta data */
2629 CAPA_OPC_META_READ = 1<<10, /**< read object meta data */
2632 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
2633 #define CAPA_OPC_MDS_ONLY \
2634 (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
2635 CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
2636 #define CAPA_OPC_OSS_ONLY \
2637 (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC | \
2638 CAPA_OPC_OSS_DESTROY)
2639 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
2640 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
2642 /* MDS capability covers object capability for operations of body r/w
2643 * (dir readpage/sendpage), index lookup/insert/delete and meta data r/w,
2644 * while OSS capability only covers object capability for operations of
2645 * oss data(file content) r/w/truncate.
2647 static inline int capa_for_mds(struct lustre_capa *c)
2649 return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) != 0;
2652 static inline int capa_for_oss(struct lustre_capa *c)
2654 return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) == 0;
2657 /* lustre_capa::lc_hmac_alg */
2659 CAPA_HMAC_ALG_SHA1 = 1, /**< sha1 algorithm */
2663 #define CAPA_FL_MASK 0x00ffffff
2664 #define CAPA_HMAC_ALG_MASK 0xff000000
2666 struct lustre_capa_key {
2667 __u64 lk_mdsid; /**< mds# */
2668 __u32 lk_keyid; /**< key# */
2670 __u8 lk_key[CAPA_HMAC_KEY_MAX_LEN]; /**< key */
2671 } __attribute__((packed));
2673 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
2675 /** The link ea holds 1 \a link_ea_entry for each hardlink */
2676 #define LINK_EA_MAGIC 0x11EAF1DFUL
2677 struct link_ea_header {
2680 __u64 leh_len; /* total size */
2686 /** Hardlink data is name and parent fid.
2687 * Stored in this crazy struct for maximum packing and endian-neutrality
2689 struct link_ea_entry {
2690 struct lu_fid lee_parent_fid;
2691 /** __u16 stored big-endian, unaligned */
2695 }__attribute__((packed));
2697 /** fid2path request/reply structure */
2698 struct getinfo_fid2path {
2699 struct lu_fid gf_fid;
2704 } __attribute__((packed));
2706 void lustre_swab_fid2path (struct getinfo_fid2path *gf);
2708 extern void lustre_swab_lnlh(struct lnl_hdr *);