4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * Lustre wire protocol definitions.
35 /** \defgroup lustreidl lustreidl
37 * Lustre wire protocol definitions.
39 * ALL structs passing over the wire should be declared here. Structs
40 * that are used in interfaces with userspace should go in lustre_user.h.
42 * All structs being declared here should be built from simple fixed-size
43 * types defined in linux/types.h or be built from other types or
44 * structs also declared in this file. Similarly, all flags and magic
45 * values in those structs should also be declared here. This ensures
46 * that the Lustre wire protocol is not influenced by external dependencies.
48 * The only other acceptable items in this file are VERY SIMPLE accessor
49 * functions to avoid callers grubbing inside the structures. Nothing that
50 * depends on external functions or definitions should be in here.
52 * Structs must be properly aligned to put 64-bit values on an 8-byte
53 * boundary. Any structs being added here must also be added to
54 * utils/wirecheck.c and "make newwiretest" run to regenerate the
55 * utils/wiretest.c sources. This allows us to verify that wire structs
56 * have the proper alignment/size on all architectures.
58 * DO NOT CHANGE any of the structs, flags, values declared here and used
59 * in released Lustre versions. Some structs may have padding fields that
60 * can be used. Some structs might allow addition at the end (verify this
61 * in the code to ensure that new/old clients that see this larger struct
62 * do not fail, otherwise you need to implement protocol compatibility).
67 #ifndef _LUSTRE_IDL_H_
68 #define _LUSTRE_IDL_H_
70 #include <asm/byteorder.h>
71 #include <linux/errno.h>
72 #include <linux/fiemap.h>
73 #include <linux/types.h>
74 #include <linux/lnet/lnet-types.h>
75 #include <linux/lustre/lustre_user.h>
76 #include <linux/lustre/lustre_ver.h>
78 #if defined(__cplusplus)
85 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
86 * FOO_REPLY_PORTAL is for incoming replies on the FOO
87 * FOO_BULK_PORTAL is for incoming bulk on the FOO
90 #define CONNMGR_REQUEST_PORTAL 1
91 #define CONNMGR_REPLY_PORTAL 2
92 /* #define OSC_REQUEST_PORTAL 3*/
93 #define OSC_REPLY_PORTAL 4
94 /*#define OSC_BULK_PORTAL 5*/
95 #define OST_IO_PORTAL 6
96 #define OST_CREATE_PORTAL 7
97 #define OST_BULK_PORTAL 8
98 /*#define MDC_REQUEST_PORTAL 9*/
99 #define MDC_REPLY_PORTAL 10
100 /*#define MDC_BULK_PORTAL 11*/
101 #define MDS_REQUEST_PORTAL 12
102 #define MDS_IO_PORTAL 13
103 #define MDS_BULK_PORTAL 14
104 #define LDLM_CB_REQUEST_PORTAL 15
105 #define LDLM_CB_REPLY_PORTAL 16
106 #define LDLM_CANCEL_REQUEST_PORTAL 17
107 #define LDLM_CANCEL_REPLY_PORTAL 18
108 /*#define PTLBD_REQUEST_PORTAL 19*/
109 /*#define PTLBD_REPLY_PORTAL 20*/
110 /*#define PTLBD_BULK_PORTAL 21*/
111 #define MDS_SETATTR_PORTAL 22
112 #define MDS_READPAGE_PORTAL 23
113 #define OUT_PORTAL 24
114 #define MGC_REPLY_PORTAL 25
115 #define MGS_REQUEST_PORTAL 26
116 #define MGS_REPLY_PORTAL 27
117 #define OST_REQUEST_PORTAL 28
118 #define FLD_REQUEST_PORTAL 29
119 #define SEQ_METADATA_PORTAL 30
120 #define SEQ_DATA_PORTAL 31
121 #define SEQ_CONTROLLER_PORTAL 32
122 #define MGS_BULK_PORTAL 33
123 /* #define DVS_PORTAL 63 */
124 /* reserved for Cray DVS - spitzcor@cray.com, roe@cray.com, n8851@cray.com */
127 * Describes a range of sequence, lsr_start is included but lsr_end is
129 * Same structure is used in fld module where lsr_index field holds mdt id
132 struct lu_seq_range {
139 struct lu_seq_range_array {
142 struct lu_seq_range lsra_lsr[0];
145 #define LU_SEQ_RANGE_MDT 0x0
146 #define LU_SEQ_RANGE_OST 0x1
147 #define LU_SEQ_RANGE_ANY 0x3
149 #define LU_SEQ_RANGE_MASK 0x3
151 /** \defgroup lu_fid lu_fid
154 extern void lustre_lma_swab(struct lustre_mdt_attrs *lma);
155 extern void lustre_lma_init(struct lustre_mdt_attrs *lma,
156 const struct lu_fid *fid,
157 __u32 compat, __u32 incompat);
158 extern void lustre_loa_swab(struct lustre_ost_attrs *loa,
160 extern void lustre_loa_init(struct lustre_ost_attrs *loa,
161 const struct lu_fid *fid,
162 __u32 compat, __u32 incompat);
164 /* copytool can use any nonnegative integer to represent archive-Ids during
165 * register with MDT thru kuc.
166 * archive num = 0 => all
167 * archive num from 1 to MAX_U32
169 #define LL_HSM_ORIGIN_MAX_ARCHIVE (sizeof(__u32) * 8)
170 /* the max count of archive ids that one agent can support */
171 #define LL_HSM_MAX_ARCHIVES_PER_AGENT 1024
174 * HSM on-disk attributes stored in a separate xattr.
177 /** Bitfield for supported data in this structure. For future use. */
180 /** HSM flags, see hsm_flags enum below */
182 /** backend archive id associated with the file */
184 /** version associated with the last archiving, if any */
187 extern void lustre_hsm_swab(struct hsm_attrs *attrs);
193 /** LASTID file has zero OID */
194 LUSTRE_FID_LASTID_OID = 0UL,
195 /** initial fid id value */
196 LUSTRE_FID_INIT_OID = 1UL
200 * Different FID Format
201 * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs#NEW.0
204 * File IDentifier generated by client from range allocated by the seq service.
205 * First 0x400 sequences [2^33, 2^33 + 0x400] are reserved for system use. Note
206 * that on ldiskfs MDTs that IGIF FIDs can use inode numbers starting at 12,
207 * but this is in the IGIF SEQ rangeand does not conflict with assigned FIDs.
210 * Inode and Generation In FID, a surrogate FID used to globally identify an
211 * existing object on OLD formatted MDT file system. This would only be used on
212 * MDT0 in a DNE filesystem, because there are not expected to be any OLD
213 * formatted DNE filesystems. Belongs to a sequence in [12, 2^32 - 1] range,
214 * where sequence number is inode number, and inode generation is used as OID.
215 * NOTE: This assumes no more than 2^32-1 inodes exist in the MDT filesystem,
216 * which is the maximum possible for an ldiskfs backend. NOTE: This assumes
217 * that the reserved ext3/ext4/ldiskfs inode numbers [0-11] are never visible
218 * to clients, which has always been true.
221 * Object ID in FID, a surrogate FID used to globally identify an existing
222 * object on OLD formatted OST file system. Belongs to a sequence in
223 * [2^32, 2^33 - 1]. Sequence number is calculated as:
224 * 1 << 32 | (ost_index << 16) | ((objid >> 32) & 0xffff)
225 * that is, SEQ consists of 16-bit OST index, and higher 16 bits of object ID.
226 * The generation of unique SEQ values per OST allows the IDIF FIDs to be
227 * identified in the FLD correctly. The OID field is calculated as:
229 * that is, it consists of lower 32 bits of object ID. NOTE This assumes that
230 * no more than 2^48-1 objects have ever been created on an OST, and that no
231 * more than 65535 OSTs are in use. Both are very reasonable assumptions (can
232 * uniquely map all objects on an OST that created 1M objects per second for 9
233 * years, or combinations thereof).
236 * Surrogate FID used to identify an existing object on OLD formatted OST
237 * filesystem. Belongs to the reserved sequence 0, and is used internally prior
238 * to the introduction of FID-on-OST, at which point IDIF will be used to
239 * identify objects as residing on a specific OST.
242 * For Lustre Log objects the object sequence 1 is used. This is compatible with
243 * both OLD and NEW.1 namespaces, as this SEQ number is in the ext3/ldiskfs
244 * reserved inode range and does not conflict with IGIF sequence numbers.
247 * For testing OST IO performance the object sequence 2 is used. This is
248 * compatible with both OLD and NEW.1 namespaces, as this SEQ number is in the
249 * ext3/ldiskfs reserved inode range and does not conflict with IGIF sequence
252 * OST_MDT1 .. OST_MAX:
253 * For testing with multiple MDTs the object sequence 3 through 9 is used,
254 * allowing direct mapping of MDTs 1 through 7 respectively, for a total of 8
255 * MDTs including OST_MDT0. This matches the legacy CMD project "group"
256 * mappings. However, this SEQ range is only for testing prior to any production
257 * DNE release, as the objects in this range conflict across all OSTs, as the
258 * OST index is not part of the FID.
261 * For compatibility with existing OLD OST network protocol structures, the FID
262 * must map onto the o_id and o_gr in a manner that ensures existing objects are
263 * identified consistently for IO, as well as onto the lock namespace to ensure
264 * both IDIFs map onto the same objects for IO as well as resources in the DLM.
267 * resource[] = {o_id, o_seq, 0, 0}; // o_seq == 0 for production releases
269 * DLM NEW.1 FID (this is the same for both the MDT and OST):
270 * resource[] = {SEQ, OID, VER, HASH};
272 * Note that for mapping IDIF values to DLM resource names the o_id may be
273 * larger than the 2^33 reserved sequence numbers for IDIF, so it is possible
274 * for the o_id numbers to overlap FID SEQ numbers in the resource. However, in
275 * all production releases the OLD o_seq field is always zero, and all valid FID
276 * OID values are non-zero, so the lock resources will not collide.
278 * For objects within the IDIF range, group extraction (non-CMD) will be:
279 * o_id = (fid->f_seq & 0x7fff) << 16 | fid->f_oid;
280 * o_seq = 0; // formerly group number
284 * Note that reserved SEQ numbers below 12 will conflict with ldiskfs
285 * inodes in the IGIF namespace, so these reserved SEQ numbers can be
286 * used for other purposes and not risk collisions with existing inodes.
289 FID_SEQ_OST_MDT0 = 0,
290 FID_SEQ_LLOG = 1, /* unnamed llogs */
292 FID_SEQ_UNUSED_START = 3,
293 FID_SEQ_UNUSED_END = 9,
294 FID_SEQ_LLOG_NAME = 10, /* named llogs */
297 FID_SEQ_IGIF_MAX = 0x0ffffffffULL,
298 FID_SEQ_IDIF = 0x100000000ULL,
299 FID_SEQ_IDIF_MAX = 0x1ffffffffULL,
300 /* Normal FID sequence starts from this value, i.e. 1<<33 */
301 FID_SEQ_START = 0x200000000ULL,
302 /* sequence for local pre-defined FIDs listed in local_oid */
303 FID_SEQ_LOCAL_FILE = 0x200000001ULL,
304 FID_SEQ_DOT_LUSTRE = 0x200000002ULL,
305 /* sequence is used for local named objects FIDs generated
306 * by local_object_storage library */
307 FID_SEQ_LOCAL_NAME = 0x200000003ULL,
308 /* Because current FLD will only cache the fid sequence, instead
309 * of oid on the client side, if the FID needs to be exposed to
310 * clients sides, it needs to make sure all of fids under one
311 * sequence will be located in one MDT. */
312 FID_SEQ_SPECIAL = 0x200000004ULL,
313 FID_SEQ_QUOTA = 0x200000005ULL,
314 FID_SEQ_QUOTA_GLB = 0x200000006ULL,
315 FID_SEQ_ROOT = 0x200000007ULL, /* Located on MDT0 */
316 FID_SEQ_LAYOUT_RBTREE = 0x200000008ULL,
317 /* sequence is used for update logs of cross-MDT operation */
318 FID_SEQ_UPDATE_LOG = 0x200000009ULL,
319 /* Sequence is used for the directory under which update logs
321 FID_SEQ_UPDATE_LOG_DIR = 0x20000000aULL,
322 FID_SEQ_NORMAL = 0x200000400ULL,
323 FID_SEQ_LOV_DEFAULT = 0xffffffffffffffffULL
326 #define OBIF_OID_MAX_BITS 32
327 #define OBIF_MAX_OID (1ULL << OBIF_OID_MAX_BITS)
328 #define OBIF_OID_MASK ((1ULL << OBIF_OID_MAX_BITS) - 1)
329 #define IDIF_OID_MAX_BITS 48
330 #define IDIF_MAX_OID (1ULL << IDIF_OID_MAX_BITS)
331 #define IDIF_OID_MASK ((1ULL << IDIF_OID_MAX_BITS) - 1)
333 /** OID for FID_SEQ_SPECIAL */
335 /* Big Filesystem Lock to serialize rename operations */
336 FID_OID_SPECIAL_BFL = 1UL,
339 /** OID for FID_SEQ_DOT_LUSTRE */
340 enum dot_lustre_oid {
341 FID_OID_DOT_LUSTRE = 1UL,
342 FID_OID_DOT_LUSTRE_OBF = 2UL,
343 FID_OID_DOT_LUSTRE_LPF = 3UL,
346 /** OID for FID_SEQ_ROOT */
349 FID_OID_ECHO_ROOT = 2UL,
352 struct lu_orphan_rec {
353 /* The MDT-object's FID referenced by the orphan OST-object */
354 struct lu_fid lor_fid;
359 struct lu_orphan_ent {
360 /* The orphan OST-object's FID */
361 struct lu_fid loe_key;
362 struct lu_orphan_rec loe_rec;
365 struct lu_orphan_rec_v2 {
366 struct lu_orphan_rec lor_rec;
367 struct ost_layout lor_layout;
371 struct lu_orphan_ent_v2 {
372 /* The orphan OST-object's FID */
373 struct lu_fid loe_key;
374 struct lu_orphan_rec_v2 loe_rec;
377 struct lu_orphan_rec_v3 {
378 struct lu_orphan_rec lor_rec;
379 struct ost_layout lor_layout;
380 /* The OST-object declared layout version in PFID EA.*/
381 __u32 lor_layout_version;
382 /* The OST-object declared layout range (of version) in PFID EA.*/
388 struct lu_orphan_ent_v3 {
389 /* The orphan OST-object's FID */
390 struct lu_fid loe_key;
391 struct lu_orphan_rec_v3 loe_rec;
396 /** \defgroup lu_dir lu_dir
400 * Enumeration of possible directory entry attributes.
402 * Attributes follow directory entry header in the order they appear in this
405 enum lu_dirent_attrs {
408 LUDA_64BITHASH = 0x0004,
410 /* The following attrs are used for MDT internal only,
411 * not visible to client */
413 /* Something in the record is unknown, to be verified in further. */
414 LUDA_UNKNOWN = 0x0400,
415 /* Ignore this record, go to next directly. */
416 LUDA_IGNORE = 0x0800,
417 /* The system is upgraded, has beed or to be repaired (dryrun). */
418 LUDA_UPGRADE = 0x1000,
419 /* The dirent has been repaired, or to be repaired (dryrun). */
420 LUDA_REPAIR = 0x2000,
421 /* Only check but not repair the dirent inconsistency */
422 LUDA_VERIFY_DRYRUN = 0x4000,
423 /* Verify the dirent consistency */
424 LUDA_VERIFY = 0x8000,
427 #define LU_DIRENT_ATTRS_MASK 0xff00
430 * Layout of readdir pages, as transmitted on wire.
433 /** valid if LUDA_FID is set. */
434 struct lu_fid lde_fid;
435 /** a unique entry identifier: a hash or an offset. */
437 /** total record length, including all attributes. */
441 /** optional variable size attributes following this entry.
442 * taken from enum lu_dirent_attrs.
445 /** name is followed by the attributes indicated in ->ldp_attrs, in
446 * their natural order. After the last attribute, padding bytes are
447 * added to make ->lde_reclen a multiple of 8.
453 * Definitions of optional directory entry attributes formats.
455 * Individual attributes do not have their length encoded in a generic way. It
456 * is assumed that consumer of an attribute knows its format. This means that
457 * it is impossible to skip over an unknown attribute, except by skipping over all
458 * remaining attributes (by using ->lde_reclen), which is not too
459 * constraining, because new server versions will append new attributes at
460 * the end of an entry.
464 * Fid directory attribute: a fid of an object referenced by the entry. This
465 * will be almost always requested by the client and supplied by the server.
467 * Aligned to 8 bytes.
469 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
474 * Aligned to 2 bytes.
481 __u64 ldp_hash_start;
485 struct lu_dirent ldp_entries[0];
488 enum lu_dirpage_flags {
490 * dirpage contains no entry.
494 * last entry's lde_hash equals ldp_hash_end.
499 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
501 if (__le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
504 return dp->ldp_entries;
507 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
509 struct lu_dirent *next;
511 if (__le16_to_cpu(ent->lde_reclen) != 0)
512 next = ((void *)ent) + __le16_to_cpu(ent->lde_reclen);
519 static inline __kernel_size_t lu_dirent_calc_size(size_t namelen, __u16 attr)
521 __kernel_size_t size;
523 if (attr & LUDA_TYPE) {
524 const __kernel_size_t align = sizeof(struct luda_type) - 1;
526 size = (sizeof(struct lu_dirent) + namelen + 1 + align) &
528 size += sizeof(struct luda_type);
530 size = sizeof(struct lu_dirent) + namelen + 1;
533 return (size + 7) & ~7;
536 static inline __u16 lu_dirent_type_get(struct lu_dirent *ent)
539 struct luda_type *lt;
542 if (__le32_to_cpu(ent->lde_attrs) & LUDA_TYPE) {
543 const unsigned int align = sizeof(struct luda_type) - 1;
545 len = __le16_to_cpu(ent->lde_namelen);
546 len = (len + align) & ~align;
547 lt = (void *)ent->lde_name + len;
548 type = __le16_to_cpu(lt->lt_type);
554 #define MDS_DIR_END_OFF 0xfffffffffffffffeULL
557 * MDS_READPAGE page size
559 * This is the directory page size packed in MDS_READPAGE RPC.
560 * It's different than PAGE_SIZE because the client needs to
561 * access the struct lu_dirpage header packed at the beginning of
562 * the "page" and without this there isn't any way to know find the
563 * lu_dirpage header is if client and server PAGE_SIZE differ.
565 #define LU_PAGE_SHIFT 12
566 #define LU_PAGE_SIZE (1UL << LU_PAGE_SHIFT)
567 #define LU_PAGE_MASK (~(LU_PAGE_SIZE - 1))
569 #define LU_PAGE_COUNT (1 << (PAGE_SHIFT - LU_PAGE_SHIFT))
573 struct lustre_handle {
576 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
578 static inline bool lustre_handle_is_used(const struct lustre_handle *lh)
580 return lh->cookie != 0;
583 static inline bool lustre_handle_equal(const struct lustre_handle *lh1,
584 const struct lustre_handle *lh2)
586 return lh1->cookie == lh2->cookie;
589 static inline void lustre_handle_copy(struct lustre_handle *tgt,
590 const struct lustre_handle *src)
592 tgt->cookie = src->cookie;
595 /* lustre_msg struct magic. DON'T use swabbed values of MAGIC as magic! */
596 enum lustre_msg_magic {
597 LUSTRE_MSG_MAGIC_V2 = 0x0BD00BD3,
598 LUSTRE_MSG_MAGIC_V2_SWABBED = 0xD30BD00B,
599 LUSTRE_MSG_MAGIC = LUSTRE_MSG_MAGIC_V2
602 /* flags for lm_flags */
604 MSGHDR_AT_SUPPORT = 0x1, /* adaptive timeouts, lm_cksum valid
605 * in early reply messages */
606 MSGHDR_CKSUM_INCOMPAT18 = 0x2, /* compat for 1.8, needs to be set well
607 * beyond 2.8.0 for compatibility */
610 #define lustre_msg lustre_msg_v2
611 /* we depend on this structure to be 8-byte aligned */
612 /* this type is only endian-adjusted in lustre_unpack_msg() */
613 struct lustre_msg_v2 {
614 __u32 lm_bufcount; /* number of buffers in lm_buflens[] */
615 __u32 lm_secflvr; /* 0 = no crypto, or sptlrpc security flavour */
616 __u32 lm_magic; /* RPC version magic = LUSTRE_MSG_MAGIC_V2 */
617 __u32 lm_repsize; /* size of preallocated reply buffer */
618 __u32 lm_cksum; /* CRC32 of ptlrpc_body early reply messages */
619 __u32 lm_flags; /* enum lustre_msghdr MSGHDR_* flags */
620 __u32 lm_padding_2; /* unused */
621 __u32 lm_padding_3; /* unused */
622 __u32 lm_buflens[0]; /* length of additional buffers in bytes,
623 * padded to a multiple of 8 bytes. */
625 * message buffers are packed after padded lm_buflens[] array,
626 * padded to a multiple of 8 bytes each to align contents.
630 /* ptlrpc_body packet pb_types */
631 #define PTL_RPC_MSG_REQUEST 4711 /* normal RPC request message */
632 #define PTL_RPC_MSG_ERR 4712 /* error reply if request unprocessed */
633 #define PTL_RPC_MSG_REPLY 4713 /* normal RPC reply message */
635 /* ptlrpc_body pb_version ((target_version << 16) | rpc_version) */
636 enum lustre_msg_version {
637 PTLRPC_MSG_VERSION = 0x00000003,
638 LUSTRE_VERSION_MASK = 0xffff0000,
639 LUSTRE_OBD_VERSION = 0x00010000,
640 LUSTRE_MDS_VERSION = 0x00020000,
641 LUSTRE_OST_VERSION = 0x00030000,
642 LUSTRE_DLM_VERSION = 0x00040000,
643 LUSTRE_LOG_VERSION = 0x00050000,
644 LUSTRE_MGS_VERSION = 0x00060000,
647 /* pb_flags that apply to all request messages */
648 /* #define MSG_LAST_REPLAY 0x0001 obsolete 2.0 => {REQ,LOCK}_REPLAY_DONE */
649 #define MSG_RESENT 0x0002 /* was previously sent, no reply seen */
650 #define MSG_REPLAY 0x0004 /* was processed, got reply, recovery */
651 /* #define MSG_AT_SUPPORT 0x0008 obsolete since 1.5, AT always enabled */
652 /* #define MSG_DELAY_REPLAY 0x0010 obsolete since 2.0 */
653 /* #define MSG_VERSION_REPLAY 0x0020 obsolete since 1.8.2, VBR always on */
654 #define MSG_REQ_REPLAY_DONE 0x0040 /* request replay over, locks next */
655 #define MSG_LOCK_REPLAY_DONE 0x0080 /* lock replay over, client done */
657 /* pb_op_flags for connect opcodes: MDS_CONNECT, OST_CONNECT, MGS_CONNECT */
658 #define MSG_CONNECT_RECOVERING 0x00000001 /* target is in recovery */
659 #define MSG_CONNECT_RECONNECT 0x00000002 /* tgt already has client import */
660 #define MSG_CONNECT_REPLAYABLE 0x00000004 /* target supports RPC replay */
661 /* #define MSG_CONNECT_PEER 0x00000008 obsolete since 1.2, removed in 1.5 */
662 #define MSG_CONNECT_LIBCLIENT 0x00000010 /* obsolete since 2.3, removed 2.6 */
663 #define MSG_CONNECT_INITIAL 0x00000020 /* first client connection attempt */
664 /* #define MSG_CONNECT_ASYNC 0x00000040 obsolete since 1.5 */
665 #define MSG_CONNECT_NEXT_VER 0x00000080 /* use next version of lustre_msg */
666 #define MSG_CONNECT_TRANSNO 0x00000100 /* client sent transno in replay */
668 /* number of previous object versions in pb_pre_versions[] */
669 #define PTLRPC_NUM_VERSIONS 4
670 /* without gss, ptlrpc_body is put at the first buffer. */
671 struct ptlrpc_body_v3 {
672 struct lustre_handle pb_handle;
673 __u32 pb_type; /* request/reply/err type: PTL_RPC_MSG_* */
674 __u32 pb_version; /* LUSTRE_*_VERSION | PTLRPC_MSG_VERSION */
675 __u32 pb_opc; /* RPC opcodes: MDS_*, OST_*, LDLM_, ... */
676 __u32 pb_status; /* negative Linux x86 error number */
677 __u64 pb_last_xid; /* highest replied XID w/o lower unreplied XID*/
678 __u16 pb_tag; /* multiple modifying RPCs virtual slot index */
681 __u64 pb_last_committed;/* rep: highest pb_transno committed to disk */
682 __u64 pb_transno; /* server-assigned transno for modifying RPCs */
683 __u32 pb_flags; /* req: MSG_* flags */
684 __u32 pb_op_flags; /* req: MSG_CONNECT_* flags */
685 __u32 pb_conn_cnt; /* connect instance of this client on server */
686 __u32 pb_timeout; /* req: max wait time; rep: service estimate */
687 __u32 pb_service_time; /* rep: server arrival to reply in seconds */
688 __u32 pb_limit; /* rep: dynamic DLM LRU lock count limit */
689 __u64 pb_slv; /* rep: dynamic DLM LRU server lock volume */
690 /* VBR: rep: previous pb_version(s) of objects modified by this RPC */
691 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
692 __u64 pb_mbits; /**< match bits for bulk request */
693 /* padding for future needs - fix lustre_swab_ptlrpc_body() also */
694 __u64 pb_padding64_0;
695 __u64 pb_padding64_1;
696 __u64 pb_padding64_2;
697 char pb_jobid[LUSTRE_JOBID_SIZE]; /* req: ASCII jobid from env + NUL */
699 #define ptlrpc_body ptlrpc_body_v3
701 struct ptlrpc_body_v2 {
702 struct lustre_handle pb_handle;
707 __u64 pb_last_xid; /* highest replied XID without lower unreplied XID */
708 __u16 pb_tag; /* virtual slot idx for multiple modifying RPCs */
711 __u64 pb_last_committed;
716 __u32 pb_timeout; /* for req, the deadline, for rep, the service est */
717 __u32 pb_service_time; /* for rep, actual service time, also used for
718 net_latency of req */
721 /* VBR: pre-versions */
722 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
723 __u64 pb_mbits; /**< unused in V2 */
724 /* padding for future needs */
725 __u64 pb_padding64_0;
726 __u64 pb_padding64_1;
727 __u64 pb_padding64_2;
730 /* message body offset for lustre_msg_v2 */
731 /* ptlrpc body offset in all request/reply messages */
732 #define MSG_PTLRPC_BODY_OFF 0
734 /* normal request/reply message record offset */
735 #define REQ_REC_OFF 1
736 #define REPLY_REC_OFF 1
738 /* ldlm request message body offset */
739 #define DLM_LOCKREQ_OFF 1 /* lockreq offset */
740 #define DLM_REQ_REC_OFF 2 /* normal dlm request record offset */
742 /* ldlm intent lock message body offset */
743 #define DLM_INTENT_IT_OFF 2 /* intent lock it offset */
744 #define DLM_INTENT_REC_OFF 3 /* intent lock record offset */
746 /* ldlm reply message body offset */
747 #define DLM_LOCKREPLY_OFF 1 /* lockrep offset */
748 #define DLM_REPLY_REC_OFF 2 /* reply record offset */
750 /** only use in req->rq_{req,rep}_swab_mask */
751 #define MSG_PTLRPC_HEADER_OFF 31
754 #define OBD_CONNECT_RDONLY 0x1ULL /*client has read-only access*/
755 #define OBD_CONNECT_INDEX 0x2ULL /*connect specific LOV idx */
756 #define OBD_CONNECT_MDS 0x4ULL /*connect from MDT to OST */
757 #define OBD_CONNECT_GRANT 0x8ULL /*OSC gets grant at connect */
758 #define OBD_CONNECT_SRVLOCK 0x10ULL /*server takes locks for cli */
759 #define OBD_CONNECT_VERSION 0x20ULL /*Lustre versions in ocd */
760 #define OBD_CONNECT_REQPORTAL 0x40ULL /*Separate non-IO req portal */
761 #define OBD_CONNECT_ACL 0x80ULL /*access control lists */
762 #define OBD_CONNECT_XATTR 0x100ULL /*client use extended attr */
763 #define OBD_CONNECT_LARGE_ACL 0x200ULL /* more than 32 ACL entries */
764 #define OBD_CONNECT_TRUNCLOCK 0x400ULL /*locks on server for punch */
765 #define OBD_CONNECT_TRANSNO 0x800ULL /*replay sends init transno */
766 #define OBD_CONNECT_IBITS 0x1000ULL /* not checked in 2.11+ */
767 #define OBD_CONNECT_BARRIER 0x2000ULL /* write barrier */
768 #define OBD_CONNECT_ATTRFID 0x4000ULL /*Server can GetAttr By Fid*/
769 #define OBD_CONNECT_NODEVOH 0x8000ULL /*No open hndl on specl nodes*/
770 #define OBD_CONNECT_RMT_CLIENT 0x10000ULL /* Remote client, never used
771 * in production. Removed in
772 * 2.9. Keep this flag to
775 #define OBD_CONNECT_RMT_CLIENT_FORCE 0x20000ULL /* Remote client by force,
776 * never used in production.
777 * Removed in 2.9. Keep this
778 * flag to avoid reusing.
780 #define OBD_CONNECT_BRW_SIZE 0x40000ULL /*Max bytes per rpc */
781 #define OBD_CONNECT_QUOTA64 0x80000ULL /*Not used since 2.4 */
782 #define OBD_CONNECT_MDS_CAPA 0x100000ULL /*MDS capability */
783 #define OBD_CONNECT_OSS_CAPA 0x200000ULL /*OSS capability */
784 #define OBD_CONNECT_CANCELSET 0x400000ULL /*Early batched cancels. */
785 #define OBD_CONNECT_SOM 0x800000ULL /*Size on MDS */
786 #define OBD_CONNECT_AT 0x1000000ULL /*client uses AT */
787 #define OBD_CONNECT_LRU_RESIZE 0x2000000ULL /*LRU resize feature. */
788 #define OBD_CONNECT_MDS_MDS 0x4000000ULL /*MDS-MDS connection */
789 #define OBD_CONNECT_REAL 0x8000000ULL /* obsolete since 2.8 */
790 #define OBD_CONNECT_CHANGE_QS 0x10000000ULL /*Not used since 2.4 */
791 #define OBD_CONNECT_CKSUM 0x20000000ULL /*support several cksum algos*/
792 #define OBD_CONNECT_FID 0x40000000ULL /*FID is supported by server */
793 #define OBD_CONNECT_VBR 0x80000000ULL /*version based recovery */
794 #define OBD_CONNECT_LOV_V3 0x100000000ULL /*client supports LOV v3 EA */
795 #define OBD_CONNECT_GRANT_SHRINK 0x200000000ULL /* support grant shrink */
796 #define OBD_CONNECT_SKIP_ORPHAN 0x400000000ULL /* don't reuse orphan objids */
797 #define OBD_CONNECT_MAX_EASIZE 0x800000000ULL /* preserved for large EA */
798 #define OBD_CONNECT_FULL20 0x1000000000ULL /* it is 2.0 client */
799 #define OBD_CONNECT_LAYOUTLOCK 0x2000000000ULL /* client uses layout lock */
800 #define OBD_CONNECT_64BITHASH 0x4000000000ULL /* client supports 64-bits
802 #define OBD_CONNECT_MAXBYTES 0x8000000000ULL /* max stripe size */
803 #define OBD_CONNECT_IMP_RECOV 0x10000000000ULL /* imp recovery support */
804 #define OBD_CONNECT_JOBSTATS 0x20000000000ULL /* jobid in ptlrpc_body */
805 #define OBD_CONNECT_UMASK 0x40000000000ULL /* create uses client umask */
806 #define OBD_CONNECT_EINPROGRESS 0x80000000000ULL /* client handles -EINPROGRESS
807 * RPC error properly */
808 #define OBD_CONNECT_GRANT_PARAM 0x100000000000ULL/* extra grant params used for
809 * finer space reservation */
810 #define OBD_CONNECT_FLOCK_OWNER 0x200000000000ULL /* for the fixed 1.8
811 * policy and 2.x server */
812 #define OBD_CONNECT_LVB_TYPE 0x400000000000ULL /* variable type of LVB */
813 #define OBD_CONNECT_NANOSEC_TIME 0x800000000000ULL /* nanosecond timestamps */
814 #define OBD_CONNECT_LIGHTWEIGHT 0x1000000000000ULL/* lightweight connection */
815 #define OBD_CONNECT_SHORTIO 0x2000000000000ULL/* short io */
816 #define OBD_CONNECT_PINGLESS 0x4000000000000ULL/* pings not required */
817 #define OBD_CONNECT_FLOCK_DEAD 0x8000000000000ULL/* improved flock deadlock detection */
818 #define OBD_CONNECT_DISP_STRIPE 0x10000000000000ULL/* create stripe disposition*/
819 #define OBD_CONNECT_OPEN_BY_FID 0x20000000000000ULL /* open by fid won't pack
821 #define OBD_CONNECT_LFSCK 0x40000000000000ULL/* support online LFSCK */
822 #define OBD_CONNECT_UNLINK_CLOSE 0x100000000000000ULL/* close file in unlink */
823 #define OBD_CONNECT_MULTIMODRPCS 0x200000000000000ULL /* support multiple modify
825 #define OBD_CONNECT_DIR_STRIPE 0x400000000000000ULL /* striped DNE dir */
826 #define OBD_CONNECT_SUBTREE 0x800000000000000ULL /* fileset mount */
827 /* was OBD_CONNECT_LOCKAHEAD_OLD 0x1000000000000000ULL old lockahead 2.12-2.13*/
829 /** bulk matchbits is sent within ptlrpc_body */
830 #define OBD_CONNECT_BULK_MBITS 0x2000000000000000ULL
831 #define OBD_CONNECT_OBDOPACK 0x4000000000000000ULL /* compact OUT obdo */
832 #define OBD_CONNECT_FLAGS2 0x8000000000000000ULL /* second flags word */
833 /* ocd_connect_flags2 flags */
834 #define OBD_CONNECT2_FILE_SECCTX 0x1ULL /* set file security context at create */
835 #define OBD_CONNECT2_LOCKAHEAD 0x2ULL /* ladvise lockahead v2 */
836 #define OBD_CONNECT2_DIR_MIGRATE 0x4ULL /* migrate striped dir */
837 #define OBD_CONNECT2_SUM_STATFS 0x8ULL /* MDT return aggregated stats */
838 #define OBD_CONNECT2_OVERSTRIPING 0x10ULL /* OST overstriping support */
839 #define OBD_CONNECT2_FLR 0x20ULL /* FLR support */
840 #define OBD_CONNECT2_WBC_INTENTS 0x40ULL /* create/unlink/... intents for wbc, also operations under client-held parent locks */
841 #define OBD_CONNECT2_LOCK_CONVERT 0x80ULL /* IBITS lock convert support */
842 #define OBD_CONNECT2_ARCHIVE_ID_ARRAY 0x100ULL /* store HSM archive_id in array */
843 #define OBD_CONNECT2_INC_XID 0x200ULL /* Increasing xid */
844 #define OBD_CONNECT2_SELINUX_POLICY 0x400ULL /* has client SELinux policy */
845 #define OBD_CONNECT2_LSOM 0x800ULL /* LSOM support */
846 #define OBD_CONNECT2_PCC 0x1000ULL /* Persistent Client Cache */
847 #define OBD_CONNECT2_CRUSH 0x2000ULL /* crush hash striped directory */
848 #define OBD_CONNECT2_ASYNC_DISCARD 0x4000ULL /* support async DoM data discard */
849 #define OBD_CONNECT2_ENCRYPT 0x8000ULL /* client-to-disk encrypt */
850 #define OBD_CONNECT2_FIDMAP 0x10000ULL /* FID map */
851 #define OBD_CONNECT2_GETATTR_PFID 0x20000ULL /* pack parent FID in getattr */
853 * Please DO NOT add flag values here before first ensuring that this same
854 * flag value is not in use on some other branch. Please clear any such
855 * changes with senior engineers before starting to use a new flag. Then,
856 * submit a small patch against EVERY branch that ONLY adds the new flag,
857 * updates obd_connect_names[], adds the flag to check_obd_connect_data(),
858 * and updates wiretests accordingly, so it can be approved and landed easily
859 * to reserve the flag for future use.
862 #define OCD_HAS_FLAG(ocd, flg) \
863 (!!((ocd)->ocd_connect_flags & OBD_CONNECT_##flg))
866 #ifdef HAVE_LRU_RESIZE_SUPPORT
867 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
869 #define LRU_RESIZE_CONNECT_FLAG 0
872 #define MDT_CONNECT_SUPPORTED (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
873 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
874 OBD_CONNECT_IBITS | OBD_CONNECT_NODEVOH | \
875 OBD_CONNECT_ATTRFID | OBD_CONNECT_CANCELSET | \
876 OBD_CONNECT_AT | OBD_CONNECT_BRW_SIZE | \
877 OBD_CONNECT_MDS_MDS | OBD_CONNECT_FID | \
878 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_VBR | \
879 OBD_CONNECT_LOV_V3 | OBD_CONNECT_FULL20 | \
880 OBD_CONNECT_64BITHASH | OBD_CONNECT_JOBSTATS | \
881 OBD_CONNECT_EINPROGRESS | \
882 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_UMASK | \
883 OBD_CONNECT_LVB_TYPE | OBD_CONNECT_LAYOUTLOCK |\
884 OBD_CONNECT_PINGLESS | OBD_CONNECT_MAX_EASIZE |\
885 OBD_CONNECT_FLOCK_DEAD | \
886 OBD_CONNECT_DISP_STRIPE | OBD_CONNECT_LFSCK | \
887 OBD_CONNECT_OPEN_BY_FID | \
888 OBD_CONNECT_DIR_STRIPE | OBD_CONNECT_GRANT | \
889 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_SRVLOCK | \
890 OBD_CONNECT_BULK_MBITS | OBD_CONNECT_CKSUM | \
891 OBD_CONNECT_MULTIMODRPCS | \
892 OBD_CONNECT_SUBTREE | OBD_CONNECT_LARGE_ACL | \
893 OBD_CONNECT_GRANT_PARAM | \
894 OBD_CONNECT_SHORTIO | OBD_CONNECT_FLAGS2)
896 #define MDT_CONNECT_SUPPORTED2 (OBD_CONNECT2_FILE_SECCTX | \
897 OBD_CONNECT2_DIR_MIGRATE | \
898 OBD_CONNECT2_SUM_STATFS | \
899 OBD_CONNECT2_OVERSTRIPING | \
901 OBD_CONNECT2_LOCK_CONVERT | \
902 OBD_CONNECT2_ARCHIVE_ID_ARRAY | \
903 OBD_CONNECT2_INC_XID | \
904 OBD_CONNECT2_SELINUX_POLICY | \
905 OBD_CONNECT2_LSOM | \
906 OBD_CONNECT2_ASYNC_DISCARD | \
908 OBD_CONNECT2_CRUSH | \
909 OBD_CONNECT2_ENCRYPT | \
910 OBD_CONNECT2_GETATTR_PFID)
912 #define OST_CONNECT_SUPPORTED (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
913 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
914 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
915 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_CANCELSET | \
916 OBD_CONNECT_AT | LRU_RESIZE_CONNECT_FLAG | \
917 OBD_CONNECT_CKSUM | OBD_CONNECT_VBR | \
918 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
919 OBD_CONNECT_GRANT_SHRINK | OBD_CONNECT_FULL20 |\
920 OBD_CONNECT_64BITHASH | OBD_CONNECT_MAXBYTES | \
921 OBD_CONNECT_MAX_EASIZE | \
922 OBD_CONNECT_EINPROGRESS | \
923 OBD_CONNECT_JOBSTATS | \
924 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_LVB_TYPE|\
925 OBD_CONNECT_LAYOUTLOCK | OBD_CONNECT_FID | \
926 OBD_CONNECT_PINGLESS | OBD_CONNECT_LFSCK | \
927 OBD_CONNECT_BULK_MBITS | \
928 OBD_CONNECT_GRANT_PARAM | \
929 OBD_CONNECT_SHORTIO | OBD_CONNECT_FLAGS2)
931 #define OST_CONNECT_SUPPORTED2 (OBD_CONNECT2_LOCKAHEAD | OBD_CONNECT2_INC_XID |\
932 OBD_CONNECT2_ENCRYPT)
934 #define ECHO_CONNECT_SUPPORTED (OBD_CONNECT_FID)
935 #define ECHO_CONNECT_SUPPORTED2 0
937 #define MGS_CONNECT_SUPPORTED (OBD_CONNECT_VERSION | OBD_CONNECT_AT | \
938 OBD_CONNECT_FULL20 | OBD_CONNECT_IMP_RECOV | \
939 OBD_CONNECT_PINGLESS |\
940 OBD_CONNECT_BULK_MBITS | OBD_CONNECT_BARRIER)
942 #define MGS_CONNECT_SUPPORTED2 0
944 /* Features required for this version of the client to work with server */
945 #define CLIENT_CONNECT_MDT_REQD (OBD_CONNECT_FID | \
946 OBD_CONNECT_ATTRFID | \
949 /* This structure is used for both request and reply.
951 * If we eventually have separate connect data for different types, which we
952 * almost certainly will, then perhaps we stick a union in here. */
953 struct obd_connect_data {
954 __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
955 __u32 ocd_version; /* lustre release version number */
956 __u32 ocd_grant; /* initial cache grant amount (bytes) */
957 __u32 ocd_index; /* LOV index to connect to */
958 __u32 ocd_brw_size; /* Maximum BRW size in bytes */
959 __u64 ocd_ibits_known; /* inode bits this client understands */
960 __u8 ocd_grant_blkbits; /* log2 of the backend filesystem blocksize */
961 __u8 ocd_grant_inobits; /* log2 of the per-inode space consumption */
962 __u16 ocd_grant_tax_kb; /* extent insertion overhead, in 1K blocks */
963 __u32 ocd_grant_max_blks;/* maximum number of blocks per extent */
964 __u64 ocd_transno; /* first transno from client to be replayed */
965 __u32 ocd_group; /* MDS group on OST */
966 __u32 ocd_cksum_types; /* supported checksum algorithms */
967 __u32 ocd_max_easize; /* How big LOV EA can be on MDS */
968 __u32 ocd_instance; /* instance # of this target */
969 __u64 ocd_maxbytes; /* Maximum stripe size in bytes */
970 /* Fields after ocd_maxbytes are only accessible by the receiver
971 * if the corresponding flag in ocd_connect_flags is set. Accessing
972 * any field after ocd_maxbytes on the receiver without a valid flag
973 * may result in out-of-bound memory access and kernel oops. */
974 __u16 ocd_maxmodrpcs; /* Maximum modify RPCs in parallel */
975 __u16 padding0; /* added 2.1.0. also fix lustre_swab_connect */
976 __u32 padding1; /* added 2.1.0. also fix lustre_swab_connect */
977 __u64 ocd_connect_flags2;
978 __u64 padding3; /* added 2.1.0. also fix lustre_swab_connect */
979 __u64 padding4; /* added 2.1.0. also fix lustre_swab_connect */
980 __u64 padding5; /* added 2.1.0. also fix lustre_swab_connect */
981 __u64 padding6; /* added 2.1.0. also fix lustre_swab_connect */
982 __u64 padding7; /* added 2.1.0. also fix lustre_swab_connect */
983 __u64 padding8; /* added 2.1.0. also fix lustre_swab_connect */
984 __u64 padding9; /* added 2.1.0. also fix lustre_swab_connect */
985 __u64 paddingA; /* added 2.1.0. also fix lustre_swab_connect */
986 __u64 paddingB; /* added 2.1.0. also fix lustre_swab_connect */
987 __u64 paddingC; /* added 2.1.0. also fix lustre_swab_connect */
988 __u64 paddingD; /* added 2.1.0. also fix lustre_swab_connect */
989 __u64 paddingE; /* added 2.1.0. also fix lustre_swab_connect */
990 __u64 paddingF; /* added 2.1.0. also fix lustre_swab_connect */
993 * Please DO NOT use any fields here before first ensuring that this same
994 * field is not in use on some other branch. Please clear any such changes
995 * with senior engineers before starting to use a new field. Then, submit
996 * a small patch against EVERY branch that ONLY adds the new field along with
997 * the matching OBD_CONNECT flag, so that can be approved and landed easily to
998 * reserve the flag for future use. */
1001 * Supported checksum algorithms. Up to 32 checksum types are supported.
1002 * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
1003 * Please update DECLARE_CKSUM_NAME in obd_cksum.h when adding a new
1004 * algorithm and also the OBD_FL_CKSUM* flags, OBD_CKSUM_ALL flag,
1005 * OBD_FL_CKSUM_ALL flag and potentially OBD_CKSUM_T10_ALL flag.
1008 OBD_CKSUM_CRC32 = 0x00000001,
1009 OBD_CKSUM_ADLER = 0x00000002,
1010 OBD_CKSUM_CRC32C = 0x00000004,
1011 OBD_CKSUM_RESERVED = 0x00000008,
1012 OBD_CKSUM_T10IP512 = 0x00000010,
1013 OBD_CKSUM_T10IP4K = 0x00000020,
1014 OBD_CKSUM_T10CRC512 = 0x00000040,
1015 OBD_CKSUM_T10CRC4K = 0x00000080,
1018 #define OBD_CKSUM_T10_ALL (OBD_CKSUM_T10IP512 | OBD_CKSUM_T10IP4K | \
1019 OBD_CKSUM_T10CRC512 | OBD_CKSUM_T10CRC4K)
1021 #define OBD_CKSUM_ALL (OBD_CKSUM_CRC32 | OBD_CKSUM_ADLER | OBD_CKSUM_CRC32C | \
1025 * The default checksum algorithm used on top of T10PI GRD tags for RPC.
1026 * Considering that the checksum-of-checksums is only computing CRC32 on a
1027 * 4KB chunk of GRD tags for a 1MB RPC for 512B sectors, or 16KB of GRD
1028 * tags for 16MB of 4KB sectors, this is only 1/256 or 1/1024 of the
1029 * total data being checksummed, so the checksum type used here should not
1030 * affect overall system performance noticeably.
1032 #define OBD_CKSUM_T10_TOP OBD_CKSUM_ADLER
1035 * OST requests: OBDO & OBD request records
1040 OST_REPLY = 0, /* reply ? */
1056 OST_QUOTACHECK = 18, /* not used since 2.4 */
1058 OST_QUOTA_ADJUST_QUNIT = 20, /* not used since 2.4 */
1061 OST_LAST_OPC /* must be < 33 to avoid MDS_GETATTR */
1063 #define OST_FIRST_OPC OST_REPLY
1066 OBD_FL_INLINEDATA = 0x00000001,
1067 OBD_FL_OBDMDEXISTS = 0x00000002,
1068 OBD_FL_DELORPHAN = 0x00000004, /* if set in o_flags delete orphans */
1069 OBD_FL_NORPC = 0x00000008, /* set in o_flags do in OSC not OST */
1070 OBD_FL_IDONLY = 0x00000010, /* set in o_flags only adjust obj id*/
1071 OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
1072 OBD_FL_DEBUG_CHECK = 0x00000040, /* echo client/server debug check */
1073 OBD_FL_NO_PRJQUOTA = 0x00000080, /* the object's project is over
1075 OBD_FL_NO_USRQUOTA = 0x00000100, /* the object's owner is over quota */
1076 OBD_FL_NO_GRPQUOTA = 0x00000200, /* the object's group is over quota */
1077 OBD_FL_CREATE_CROW = 0x00000400, /* object should be create on write */
1078 OBD_FL_SRVLOCK = 0x00000800, /* delegate DLM locking to server */
1079 OBD_FL_CKSUM_CRC32 = 0x00001000, /* CRC32 checksum type */
1080 OBD_FL_CKSUM_ADLER = 0x00002000, /* ADLER checksum type */
1081 OBD_FL_CKSUM_CRC32C = 0x00004000, /* CRC32C checksum type */
1082 OBD_FL_CKSUM_T10IP512 = 0x00005000, /* T10PI IP cksum, 512B sector */
1083 OBD_FL_CKSUM_T10IP4K = 0x00006000, /* T10PI IP cksum, 4KB sector */
1084 OBD_FL_CKSUM_T10CRC512 = 0x00007000, /* T10PI CRC cksum, 512B sector */
1085 OBD_FL_CKSUM_T10CRC4K = 0x00008000, /* T10PI CRC cksum, 4KB sector */
1086 OBD_FL_CKSUM_RSVD3 = 0x00010000, /* for future cksum types */
1087 OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
1088 OBD_FL_MMAP = 0x00040000, /* object is mmapped on the client.
1089 * XXX: obsoleted - reserved for old
1090 * clients prior than 2.2 */
1091 OBD_FL_RECOV_RESEND = 0x00080000, /* recoverable resent */
1092 OBD_FL_NOSPC_BLK = 0x00100000, /* no more block space on OST */
1093 OBD_FL_FLUSH = 0x00200000, /* flush pages on the OST */
1094 OBD_FL_SHORT_IO = 0x00400000, /* short io request */
1095 /* OBD_FL_LOCAL_MASK = 0xF0000000, was local-only flags until 2.10 */
1098 * Note that while the original checksum values were separate bits,
1099 * in 2.x we can actually allow all values from 1-31. T10-PI checksum
1100 * types already use values which are not separate bits.
1102 OBD_FL_CKSUM_ALL = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER |
1103 OBD_FL_CKSUM_CRC32C | OBD_FL_CKSUM_T10IP512 |
1104 OBD_FL_CKSUM_T10IP4K | OBD_FL_CKSUM_T10CRC512 |
1105 OBD_FL_CKSUM_T10CRC4K,
1107 OBD_FL_NO_QUOTA_ALL = OBD_FL_NO_USRQUOTA | OBD_FL_NO_GRPQUOTA |
1112 * All LOV EA magics should have the same postfix, if some new version
1113 * Lustre instroduces new LOV EA magic, then when down-grade to an old
1114 * Lustre, even though the old version system does not recognizes such
1115 * new magic, it still can distinguish the corrupted cases by checking
1116 * the magic's postfix.
1118 #define LOV_MAGIC_MAGIC 0x0BD0
1119 #define LOV_MAGIC_MASK 0xFFFF
1121 #define LOV_MAGIC_V1 (0x0BD10000 | LOV_MAGIC_MAGIC)
1122 #define LOV_MAGIC_JOIN_V1 (0x0BD20000 | LOV_MAGIC_MAGIC)
1123 #define LOV_MAGIC_V3 (0x0BD30000 | LOV_MAGIC_MAGIC)
1124 #define LOV_MAGIC_MIGRATE (0x0BD40000 | LOV_MAGIC_MAGIC)
1125 /* reserved for specifying OSTs */
1126 #define LOV_MAGIC_SPECIFIC (0x0BD50000 | LOV_MAGIC_MAGIC)
1127 #define LOV_MAGIC LOV_MAGIC_V1
1128 #define LOV_MAGIC_COMP_V1 (0x0BD60000 | LOV_MAGIC_MAGIC)
1129 #define LOV_MAGIC_FOREIGN (0x0BD70000 | LOV_MAGIC_MAGIC)
1130 #define LOV_MAGIC_SEL (0x0BD80000 | LOV_MAGIC_MAGIC)
1133 * magic for fully defined striping
1134 * the idea is that we should have different magics for striping "hints"
1135 * (struct lov_user_md_v[13]) and defined ready-to-use striping (struct
1136 * lov_mds_md_v[13]). at the moment the magics are used in wire protocol,
1137 * we can't just change it w/o long way preparation, but we still need a
1138 * mechanism to allow LOD to differentiate hint versus ready striping.
1139 * so, at the moment we do a trick: MDT knows what to expect from request
1140 * depending on the case (replay uses ready striping, non-replay req uses
1141 * hints), so MDT replaces magic with appropriate one and now LOD can
1142 * easily understand what's inside -bzzz
1144 * those *_DEF magics are only used on server side internally, they
1145 * won't be put on wire or disk.
1147 #define LOV_MAGIC_DEFINED 0x10000000
1148 #define LOV_MAGIC_V1_DEFINED (LOV_MAGIC_DEFINED | LOV_MAGIC_V1)
1149 #define LOV_MAGIC_V3_DEFINED (LOV_MAGIC_DEFINED | LOV_MAGIC_V3)
1150 #define LOV_MAGIC_COMP_V1_DEFINED (LOV_MAGIC_DEFINED | LOV_MAGIC_COMP_V1)
1152 #define lov_pattern(pattern) (pattern & ~LOV_PATTERN_F_MASK)
1153 #define lov_pattern_flags(pattern) (pattern & LOV_PATTERN_F_MASK)
1155 #define lov_ost_data lov_ost_data_v1
1156 struct lov_ost_data_v1 { /* per-stripe data structure (little-endian)*/
1157 struct ost_id l_ost_oi; /* OST object ID */
1158 __u32 l_ost_gen; /* generation of this l_ost_idx */
1159 __u32 l_ost_idx; /* OST index in LOV (lov_tgt_desc->tgts) */
1162 #define lov_mds_md lov_mds_md_v1
1163 struct lov_mds_md_v1 { /* LOV EA mds/wire data (little-endian) */
1164 __u32 lmm_magic; /* magic number = LOV_MAGIC_V1 */
1165 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1166 struct ost_id lmm_oi; /* LOV object ID */
1167 __u32 lmm_stripe_size; /* size of stripe in bytes */
1168 /* lmm_stripe_count used to be __u32 */
1169 __u16 lmm_stripe_count; /* num stripes in use for this object */
1170 __u16 lmm_layout_gen; /* layout generation number */
1171 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1174 #define MAX_MD_SIZE_OLD (sizeof(struct lov_mds_md) + \
1175 4 * sizeof(struct lov_ost_data))
1176 #define MAX_MD_SIZE (sizeof(struct lov_comp_md_v1) + \
1177 4 * (sizeof(struct lov_comp_md_entry_v1) + \
1179 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
1181 /* This is the default MDT reply size allocated, should the striping be bigger,
1182 * it will be reallocated in mdt_fix_reply.
1183 * 100 stripes is a bit less than 2.5k of data */
1184 #define DEF_REP_MD_SIZE (sizeof(struct lov_mds_md) + \
1185 100 * sizeof(struct lov_ost_data))
1187 #define XATTR_NAME_ACL_ACCESS "system.posix_acl_access"
1188 #define XATTR_NAME_ACL_DEFAULT "system.posix_acl_default"
1189 #define XATTR_USER_PREFIX "user."
1190 #define XATTR_TRUSTED_PREFIX "trusted."
1191 #define XATTR_SECURITY_PREFIX "security."
1193 #define XATTR_NAME_SOM "trusted.som"
1194 #define XATTR_NAME_LOV "trusted.lov"
1195 #define XATTR_NAME_LMA "trusted.lma"
1196 #define XATTR_NAME_LMV "trusted.lmv"
1197 #define XATTR_NAME_DEFAULT_LMV "trusted.dmv"
1198 #define XATTR_NAME_LINK "trusted.link"
1199 #define XATTR_NAME_FID "trusted.fid"
1200 #define XATTR_NAME_VERSION "trusted.version"
1201 #define XATTR_NAME_SOM "trusted.som"
1202 #define XATTR_NAME_HSM "trusted.hsm"
1203 #define XATTR_NAME_LFSCK_BITMAP "trusted.lfsck_bitmap"
1204 #define XATTR_NAME_DUMMY "trusted.dummy"
1206 #define LL_XATTR_NAME_ENCRYPTION_CONTEXT XATTR_SECURITY_PREFIX"c"
1208 #define XATTR_NAME_LFSCK_NAMESPACE "trusted.lfsck_ns"
1209 #define XATTR_NAME_MAX_LEN 32 /* increase this, if there is longer name. */
1211 struct lov_mds_md_v3 { /* LOV EA mds/wire data (little-endian) */
1212 __u32 lmm_magic; /* magic number = LOV_MAGIC_V3 */
1213 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1214 struct ost_id lmm_oi; /* LOV object ID */
1215 __u32 lmm_stripe_size; /* size of stripe in bytes */
1216 /* lmm_stripe_count used to be __u32 */
1217 __u16 lmm_stripe_count; /* num stripes in use for this object */
1218 __u16 lmm_layout_gen; /* layout generation number */
1219 char lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* must be 32bit aligned */
1220 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1223 static inline __u32 lov_mds_md_size(__u16 stripes, __u32 lmm_magic)
1225 if (stripes == (__u16)-1)
1228 if (lmm_magic == LOV_MAGIC_V3)
1229 return sizeof(struct lov_mds_md_v3) +
1230 stripes * sizeof(struct lov_ost_data_v1);
1232 return sizeof(struct lov_mds_md_v1) +
1233 stripes * sizeof(struct lov_ost_data_v1);
1237 lov_mds_md_max_stripe_count(__kernel_size_t buf_size, __u32 lmm_magic)
1239 switch (lmm_magic) {
1240 case LOV_MAGIC_V1: {
1241 struct lov_mds_md_v1 lmm;
1243 if (buf_size < sizeof(lmm))
1246 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1248 case LOV_MAGIC_V3: {
1249 struct lov_mds_md_v3 lmm;
1251 if (buf_size < sizeof(lmm))
1254 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1261 #define OBD_MD_FLID (0x00000001ULL) /* object ID */
1262 #define OBD_MD_FLATIME (0x00000002ULL) /* access time */
1263 #define OBD_MD_FLMTIME (0x00000004ULL) /* data modification time */
1264 #define OBD_MD_FLCTIME (0x00000008ULL) /* change time */
1265 #define OBD_MD_FLSIZE (0x00000010ULL) /* size */
1266 #define OBD_MD_FLBLOCKS (0x00000020ULL) /* allocated blocks count */
1267 #define OBD_MD_FLBLKSZ (0x00000040ULL) /* block size */
1268 #define OBD_MD_FLMODE (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1269 #define OBD_MD_FLTYPE (0x00000100ULL) /* object type (mode & S_IFMT) */
1270 #define OBD_MD_FLUID (0x00000200ULL) /* user ID */
1271 #define OBD_MD_FLGID (0x00000400ULL) /* group ID */
1272 #define OBD_MD_FLFLAGS (0x00000800ULL) /* flags word */
1273 #define OBD_MD_DOM_SIZE (0X00001000ULL) /* Data-on-MDT component size */
1274 #define OBD_MD_FLNLINK (0x00002000ULL) /* link count */
1275 #define OBD_MD_FLPARENT (0x00004000ULL) /* parent FID */
1276 #define OBD_MD_LAYOUT_VERSION (0x00008000ULL) /* OST object layout version */
1277 #define OBD_MD_FLRDEV (0x00010000ULL) /* device number */
1278 #define OBD_MD_FLEASIZE (0x00020000ULL) /* extended attribute data */
1279 #define OBD_MD_LINKNAME (0x00040000ULL) /* symbolic link target */
1280 #define OBD_MD_FLHANDLE (0x00080000ULL) /* file/lock handle */
1281 #define OBD_MD_FLCKSUM (0x00100000ULL) /* bulk data checksum */
1282 /* OBD_MD_FLQOS (0x00200000ULL) has never been used */
1283 /* OBD_MD_FLCOOKIE (0x00800000ULL) obsolete in 2.8 */
1284 #define OBD_MD_FLPRJQUOTA (0x00400000ULL) /* over quota flags sent from ost */
1285 #define OBD_MD_FLGROUP (0x01000000ULL) /* group */
1286 #define OBD_MD_FLFID (0x02000000ULL) /* ->ost write inline fid */
1287 /* OBD_MD_FLEPOCH (0x04000000ULL) obsolete 2.7.50 */
1288 /* ->mds if epoch opens or closes */
1289 #define OBD_MD_FLGRANT (0x08000000ULL) /* ost preallocation space grant */
1290 #define OBD_MD_FLDIREA (0x10000000ULL) /* dir's extended attribute data */
1291 #define OBD_MD_FLUSRQUOTA (0x20000000ULL) /* over quota flags sent from ost */
1292 #define OBD_MD_FLGRPQUOTA (0x40000000ULL) /* over quota flags sent from ost */
1293 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1295 #define OBD_MD_MDS (0x0000000100000000ULL) /* where an inode lives on */
1296 /* OBD_MD_REINT (0x0000000200000000ULL) obsolete 1.8 */
1297 #define OBD_MD_MEA (0x0000000400000000ULL) /* CMD split EA */
1298 #define OBD_MD_TSTATE (0x0000000800000000ULL) /* transient state field */
1300 #define OBD_MD_FLXATTR (0x0000001000000000ULL) /* xattr */
1301 #define OBD_MD_FLXATTRLS (0x0000002000000000ULL) /* xattr list */
1302 #define OBD_MD_FLXATTRRM (0x0000004000000000ULL) /* xattr remove */
1303 #define OBD_MD_FLACL (0x0000008000000000ULL) /* ACL */
1304 #define OBD_MD_FLAGSTATFS (0x0000010000000000ULL) /* aggregated statfs */
1305 /* OBD_MD_FLMDSCAPA (0x0000020000000000ULL) obsolete 2.7.54 */
1306 /* OBD_MD_FLOSSCAPA (0x0000040000000000ULL) obsolete 2.7.54 */
1307 /* OBD_MD_FLCKSPLIT (0x0000080000000000ULL) obsolete 2.3.58*/
1308 #define OBD_MD_FLCROSSREF (0x0000100000000000ULL) /* Cross-ref case */
1309 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1310 * under lock; for xattr
1311 * requests means the
1312 * client holds the lock */
1313 #define OBD_MD_FLOBJCOUNT (0x0000400000000000ULL) /* for multiple destroy */
1315 #define OBD_MD_FLDATAVERSION (0x0010000000000000ULL) /* iversion sum */
1316 #define OBD_MD_CLOSE_INTENT_EXECED (0x0020000000000000ULL) /* close intent
1319 #define OBD_MD_DEFAULT_MEA (0x0040000000000000ULL) /* default MEA */
1320 #define OBD_MD_FLOSTLAYOUT (0x0080000000000000ULL) /* contain ost_layout */
1321 #define OBD_MD_FLPROJID (0x0100000000000000ULL) /* project ID */
1322 #define OBD_MD_SECCTX (0x0200000000000000ULL) /* embed security xattr */
1323 #define OBD_MD_FLLAZYSIZE (0x0400000000000000ULL) /* Lazy size */
1324 #define OBD_MD_FLLAZYBLOCKS (0x0800000000000000ULL) /* Lazy blocks */
1325 #define OBD_MD_FLBTIME (0x1000000000000000ULL) /* birth time */
1326 #define OBD_MD_ENCCTX (0x2000000000000000ULL) /* embed encryption ctx */
1328 #define OBD_MD_FLALLQUOTA (OBD_MD_FLUSRQUOTA | \
1329 OBD_MD_FLGRPQUOTA | \
1332 #define OBD_MD_FLGETATTR (OBD_MD_FLID | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1333 OBD_MD_FLCTIME | OBD_MD_FLSIZE | OBD_MD_FLBLKSZ | \
1334 OBD_MD_FLMODE | OBD_MD_FLTYPE | OBD_MD_FLUID | \
1335 OBD_MD_FLGID | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1336 OBD_MD_FLPARENT | OBD_MD_FLRDEV | OBD_MD_FLGROUP | \
1337 OBD_MD_FLPROJID | OBD_MD_FLBTIME)
1339 #define OBD_MD_FLXATTRALL (OBD_MD_FLXATTR | OBD_MD_FLXATTRLS)
1341 /* don't forget obdo_fid which is way down at the bottom so it can
1342 * come after the definition of llog_cookie */
1346 HSS_CLEARMASK = 0x02,
1347 HSS_ARCHIVE_ID = 0x04,
1350 struct hsm_state_set {
1352 __u32 hss_archive_id;
1354 __u64 hss_clearmask;
1357 /* ost_body.data values for OST_BRW */
1359 #define OBD_BRW_READ 0x01
1360 #define OBD_BRW_WRITE 0x02
1361 #define OBD_BRW_RWMASK (OBD_BRW_READ | OBD_BRW_WRITE)
1362 #define OBD_BRW_NDELAY 0x04 /* Non-delay RPC should be issued for
1363 * this page. Non-delay RPCs have bit
1364 * rq_no_delay set. */
1365 #define OBD_BRW_SYNC 0x08 /* this page is a part of synchronous
1366 * transfer and is not accounted in
1368 #define OBD_BRW_CHECK 0x10
1369 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
1370 #define OBD_BRW_GRANTED 0x40 /* the ost manages this */
1371 /* OBD_BRW_NOCACHE is currently neither set nor tested */
1372 #define OBD_BRW_NOCACHE 0x80 /* this page is a part of non-cached IO */
1373 #define OBD_BRW_NOQUOTA 0x100
1374 #define OBD_BRW_SRVLOCK 0x200 /* Client holds no lock over this page */
1375 #define OBD_BRW_ASYNC 0x400 /* Server may delay commit to disk */
1376 #define OBD_BRW_MEMALLOC 0x800 /* Client runs in the "kswapd" context */
1377 #define OBD_BRW_OVER_USRQUOTA 0x1000 /* Running out of user quota */
1378 #define OBD_BRW_OVER_GRPQUOTA 0x2000 /* Running out of group quota */
1379 #define OBD_BRW_SOFT_SYNC 0x4000 /* This flag notifies the server
1380 * that the client is running low on
1381 * space for unstable pages; asking
1382 * it to sync quickly */
1383 #define OBD_BRW_OVER_PRJQUOTA 0x8000 /* Running out of project quota */
1384 #define OBD_BRW_RDMA_ONLY 0x20000 /* RPC contains RDMA-only pages*/
1386 #define OBD_BRW_OVER_ALLQUOTA (OBD_BRW_OVER_USRQUOTA | \
1387 OBD_BRW_OVER_GRPQUOTA | \
1388 OBD_BRW_OVER_PRJQUOTA)
1390 #define OBD_BRW_LOCAL1 0x80000000UL /*
1391 * osd-ldiskfs internal,
1392 * page mapped to real block
1395 #define OBD_BRW_LOCALS (OBD_BRW_LOCAL1)
1397 #define OBD_MAX_GRANT 0x7fffffffUL /* Max grant allowed to one client: 2 GiB */
1399 #define OBD_OBJECT_EOF LUSTRE_EOF
1401 #define OST_MIN_PRECREATE 32
1402 #define OST_MAX_PRECREATE 20000
1405 struct ost_id ioo_oid; /* object ID, if multi-obj BRW */
1406 __u32 ioo_max_brw; /* low 16 bits were o_mode before 2.4,
1407 * now (PTLRPC_BULK_OPS_COUNT - 1) in
1408 * high 16 bits in 2.4 and later */
1409 __u32 ioo_bufcnt; /* number of niobufs for this object */
1412 /* NOTE: IOOBJ_MAX_BRW_BITS defines the _offset_ of the max_brw field in
1413 * ioo_max_brw, NOT the maximum number of bits in PTLRPC_BULK_OPS_BITS.
1414 * That said, ioo_max_brw is a 32-bit field so the limit is also 16 bits. */
1415 #define IOOBJ_MAX_BRW_BITS 16
1416 #define ioobj_max_brw_get(ioo) (((ioo)->ioo_max_brw >> IOOBJ_MAX_BRW_BITS) + 1)
1417 #define ioobj_max_brw_set(ioo, num) \
1418 do { (ioo)->ioo_max_brw = ((num) - 1) << IOOBJ_MAX_BRW_BITS; } while (0)
1420 /* multiple of 8 bytes => can array */
1421 struct niobuf_remote {
1427 /* lock value block communicated between the filter and llite */
1429 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1430 * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1431 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1432 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1433 #define OST_LVB_IS_ERR(blocks) \
1434 ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1435 #define OST_LVB_SET_ERR(blocks, rc) \
1436 do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1437 #define OST_LVB_GET_ERR(blocks) (int)(blocks - OST_LVB_ERR_INIT)
1460 * lquota data structures
1463 #ifndef QUOTABLOCK_BITS
1464 # define QUOTABLOCK_BITS LUSTRE_QUOTABLOCK_BITS
1467 #ifndef QUOTABLOCK_SIZE
1468 # define QUOTABLOCK_SIZE LUSTRE_QUOTABLOCK_SIZE
1472 # define toqb lustre_stoqb
1475 /* The lquota_id structure is an union of all the possible identifier types that
1476 * can be used with quota, this includes:
1479 * - a FID which can be used for per-directory quota in the future */
1481 struct lu_fid qid_fid; /* FID for per-directory quota */
1482 __u64 qid_uid; /* user identifier */
1483 __u64 qid_gid; /* group identifier */
1484 __u64 qid_projid; /* project identifier */
1487 /* quotactl management */
1488 struct obd_quotactl {
1490 __u32 qc_type; /* see Q_* flag below */
1493 struct obd_dqinfo qc_dqinfo;
1494 struct obd_dqblk qc_dqblk;
1495 char qc_poolname[0];
1498 #define Q_COPY(out, in, member) (out)->member = (in)->member
1500 #define QCTL_COPY(out, in) \
1502 Q_COPY(out, in, qc_cmd); \
1503 Q_COPY(out, in, qc_type); \
1504 Q_COPY(out, in, qc_id); \
1505 Q_COPY(out, in, qc_stat); \
1506 Q_COPY(out, in, qc_dqinfo); \
1507 Q_COPY(out, in, qc_dqblk); \
1508 if (LUSTRE_Q_CMD_IS_POOL(in->qc_cmd)) \
1509 memcpy(out->qc_poolname, \
1511 LOV_MAXPOOLNAME + 1); \
1514 /* Body of quota request used for quota acquire/release RPCs between quota
1515 * master (aka QMT) and slaves (ak QSD). */
1517 struct lu_fid qb_fid; /* FID of global index packing the pool ID
1518 * and type (data or metadata) as well as
1519 * the quota type (user or group). */
1520 union lquota_id qb_id; /* uid or gid or directory FID */
1521 __u32 qb_flags; /* see below */
1523 __u64 qb_count; /* acquire/release count (kbytes/inodes) */
1524 __u64 qb_usage; /* current slave usage (kbytes/inodes) */
1525 __u64 qb_slv_ver; /* slave index file version */
1526 struct lustre_handle qb_lockh; /* per-ID lock handle */
1527 struct lustre_handle qb_glb_lockh; /* global lock handle */
1528 __u64 qb_padding1[4];
1531 /* When the quota_body is used in the reply of quota global intent
1532 * lock (IT_QUOTA_CONN) reply, qb_fid contains slave index file FID. */
1533 #define qb_slv_fid qb_fid
1534 /* qb_usage is the current qunit (in kbytes/inodes) when quota_body is used in
1536 #define qb_qunit qb_usage
1538 #define QUOTA_DQACQ_FL_ACQ 0x1 /* acquire quota */
1539 #define QUOTA_DQACQ_FL_PREACQ 0x2 /* pre-acquire */
1540 #define QUOTA_DQACQ_FL_REL 0x4 /* release quota */
1541 #define QUOTA_DQACQ_FL_REPORT 0x8 /* report usage */
1543 /* Quota types currently supported */
1545 LQUOTA_TYPE_USR = 0x00, /* maps to USRQUOTA */
1546 LQUOTA_TYPE_GRP = 0x01, /* maps to GRPQUOTA */
1547 LQUOTA_TYPE_PRJ = 0x02, /* maps to PRJQUOTA */
1551 /* There are 2 different resource types on which a quota limit can be enforced:
1552 * - inodes on the MDTs
1553 * - blocks on the OSTs */
1555 LQUOTA_RES_MD = 0x01, /* skip 0 to avoid null oid in FID */
1556 LQUOTA_RES_DT = 0x02,
1558 LQUOTA_FIRST_RES = LQUOTA_RES_MD
1560 #define LQUOTA_NR_RES (LQUOTA_LAST_RES - LQUOTA_FIRST_RES + 1)
1563 * Space accounting support
1564 * Format of an accounting record, providing disk usage information for a given
1567 struct lquota_acct_rec { /* 16 bytes */
1568 __u64 bspace; /* current space in use */
1569 __u64 ispace; /* current # inodes in use */
1573 * Global quota index support
1574 * Format of a global record, providing global quota settings for a given quota
1577 struct lquota_glb_rec { /* 32 bytes */
1578 __u64 qbr_hardlimit; /* quota hard limit, in #inodes or kbytes */
1579 __u64 qbr_softlimit; /* quota soft limit, in #inodes or kbytes */
1580 __u64 qbr_time; /* grace time, in seconds */
1581 __u64 qbr_granted; /* how much is granted to slaves, in #inodes or
1586 * Slave index support
1587 * Format of a slave record, recording how much space is granted to a given
1590 struct lquota_slv_rec { /* 8 bytes */
1591 __u64 qsr_granted; /* space granted to the slave for the key=ID,
1592 * in #inodes or kbytes */
1595 /* Data structures associated with the quota locks */
1597 /* Glimpse descriptor used for the index & per-ID quota locks */
1598 struct ldlm_gl_lquota_desc {
1599 union lquota_id gl_id; /* quota ID subject to the glimpse */
1600 __u64 gl_flags; /* see LQUOTA_FL* below */
1601 __u64 gl_ver; /* new index version */
1602 __u64 gl_hardlimit; /* new hardlimit or qunit value */
1603 __u64 gl_softlimit; /* new softlimit */
1607 #define gl_qunit gl_hardlimit /* current qunit value used when
1608 * glimpsing per-ID quota locks */
1610 /* quota glimpse flags */
1611 #define LQUOTA_FL_EDQUOT 0x1 /* user/group out of quota space on QMT */
1613 /* LVB used with quota (global and per-ID) locks */
1615 __u64 lvb_flags; /* see LQUOTA_FL* above */
1616 __u64 lvb_id_may_rel; /* space that might be released later */
1617 __u64 lvb_id_rel; /* space released by the slave for this ID */
1618 __u64 lvb_id_qunit; /* current qunit value */
1622 /* LVB used with global quota lock */
1623 #define lvb_glb_ver lvb_id_may_rel /* current version of the global index */
1631 #define QUOTA_FIRST_OPC QUOTA_DQACQ
1640 MDS_GETATTR_NAME = 34,
1645 MDS_DISCONNECT = 39,
1648 MDS_PIN = 42, /* obsolete, never used in a release */
1649 MDS_UNPIN = 43, /* obsolete, never used in a release */
1651 MDS_DONE_WRITING = 45, /* obsolete since 2.8.0 */
1653 MDS_QUOTACHECK = 47, /* not used since 2.4 */
1656 MDS_SETXATTR = 50, /* obsolete, now it's MDS_REINT op */
1658 MDS_IS_SUBDIR = 52, /* obsolete, never used in a release */
1660 MDS_HSM_STATE_GET = 54,
1661 MDS_HSM_STATE_SET = 55,
1662 MDS_HSM_ACTION = 56,
1663 MDS_HSM_PROGRESS = 57,
1664 MDS_HSM_REQUEST = 58,
1665 MDS_HSM_CT_REGISTER = 59,
1666 MDS_HSM_CT_UNREGISTER = 60,
1667 MDS_SWAP_LAYOUTS = 61,
1672 #define MDS_FIRST_OPC MDS_GETATTR
1675 /* opcodes for object update */
1681 #define OUT_UPDATE_FIRST_OPC OUT_UPDATE
1701 /* the disposition of the intent outlines what was executed */
1702 #define DISP_IT_EXECD 0x00000001
1703 #define DISP_LOOKUP_EXECD 0x00000002
1704 #define DISP_LOOKUP_NEG 0x00000004
1705 #define DISP_LOOKUP_POS 0x00000008
1706 #define DISP_OPEN_CREATE 0x00000010
1707 #define DISP_OPEN_OPEN 0x00000020
1708 #define DISP_ENQ_COMPLETE 0x00400000 /* obsolete and unused */
1709 #define DISP_ENQ_OPEN_REF 0x00800000
1710 #define DISP_ENQ_CREATE_REF 0x01000000
1711 #define DISP_OPEN_LOCK 0x02000000
1712 #define DISP_OPEN_LEASE 0x04000000
1713 #define DISP_OPEN_STRIPE 0x08000000
1714 #define DISP_OPEN_DENY 0x10000000
1716 /* INODE LOCK PARTS */
1717 enum mds_ibits_locks {
1718 MDS_INODELOCK_LOOKUP = 0x000001, /* For namespace, dentry etc. Was
1719 * used to protect permission (mode,
1720 * owner, group, etc) before 2.4. */
1721 MDS_INODELOCK_UPDATE = 0x000002, /* size, links, timestamps */
1722 MDS_INODELOCK_OPEN = 0x000004, /* For opened files */
1723 MDS_INODELOCK_LAYOUT = 0x000008, /* for layout */
1725 /* The PERM bit is added in 2.4, and is used to protect permission
1726 * (mode, owner, group, ACL, etc.) separate from LOOKUP lock.
1727 * For remote directories (in DNE) these locks will be granted by
1728 * different MDTs (different LDLM namespace).
1730 * For local directory, the MDT always grants UPDATE|PERM together.
1731 * For remote directory, master MDT (where remote directory is) grants
1732 * UPDATE|PERM, and remote MDT (where name entry is) grants LOOKUP_LOCK.
1734 MDS_INODELOCK_PERM = 0x000010,
1735 MDS_INODELOCK_XATTR = 0x000020, /* non-permission extended attrs */
1736 MDS_INODELOCK_DOM = 0x000040, /* Data for Data-on-MDT files */
1737 /* Do not forget to increase MDS_INODELOCK_NUMBITS when adding bits */
1739 #define MDS_INODELOCK_NUMBITS 7
1740 /* This FULL lock is useful to take on unlink sort of operations */
1741 #define MDS_INODELOCK_FULL ((1 << MDS_INODELOCK_NUMBITS) - 1)
1742 /* DOM lock shouldn't be canceled early, use this macro for ELC */
1743 #define MDS_INODELOCK_ELC (MDS_INODELOCK_FULL & ~MDS_INODELOCK_DOM)
1745 /* NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
1746 * but was moved into name[1] along with the OID to avoid consuming the
1747 * name[2,3] fields that need to be used for the quota id (also a FID). */
1749 LUSTRE_RES_ID_SEQ_OFF = 0,
1750 LUSTRE_RES_ID_VER_OID_OFF = 1,
1751 LUSTRE_RES_ID_WAS_VER_OFF = 2, /* see note above */
1752 LUSTRE_RES_ID_QUOTA_SEQ_OFF = 2,
1753 LUSTRE_RES_ID_QUOTA_VER_OID_OFF = 3,
1754 LUSTRE_RES_ID_HSH_OFF = 3
1757 #define MDS_STATUS_CONN 1
1758 #define MDS_STATUS_LOV 2
1761 /* these should be identical to their EXT4_*_FL counterparts, they are
1762 * redefined here only to avoid dragging in fs/ext4/ext4.h */
1763 LUSTRE_SYNC_FL = 0x00000008, /* Synchronous updates */
1764 LUSTRE_IMMUTABLE_FL = 0x00000010, /* Immutable file */
1765 LUSTRE_APPEND_FL = 0x00000020, /* file writes may only append */
1766 LUSTRE_NODUMP_FL = 0x00000040, /* do not dump file */
1767 LUSTRE_NOATIME_FL = 0x00000080, /* do not update atime */
1768 LUSTRE_INDEX_FL = 0x00001000, /* hash-indexed directory */
1769 LUSTRE_DIRSYNC_FL = 0x00010000, /* dirsync behaviour (dir only) */
1770 LUSTRE_TOPDIR_FL = 0x00020000, /* Top of directory hierarchies*/
1771 LUSTRE_INLINE_DATA_FL = 0x10000000, /* Inode has inline data. */
1772 LUSTRE_PROJINHERIT_FL = 0x20000000, /* Create with parents projid */
1774 /* These flags will not be identical to any EXT4_*_FL counterparts,
1775 * and only reserved for lustre purpose. Note: these flags might
1776 * be conflict with some of EXT4 flags, so
1777 * 1. these conflict flags needs to be removed when the flag is
1778 * wired by la_flags see osd_attr_get().
1779 * 2. If these flags needs to be stored into inode, they will be
1780 * stored in LMA. see LMAI_XXXX */
1781 LUSTRE_ORPHAN_FL = 0x00002000,
1782 LUSTRE_SET_SYNC_FL = 0x00040000, /* Synchronous setattr on OSTs */
1783 LUSTRE_ENCRYPT_FL = 0x00800000, /* encrypted file */
1785 LUSTRE_LMA_FL_MASKS = LUSTRE_ENCRYPT_FL | LUSTRE_ORPHAN_FL,
1788 #ifndef FS_XFLAG_SYNC
1789 #define FS_XFLAG_SYNC 0x00000020 /* all writes synchronous */
1791 #ifndef FS_XFLAG_NOATIME
1792 #define FS_XFLAG_NOATIME 0x00000040 /* do not update access time */
1794 #ifndef FS_XFLAG_IMMUTABLE
1795 #define FS_XFLAG_IMMUTABLE 0x00000008 /* file cannot be modified */
1797 #ifndef FS_XFLAG_APPEND
1798 #define FS_XFLAG_APPEND 0x00000010 /* all writes append */
1800 #ifndef FS_XFLAG_PROJINHERIT
1801 #define FS_XFLAG_PROJINHERIT 0x00000200 /* create with parents projid */
1804 /* 64 possible states */
1805 enum md_transient_state {
1806 MS_RESTORE = (1 << 0), /* restore is running */
1810 struct lu_fid mbo_fid1;
1811 struct lu_fid mbo_fid2;
1812 struct lustre_handle mbo_open_handle;
1814 __u64 mbo_size; /* Offset, in the case of MDS_READPAGE */
1818 __u64 mbo_blocks; /* XID, in the case of MDS_READPAGE */
1819 __u64 mbo_version; /* was mbo_ioepoch before 2.11 */
1820 __u64 mbo_t_state; /* transient file state defined in
1821 * enum md_transient_state
1822 * was "ino" until 2.4.0 */
1825 __u32 mbo_capability;
1829 __u32 mbo_flags; /* LUSTRE_*_FL file attributes */
1831 __u32 mbo_nlink; /* #bytes to read in the case of MDS_READPAGE */
1832 __u32 mbo_layout_gen; /* was "generation" until 2.4.0 */
1834 __u32 mbo_eadatasize;
1836 __u32 mbo_max_mdsize;
1837 __u32 mbo_unused3; /* was max_cookiesize until 2.8 */
1838 __u32 mbo_uid_h; /* high 32-bits of uid, for FUID */
1839 __u32 mbo_gid_h; /* high 32-bits of gid, for FUID */
1841 __u64 mbo_dom_size; /* size of DOM component */
1842 __u64 mbo_dom_blocks; /* blocks consumed by DOM component */
1844 __u64 mbo_padding_9; /* also fix lustre_swab_mdt_body */
1845 __u64 mbo_padding_10;
1848 struct mdt_ioepoch {
1849 struct lustre_handle mio_open_handle;
1850 __u64 mio_unused1; /* was ioepoch */
1851 __u32 mio_unused2; /* was flags */
1855 /* permissions for md_perm.mp_perm */
1857 CFS_SETUID_PERM = 0x01,
1858 CFS_SETGID_PERM = 0x02,
1859 CFS_SETGRP_PERM = 0x04,
1862 struct mdt_rec_setattr {
1872 __u32 sa_padding_1_h;
1873 struct lu_fid sa_fid;
1882 __u32 sa_attr_flags;
1884 __u32 sa_bias; /* some operation flags */
1891 * Attribute flags used in mdt_rec_setattr::sa_valid.
1892 * The kernel's #defines for ATTR_* should not be used over the network
1893 * since the client and MDS may run different kernels (see bug 13828)
1894 * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1896 #define MDS_ATTR_MODE 0x1ULL /* = 1 */
1897 #define MDS_ATTR_UID 0x2ULL /* = 2 */
1898 #define MDS_ATTR_GID 0x4ULL /* = 4 */
1899 #define MDS_ATTR_SIZE 0x8ULL /* = 8 */
1900 #define MDS_ATTR_ATIME 0x10ULL /* = 16 */
1901 #define MDS_ATTR_MTIME 0x20ULL /* = 32 */
1902 #define MDS_ATTR_CTIME 0x40ULL /* = 64 */
1903 #define MDS_ATTR_ATIME_SET 0x80ULL /* = 128 */
1904 #define MDS_ATTR_MTIME_SET 0x100ULL /* = 256 */
1905 #define MDS_ATTR_FORCE 0x200ULL /* = 512, Not a change, but a change it */
1906 #define MDS_ATTR_ATTR_FLAG 0x400ULL /* = 1024 */
1907 #define MDS_ATTR_KILL_SUID 0x800ULL /* = 2048 */
1908 #define MDS_ATTR_KILL_SGID 0x1000ULL /* = 4096 */
1909 #define MDS_ATTR_CTIME_SET 0x2000ULL /* = 8192 */
1910 #define MDS_ATTR_FROM_OPEN 0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
1911 #define MDS_ATTR_BLOCKS 0x8000ULL /* = 32768 */
1912 #define MDS_ATTR_PROJID 0x10000ULL /* = 65536 */
1913 #define MDS_ATTR_LSIZE 0x20000ULL /* = 131072 */
1914 #define MDS_ATTR_LBLOCKS 0x40000ULL /* = 262144 */
1915 #define MDS_ATTR_OVERRIDE 0x2000000ULL /* = 33554432 */
1918 /* MDS_CHECK_SPLIT = 1 << 0, obsolete before 2.3.58 */
1919 MDS_CROSS_REF = 1 << 1,
1920 /* MDS_VTX_BYPASS = 1 << 2, obsolete since 2.3.54 */
1921 MDS_PERM_BYPASS = 1 << 3,
1922 /* MDS_SOM = 1 << 4, obsolete since 2.8.0 */
1923 MDS_QUOTA_IGNORE = 1 << 5,
1924 /* MDS_CLOSE_CLEANUP = 1 << 6, obsolete since 2.3.51 */
1925 MDS_KEEP_ORPHAN = 1 << 7,
1926 MDS_RECOV_OPEN = 1 << 8,
1927 MDS_DATA_MODIFIED = 1 << 9,
1928 MDS_CREATE_VOLATILE = 1 << 10,
1929 MDS_OWNEROVERRIDE = 1 << 11,
1930 MDS_HSM_RELEASE = 1 << 12,
1931 MDS_CLOSE_MIGRATE = 1 << 13,
1932 MDS_CLOSE_LAYOUT_SWAP = 1 << 14,
1933 MDS_CLOSE_LAYOUT_MERGE = 1 << 15,
1934 MDS_CLOSE_RESYNC_DONE = 1 << 16,
1935 MDS_CLOSE_LAYOUT_SPLIT = 1 << 17,
1936 MDS_TRUNC_KEEP_LEASE = 1 << 18,
1937 MDS_PCC_ATTACH = 1 << 19,
1938 MDS_CLOSE_UPDATE_TIMES = 1 << 20,
1941 #define MDS_CLOSE_INTENT (MDS_HSM_RELEASE | MDS_CLOSE_LAYOUT_SWAP | \
1942 MDS_CLOSE_LAYOUT_MERGE | MDS_CLOSE_LAYOUT_SPLIT | \
1943 MDS_CLOSE_RESYNC_DONE)
1945 /* instance of mdt_reint_rec */
1946 struct mdt_rec_create {
1954 __u32 cr_suppgid1_h;
1956 __u32 cr_suppgid2_h;
1957 struct lu_fid cr_fid1;
1958 struct lu_fid cr_fid2;
1959 struct lustre_handle cr_open_handle_old; /* in case of open replay */
1963 __u32 cr_archive_id;
1966 __u64 cr_padding_1; /* rr_blocks */
1969 /* use of helpers set/get_mrc_cr_flags() is needed to access
1970 * 64 bits cr_flags [cr_flags_l, cr_flags_h], this is done to
1971 * extend cr_flags size without breaking 1.8 compat */
1972 __u32 cr_flags_l; /* for use with open, low 32 bits */
1973 __u32 cr_flags_h; /* for use with open, high 32 bits */
1974 __u32 cr_umask; /* umask for create */
1975 __u32 cr_padding_4; /* rr_padding_4 */
1978 /* instance of mdt_reint_rec */
1979 struct mdt_rec_link {
1987 __u32 lk_suppgid1_h;
1989 __u32 lk_suppgid2_h;
1990 struct lu_fid lk_fid1;
1991 struct lu_fid lk_fid2;
1993 __u64 lk_padding_1; /* rr_atime */
1994 __u64 lk_padding_2; /* rr_ctime */
1995 __u64 lk_padding_3; /* rr_size */
1996 __u64 lk_padding_4; /* rr_blocks */
1998 __u32 lk_padding_5; /* rr_mode */
1999 __u32 lk_padding_6; /* rr_flags */
2000 __u32 lk_padding_7; /* rr_padding_2 */
2001 __u32 lk_padding_8; /* rr_padding_3 */
2002 __u32 lk_padding_9; /* rr_padding_4 */
2005 /* instance of mdt_reint_rec */
2006 struct mdt_rec_unlink {
2014 __u32 ul_suppgid1_h;
2016 __u32 ul_suppgid2_h;
2017 struct lu_fid ul_fid1;
2018 struct lu_fid ul_fid2;
2020 __u64 ul_padding_2; /* rr_atime */
2021 __u64 ul_padding_3; /* rr_ctime */
2022 __u64 ul_padding_4; /* rr_size */
2023 __u64 ul_padding_5; /* rr_blocks */
2026 __u32 ul_padding_6; /* rr_flags */
2027 __u32 ul_padding_7; /* rr_padding_2 */
2028 __u32 ul_padding_8; /* rr_padding_3 */
2029 __u32 ul_padding_9; /* rr_padding_4 */
2032 /* instance of mdt_reint_rec */
2033 struct mdt_rec_rename {
2041 __u32 rn_suppgid1_h;
2043 __u32 rn_suppgid2_h;
2044 struct lu_fid rn_fid1;
2045 struct lu_fid rn_fid2;
2047 __u64 rn_padding_1; /* rr_atime */
2048 __u64 rn_padding_2; /* rr_ctime */
2049 __u64 rn_padding_3; /* rr_size */
2050 __u64 rn_padding_4; /* rr_blocks */
2051 __u32 rn_bias; /* some operation flags */
2052 __u32 rn_mode; /* cross-ref rename has mode */
2053 __u32 rn_padding_5; /* rr_flags */
2054 __u32 rn_padding_6; /* rr_padding_2 */
2055 __u32 rn_padding_7; /* rr_padding_3 */
2056 __u32 rn_padding_8; /* rr_padding_4 */
2059 /* instance of mdt_reint_rec */
2060 struct mdt_rec_setxattr {
2068 __u32 sx_suppgid1_h;
2070 __u32 sx_suppgid2_h;
2071 struct lu_fid sx_fid;
2072 __u64 sx_padding_1; /* These three are rr_fid2 */
2077 __u64 sx_padding_5; /* rr_ctime */
2078 __u64 sx_padding_6; /* rr_size */
2079 __u64 sx_padding_7; /* rr_blocks */
2082 __u32 sx_padding_8; /* rr_flags */
2083 __u32 sx_padding_9; /* rr_padding_2 */
2084 __u32 sx_padding_10; /* rr_padding_3 */
2085 __u32 sx_padding_11; /* rr_padding_4 */
2088 /* instance of mdt_reint_rec
2089 * FLR: for file resync MDS_REINT_RESYNC RPC. */
2090 struct mdt_rec_resync {
2098 __u32 rs_suppgid1_h;
2100 __u32 rs_suppgid2_h;
2101 struct lu_fid rs_fid;
2102 __u8 rs_padding0[sizeof(struct lu_fid)];
2103 struct lustre_handle rs_lease_handle; /* rr_mtime */
2104 __s64 rs_padding1; /* rr_atime */
2105 __s64 rs_padding2; /* rr_ctime */
2106 __u64 rs_padding3; /* rr_size */
2107 __u64 rs_padding4; /* rr_blocks */
2109 __u32 rs_padding5; /* rr_mode */
2110 __u32 rs_padding6; /* rr_flags */
2111 __u32 rs_padding7; /* rr_flags_h */
2112 __u32 rs_padding8; /* rr_umask */
2114 __u16 rs_padding9; /* rr_padding_4 */
2118 * mdt_rec_reint is the template for all mdt_reint_xxx structures.
2119 * Do NOT change the size of various members, otherwise the value
2120 * will be broken in lustre_swab_mdt_rec_reint().
2122 * If you add new members in other mdt_reint_xxx structres and need to use the
2123 * rr_padding_x fields, then update lustre_swab_mdt_rec_reint() also.
2125 struct mdt_rec_reint {
2133 __u32 rr_suppgid1_h;
2135 __u32 rr_suppgid2_h;
2136 struct lu_fid rr_fid1;
2137 struct lu_fid rr_fid2;
2149 __u16 rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
2152 #define LMV_DESC_QOS_MAXAGE_DEFAULT 60 /* Seconds */
2154 /* lmv structures */
2156 __u32 ld_tgt_count; /* how many MDS's */
2157 __u32 ld_active_tgt_count; /* how many active */
2158 __u32 ld_default_stripe_count; /* how many objects are used */
2159 __u32 ld_pattern; /* default hash pattern */
2160 __u64 ld_default_hash_size;
2161 __u64 ld_padding_1; /* also fix lustre_swab_lmv_desc */
2162 __u32 ld_padding_2; /* also fix lustre_swab_lmv_desc */
2163 __u32 ld_qos_maxage; /* in second */
2164 __u32 ld_padding_3; /* also fix lustre_swab_lmv_desc */
2165 __u32 ld_padding_4; /* also fix lustre_swab_lmv_desc */
2166 struct obd_uuid ld_uuid;
2169 /* LMV layout EA, and it will be stored both in master and slave object */
2170 struct lmv_mds_md_v1 {
2172 __u32 lmv_stripe_count;
2173 __u32 lmv_master_mdt_index; /* On master object, it is master
2174 * MDT index, on slave object, it
2175 * is stripe index of the slave obj */
2176 __u32 lmv_hash_type; /* dir stripe policy, i.e. indicate
2177 * which hash function to be used,
2178 * Note: only lower 16 bits is being
2179 * used for now. Higher 16 bits will
2180 * be used to mark the object status,
2181 * for example migrating or dead. */
2182 __u32 lmv_layout_version; /* increased each time layout changed,
2183 * by directory migration, restripe
2185 __u32 lmv_migrate_offset; /* once this is set, it means this
2186 * directory is been migrated, stripes
2187 * before this offset belong to target,
2188 * from this to source. */
2189 __u32 lmv_migrate_hash; /* hash type of source stripes of
2190 * migrating directory */
2193 char lmv_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
2194 struct lu_fid lmv_stripe_fids[0]; /* FIDs for each stripe */
2197 #define LMV_DEBUG(mask, lmv, msg) \
2199 "%s LMV: magic=%#x count=%u index=%u hash=%#x version=%u migrate offset=%u migrate hash=%u.\n", \
2200 msg, (lmv)->lmv_magic, (lmv)->lmv_stripe_count, \
2201 (lmv)->lmv_master_mdt_index, (lmv)->lmv_hash_type, \
2202 (lmv)->lmv_layout_version, (lmv)->lmv_migrate_offset, \
2203 (lmv)->lmv_migrate_hash)
2205 /* stripe count before directory split */
2206 #define lmv_split_offset lmv_migrate_offset
2207 /* stripe count after directory merge */
2208 #define lmv_merge_offset lmv_migrate_offset
2209 /* directory hash type after merge */
2210 #define lmv_merge_hash lmv_migrate_hash
2212 /* foreign LMV EA */
2213 struct lmv_foreign_md {
2214 __u32 lfm_magic; /* magic number = LMV_MAGIC_FOREIGN */
2215 __u32 lfm_length; /* length of lfm_value */
2216 __u32 lfm_type; /* type, see LU_FOREIGN_TYPE_ */
2217 __u32 lfm_flags; /* flags, type specific */
2218 char lfm_value[]; /* free format value */
2221 #define LMV_MAGIC_V1 0x0CD20CD0 /* normal stripe lmv magic */
2222 #define LMV_MAGIC LMV_MAGIC_V1
2224 /* #define LMV_USER_MAGIC 0x0CD30CD0 */
2225 #define LMV_MAGIC_STRIPE 0x0CD40CD0 /* magic for dir sub_stripe */
2226 #define LMV_MAGIC_FOREIGN 0x0CD50CD0 /* magic for lmv foreign */
2229 * The FNV-1a hash algorithm is as follows:
2230 * hash = FNV_offset_basis
2231 * for each octet_of_data to be hashed
2232 * hash = hash XOR octet_of_data
2233 * hash = hash × FNV_prime
2235 * http://en.wikipedia.org/wiki/Fowler–Noll–Vo_hash_function#FNV-1a_hash
2237 * http://www.isthe.com/chongo/tech/comp/fnv/index.html#FNV-reference-source
2238 * FNV_prime is 2^40 + 2^8 + 0xb3 = 0x100000001b3ULL
2240 #define LUSTRE_FNV_1A_64_PRIME 0x100000001b3ULL
2241 #define LUSTRE_FNV_1A_64_OFFSET_BIAS 0xcbf29ce484222325ULL
2242 static inline __u64 lustre_hash_fnv_1a_64(const void *buf, __kernel_size_t size)
2244 __u64 hash = LUSTRE_FNV_1A_64_OFFSET_BIAS;
2245 const unsigned char *p = buf;
2248 for (i = 0; i < size; i++) {
2250 hash *= LUSTRE_FNV_1A_64_PRIME;
2256 /* CRUSH placement group count */
2257 #define LMV_CRUSH_PG_COUNT 4096
2261 struct lmv_mds_md_v1 lmv_md_v1;
2262 struct lmv_user_md lmv_user_md;
2263 struct lmv_foreign_md lmv_foreign_md;
2266 static inline __kernel_ssize_t lmv_mds_md_size(int stripe_count,
2267 unsigned int lmm_magic)
2269 __kernel_ssize_t len = -EINVAL;
2271 switch (lmm_magic) {
2272 case LMV_MAGIC_V1: {
2273 struct lmv_mds_md_v1 *lmm1;
2275 len = sizeof(*lmm1);
2276 len += stripe_count * sizeof(lmm1->lmv_stripe_fids[0]);
2284 static inline int lmv_mds_md_stripe_count_get(const union lmv_mds_md *lmm)
2286 switch (__le32_to_cpu(lmm->lmv_magic)) {
2288 return __le32_to_cpu(lmm->lmv_md_v1.lmv_stripe_count);
2289 case LMV_USER_MAGIC:
2290 return __le32_to_cpu(lmm->lmv_user_md.lum_stripe_count);
2296 static inline int lmv_mds_md_hash_type_get(const union lmv_mds_md *lmm)
2298 switch (__le32_to_cpu(lmm->lmv_magic)) {
2300 return __le32_to_cpu(lmm->lmv_md_v1.lmv_hash_type);
2301 case LMV_USER_MAGIC:
2302 return __le32_to_cpu(lmm->lmv_user_md.lum_hash_type);
2312 FLD_FIRST_OPC = FLD_QUERY
2318 SEQ_FIRST_OPC = SEQ_QUERY
2322 SEQ_ALLOC_SUPER = 0,
2334 LFSCK_NOTIFY = 1101,
2337 LFSCK_FIRST_OPC = LFSCK_NOTIFY
2341 * LOV data structures
2344 #define LOV_MAX_UUID_BUFFER_SIZE 8192
2345 /* The size of the buffer the lov/mdc reserves for the
2346 * array of UUIDs returned by the MDS. With the current
2347 * protocol, this will limit the max number of OSTs per LOV */
2349 #define LOV_DESC_MAGIC 0xB0CCDE5C
2350 #define LOV_DESC_QOS_MAXAGE_DEFAULT 5 /* Seconds */
2351 #define LOV_DESC_STRIPE_SIZE_DEFAULT (1 << LNET_MTU_BITS)
2353 /* LOV settings descriptor (should only contain static info) */
2355 __u32 ld_tgt_count; /* how many OBD's */
2356 __u32 ld_active_tgt_count; /* how many active */
2357 __s32 ld_default_stripe_count; /* how many objects are used */
2358 __u32 ld_pattern; /* default PATTERN_RAID0 */
2359 __u64 ld_default_stripe_size; /* in bytes */
2360 __s64 ld_default_stripe_offset; /* starting OST index */
2361 __u32 ld_padding_0; /* unused */
2362 __u32 ld_qos_maxage; /* in second */
2363 __u32 ld_padding_1; /* also fix lustre_swab_lov_desc */
2364 __u32 ld_padding_2; /* also fix lustre_swab_lov_desc */
2365 struct obd_uuid ld_uuid;
2368 #define ld_magic ld_active_tgt_count /* for swabbing from llogs */
2373 /* opcodes -- MUST be distinct from OST/MDS opcodes */
2378 LDLM_BL_CALLBACK = 104,
2379 LDLM_CP_CALLBACK = 105,
2380 LDLM_GL_CALLBACK = 106,
2381 LDLM_SET_INFO = 107,
2384 #define LDLM_FIRST_OPC LDLM_ENQUEUE
2386 #define RES_NAME_SIZE 4
2387 struct ldlm_res_id {
2388 __u64 name[RES_NAME_SIZE];
2391 #define DLDLMRES "[%#llx:%#llx:%#llx].%#llx"
2392 #define PLDLMRES(res) (unsigned long long)(res)->lr_name.name[0], \
2393 (unsigned long long)(res)->lr_name.name[1], \
2394 (unsigned long long)(res)->lr_name.name[2], \
2395 (unsigned long long)(res)->lr_name.name[3]
2411 #define LCK_MODE_NUM 8
2421 #define LDLM_MIN_TYPE LDLM_PLAIN
2423 struct ldlm_extent {
2429 static inline bool ldlm_extent_equal(const struct ldlm_extent *ex1,
2430 const struct ldlm_extent *ex2)
2432 return ex1->start == ex2->start && ex1->end == ex2->end;
2435 struct ldlm_inodebits {
2438 __u64 try_bits; /* optional bits to try */
2439 __u64 cancel_bits; /* for lock convert */
2444 struct ldlm_flock_wire {
2452 /* it's important that the fields of the ldlm_extent structure match
2453 * the first fields of the ldlm_flock structure because there is only
2454 * one ldlm_swab routine to process the ldlm_policy_data_t union. if
2455 * this ever changes we will need to swab the union differently based
2456 * on the resource type. */
2458 union ldlm_wire_policy_data {
2459 struct ldlm_extent l_extent;
2460 struct ldlm_flock_wire l_flock;
2461 struct ldlm_inodebits l_inodebits;
2464 struct barrier_lvb {
2470 struct ldlm_gl_barrier_desc {
2476 union ldlm_gl_desc {
2477 struct ldlm_gl_lquota_desc lquota_desc;
2478 struct ldlm_gl_barrier_desc barrier_desc;
2481 enum ldlm_intent_flags {
2482 IT_OPEN = 0x00000001,
2483 IT_CREAT = 0x00000002,
2484 IT_OPEN_CREAT = IT_OPEN | IT_CREAT, /* To allow case label. */
2485 IT_READDIR = 0x00000004, /* Used by mdc, not put on the wire. */
2486 IT_GETATTR = 0x00000008,
2487 IT_LOOKUP = 0x00000010,
2488 /* IT_UNLINK = 0x00000020, Obsolete. */
2489 /* IT_TRUNC = 0x00000040, Obsolete. */
2490 IT_GETXATTR = 0x00000080,
2491 /* IT_EXEC = 0x00000100, Obsolete. */
2492 /* IT_PIN = 0x00000200, Obsolete. */
2493 IT_LAYOUT = 0x00000400,
2494 IT_QUOTA_DQACQ = 0x00000800,
2495 IT_QUOTA_CONN = 0x00001000,
2496 /* IT_SETXATTR = 0x00002000, Obsolete. */
2497 IT_GLIMPSE = 0x00004000,
2498 IT_BRW = 0x00008000,
2501 struct ldlm_intent {
2505 struct ldlm_resource_desc {
2506 enum ldlm_type lr_type;
2507 __u32 lr_pad; /* also fix lustre_swab_ldlm_resource_desc */
2508 struct ldlm_res_id lr_name;
2511 struct ldlm_lock_desc {
2512 struct ldlm_resource_desc l_resource;
2513 enum ldlm_mode l_req_mode;
2514 enum ldlm_mode l_granted_mode;
2515 union ldlm_wire_policy_data l_policy_data;
2518 #define LDLM_LOCKREQ_HANDLES 2
2519 #define LDLM_ENQUEUE_CANCEL_OFF 1
2521 struct ldlm_request {
2522 __u32 lock_flags; /* LDLM_FL_*, see lustre_dlm_flags.h */
2523 __u32 lock_count; /* number of locks in lock_handle[] */
2524 struct ldlm_lock_desc lock_desc;/* lock descriptor */
2525 struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
2530 __u32 lock_padding; /* also fix lustre_swab_ldlm_reply */
2531 struct ldlm_lock_desc lock_desc;
2532 struct lustre_handle lock_handle;
2533 __u64 lock_policy_res1;
2534 __u64 lock_policy_res2;
2537 #define ldlm_flags_to_wire(flags) ((__u32)(flags))
2538 #define ldlm_flags_from_wire(flags) ((__u64)(flags))
2541 * Opcodes for mountconf (mgs and mgc)
2545 MGS_DISCONNECT = 251,
2546 MGS_EXCEPTION = 252, /* node died, etc. */
2547 MGS_TARGET_REG = 253, /* whenever target starts up */
2548 MGS_TARGET_DEL = 254,
2550 MGS_CONFIG_READ = 256,
2552 MGS_FIRST_OPC = MGS_CONNECT
2555 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 18, 53, 0)
2556 #define MGS_PARAM_MAXLEN 1024
2557 #define KEY_SET_INFO "set_info"
2559 struct mgs_send_param {
2560 char mgs_param[MGS_PARAM_MAXLEN];
2564 /* We pass this info to the MGS so it can write config logs */
2565 #define MTI_NAME_MAXLEN 64
2566 #define MTI_PARAM_MAXLEN 4096
2567 #define MTI_NIDS_MAX 32
2568 struct mgs_target_info {
2569 __u32 mti_lustre_ver;
2570 __u32 mti_stripe_index;
2571 __u32 mti_config_ver;
2572 __u32 mti_flags; /* LDD_F_* */
2573 __u32 mti_nid_count;
2574 __u32 mti_instance; /* Running instance of target */
2575 char mti_fsname[MTI_NAME_MAXLEN];
2576 char mti_svname[MTI_NAME_MAXLEN];
2577 char mti_uuid[sizeof(struct obd_uuid)];
2578 __u64 mti_nids[MTI_NIDS_MAX]; /* host nids (lnet_nid_t) */
2579 char mti_params[MTI_PARAM_MAXLEN];
2582 struct mgs_nidtbl_entry {
2583 __u64 mne_version; /* table version of this entry */
2584 __u32 mne_instance; /* target instance # */
2585 __u32 mne_index; /* target index */
2586 __u32 mne_length; /* length of this entry - by bytes */
2587 __u8 mne_type; /* target type LDD_F_SV_TYPE_OST/MDT */
2588 __u8 mne_nid_type; /* type of nid(mbz). for ipv6. */
2589 __u8 mne_nid_size; /* size of each NID, by bytes */
2590 __u8 mne_nid_count; /* # of NIDs in buffer */
2592 lnet_nid_t nids[0]; /* variable size buffer for NIDs. */
2597 CONFIG_T_CONFIG = 0,
2598 CONFIG_T_SPTLRPC = 1,
2599 CONFIG_T_RECOVER = 2,
2600 CONFIG_T_PARAMS = 3,
2601 CONFIG_T_NODEMAP = 4,
2602 CONFIG_T_BARRIER = 5,
2606 struct mgs_config_body {
2607 char mcb_name[MTI_NAME_MAXLEN]; /* logname */
2608 __u64 mcb_offset; /* next index of config log to request */
2609 __u16 mcb_type; /* type of log: CONFIG_T_[CONFIG|RECOVER] */
2610 __u8 mcb_nm_cur_pass;
2611 __u8 mcb_bits; /* bits unit size of config log */
2612 __u32 mcb_units; /* # of units for bulk transfer */
2615 struct mgs_config_res {
2616 __u64 mcr_offset; /* index of last config log */
2618 __u64 mcr_size; /* size of the log */
2619 __u64 mcr_nm_cur_pass; /* current nodemap config pass */
2623 /* Config marker flags (in config log) */
2624 #define CM_START 0x01
2626 #define CM_SKIP 0x04
2627 #define CM_UPGRADE146 0x08
2628 #define CM_EXCLUDE 0x10
2629 #define CM_START_SKIP (CM_START | CM_SKIP)
2632 __u32 cm_step; /* aka config version */
2634 __u32 cm_vers; /* lustre release version number */
2635 __u32 cm_padding; /* 64 bit align */
2636 __s64 cm_createtime; /*when this record was first created */
2637 __s64 cm_canceltime; /*when this record is no longer valid*/
2638 char cm_tgtname[MTI_NAME_MAXLEN];
2639 char cm_comment[MTI_NAME_MAXLEN];
2643 * Opcodes for multiple servers.
2647 /* OBD_LOG_CANCEL = 401, obsolete since 1.5 */
2648 /* OBD_QC_CALLBACK = 402, obsolete since 2.4 */
2651 OBD_FIRST_OPC = OBD_PING
2655 * llog contexts indices.
2657 * There is compatibility problem with indexes below, they are not
2658 * continuous and must keep their numbers for compatibility needs.
2659 * See LU-5218 for details.
2662 LLOG_CONFIG_ORIG_CTXT = 0,
2663 LLOG_CONFIG_REPL_CTXT = 1,
2664 LLOG_MDS_OST_ORIG_CTXT = 2,
2665 LLOG_MDS_OST_REPL_CTXT = 3, /* kept just to avoid re-assignment */
2666 LLOG_SIZE_ORIG_CTXT = 4,
2667 LLOG_SIZE_REPL_CTXT = 5,
2668 LLOG_TEST_ORIG_CTXT = 8,
2669 LLOG_TEST_REPL_CTXT = 9, /* kept just to avoid re-assignment */
2670 LLOG_CHANGELOG_ORIG_CTXT = 12, /**< changelog generation on mdd */
2671 LLOG_CHANGELOG_REPL_CTXT = 13, /**< changelog access on clients */
2672 /* for multiple changelog consumers */
2673 LLOG_CHANGELOG_USER_ORIG_CTXT = 14,
2674 LLOG_AGENT_ORIG_CTXT = 15, /**< agent requests generation on cdt */
2675 LLOG_UPDATELOG_ORIG_CTXT = 16, /* update log */
2676 LLOG_UPDATELOG_REPL_CTXT = 17, /* update log */
2680 /** Identifier for a single log object */
2682 struct ost_id lgl_oi;
2684 } __attribute__((packed));
2686 /** Records written to the CATALOGS list */
2687 #define CATLIST "CATALOGS"
2689 struct llog_logid lci_logid;
2693 } __attribute__((packed));
2695 /* Log data record types - there is no specific reason that these need to
2696 * be related to the RPC opcodes, but no reason not to (may be handy later?)
2698 #define LLOG_OP_MAGIC 0x10600000
2699 #define LLOG_OP_MASK 0xfff00000
2702 LLOG_PAD_MAGIC = LLOG_OP_MAGIC | 0x00000,
2703 OST_SZ_REC = LLOG_OP_MAGIC | 0x00f00,
2704 /* OST_RAID1_REC = LLOG_OP_MAGIC | 0x01000, never used */
2705 MDS_UNLINK_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) |
2706 REINT_UNLINK, /* obsolete after 2.5.0 */
2707 MDS_UNLINK64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2709 /* MDS_SETATTR_REC = LLOG_OP_MAGIC | 0x12401, obsolete 1.8.0 */
2710 MDS_SETATTR64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2712 OBD_CFG_REC = LLOG_OP_MAGIC | 0x20000,
2713 /* PTL_CFG_REC = LLOG_OP_MAGIC | 0x30000, obsolete 1.4.0 */
2714 LLOG_GEN_REC = LLOG_OP_MAGIC | 0x40000,
2715 /* LLOG_JOIN_REC = LLOG_OP_MAGIC | 0x50000, obsolete 1.8.0 */
2716 CHANGELOG_REC = LLOG_OP_MAGIC | 0x60000,
2717 CHANGELOG_USER_REC = LLOG_OP_MAGIC | 0x70000,
2718 HSM_AGENT_REC = LLOG_OP_MAGIC | 0x80000,
2719 UPDATE_REC = LLOG_OP_MAGIC | 0xa0000,
2720 LLOG_HDR_MAGIC = LLOG_OP_MAGIC | 0x45539,
2721 LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
2724 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
2725 (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == __swab32(LLOG_OP_MAGIC))
2727 /** Log record header - stored in little endian order.
2728 * Each record must start with this struct, end with a llog_rec_tail,
2729 * and be a multiple of 256 bits in size.
2731 struct llog_rec_hdr {
2736 } __attribute__((packed));
2738 struct llog_rec_tail {
2741 } __attribute__((packed));
2743 /* Where data follow just after header */
2744 #define REC_DATA(ptr) \
2745 ((void *)((char *)ptr + sizeof(struct llog_rec_hdr)))
2747 #define REC_DATA_LEN(rec) \
2748 (rec->lrh_len - sizeof(struct llog_rec_hdr) - \
2749 sizeof(struct llog_rec_tail))
2751 struct llog_logid_rec {
2752 struct llog_rec_hdr lid_hdr;
2753 struct llog_logid lid_id;
2757 struct llog_rec_tail lid_tail;
2758 } __attribute__((packed));
2760 struct llog_unlink_rec {
2761 struct llog_rec_hdr lur_hdr;
2765 struct llog_rec_tail lur_tail;
2766 } __attribute__((packed));
2768 struct llog_unlink64_rec {
2769 struct llog_rec_hdr lur_hdr;
2770 struct lu_fid lur_fid;
2771 __u32 lur_count; /* to destroy the lost precreated */
2775 struct llog_rec_tail lur_tail;
2776 } __attribute__((packed));
2778 struct llog_setattr64_rec {
2779 struct llog_rec_hdr lsr_hdr;
2780 struct ost_id lsr_oi;
2786 struct llog_rec_tail lsr_tail;
2787 } __attribute__((packed));
2789 /* Extended to support project quota */
2790 struct llog_setattr64_rec_v2 {
2791 struct llog_rec_hdr lsr_hdr;
2792 struct ost_id lsr_oi;
2799 __u32 lsr_layout_version;
2802 struct llog_rec_tail lsr_tail;
2803 } __attribute__((packed));
2805 struct llog_size_change_rec {
2806 struct llog_rec_hdr lsc_hdr;
2807 struct ll_fid lsc_fid;
2812 struct llog_rec_tail lsc_tail;
2813 } __attribute__((packed));
2815 #define CHANGELOG_MAGIC 0xca103000
2817 /** \a changelog_rec_type's that can't be masked */
2818 #define CHANGELOG_MINMASK (1 << CL_MARK)
2819 /** bits covering all \a changelog_rec_type's */
2820 #define CHANGELOG_ALLMASK 0XFFFFFFFF
2821 /** default \a changelog_rec_type mask. Allow all of them, except
2822 * CL_ATIME since it can really be time consuming, and not necessary
2824 * Remove also CL_OPEN, CL_GETXATTR and CL_DN_OPEN from default list as it can
2825 * be costly and only necessary for audit purpose.
2827 #define CHANGELOG_DEFMASK (CHANGELOG_ALLMASK & \
2828 ~(1 << CL_ATIME | 1 << CL_OPEN | 1 << CL_GETXATTR | \
2831 /* changelog llog name, needed by client replicators */
2832 #define CHANGELOG_CATALOG "changelog_catalog"
2834 struct changelog_setinfo {
2837 } __attribute__((packed));
2839 /** changelog record */
2840 struct llog_changelog_rec {
2841 struct llog_rec_hdr cr_hdr;
2842 struct changelog_rec cr; /**< Variable length field */
2843 struct llog_rec_tail cr_do_not_use; /**< for_sizeof_only */
2844 } __attribute__((packed));
2846 #define CHANGELOG_USER_PREFIX "cl"
2848 struct llog_changelog_user_rec {
2849 struct llog_rec_hdr cur_hdr;
2851 /* only intended to be used in relative time comparisons to
2852 * detect idle users */
2855 struct llog_rec_tail cur_tail;
2856 } __attribute__((packed));
2858 enum agent_req_status {
2866 static inline const char *agent_req_status2name(enum agent_req_status ars)
2884 struct llog_agent_req_rec {
2885 struct llog_rec_hdr arr_hdr; /**< record header */
2886 __u32 arr_status; /**< status of the request */
2888 * agent_req_status */
2889 __u32 arr_archive_id; /**< backend archive number */
2890 __u64 arr_flags; /**< req flags */
2891 __u64 arr_compound_id; /**< compound cookie, ignored */
2892 __u64 arr_req_create; /**< req. creation time */
2893 __u64 arr_req_change; /**< req. status change time */
2894 struct hsm_action_item arr_hai; /**< req. to the agent */
2895 struct llog_rec_tail arr_tail; /**< record tail for_sizezof_only */
2896 } __attribute__((packed));
2898 /* Old llog gen for compatibility */
2902 } __attribute__((packed));
2904 struct llog_gen_rec {
2905 struct llog_rec_hdr lgr_hdr;
2906 struct llog_gen lgr_gen;
2910 struct llog_rec_tail lgr_tail;
2913 /* flags for the logs */
2915 LLOG_F_ZAP_WHEN_EMPTY = 0x1,
2916 LLOG_F_IS_CAT = 0x2,
2917 LLOG_F_IS_PLAIN = 0x4,
2918 LLOG_F_EXT_JOBID = 0x8,
2919 LLOG_F_IS_FIXSIZE = 0x10,
2920 LLOG_F_EXT_EXTRA_FLAGS = 0x20,
2921 LLOG_F_EXT_X_UIDGID = 0x40,
2922 LLOG_F_EXT_X_NID = 0x80,
2923 LLOG_F_EXT_X_OMODE = 0x100,
2924 LLOG_F_EXT_X_XATTR = 0x200,
2926 /* Note: Flags covered by LLOG_F_EXT_MASK will be inherited from
2927 * catlog to plain log, so do not add LLOG_F_IS_FIXSIZE here,
2928 * because the catlog record is usually fixed size, but its plain
2929 * log record can be variable */
2930 LLOG_F_EXT_MASK = LLOG_F_EXT_JOBID | LLOG_F_EXT_EXTRA_FLAGS |
2931 LLOG_F_EXT_X_UIDGID | LLOG_F_EXT_X_NID |
2932 LLOG_F_EXT_X_OMODE | LLOG_F_EXT_X_XATTR,
2935 /* means first record of catalog */
2937 LLOG_CAT_FIRST = -1,
2940 /* On-disk header structure of each log object, stored in little endian order */
2941 #define LLOG_MIN_CHUNK_SIZE 8192
2942 #define LLOG_HEADER_SIZE (96) /* sizeof (llog_log_hdr) + sizeof(llh_tail)
2943 * - sizeof(llh_bitmap) */
2944 #define LLOG_BITMAP_BYTES (LLOG_MIN_CHUNK_SIZE - LLOG_HEADER_SIZE)
2945 #define LLOG_MIN_REC_SIZE (24) /* round(llog_rec_hdr + llog_rec_tail) */
2947 struct llog_log_hdr {
2948 struct llog_rec_hdr llh_hdr;
2949 __s64 llh_timestamp;
2951 __u32 llh_bitmap_offset;
2954 /* for a catalog the first/oldest and still in-use plain slot is just
2955 * next to it. It will serve as the upper limit after Catalog has
2958 struct obd_uuid llh_tgtuuid;
2959 __u32 llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32)-23];
2960 /* These fields must always be at the end of the llog_log_hdr.
2961 * Note: llh_bitmap size is variable because llog chunk size could be
2962 * bigger than LLOG_MIN_CHUNK_SIZE, i.e. sizeof(llog_log_hdr) > 8192
2963 * bytes, and the real size is stored in llh_hdr.lrh_len, which means
2964 * llh_tail should only be refered by LLOG_HDR_TAIL().
2965 * But this structure is also used by client/server llog interface
2966 * (see llog_client.c), it will be kept in its original way to avoid
2967 * compatiblity issue. */
2968 __u32 llh_bitmap[LLOG_BITMAP_BYTES / sizeof(__u32)];
2969 struct llog_rec_tail llh_tail;
2970 } __attribute__((packed));
2971 #undef LLOG_HEADER_SIZE
2972 #undef LLOG_BITMAP_BYTES
2974 #define LLOG_HDR_BITMAP_SIZE(llh) (__u32)((llh->llh_hdr.lrh_len - \
2975 llh->llh_bitmap_offset - \
2976 sizeof(llh->llh_tail)) * 8)
2977 #define LLOG_HDR_BITMAP(llh) (__u32 *)((char *)(llh) + \
2978 (llh)->llh_bitmap_offset)
2979 #define LLOG_HDR_TAIL(llh) ((struct llog_rec_tail *)((char *)llh + \
2980 llh->llh_hdr.lrh_len - \
2981 sizeof(llh->llh_tail)))
2983 /** log cookies are used to reference a specific log file and a record therein,
2984 and pass record offset from llog_process_thread to llog_write */
2985 struct llog_cookie {
2987 struct llog_logid lgc_lgl;
2993 } __attribute__((packed));
2995 /** llog protocol */
2996 enum llogd_rpc_ops {
2997 LLOG_ORIGIN_HANDLE_CREATE = 501,
2998 LLOG_ORIGIN_HANDLE_NEXT_BLOCK = 502,
2999 LLOG_ORIGIN_HANDLE_READ_HEADER = 503,
3000 /* LLOG_ORIGIN_HANDLE_WRITE_REC = 504, Obsolete by 2.1. */
3001 /* LLOG_ORIGIN_HANDLE_CLOSE = 505, Obsolete by 1.8. */
3002 /* LLOG_ORIGIN_CONNECT = 506, Obsolete by 2.4. */
3003 /* LLOG_CATINFO = 507, Obsolete by 2.3. */
3004 LLOG_ORIGIN_HANDLE_PREV_BLOCK = 508,
3005 LLOG_ORIGIN_HANDLE_DESTROY = 509, /* Obsolete by 2.11. */
3007 LLOG_FIRST_OPC = LLOG_ORIGIN_HANDLE_CREATE
3011 struct llog_logid lgd_logid;
3013 __u32 lgd_llh_flags;
3015 __u32 lgd_saved_index;
3017 __u64 lgd_cur_offset;
3018 } __attribute__((packed));
3020 struct llogd_conn_body {
3021 struct llog_gen lgdc_gen;
3022 struct llog_logid lgdc_logid;
3023 __u32 lgdc_ctxt_idx;
3024 } __attribute__((packed));
3026 /* Note: 64-bit types are 64-bit aligned in structure */
3028 __u64 o_valid; /* hot fields in this obdo */
3031 __u64 o_size; /* o_size-o_blocks == ost_lvb */
3035 __u64 o_blocks; /* brw: cli sent cached bytes */
3038 /* 32-bit fields start here: keep an even number of them via padding */
3039 __u32 o_blksize; /* optimal IO blocksize */
3040 __u32 o_mode; /* brw: cli sent cache remain */
3044 __u32 o_nlink; /* brw: checksum */
3046 __u32 o_misc; /* brw: o_dropped */
3048 __u64 o_ioepoch; /* epoch in ost writes */
3049 __u32 o_stripe_idx; /* holds stripe idx */
3051 struct lustre_handle o_handle; /* brw: lock handle to prolong
3053 /* Originally, the field is llog_cookie for destroy with unlink cookie
3054 * from MDS, it is obsolete in 2.8. Then reuse it by client to transfer
3055 * layout and PFL information in IO, setattr RPCs. Since llog_cookie is
3056 * not used on wire any longer, remove it from the obdo, then it can be
3057 * enlarged freely in the further without affect related RPCs.
3059 * sizeof(ost_layout) + sieof(__u32) == sizeof(llog_cookie). */
3060 struct ost_layout o_layout;
3061 __u32 o_layout_version;
3065 __u64 o_data_version; /* getattr: sum of iversion for
3067 * brw: grant space consumed on
3068 * the client for the write */
3070 __u32 o_padding_4; /* also fix
3071 * lustre_swab_obdo() */
3076 #define o_dirty o_blocks
3077 #define o_undirty o_mode
3078 #define o_dropped o_misc
3079 #define o_cksum o_nlink
3080 #define o_grant_used o_data_version
3081 #define o_falloc_mode o_nlink
3083 struct lfsck_request {
3095 __u16 lr_async_windows;
3097 struct lu_fid lr_fid;
3098 struct lu_fid lr_fid2;
3106 struct lfsck_reply {
3113 LE_LASTID_REBUILDING = 1,
3114 LE_LASTID_REBUILT = 2,
3120 /* LE_FID_ACCESSED = 8, moved to lfsck_events_local */
3122 LE_CONDITIONAL_DESTROY = 10,
3123 LE_PAIRS_VERIFY = 11,
3124 LE_SET_LMV_MASTER = 15,
3125 LE_SET_LMV_SLAVE = 16,
3128 enum lfsck_event_flags {
3129 LEF_TO_OST = 0x00000001,
3130 LEF_FROM_OST = 0x00000002,
3131 LEF_SET_LMV_HASH = 0x00000004,
3132 LEF_SET_LMV_ALL = 0x00000008,
3133 LEF_RECHECK_NAME_HASH = 0x00000010,
3134 LEF_QUERY_ALL = 0x00000020,
3137 /* request structure for OST's */
3142 /* Key for FIEMAP to be used in get_info calls */
3143 struct ll_fiemap_info_key {
3145 struct obdo lfik_oa;
3146 struct fiemap lfik_fiemap;
3149 #define IDX_INFO_MAGIC 0x3D37CC37
3151 /* Index file transfer through the network. The server serializes the index into
3152 * a byte stream which is sent to the client via a bulk transfer */
3156 /* reply: see idx_info_flags below */
3159 /* request & reply: number of lu_idxpage (to be) transferred */
3163 /* request: requested attributes passed down to the iterator API */
3166 /* request & reply: index file identifier (FID) */
3167 struct lu_fid ii_fid;
3169 /* reply: version of the index file before starting to walk the index.
3170 * Please note that the version can be modified at any time during the
3174 /* request: hash to start with:
3175 * reply: hash of the first entry of the first lu_idxpage and hash
3176 * of the entry to read next if any */
3177 __u64 ii_hash_start;
3180 /* reply: size of keys in lu_idxpages, minimal one if II_FL_VARKEY is
3184 /* reply: size of records in lu_idxpages, minimal one if II_FL_VARREC
3193 #define II_END_OFF MDS_DIR_END_OFF /* all entries have been read */
3195 /* List of flags used in idx_info::ii_flags */
3196 enum idx_info_flags {
3197 II_FL_NOHASH = 1 << 0, /* client doesn't care about hash value */
3198 II_FL_VARKEY = 1 << 1, /* keys can be of variable size */
3199 II_FL_VARREC = 1 << 2, /* records can be of variable size */
3200 II_FL_NONUNQ = 1 << 3, /* index supports non-unique keys */
3201 II_FL_NOKEY = 1 << 4, /* client doesn't care about key */
3204 #define LIP_MAGIC 0x8A6D6B6C
3206 /* 4KB (= LU_PAGE_SIZE) container gathering key/record pairs */
3208 /* 16-byte header */
3211 __u16 lip_nr; /* number of entries in the container */
3212 __u64 lip_pad0; /* additional padding for future use */
3214 /* key/record pairs are stored in the remaining 4080 bytes.
3215 * depending upon the flags in idx_info::ii_flags, each key/record
3216 * pair might be preceded by:
3218 * - the key size (II_FL_VARKEY is set)
3219 * - the record size (II_FL_VARREC is set)
3221 * For the time being, we only support fixed-size key & record. */
3222 char lip_entries[0];
3225 #define LIP_HDR_SIZE (offsetof(struct lu_idxpage, lip_entries))
3227 /* Gather all possible type associated with a 4KB container */
3229 struct lu_dirpage lp_dir; /* for MDS_READPAGE */
3230 struct lu_idxpage lp_idx; /* for OBD_IDX_READ */
3231 char lp_array[LU_PAGE_SIZE];
3234 /* security opcodes */
3237 SEC_CTX_INIT_CONT = 802,
3240 SEC_FIRST_OPC = SEC_CTX_INIT
3243 /** The link ea holds 1 \a link_ea_entry for each hardlink */
3244 #define LINK_EA_MAGIC 0x11EAF1DFUL
3245 struct link_ea_header {
3248 __u64 leh_len; /* total size */
3249 __u32 leh_overflow_time;
3253 /** Hardlink data is name and parent fid.
3254 * Stored in this crazy struct for maximum packing and endian-neutrality
3256 struct link_ea_entry {
3257 /** __u16 stored big-endian, unaligned */
3258 unsigned char lee_reclen[2];
3259 unsigned char lee_parent_fid[sizeof(struct lu_fid)];
3261 } __attribute__((packed));
3263 /** fid2path request/reply structure */
3264 struct getinfo_fid2path {
3265 struct lu_fid gf_fid;
3271 struct lu_fid gf_root_fid[0];
3273 } __attribute__((packed));
3275 /** path2parent request/reply structures */
3277 struct lu_fid gp_fid; /**< parent FID */
3278 __u32 gp_linkno; /**< hardlink number */
3279 __u32 gp_name_size; /**< size of the name field */
3280 char gp_name[0]; /**< zero-terminated link name */
3281 } __attribute__((packed));
3283 enum layout_intent_opc {
3284 LAYOUT_INTENT_ACCESS = 0, /** generic access */
3285 LAYOUT_INTENT_READ = 1, /** not used */
3286 LAYOUT_INTENT_WRITE = 2, /** write file, for comp layout */
3287 LAYOUT_INTENT_GLIMPSE = 3, /** not used */
3288 LAYOUT_INTENT_TRUNC = 4, /** truncate file, for comp layout */
3289 LAYOUT_INTENT_RELEASE = 5, /** reserved for HSM release */
3290 LAYOUT_INTENT_RESTORE = 6, /** reserved for HSM restore */
3293 /* enqueue layout lock with intent */
3294 struct layout_intent {
3295 __u32 li_opc; /* intent operation for enqueue, read, write etc */
3297 struct lu_extent li_extent;
3298 } __attribute__((packed));
3301 * On the wire version of hsm_progress structure.
3303 * Contains the userspace hsm_progress and some internal fields.
3305 struct hsm_progress_kernel {
3306 /* Field taken from struct hsm_progress */
3307 struct lu_fid hpk_fid;
3309 struct hsm_extent hpk_extent;
3311 __u16 hpk_errval; /* positive val */
3313 /* Additional fields */
3314 __u64 hpk_data_version;
3316 } __attribute__((packed));
3319 * OUT_UPDATE RPC Format
3321 * During the cross-ref operation, the Master MDT, which the client send the
3322 * request to, will disassembly the operation into object updates, then OSP
3323 * will send these updates to the remote MDT to be executed.
3325 * An UPDATE_OBJ RPC does a list of updates. Each update belongs to an
3326 * operation and does a type of modification to an object.
3334 * update (ub_count-th)
3336 * ub_count must be less than or equal to UPDATE_PER_RPC_MAX.
3341 * rc [+ buffers] (1st)
3342 * rc [+ buffers] (2st)
3344 * rc [+ buffers] (nr_count-th)
3346 * ur_count must be less than or equal to UPDATE_PER_RPC_MAX and should usually
3347 * be equal to ub_count.
3351 * Type of each update, if adding/deleting update, please also update
3352 * update_opcode in lustre/target/out_lib.c.
3364 OUT_INDEX_LOOKUP = 9,
3365 OUT_INDEX_INSERT = 10,
3366 OUT_INDEX_DELETE = 11,
3372 OUT_XATTR_LIST = 17,
3377 UPDATE_FL_OST = 0x00000001, /* op from OST (not MDT) */
3378 UPDATE_FL_SYNC = 0x00000002, /* commit before replying */
3379 UPDATE_FL_COMMITTED = 0x00000004, /* op committed globally */
3380 UPDATE_FL_NOLOG = 0x00000008 /* for idempotent updates */
3383 struct object_update_param {
3384 __u16 oup_len; /* length of this parameter */
3391 struct object_update {
3392 __u16 ou_type; /* enum update_type */
3393 __u16 ou_params_count; /* update parameters count */
3394 __u32 ou_result_size; /* how many bytes can return */
3395 __u32 ou_flags; /* enum update_flag */
3396 __u32 ou_padding1; /* padding 1 */
3397 __u64 ou_batchid; /* op transno on master */
3398 struct lu_fid ou_fid; /* object to be updated */
3399 struct object_update_param ou_params[0]; /* update params */
3402 #define UPDATE_REQUEST_MAGIC_V1 0xBDDE0001
3403 #define UPDATE_REQUEST_MAGIC_V2 0xBDDE0002
3404 #define UPDATE_REQUEST_MAGIC UPDATE_REQUEST_MAGIC_V2
3405 /* Hold object_updates sending to the remote OUT in single RPC */
3406 struct object_update_request {
3408 __u16 ourq_count; /* number of ourq_updates[] */
3410 struct object_update ourq_updates[0];
3413 #define OUT_UPDATE_HEADER_MAGIC 0xBDDF0001
3414 #define OUT_UPDATE_MAX_INLINE_SIZE 4096
3415 /* Header for updates request between MDTs */
3416 struct out_update_header {
3419 __u32 ouh_inline_length;
3420 __u32 ouh_reply_size;
3421 __u32 ouh_inline_data[0];
3424 struct out_update_buffer {
3429 /* the result of object update */
3430 struct object_update_result {
3437 #define UPDATE_REPLY_MAGIC_V1 0x00BD0001
3438 #define UPDATE_REPLY_MAGIC_V2 0x00BD0002
3439 #define UPDATE_REPLY_MAGIC UPDATE_REPLY_MAGIC_V2
3440 /* Hold object_update_results being replied from the remote OUT. */
3441 struct object_update_reply {
3448 /* read update result */
3449 struct out_read_reply {
3456 /** layout swap request structure
3457 * fid1 and fid2 are in mdt_body
3459 struct mdc_swap_layouts {
3461 } __attribute__((packed));
3463 #define INLINE_RESYNC_ARRAY_SIZE 15
3464 struct close_data_resync_done {
3466 __u32 resync_ids_inline[INLINE_RESYNC_ARRAY_SIZE];
3470 struct lustre_handle cd_handle;
3471 struct lu_fid cd_fid;
3472 __u64 cd_data_version;
3474 __u64 cd_reserved[8];
3475 struct close_data_resync_done cd_resync;
3479 __u32 cd_archive_id;
3483 /* Update llog format */
3485 struct lu_fid uop_fid;
3487 __u16 uop_param_count;
3488 __u16 uop_params_off[0];
3489 } __attribute__((packed));
3492 struct update_op uops_op[0];
3495 struct update_params {
3496 struct object_update_param up_params[0];
3499 enum update_records_flag {
3500 UPDATE_RECORD_CONTINUE = 1 >> 0,
3503 * This is the update record format used to store the updates in
3504 * disk. All updates of the operation will be stored in ur_ops.
3505 * All of parameters for updates of the operation will be stored
3507 * To save the space of the record, parameters in ur_ops will only
3508 * remember their offset in ur_params, so to avoid storing duplicate
3509 * parameters in ur_params, which can help us save a lot space for
3510 * operation like creating striped directory.
3512 struct update_records {
3513 __u64 ur_master_transno;
3516 /* If the operation includes multiple updates, then ur_index
3517 * means the index of the update inside the whole updates. */
3519 __u32 ur_update_count;
3520 __u32 ur_param_count;
3521 struct update_ops ur_ops;
3522 /* Note ur_ops has a variable size, so comment out
3523 * the following ur_params, in case some use it directly
3524 * update_records->ur_params
3526 * struct update_params ur_params;
3530 struct llog_update_record {
3531 struct llog_rec_hdr lur_hdr;
3532 struct update_records lur_update_rec;
3533 /* Note ur_update_rec has a variable size, so comment out
3534 * the following ur_tail, in case someone use it directly
3536 * struct llog_rec_tail lur_tail;
3540 /* sepol string format is:
3541 * <1-digit for SELinux status>:<policy name>:<policy version>:<policy hash>
3543 /* Max length of the sepol string
3544 * Should be large enough to contain a sha512sum of the policy
3546 #define SELINUX_MODE_LEN 1
3547 #define SELINUX_POLICY_VER_LEN 3 /* 3 chars to leave room for the future */
3548 #define SELINUX_POLICY_HASH_LEN 64
3549 #define LUSTRE_NODEMAP_SEPOL_LENGTH (SELINUX_MODE_LEN + NAME_MAX + \
3550 SELINUX_POLICY_VER_LEN + \
3551 SELINUX_POLICY_HASH_LEN + 3)
3553 /* nodemap records, uses 32 byte record length */
3554 #define LUSTRE_NODEMAP_NAME_LENGTH 16
3555 struct nodemap_cluster_rec {
3556 char ncr_name[LUSTRE_NODEMAP_NAME_LENGTH + 1];
3560 __u32 ncr_squash_uid;
3561 __u32 ncr_squash_gid;
3564 /* lnet_nid_t is 8 bytes */
3565 struct nodemap_range_rec {
3566 lnet_nid_t nrr_start_nid;
3567 lnet_nid_t nrr_end_nid;
3572 struct nodemap_id_rec {
3580 struct nodemap_global_rec {
3591 struct nodemap_cluster_rec ncr;
3592 struct nodemap_range_rec nrr;
3593 struct nodemap_id_rec nir;
3594 struct nodemap_global_rec ngr;
3597 /* This is the lu_ladvise struct which goes out on the wire.
3598 * Corresponds to the userspace arg llapi_lu_ladvise.
3599 * value[1-4] are unspecified fields, used differently by different advices */
3601 __u16 lla_advice; /* advice type */
3602 __u16 lla_value1; /* values for different advice types */
3604 __u64 lla_start; /* first byte of extent for advice */
3605 __u64 lla_end; /* last byte of extent for advice */
3610 /* This is the ladvise_hdr which goes on the wire, corresponds to the userspace
3611 * arg llapi_ladvise_hdr.
3612 * value[1-3] are unspecified fields, used differently by different advices */
3613 struct ladvise_hdr {
3614 __u32 lah_magic; /* LADVISE_MAGIC */
3615 __u32 lah_count; /* number of advices */
3616 __u64 lah_flags; /* from enum ladvise_flag */
3617 __u32 lah_value1; /* unused */
3618 __u32 lah_value2; /* unused */
3619 __u64 lah_value3; /* unused */
3620 struct lu_ladvise lah_advise[0]; /* advices in this header */
3623 #if defined(__cplusplus)