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/include/lustre/lustre_idl.h
34 * Lustre wire protocol definitions.
37 /** \defgroup lustreidl lustreidl
39 * Lustre wire protocol definitions.
41 * ALL structs passing over the wire should be declared here. Structs
42 * that are used in interfaces with userspace should go in lustre_user.h.
44 * All structs being declared here should be built from simple fixed-size
45 * types (__u8, __u16, __u32, __u64) or be built from other types or
46 * structs also declared in this file. Similarly, all flags and magic
47 * values in those structs should also be declared here. This ensures
48 * that the Lustre wire protocol is not influenced by external dependencies.
50 * The only other acceptable items in this file are VERY SIMPLE accessor
51 * functions to avoid callers grubbing inside the structures. Nothing that
52 * depends on external functions or definitions should be in here.
54 * Structs must be properly aligned to put 64-bit values on an 8-byte
55 * boundary. Any structs being added here must also be added to
56 * utils/wirecheck.c and "make newwiretest" run to regenerate the
57 * utils/wiretest.c sources. This allows us to verify that wire structs
58 * have the proper alignment/size on all architectures.
60 * DO NOT CHANGE any of the structs, flags, values declared here and used
61 * in released Lustre versions. Some structs may have padding fields that
62 * can be used. Some structs might allow addition at the end (verify this
63 * in the code to ensure that new/old clients that see this larger struct
64 * do not fail, otherwise you need to implement protocol compatibility).
69 #ifndef _LUSTRE_IDL_H_
70 #define _LUSTRE_IDL_H_
72 #include <asm/byteorder.h>
73 #include <linux/errno.h>
74 #include <linux/types.h>
77 * This is due to us being out of kernel and the way the OpenSFS branch
81 # include <uapi/linux/lnet/lnet-types.h>
82 # include <uapi/linux/lustre/lustre_user.h> /* Defn's shared with user-space. */
83 # include <uapi/linux/lustre/lustre_ver.h>
85 # include <linux/lnet/lnet-types.h>
86 # include <linux/lustre/lustre_user.h>
87 # include <linux/lustre/lustre_ver.h>
90 #if defined(__cplusplus)
97 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
98 * FOO_REPLY_PORTAL is for incoming replies on the FOO
99 * FOO_BULK_PORTAL is for incoming bulk on the FOO
102 #define CONNMGR_REQUEST_PORTAL 1
103 #define CONNMGR_REPLY_PORTAL 2
104 //#define OSC_REQUEST_PORTAL 3
105 #define OSC_REPLY_PORTAL 4
106 //#define OSC_BULK_PORTAL 5
107 #define OST_IO_PORTAL 6
108 #define OST_CREATE_PORTAL 7
109 #define OST_BULK_PORTAL 8
110 //#define MDC_REQUEST_PORTAL 9
111 #define MDC_REPLY_PORTAL 10
112 //#define MDC_BULK_PORTAL 11
113 #define MDS_REQUEST_PORTAL 12
114 #define MDS_IO_PORTAL 13
115 #define MDS_BULK_PORTAL 14
116 #define LDLM_CB_REQUEST_PORTAL 15
117 #define LDLM_CB_REPLY_PORTAL 16
118 #define LDLM_CANCEL_REQUEST_PORTAL 17
119 #define LDLM_CANCEL_REPLY_PORTAL 18
120 //#define PTLBD_REQUEST_PORTAL 19
121 //#define PTLBD_REPLY_PORTAL 20
122 //#define PTLBD_BULK_PORTAL 21
123 #define MDS_SETATTR_PORTAL 22
124 #define MDS_READPAGE_PORTAL 23
125 #define OUT_PORTAL 24
126 #define MGC_REPLY_PORTAL 25
127 #define MGS_REQUEST_PORTAL 26
128 #define MGS_REPLY_PORTAL 27
129 #define OST_REQUEST_PORTAL 28
130 #define FLD_REQUEST_PORTAL 29
131 #define SEQ_METADATA_PORTAL 30
132 #define SEQ_DATA_PORTAL 31
133 #define SEQ_CONTROLLER_PORTAL 32
134 #define MGS_BULK_PORTAL 33
135 /* #define DVS_PORTAL 63 */
136 /* reserved for Cray DVS - spitzcor@cray.com, roe@cray.com, n8851@cray.com */
139 * Describes a range of sequence, lsr_start is included but lsr_end is
141 * Same structure is used in fld module where lsr_index field holds mdt id
144 struct lu_seq_range {
151 struct lu_seq_range_array {
154 struct lu_seq_range lsra_lsr[0];
157 #define LU_SEQ_RANGE_MDT 0x0
158 #define LU_SEQ_RANGE_OST 0x1
159 #define LU_SEQ_RANGE_ANY 0x3
161 #define LU_SEQ_RANGE_MASK 0x3
163 /** \defgroup lu_fid lu_fid
166 extern void lustre_lma_swab(struct lustre_mdt_attrs *lma);
167 extern void lustre_lma_init(struct lustre_mdt_attrs *lma,
168 const struct lu_fid *fid,
169 __u32 compat, __u32 incompat);
170 extern void lustre_loa_swab(struct lustre_ost_attrs *loa,
172 extern void lustre_loa_init(struct lustre_ost_attrs *loa,
173 const struct lu_fid *fid,
174 __u32 compat, __u32 incompat);
176 /* copytool can use any nonnegative integer to represent archive-Ids during
177 * register with MDT thru kuc.
178 * archive num = 0 => all
179 * archive num from 1 to MAX_U32
181 #define LL_HSM_ORIGIN_MAX_ARCHIVE (sizeof(__u32) * 8)
182 /* the max count of archive ids that one agent can support */
183 #define LL_HSM_MAX_ARCHIVES_PER_AGENT 1024
186 * HSM on-disk attributes stored in a separate xattr.
189 /** Bitfield for supported data in this structure. For future use. */
192 /** HSM flags, see hsm_flags enum below */
194 /** backend archive id associated with the file */
196 /** version associated with the last archiving, if any */
199 extern void lustre_hsm_swab(struct hsm_attrs *attrs);
205 /** LASTID file has zero OID */
206 LUSTRE_FID_LASTID_OID = 0UL,
207 /** initial fid id value */
208 LUSTRE_FID_INIT_OID = 1UL
212 * Different FID Format
213 * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs#NEW.0
216 * File IDentifier generated by client from range allocated by the seq service.
217 * First 0x400 sequences [2^33, 2^33 + 0x400] are reserved for system use. Note
218 * that on ldiskfs MDTs that IGIF FIDs can use inode numbers starting at 12,
219 * but this is in the IGIF SEQ rangeand does not conflict with assigned FIDs.
222 * Inode and Generation In FID, a surrogate FID used to globally identify an
223 * existing object on OLD formatted MDT file system. This would only be used on
224 * MDT0 in a DNE filesystem, because there are not expected to be any OLD
225 * formatted DNE filesystems. Belongs to a sequence in [12, 2^32 - 1] range,
226 * where sequence number is inode number, and inode generation is used as OID.
227 * NOTE: This assumes no more than 2^32-1 inodes exist in the MDT filesystem,
228 * which is the maximum possible for an ldiskfs backend. NOTE: This assumes
229 * that the reserved ext3/ext4/ldiskfs inode numbers [0-11] are never visible
230 * to clients, which has always been true.
233 * Object ID in FID, a surrogate FID used to globally identify an existing
234 * object on OLD formatted OST file system. Belongs to a sequence in
235 * [2^32, 2^33 - 1]. Sequence number is calculated as:
236 * 1 << 32 | (ost_index << 16) | ((objid >> 32) & 0xffff)
237 * that is, SEQ consists of 16-bit OST index, and higher 16 bits of object ID.
238 * The generation of unique SEQ values per OST allows the IDIF FIDs to be
239 * identified in the FLD correctly. The OID field is calculated as:
241 * that is, it consists of lower 32 bits of object ID. NOTE This assumes that
242 * no more than 2^48-1 objects have ever been created on an OST, and that no
243 * more than 65535 OSTs are in use. Both are very reasonable assumptions (can
244 * uniquely map all objects on an OST that created 1M objects per second for 9
245 * years, or combinations thereof).
248 * Surrogate FID used to identify an existing object on OLD formatted OST
249 * filesystem. Belongs to the reserved sequence 0, and is used internally prior
250 * to the introduction of FID-on-OST, at which point IDIF will be used to
251 * identify objects as residing on a specific OST.
254 * For Lustre Log objects the object sequence 1 is used. This is compatible with
255 * both OLD and NEW.1 namespaces, as this SEQ number is in the ext3/ldiskfs
256 * reserved inode range and does not conflict with IGIF sequence numbers.
259 * For testing OST IO performance the object sequence 2 is used. This is
260 * compatible with both OLD and NEW.1 namespaces, as this SEQ number is in the
261 * ext3/ldiskfs reserved inode range and does not conflict with IGIF sequence
264 * OST_MDT1 .. OST_MAX:
265 * For testing with multiple MDTs the object sequence 3 through 9 is used,
266 * allowing direct mapping of MDTs 1 through 7 respectively, for a total of 8
267 * MDTs including OST_MDT0. This matches the legacy CMD project "group"
268 * mappings. However, this SEQ range is only for testing prior to any production
269 * DNE release, as the objects in this range conflict across all OSTs, as the
270 * OST index is not part of the FID.
273 * For compatibility with existing OLD OST network protocol structures, the FID
274 * must map onto the o_id and o_gr in a manner that ensures existing objects are
275 * identified consistently for IO, as well as onto the lock namespace to ensure
276 * both IDIFs map onto the same objects for IO as well as resources in the DLM.
279 * resource[] = {o_id, o_seq, 0, 0}; // o_seq == 0 for production releases
281 * DLM NEW.1 FID (this is the same for both the MDT and OST):
282 * resource[] = {SEQ, OID, VER, HASH};
284 * Note that for mapping IDIF values to DLM resource names the o_id may be
285 * larger than the 2^33 reserved sequence numbers for IDIF, so it is possible
286 * for the o_id numbers to overlap FID SEQ numbers in the resource. However, in
287 * all production releases the OLD o_seq field is always zero, and all valid FID
288 * OID values are non-zero, so the lock resources will not collide.
290 * For objects within the IDIF range, group extraction (non-CMD) will be:
291 * o_id = (fid->f_seq & 0x7fff) << 16 | fid->f_oid;
292 * o_seq = 0; // formerly group number
296 * Note that reserved SEQ numbers below 12 will conflict with ldiskfs
297 * inodes in the IGIF namespace, so these reserved SEQ numbers can be
298 * used for other purposes and not risk collisions with existing inodes.
301 FID_SEQ_OST_MDT0 = 0,
302 FID_SEQ_LLOG = 1, /* unnamed llogs */
304 FID_SEQ_UNUSED_START = 3,
305 FID_SEQ_UNUSED_END = 9,
306 FID_SEQ_LLOG_NAME = 10, /* named llogs */
309 FID_SEQ_IGIF_MAX = 0x0ffffffffULL,
310 FID_SEQ_IDIF = 0x100000000ULL,
311 FID_SEQ_IDIF_MAX = 0x1ffffffffULL,
312 /* Normal FID sequence starts from this value, i.e. 1<<33 */
313 FID_SEQ_START = 0x200000000ULL,
314 /* sequence for local pre-defined FIDs listed in local_oid */
315 FID_SEQ_LOCAL_FILE = 0x200000001ULL,
316 FID_SEQ_DOT_LUSTRE = 0x200000002ULL,
317 /* sequence is used for local named objects FIDs generated
318 * by local_object_storage library */
319 FID_SEQ_LOCAL_NAME = 0x200000003ULL,
320 /* Because current FLD will only cache the fid sequence, instead
321 * of oid on the client side, if the FID needs to be exposed to
322 * clients sides, it needs to make sure all of fids under one
323 * sequence will be located in one MDT. */
324 FID_SEQ_SPECIAL = 0x200000004ULL,
325 FID_SEQ_QUOTA = 0x200000005ULL,
326 FID_SEQ_QUOTA_GLB = 0x200000006ULL,
327 FID_SEQ_ROOT = 0x200000007ULL, /* Located on MDT0 */
328 FID_SEQ_LAYOUT_RBTREE = 0x200000008ULL,
329 /* sequence is used for update logs of cross-MDT operation */
330 FID_SEQ_UPDATE_LOG = 0x200000009ULL,
331 /* Sequence is used for the directory under which update logs
333 FID_SEQ_UPDATE_LOG_DIR = 0x20000000aULL,
334 FID_SEQ_NORMAL = 0x200000400ULL,
335 FID_SEQ_LOV_DEFAULT = 0xffffffffffffffffULL
338 #define OBIF_OID_MAX_BITS 32
339 #define OBIF_MAX_OID (1ULL << OBIF_OID_MAX_BITS)
340 #define OBIF_OID_MASK ((1ULL << OBIF_OID_MAX_BITS) - 1)
341 #define IDIF_OID_MAX_BITS 48
342 #define IDIF_MAX_OID (1ULL << IDIF_OID_MAX_BITS)
343 #define IDIF_OID_MASK ((1ULL << IDIF_OID_MAX_BITS) - 1)
345 /** OID for FID_SEQ_SPECIAL */
347 /* Big Filesystem Lock to serialize rename operations */
348 FID_OID_SPECIAL_BFL = 1UL,
351 /** OID for FID_SEQ_DOT_LUSTRE */
352 enum dot_lustre_oid {
353 FID_OID_DOT_LUSTRE = 1UL,
354 FID_OID_DOT_LUSTRE_OBF = 2UL,
355 FID_OID_DOT_LUSTRE_LPF = 3UL,
358 /** OID for FID_SEQ_ROOT */
361 FID_OID_ECHO_ROOT = 2UL,
364 struct lu_orphan_rec {
365 /* The MDT-object's FID referenced by the orphan OST-object */
366 struct lu_fid lor_fid;
371 struct lu_orphan_ent {
372 /* The orphan OST-object's FID */
373 struct lu_fid loe_key;
374 struct lu_orphan_rec loe_rec;
377 struct lu_orphan_rec_v2 {
378 struct lu_orphan_rec lor_rec;
379 struct ost_layout lor_layout;
383 struct lu_orphan_ent_v2 {
384 /* The orphan OST-object's FID */
385 struct lu_fid loe_key;
386 struct lu_orphan_rec_v2 loe_rec;
389 struct lu_orphan_rec_v3 {
390 struct lu_orphan_rec lor_rec;
391 struct ost_layout lor_layout;
392 /* The OST-object declared layout version in PFID EA.*/
393 __u32 lor_layout_version;
394 /* The OST-object declared layout range (of version) in PFID EA.*/
400 struct lu_orphan_ent_v3 {
401 /* The orphan OST-object's FID */
402 struct lu_fid loe_key;
403 struct lu_orphan_rec_v3 loe_rec;
408 /** \defgroup lu_dir lu_dir
412 * Enumeration of possible directory entry attributes.
414 * Attributes follow directory entry header in the order they appear in this
417 enum lu_dirent_attrs {
420 LUDA_64BITHASH = 0x0004,
422 /* The following attrs are used for MDT internal only,
423 * not visible to client */
425 /* Something in the record is unknown, to be verified in further. */
426 LUDA_UNKNOWN = 0x0400,
427 /* Ignore this record, go to next directly. */
428 LUDA_IGNORE = 0x0800,
429 /* The system is upgraded, has beed or to be repaired (dryrun). */
430 LUDA_UPGRADE = 0x1000,
431 /* The dirent has been repaired, or to be repaired (dryrun). */
432 LUDA_REPAIR = 0x2000,
433 /* Only check but not repair the dirent inconsistency */
434 LUDA_VERIFY_DRYRUN = 0x4000,
435 /* Verify the dirent consistency */
436 LUDA_VERIFY = 0x8000,
439 #define LU_DIRENT_ATTRS_MASK 0xff00
442 * Layout of readdir pages, as transmitted on wire.
445 /** valid if LUDA_FID is set. */
446 struct lu_fid lde_fid;
447 /** a unique entry identifier: a hash or an offset. */
449 /** total record length, including all attributes. */
453 /** optional variable size attributes following this entry.
454 * taken from enum lu_dirent_attrs.
457 /** name is followed by the attributes indicated in ->ldp_attrs, in
458 * their natural order. After the last attribute, padding bytes are
459 * added to make ->lde_reclen a multiple of 8.
465 * Definitions of optional directory entry attributes formats.
467 * Individual attributes do not have their length encoded in a generic way. It
468 * is assumed that consumer of an attribute knows its format. This means that
469 * it is impossible to skip over an unknown attribute, except by skipping over all
470 * remaining attributes (by using ->lde_reclen), which is not too
471 * constraining, because new server versions will append new attributes at
472 * the end of an entry.
476 * Fid directory attribute: a fid of an object referenced by the entry. This
477 * will be almost always requested by the client and supplied by the server.
479 * Aligned to 8 bytes.
481 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
486 * Aligned to 2 bytes.
493 __u64 ldp_hash_start;
497 struct lu_dirent ldp_entries[0];
500 enum lu_dirpage_flags {
502 * dirpage contains no entry.
506 * last entry's lde_hash equals ldp_hash_end.
511 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
513 if (__le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
516 return dp->ldp_entries;
519 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
521 struct lu_dirent *next;
523 if (__le16_to_cpu(ent->lde_reclen) != 0)
524 next = ((void *)ent) + __le16_to_cpu(ent->lde_reclen);
531 static inline size_t lu_dirent_calc_size(size_t namelen, __u16 attr)
535 if (attr & LUDA_TYPE) {
536 const size_t align = sizeof(struct luda_type) - 1;
538 size = (sizeof(struct lu_dirent) + namelen + 1 + align) &
540 size += sizeof(struct luda_type);
542 size = sizeof(struct lu_dirent) + namelen + 1;
545 return (size + 7) & ~7;
548 #define MDS_DIR_END_OFF 0xfffffffffffffffeULL
551 * MDS_READPAGE page size
553 * This is the directory page size packed in MDS_READPAGE RPC.
554 * It's different than PAGE_SIZE because the client needs to
555 * access the struct lu_dirpage header packed at the beginning of
556 * the "page" and without this there isn't any way to know find the
557 * lu_dirpage header is if client and server PAGE_SIZE differ.
559 #define LU_PAGE_SHIFT 12
560 #define LU_PAGE_SIZE (1UL << LU_PAGE_SHIFT)
561 #define LU_PAGE_MASK (~(LU_PAGE_SIZE - 1))
563 #define LU_PAGE_COUNT (1 << (PAGE_SHIFT - LU_PAGE_SHIFT))
567 struct lustre_handle {
570 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
572 static inline bool lustre_handle_is_used(const struct lustre_handle *lh)
574 return lh->cookie != 0;
577 static inline bool lustre_handle_equal(const struct lustre_handle *lh1,
578 const struct lustre_handle *lh2)
580 return lh1->cookie == lh2->cookie;
583 static inline void lustre_handle_copy(struct lustre_handle *tgt,
584 const struct lustre_handle *src)
586 tgt->cookie = src->cookie;
589 /* lustre_msg struct magic. DON'T use swabbed values of MAGIC as magic! */
590 enum lustre_msg_magic {
591 LUSTRE_MSG_MAGIC_V2 = 0x0BD00BD3,
592 LUSTRE_MSG_MAGIC_V2_SWABBED = 0xD30BD00B,
593 LUSTRE_MSG_MAGIC = LUSTRE_MSG_MAGIC_V2
596 /* flags for lm_flags */
598 MSGHDR_AT_SUPPORT = 0x1, /* adaptive timeouts, lm_cksum valid
599 * in early reply messages */
600 MSGHDR_CKSUM_INCOMPAT18 = 0x2, /* compat for 1.8, needs to be set well
601 * beyond 2.8.0 for compatibility */
604 #define lustre_msg lustre_msg_v2
605 /* we depend on this structure to be 8-byte aligned */
606 /* this type is only endian-adjusted in lustre_unpack_msg() */
607 struct lustre_msg_v2 {
608 __u32 lm_bufcount; /* number of buffers in lm_buflens[] */
609 __u32 lm_secflvr; /* 0 = no crypto, or sptlrpc security flavour */
610 __u32 lm_magic; /* RPC version magic = LUSTRE_MSG_MAGIC_V2 */
611 __u32 lm_repsize; /* size of preallocated reply buffer */
612 __u32 lm_cksum; /* CRC32 of ptlrpc_body early reply messages */
613 __u32 lm_flags; /* enum lustre_msghdr MSGHDR_* flags */
614 __u32 lm_padding_2; /* unused */
615 __u32 lm_padding_3; /* unused */
616 __u32 lm_buflens[0]; /* length of additional buffers in bytes,
617 * padded to a multiple of 8 bytes. */
619 * message buffers are packed after padded lm_buflens[] array,
620 * padded to a multiple of 8 bytes each to align contents.
624 /* ptlrpc_body packet pb_types */
625 #define PTL_RPC_MSG_REQUEST 4711 /* normal RPC request message */
626 #define PTL_RPC_MSG_ERR 4712 /* error reply if request unprocessed */
627 #define PTL_RPC_MSG_REPLY 4713 /* normal RPC reply message */
629 /* ptlrpc_body pb_version ((target_version << 16) | rpc_version) */
630 enum lustre_msg_version {
631 PTLRPC_MSG_VERSION = 0x00000003,
632 LUSTRE_VERSION_MASK = 0xffff0000,
633 LUSTRE_OBD_VERSION = 0x00010000,
634 LUSTRE_MDS_VERSION = 0x00020000,
635 LUSTRE_OST_VERSION = 0x00030000,
636 LUSTRE_DLM_VERSION = 0x00040000,
637 LUSTRE_LOG_VERSION = 0x00050000,
638 LUSTRE_MGS_VERSION = 0x00060000,
641 /* pb_flags that apply to all request messages */
642 /* #define MSG_LAST_REPLAY 0x0001 obsolete 2.0 => {REQ,LOCK}_REPLAY_DONE */
643 #define MSG_RESENT 0x0002 /* was previously sent, no reply seen */
644 #define MSG_REPLAY 0x0004 /* was processed, got reply, recovery */
645 /* #define MSG_AT_SUPPORT 0x0008 obsolete since 1.5, AT always enabled */
646 /* #define MSG_DELAY_REPLAY 0x0010 obsolete since 2.0 */
647 /* #define MSG_VERSION_REPLAY 0x0020 obsolete since 1.8.2, VBR always on */
648 #define MSG_REQ_REPLAY_DONE 0x0040 /* request replay over, locks next */
649 #define MSG_LOCK_REPLAY_DONE 0x0080 /* lock replay over, client done */
651 /* pb_op_flags for connect opcodes: MDS_CONNECT, OST_CONNECT, MGS_CONNECT */
652 #define MSG_CONNECT_RECOVERING 0x00000001 /* target is in recovery */
653 #define MSG_CONNECT_RECONNECT 0x00000002 /* tgt already has client import */
654 #define MSG_CONNECT_REPLAYABLE 0x00000004 /* target supports RPC replay */
655 /* #define MSG_CONNECT_PEER 0x00000008 obsolete since 1.2, removed in 1.5 */
656 #define MSG_CONNECT_LIBCLIENT 0x00000010 /* obsolete since 2.3, removed 2.6 */
657 #define MSG_CONNECT_INITIAL 0x00000020 /* first client connection attempt */
658 /* #define MSG_CONNECT_ASYNC 0x00000040 obsolete since 1.5 */
659 #define MSG_CONNECT_NEXT_VER 0x00000080 /* use next version of lustre_msg */
660 #define MSG_CONNECT_TRANSNO 0x00000100 /* client sent transno in replay */
662 /* number of previous object versions in pb_pre_versions[] */
663 #define PTLRPC_NUM_VERSIONS 4
664 /* without gss, ptlrpc_body is put at the first buffer. */
665 struct ptlrpc_body_v3 {
666 struct lustre_handle pb_handle;
667 __u32 pb_type; /* request/reply/err type: PTL_RPC_MSG_* */
668 __u32 pb_version; /* LUSTRE_*_VERSION | PTLRPC_MSG_VERSION */
669 __u32 pb_opc; /* RPC opcodes: MDS_*, OST_*, LDLM_, ... */
670 __u32 pb_status; /* negative Linux x86 error number */
671 __u64 pb_last_xid; /* highest replied XID w/o lower unreplied XID*/
672 __u16 pb_tag; /* multiple modifying RPCs virtual slot index */
675 __u64 pb_last_committed;/* rep: highest pb_transno committed to disk */
676 __u64 pb_transno; /* server-assigned transno for modifying RPCs */
677 __u32 pb_flags; /* req: MSG_* flags */
678 __u32 pb_op_flags; /* req: MSG_CONNECT_* flags */
679 __u32 pb_conn_cnt; /* connect instance of this client on server */
680 __u32 pb_timeout; /* req: max wait time; rep: service estimate */
681 __u32 pb_service_time; /* rep: server arrival to reply in seconds */
682 __u32 pb_limit; /* rep: dynamic DLM LRU lock count limit */
683 __u64 pb_slv; /* rep: dynamic DLM LRU server lock volume */
684 /* VBR: rep: previous pb_version(s) of objects modified by this RPC */
685 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
686 __u64 pb_mbits; /**< match bits for bulk request */
687 /* padding for future needs - fix lustre_swab_ptlrpc_body() also */
688 __u64 pb_padding64_0;
689 __u64 pb_padding64_1;
690 __u64 pb_padding64_2;
691 char pb_jobid[LUSTRE_JOBID_SIZE]; /* req: ASCII jobid from env + NUL */
693 #define ptlrpc_body ptlrpc_body_v3
695 struct ptlrpc_body_v2 {
696 struct lustre_handle pb_handle;
701 __u64 pb_last_xid; /* highest replied XID without lower unreplied XID */
702 __u16 pb_tag; /* virtual slot idx for multiple modifying RPCs */
705 __u64 pb_last_committed;
710 __u32 pb_timeout; /* for req, the deadline, for rep, the service est */
711 __u32 pb_service_time; /* for rep, actual service time, also used for
712 net_latency of req */
715 /* VBR: pre-versions */
716 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
717 __u64 pb_mbits; /**< unused in V2 */
718 /* padding for future needs */
719 __u64 pb_padding64_0;
720 __u64 pb_padding64_1;
721 __u64 pb_padding64_2;
724 /* message body offset for lustre_msg_v2 */
725 /* ptlrpc body offset in all request/reply messages */
726 #define MSG_PTLRPC_BODY_OFF 0
728 /* normal request/reply message record offset */
729 #define REQ_REC_OFF 1
730 #define REPLY_REC_OFF 1
732 /* ldlm request message body offset */
733 #define DLM_LOCKREQ_OFF 1 /* lockreq offset */
734 #define DLM_REQ_REC_OFF 2 /* normal dlm request record offset */
736 /* ldlm intent lock message body offset */
737 #define DLM_INTENT_IT_OFF 2 /* intent lock it offset */
738 #define DLM_INTENT_REC_OFF 3 /* intent lock record offset */
740 /* ldlm reply message body offset */
741 #define DLM_LOCKREPLY_OFF 1 /* lockrep offset */
742 #define DLM_REPLY_REC_OFF 2 /* reply record offset */
744 /** only use in req->rq_{req,rep}_swab_mask */
745 #define MSG_PTLRPC_HEADER_OFF 31
748 #define OBD_CONNECT_RDONLY 0x1ULL /*client has read-only access*/
749 #define OBD_CONNECT_INDEX 0x2ULL /*connect specific LOV idx */
750 #define OBD_CONNECT_MDS 0x4ULL /*connect from MDT to OST */
751 #define OBD_CONNECT_GRANT 0x8ULL /*OSC gets grant at connect */
752 #define OBD_CONNECT_SRVLOCK 0x10ULL /*server takes locks for cli */
753 #define OBD_CONNECT_VERSION 0x20ULL /*Lustre versions in ocd */
754 #define OBD_CONNECT_REQPORTAL 0x40ULL /*Separate non-IO req portal */
755 #define OBD_CONNECT_ACL 0x80ULL /*access control lists */
756 #define OBD_CONNECT_XATTR 0x100ULL /*client use extended attr */
757 #define OBD_CONNECT_LARGE_ACL 0x200ULL /* more than 32 ACL entries */
758 #define OBD_CONNECT_TRUNCLOCK 0x400ULL /*locks on server for punch */
759 #define OBD_CONNECT_TRANSNO 0x800ULL /*replay sends init transno */
760 #define OBD_CONNECT_IBITS 0x1000ULL /* not checked in 2.11+ */
761 #define OBD_CONNECT_BARRIER 0x2000ULL /* write barrier */
762 #define OBD_CONNECT_ATTRFID 0x4000ULL /*Server can GetAttr By Fid*/
763 #define OBD_CONNECT_NODEVOH 0x8000ULL /*No open hndl on specl nodes*/
764 #define OBD_CONNECT_RMT_CLIENT 0x10000ULL /* Remote client, never used
765 * in production. Removed in
766 * 2.9. Keep this flag to
769 #define OBD_CONNECT_RMT_CLIENT_FORCE 0x20000ULL /* Remote client by force,
770 * never used in production.
771 * Removed in 2.9. Keep this
772 * flag to avoid reusing.
774 #define OBD_CONNECT_BRW_SIZE 0x40000ULL /*Max bytes per rpc */
775 #define OBD_CONNECT_QUOTA64 0x80000ULL /*Not used since 2.4 */
776 #define OBD_CONNECT_MDS_CAPA 0x100000ULL /*MDS capability */
777 #define OBD_CONNECT_OSS_CAPA 0x200000ULL /*OSS capability */
778 #define OBD_CONNECT_CANCELSET 0x400000ULL /*Early batched cancels. */
779 #define OBD_CONNECT_SOM 0x800000ULL /*Size on MDS */
780 #define OBD_CONNECT_AT 0x1000000ULL /*client uses AT */
781 #define OBD_CONNECT_LRU_RESIZE 0x2000000ULL /*LRU resize feature. */
782 #define OBD_CONNECT_MDS_MDS 0x4000000ULL /*MDS-MDS connection */
783 #define OBD_CONNECT_REAL 0x8000000ULL /* obsolete since 2.8 */
784 #define OBD_CONNECT_CHANGE_QS 0x10000000ULL /*Not used since 2.4 */
785 #define OBD_CONNECT_CKSUM 0x20000000ULL /*support several cksum algos*/
786 #define OBD_CONNECT_FID 0x40000000ULL /*FID is supported by server */
787 #define OBD_CONNECT_VBR 0x80000000ULL /*version based recovery */
788 #define OBD_CONNECT_LOV_V3 0x100000000ULL /*client supports LOV v3 EA */
789 #define OBD_CONNECT_GRANT_SHRINK 0x200000000ULL /* support grant shrink */
790 #define OBD_CONNECT_SKIP_ORPHAN 0x400000000ULL /* don't reuse orphan objids */
791 #define OBD_CONNECT_MAX_EASIZE 0x800000000ULL /* preserved for large EA */
792 #define OBD_CONNECT_FULL20 0x1000000000ULL /* it is 2.0 client */
793 #define OBD_CONNECT_LAYOUTLOCK 0x2000000000ULL /* client uses layout lock */
794 #define OBD_CONNECT_64BITHASH 0x4000000000ULL /* client supports 64-bits
796 #define OBD_CONNECT_MAXBYTES 0x8000000000ULL /* max stripe size */
797 #define OBD_CONNECT_IMP_RECOV 0x10000000000ULL /* imp recovery support */
798 #define OBD_CONNECT_JOBSTATS 0x20000000000ULL /* jobid in ptlrpc_body */
799 #define OBD_CONNECT_UMASK 0x40000000000ULL /* create uses client umask */
800 #define OBD_CONNECT_EINPROGRESS 0x80000000000ULL /* client handles -EINPROGRESS
801 * RPC error properly */
802 #define OBD_CONNECT_GRANT_PARAM 0x100000000000ULL/* extra grant params used for
803 * finer space reservation */
804 #define OBD_CONNECT_FLOCK_OWNER 0x200000000000ULL /* for the fixed 1.8
805 * policy and 2.x server */
806 #define OBD_CONNECT_LVB_TYPE 0x400000000000ULL /* variable type of LVB */
807 #define OBD_CONNECT_NANOSEC_TIME 0x800000000000ULL /* nanosecond timestamps */
808 #define OBD_CONNECT_LIGHTWEIGHT 0x1000000000000ULL/* lightweight connection */
809 #define OBD_CONNECT_SHORTIO 0x2000000000000ULL/* short io */
810 #define OBD_CONNECT_PINGLESS 0x4000000000000ULL/* pings not required */
811 #define OBD_CONNECT_FLOCK_DEAD 0x8000000000000ULL/* improved flock deadlock detection */
812 #define OBD_CONNECT_DISP_STRIPE 0x10000000000000ULL/* create stripe disposition*/
813 #define OBD_CONNECT_OPEN_BY_FID 0x20000000000000ULL /* open by fid won't pack
815 #define OBD_CONNECT_LFSCK 0x40000000000000ULL/* support online LFSCK */
816 #define OBD_CONNECT_UNLINK_CLOSE 0x100000000000000ULL/* close file in unlink */
817 #define OBD_CONNECT_MULTIMODRPCS 0x200000000000000ULL /* support multiple modify
819 #define OBD_CONNECT_DIR_STRIPE 0x400000000000000ULL /* striped DNE dir */
820 #define OBD_CONNECT_SUBTREE 0x800000000000000ULL /* fileset mount */
821 #define OBD_CONNECT_LOCKAHEAD_OLD 0x1000000000000000ULL /* Old Cray lockahead */
823 /** bulk matchbits is sent within ptlrpc_body */
824 #define OBD_CONNECT_BULK_MBITS 0x2000000000000000ULL
825 #define OBD_CONNECT_OBDOPACK 0x4000000000000000ULL /* compact OUT obdo */
826 #define OBD_CONNECT_FLAGS2 0x8000000000000000ULL /* second flags word */
827 /* ocd_connect_flags2 flags */
828 #define OBD_CONNECT2_FILE_SECCTX 0x1ULL /* set file security context at create */
829 #define OBD_CONNECT2_LOCKAHEAD 0x2ULL /* ladvise lockahead v2 */
830 #define OBD_CONNECT2_DIR_MIGRATE 0x4ULL /* migrate striped dir */
831 #define OBD_CONNECT2_SUM_STATFS 0x8ULL /* MDT return aggregated stats */
832 #define OBD_CONNECT2_FLR 0x20ULL /* FLR support */
833 #define OBD_CONNECT2_WBC_INTENTS 0x40ULL /* create/unlink/... intents for wbc, also operations under client-held parent locks */
834 #define OBD_CONNECT2_LOCK_CONVERT 0x80ULL /* IBITS lock convert support */
835 #define OBD_CONNECT2_ARCHIVE_ID_ARRAY 0x100ULL /* store HSM archive_id in array */
836 #define OBD_CONNECT2_SELINUX_POLICY 0x400ULL /* has client SELinux policy */
837 #define OBD_CONNECT2_LSOM 0x800ULL /* LSOM support */
838 #define OBD_CONNECT2_PCC 0x1000ULL /* Persistent Client Cache */
839 #define OBD_CONNECT2_PLAIN_LAYOUT 0x2000ULL /* Plain Directory Layout */
842 * Please DO NOT add flag values here before first ensuring that this same
843 * flag value is not in use on some other branch. Please clear any such
844 * changes with senior engineers before starting to use a new flag. Then,
845 * submit a small patch against EVERY branch that ONLY adds the new flag,
846 * updates obd_connect_names[] for lprocfs_rd_connect_flags(), adds the
847 * flag to check_obd_connect_data(), and updates wiretests accordingly, so it
848 * can be approved and landed easily to reserve the flag for future use. */
850 /* The MNE_SWAB flag is overloading the MDS_MDS bit only for the MGS
851 * connection. It is a temporary bug fix for Imperative Recovery interop
852 * between 2.2 and 2.3 x86/ppc nodes, and can be removed when interop for
853 * 2.2 clients/servers is no longer needed. LU-1252/LU-1644. */
854 #define OBD_CONNECT_MNE_SWAB OBD_CONNECT_MDS_MDS
856 #define OCD_HAS_FLAG(ocd, flg) \
857 (!!((ocd)->ocd_connect_flags & OBD_CONNECT_##flg))
860 #ifdef HAVE_LRU_RESIZE_SUPPORT
861 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
863 #define LRU_RESIZE_CONNECT_FLAG 0
866 #define MDT_CONNECT_SUPPORTED (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
867 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
868 OBD_CONNECT_IBITS | OBD_CONNECT_NODEVOH | \
869 OBD_CONNECT_ATTRFID | OBD_CONNECT_CANCELSET | \
870 OBD_CONNECT_AT | OBD_CONNECT_BRW_SIZE | \
871 OBD_CONNECT_MDS_MDS | OBD_CONNECT_FID | \
872 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_VBR | \
873 OBD_CONNECT_LOV_V3 | OBD_CONNECT_FULL20 | \
874 OBD_CONNECT_64BITHASH | OBD_CONNECT_JOBSTATS | \
875 OBD_CONNECT_EINPROGRESS | \
876 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_UMASK | \
877 OBD_CONNECT_LVB_TYPE | OBD_CONNECT_LAYOUTLOCK |\
878 OBD_CONNECT_PINGLESS | OBD_CONNECT_MAX_EASIZE |\
879 OBD_CONNECT_FLOCK_DEAD | \
880 OBD_CONNECT_DISP_STRIPE | OBD_CONNECT_LFSCK | \
881 OBD_CONNECT_OPEN_BY_FID | \
882 OBD_CONNECT_DIR_STRIPE | OBD_CONNECT_GRANT | \
883 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_SRVLOCK | \
884 OBD_CONNECT_BULK_MBITS | OBD_CONNECT_CKSUM | \
885 OBD_CONNECT_MULTIMODRPCS | \
886 OBD_CONNECT_SUBTREE | OBD_CONNECT_LARGE_ACL | \
887 OBD_CONNECT_GRANT_PARAM | \
888 OBD_CONNECT_SHORTIO | OBD_CONNECT_FLAGS2)
890 #define MDT_CONNECT_SUPPORTED2 (OBD_CONNECT2_FILE_SECCTX | OBD_CONNECT2_FLR | \
891 OBD_CONNECT2_SUM_STATFS | \
892 OBD_CONNECT2_LOCK_CONVERT | \
893 OBD_CONNECT2_DIR_MIGRATE | \
894 OBD_CONNECT2_ARCHIVE_ID_ARRAY | \
895 OBD_CONNECT2_SELINUX_POLICY | \
898 #define OST_CONNECT_SUPPORTED (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
899 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
900 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
901 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_CANCELSET | \
902 OBD_CONNECT_AT | LRU_RESIZE_CONNECT_FLAG | \
903 OBD_CONNECT_CKSUM | OBD_CONNECT_VBR | \
904 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
905 OBD_CONNECT_GRANT_SHRINK | OBD_CONNECT_FULL20 |\
906 OBD_CONNECT_64BITHASH | OBD_CONNECT_MAXBYTES | \
907 OBD_CONNECT_MAX_EASIZE | \
908 OBD_CONNECT_EINPROGRESS | \
909 OBD_CONNECT_JOBSTATS | \
910 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_LVB_TYPE|\
911 OBD_CONNECT_LAYOUTLOCK | OBD_CONNECT_FID | \
912 OBD_CONNECT_PINGLESS | OBD_CONNECT_LFSCK | \
913 OBD_CONNECT_BULK_MBITS | \
914 OBD_CONNECT_GRANT_PARAM | \
915 OBD_CONNECT_SHORTIO | OBD_CONNECT_FLAGS2)
917 #define OST_CONNECT_SUPPORTED2 OBD_CONNECT2_LOCKAHEAD
919 #define ECHO_CONNECT_SUPPORTED (OBD_CONNECT_FID)
920 #define ECHO_CONNECT_SUPPORTED2 0
922 #define MGS_CONNECT_SUPPORTED (OBD_CONNECT_VERSION | OBD_CONNECT_AT | \
923 OBD_CONNECT_FULL20 | OBD_CONNECT_IMP_RECOV | \
924 OBD_CONNECT_MNE_SWAB | OBD_CONNECT_PINGLESS |\
925 OBD_CONNECT_BULK_MBITS | OBD_CONNECT_BARRIER)
927 #define MGS_CONNECT_SUPPORTED2 0
929 /* Features required for this version of the client to work with server */
930 #define CLIENT_CONNECT_MDT_REQD (OBD_CONNECT_FID | \
931 OBD_CONNECT_ATTRFID | \
934 /* This structure is used for both request and reply.
936 * If we eventually have separate connect data for different types, which we
937 * almost certainly will, then perhaps we stick a union in here. */
938 struct obd_connect_data {
939 __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
940 __u32 ocd_version; /* lustre release version number */
941 __u32 ocd_grant; /* initial cache grant amount (bytes) */
942 __u32 ocd_index; /* LOV index to connect to */
943 __u32 ocd_brw_size; /* Maximum BRW size in bytes */
944 __u64 ocd_ibits_known; /* inode bits this client understands */
945 __u8 ocd_grant_blkbits; /* log2 of the backend filesystem blocksize */
946 __u8 ocd_grant_inobits; /* log2 of the per-inode space consumption */
947 __u16 ocd_grant_tax_kb; /* extent insertion overhead, in 1K blocks */
948 __u32 ocd_grant_max_blks;/* maximum number of blocks per extent */
949 __u64 ocd_transno; /* first transno from client to be replayed */
950 __u32 ocd_group; /* MDS group on OST */
951 __u32 ocd_cksum_types; /* supported checksum algorithms */
952 __u32 ocd_max_easize; /* How big LOV EA can be on MDS */
953 __u32 ocd_instance; /* instance # of this target */
954 __u64 ocd_maxbytes; /* Maximum stripe size in bytes */
955 /* Fields after ocd_maxbytes are only accessible by the receiver
956 * if the corresponding flag in ocd_connect_flags is set. Accessing
957 * any field after ocd_maxbytes on the receiver without a valid flag
958 * may result in out-of-bound memory access and kernel oops. */
959 __u16 ocd_maxmodrpcs; /* Maximum modify RPCs in parallel */
960 __u16 padding0; /* added 2.1.0. also fix lustre_swab_connect */
961 __u32 padding1; /* added 2.1.0. also fix lustre_swab_connect */
962 __u64 ocd_connect_flags2;
963 __u64 padding3; /* added 2.1.0. also fix lustre_swab_connect */
964 __u64 padding4; /* added 2.1.0. also fix lustre_swab_connect */
965 __u64 padding5; /* added 2.1.0. also fix lustre_swab_connect */
966 __u64 padding6; /* added 2.1.0. also fix lustre_swab_connect */
967 __u64 padding7; /* added 2.1.0. also fix lustre_swab_connect */
968 __u64 padding8; /* added 2.1.0. also fix lustre_swab_connect */
969 __u64 padding9; /* added 2.1.0. also fix lustre_swab_connect */
970 __u64 paddingA; /* added 2.1.0. also fix lustre_swab_connect */
971 __u64 paddingB; /* added 2.1.0. also fix lustre_swab_connect */
972 __u64 paddingC; /* added 2.1.0. also fix lustre_swab_connect */
973 __u64 paddingD; /* added 2.1.0. also fix lustre_swab_connect */
974 __u64 paddingE; /* added 2.1.0. also fix lustre_swab_connect */
975 __u64 paddingF; /* added 2.1.0. also fix lustre_swab_connect */
978 * Please DO NOT use any fields here before first ensuring that this same
979 * field is not in use on some other branch. Please clear any such changes
980 * with senior engineers before starting to use a new field. Then, submit
981 * a small patch against EVERY branch that ONLY adds the new field along with
982 * the matching OBD_CONNECT flag, so that can be approved and landed easily to
983 * reserve the flag for future use. */
986 * Supported checksum algorithms. Up to 32 checksum types are supported.
987 * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
988 * Please update DECLARE_CKSUM_NAME in obd_cksum.h when adding a new
989 * algorithm and also the OBD_FL_CKSUM* flags, OBD_CKSUM_ALL flag,
990 * OBD_FL_CKSUM_ALL flag and potentially OBD_CKSUM_T10_ALL flag.
993 OBD_CKSUM_CRC32 = 0x00000001,
994 OBD_CKSUM_ADLER = 0x00000002,
995 OBD_CKSUM_CRC32C = 0x00000004,
996 OBD_CKSUM_RESERVED = 0x00000008,
997 OBD_CKSUM_T10IP512 = 0x00000010,
998 OBD_CKSUM_T10IP4K = 0x00000020,
999 OBD_CKSUM_T10CRC512 = 0x00000040,
1000 OBD_CKSUM_T10CRC4K = 0x00000080,
1003 #define OBD_CKSUM_T10_ALL (OBD_CKSUM_T10IP512 | OBD_CKSUM_T10IP4K | \
1004 OBD_CKSUM_T10CRC512 | OBD_CKSUM_T10CRC4K)
1006 #define OBD_CKSUM_ALL (OBD_CKSUM_CRC32 | OBD_CKSUM_ADLER | OBD_CKSUM_CRC32C | \
1010 * The default checksum algorithm used on top of T10PI GRD tags for RPC.
1011 * Considering that the checksum-of-checksums is only computing CRC32 on a
1012 * 4KB chunk of GRD tags for a 1MB RPC for 512B sectors, or 16KB of GRD
1013 * tags for 16MB of 4KB sectors, this is only 1/256 or 1/1024 of the
1014 * total data being checksummed, so the checksum type used here should not
1015 * affect overall system performance noticeably.
1017 #define OBD_CKSUM_T10_TOP OBD_CKSUM_ADLER
1020 * OST requests: OBDO & OBD request records
1025 OST_REPLY = 0, /* reply ? */
1041 OST_QUOTACHECK = 18, /* not used since 2.4 */
1043 OST_QUOTA_ADJUST_QUNIT = 20, /* not used since 2.4 */
1045 OST_LAST_OPC /* must be < 33 to avoid MDS_GETATTR */
1047 #define OST_FIRST_OPC OST_REPLY
1050 OBD_FL_INLINEDATA = 0x00000001,
1051 OBD_FL_OBDMDEXISTS = 0x00000002,
1052 OBD_FL_DELORPHAN = 0x00000004, /* if set in o_flags delete orphans */
1053 OBD_FL_NORPC = 0x00000008, /* set in o_flags do in OSC not OST */
1054 OBD_FL_IDONLY = 0x00000010, /* set in o_flags only adjust obj id*/
1055 OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
1056 OBD_FL_DEBUG_CHECK = 0x00000040, /* echo client/server debug check */
1057 OBD_FL_NO_PRJQUOTA = 0x00000080, /* the object's project is over
1059 OBD_FL_NO_USRQUOTA = 0x00000100, /* the object's owner is over quota */
1060 OBD_FL_NO_GRPQUOTA = 0x00000200, /* the object's group is over quota */
1061 OBD_FL_CREATE_CROW = 0x00000400, /* object should be create on write */
1062 OBD_FL_SRVLOCK = 0x00000800, /* delegate DLM locking to server */
1063 OBD_FL_CKSUM_CRC32 = 0x00001000, /* CRC32 checksum type */
1064 OBD_FL_CKSUM_ADLER = 0x00002000, /* ADLER checksum type */
1065 OBD_FL_CKSUM_CRC32C = 0x00004000, /* CRC32C checksum type */
1066 OBD_FL_CKSUM_T10IP512 = 0x00005000, /* T10PI IP cksum, 512B sector */
1067 OBD_FL_CKSUM_T10IP4K = 0x00006000, /* T10PI IP cksum, 4KB sector */
1068 OBD_FL_CKSUM_T10CRC512 = 0x00007000, /* T10PI CRC cksum, 512B sector */
1069 OBD_FL_CKSUM_T10CRC4K = 0x00008000, /* T10PI CRC cksum, 4KB sector */
1070 OBD_FL_CKSUM_RSVD3 = 0x00010000, /* for future cksum types */
1071 OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
1072 OBD_FL_MMAP = 0x00040000, /* object is mmapped on the client.
1073 * XXX: obsoleted - reserved for old
1074 * clients prior than 2.2 */
1075 OBD_FL_RECOV_RESEND = 0x00080000, /* recoverable resent */
1076 OBD_FL_NOSPC_BLK = 0x00100000, /* no more block space on OST */
1077 OBD_FL_FLUSH = 0x00200000, /* flush pages on the OST */
1078 OBD_FL_SHORT_IO = 0x00400000, /* short io request */
1079 /* OBD_FL_LOCAL_MASK = 0xF0000000, was local-only flags until 2.10 */
1082 * Note that while the original checksum values were separate bits,
1083 * in 2.x we can actually allow all values from 1-31. T10-PI checksum
1084 * types already use values which are not separate bits.
1086 OBD_FL_CKSUM_ALL = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER |
1087 OBD_FL_CKSUM_CRC32C | OBD_FL_CKSUM_T10IP512 |
1088 OBD_FL_CKSUM_T10IP4K | OBD_FL_CKSUM_T10CRC512 |
1089 OBD_FL_CKSUM_T10CRC4K,
1091 OBD_FL_NO_QUOTA_ALL = OBD_FL_NO_USRQUOTA | OBD_FL_NO_GRPQUOTA |
1096 * All LOV EA magics should have the same postfix, if some new version
1097 * Lustre instroduces new LOV EA magic, then when down-grade to an old
1098 * Lustre, even though the old version system does not recognizes such
1099 * new magic, it still can distinguish the corrupted cases by checking
1100 * the magic's postfix.
1102 #define LOV_MAGIC_MAGIC 0x0BD0
1103 #define LOV_MAGIC_MASK 0xFFFF
1105 #define LOV_MAGIC_V1 (0x0BD10000 | LOV_MAGIC_MAGIC)
1106 #define LOV_MAGIC_JOIN_V1 (0x0BD20000 | LOV_MAGIC_MAGIC)
1107 #define LOV_MAGIC_V3 (0x0BD30000 | LOV_MAGIC_MAGIC)
1108 #define LOV_MAGIC_MIGRATE (0x0BD40000 | LOV_MAGIC_MAGIC)
1109 /* reserved for specifying OSTs */
1110 #define LOV_MAGIC_SPECIFIC (0x0BD50000 | LOV_MAGIC_MAGIC)
1111 #define LOV_MAGIC LOV_MAGIC_V1
1112 #define LOV_MAGIC_COMP_V1 (0x0BD60000 | LOV_MAGIC_MAGIC)
1115 * magic for fully defined striping
1116 * the idea is that we should have different magics for striping "hints"
1117 * (struct lov_user_md_v[13]) and defined ready-to-use striping (struct
1118 * lov_mds_md_v[13]). at the moment the magics are used in wire protocol,
1119 * we can't just change it w/o long way preparation, but we still need a
1120 * mechanism to allow LOD to differentiate hint versus ready striping.
1121 * so, at the moment we do a trick: MDT knows what to expect from request
1122 * depending on the case (replay uses ready striping, non-replay req uses
1123 * hints), so MDT replaces magic with appropriate one and now LOD can
1124 * easily understand what's inside -bzzz
1126 * those *_DEF magics are only used on server side internally, they
1127 * won't be put on wire or disk.
1129 #define LOV_MAGIC_DEFINED 0x10000000
1130 #define LOV_MAGIC_V1_DEFINED (LOV_MAGIC_DEFINED | LOV_MAGIC_V1)
1131 #define LOV_MAGIC_V3_DEFINED (LOV_MAGIC_DEFINED | LOV_MAGIC_V3)
1132 #define LOV_MAGIC_COMP_V1_DEFINED (LOV_MAGIC_DEFINED | LOV_MAGIC_COMP_V1)
1134 #define lov_pattern(pattern) (pattern & ~LOV_PATTERN_F_MASK)
1135 #define lov_pattern_flags(pattern) (pattern & LOV_PATTERN_F_MASK)
1137 #define lov_ost_data lov_ost_data_v1
1138 struct lov_ost_data_v1 { /* per-stripe data structure (little-endian)*/
1139 struct ost_id l_ost_oi; /* OST object ID */
1140 __u32 l_ost_gen; /* generation of this l_ost_idx */
1141 __u32 l_ost_idx; /* OST index in LOV (lov_tgt_desc->tgts) */
1144 #define lov_mds_md lov_mds_md_v1
1145 struct lov_mds_md_v1 { /* LOV EA mds/wire data (little-endian) */
1146 __u32 lmm_magic; /* magic number = LOV_MAGIC_V1 */
1147 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1148 struct ost_id lmm_oi; /* LOV object ID */
1149 __u32 lmm_stripe_size; /* size of stripe in bytes */
1150 /* lmm_stripe_count used to be __u32 */
1151 __u16 lmm_stripe_count; /* num stripes in use for this object */
1152 __u16 lmm_layout_gen; /* layout generation number */
1153 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1156 #define MAX_MD_SIZE_OLD (sizeof(struct lov_mds_md) + \
1157 4 * sizeof(struct lov_ost_data))
1158 #define MAX_MD_SIZE (sizeof(struct lov_comp_md_v1) + \
1159 4 * (sizeof(struct lov_comp_md_entry_v1) + \
1161 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
1163 /* This is the default MDT reply size allocated, should the striping be bigger,
1164 * it will be reallocated in mdt_fix_reply.
1165 * 100 stripes is a bit less than 2.5k of data */
1166 #define DEF_REP_MD_SIZE (sizeof(struct lov_mds_md) + \
1167 100 * sizeof(struct lov_ost_data))
1169 #define XATTR_NAME_ACL_ACCESS "system.posix_acl_access"
1170 #define XATTR_NAME_ACL_DEFAULT "system.posix_acl_default"
1171 #define XATTR_USER_PREFIX "user."
1172 #define XATTR_TRUSTED_PREFIX "trusted."
1173 #define XATTR_SECURITY_PREFIX "security."
1175 #define XATTR_NAME_SOM "trusted.som"
1176 #define XATTR_NAME_LOV "trusted.lov"
1177 #define XATTR_NAME_LMA "trusted.lma"
1178 #define XATTR_NAME_LMV "trusted.lmv"
1179 #define XATTR_NAME_DEFAULT_LMV "trusted.dmv"
1180 #define XATTR_NAME_LINK "trusted.link"
1181 #define XATTR_NAME_FID "trusted.fid"
1182 #define XATTR_NAME_VERSION "trusted.version"
1183 #define XATTR_NAME_SOM "trusted.som"
1184 #define XATTR_NAME_HSM "trusted.hsm"
1185 #define XATTR_NAME_LFSCK_BITMAP "trusted.lfsck_bitmap"
1186 #define XATTR_NAME_DUMMY "trusted.dummy"
1188 #define XATTR_NAME_LFSCK_NAMESPACE "trusted.lfsck_ns"
1189 #define XATTR_NAME_MAX_LEN 32 /* increase this, if there is longer name. */
1191 struct lov_mds_md_v3 { /* LOV EA mds/wire data (little-endian) */
1192 __u32 lmm_magic; /* magic number = LOV_MAGIC_V3 */
1193 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1194 struct ost_id lmm_oi; /* LOV object ID */
1195 __u32 lmm_stripe_size; /* size of stripe in bytes */
1196 /* lmm_stripe_count used to be __u32 */
1197 __u16 lmm_stripe_count; /* num stripes in use for this object */
1198 __u16 lmm_layout_gen; /* layout generation number */
1199 char lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* must be 32bit aligned */
1200 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1203 static inline __u32 lov_mds_md_size(__u16 stripes, __u32 lmm_magic)
1205 if (stripes == (__u16)-1)
1208 if (lmm_magic == LOV_MAGIC_V3)
1209 return sizeof(struct lov_mds_md_v3) +
1210 stripes * sizeof(struct lov_ost_data_v1);
1212 return sizeof(struct lov_mds_md_v1) +
1213 stripes * sizeof(struct lov_ost_data_v1);
1217 lov_mds_md_max_stripe_count(size_t buf_size, __u32 lmm_magic)
1219 switch (lmm_magic) {
1220 case LOV_MAGIC_V1: {
1221 struct lov_mds_md_v1 lmm;
1223 if (buf_size < sizeof(lmm))
1226 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1228 case LOV_MAGIC_V3: {
1229 struct lov_mds_md_v3 lmm;
1231 if (buf_size < sizeof(lmm))
1234 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1241 #define OBD_MD_FLID (0x00000001ULL) /* object ID */
1242 #define OBD_MD_FLATIME (0x00000002ULL) /* access time */
1243 #define OBD_MD_FLMTIME (0x00000004ULL) /* data modification time */
1244 #define OBD_MD_FLCTIME (0x00000008ULL) /* change time */
1245 #define OBD_MD_FLSIZE (0x00000010ULL) /* size */
1246 #define OBD_MD_FLBLOCKS (0x00000020ULL) /* allocated blocks count */
1247 #define OBD_MD_FLBLKSZ (0x00000040ULL) /* block size */
1248 #define OBD_MD_FLMODE (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1249 #define OBD_MD_FLTYPE (0x00000100ULL) /* object type (mode & S_IFMT) */
1250 #define OBD_MD_FLUID (0x00000200ULL) /* user ID */
1251 #define OBD_MD_FLGID (0x00000400ULL) /* group ID */
1252 #define OBD_MD_FLFLAGS (0x00000800ULL) /* flags word */
1253 #define OBD_MD_DOM_SIZE (0X00001000ULL) /* Data-on-MDT component size */
1254 #define OBD_MD_FLNLINK (0x00002000ULL) /* link count */
1255 #define OBD_MD_FLPARENT (0x00004000ULL) /* parent FID */
1256 #define OBD_MD_LAYOUT_VERSION (0x00008000ULL) /* OST object layout version */
1257 #define OBD_MD_FLRDEV (0x00010000ULL) /* device number */
1258 #define OBD_MD_FLEASIZE (0x00020000ULL) /* extended attribute data */
1259 #define OBD_MD_LINKNAME (0x00040000ULL) /* symbolic link target */
1260 #define OBD_MD_FLHANDLE (0x00080000ULL) /* file/lock handle */
1261 #define OBD_MD_FLCKSUM (0x00100000ULL) /* bulk data checksum */
1262 /* OBD_MD_FLQOS (0x00200000ULL) has never been used */
1263 /* OBD_MD_FLCOOKIE (0x00800000ULL) obsolete in 2.8 */
1264 #define OBD_MD_FLPRJQUOTA (0x00400000ULL) /* over quota flags sent from ost */
1265 #define OBD_MD_FLGROUP (0x01000000ULL) /* group */
1266 #define OBD_MD_FLFID (0x02000000ULL) /* ->ost write inline fid */
1267 /* OBD_MD_FLEPOCH (0x04000000ULL) obsolete 2.7.50 */
1268 /* ->mds if epoch opens or closes */
1269 #define OBD_MD_FLGRANT (0x08000000ULL) /* ost preallocation space grant */
1270 #define OBD_MD_FLDIREA (0x10000000ULL) /* dir's extended attribute data */
1271 #define OBD_MD_FLUSRQUOTA (0x20000000ULL) /* over quota flags sent from ost */
1272 #define OBD_MD_FLGRPQUOTA (0x40000000ULL) /* over quota flags sent from ost */
1273 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1275 #define OBD_MD_MDS (0x0000000100000000ULL) /* where an inode lives on */
1276 /* OBD_MD_REINT (0x0000000200000000ULL) obsolete 1.8 */
1277 #define OBD_MD_MEA (0x0000000400000000ULL) /* CMD split EA */
1278 #define OBD_MD_TSTATE (0x0000000800000000ULL) /* transient state field */
1280 #define OBD_MD_FLXATTR (0x0000001000000000ULL) /* xattr */
1281 #define OBD_MD_FLXATTRLS (0x0000002000000000ULL) /* xattr list */
1282 #define OBD_MD_FLXATTRRM (0x0000004000000000ULL) /* xattr remove */
1283 #define OBD_MD_FLACL (0x0000008000000000ULL) /* ACL */
1284 #define OBD_MD_FLAGSTATFS (0x0000010000000000ULL) /* aggregated statfs */
1285 /* OBD_MD_FLMDSCAPA (0x0000020000000000ULL) obsolete 2.7.54 */
1286 /* OBD_MD_FLOSSCAPA (0x0000040000000000ULL) obsolete 2.7.54 */
1287 /* OBD_MD_FLCKSPLIT (0x0000080000000000ULL) obsolete 2.3.58*/
1288 #define OBD_MD_FLCROSSREF (0x0000100000000000ULL) /* Cross-ref case */
1289 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1290 * under lock; for xattr
1291 * requests means the
1292 * client holds the lock */
1293 #define OBD_MD_FLOBJCOUNT (0x0000400000000000ULL) /* for multiple destroy */
1295 #define OBD_MD_FLDATAVERSION (0x0010000000000000ULL) /* iversion sum */
1296 #define OBD_MD_CLOSE_INTENT_EXECED (0x0020000000000000ULL) /* close intent
1299 #define OBD_MD_DEFAULT_MEA (0x0040000000000000ULL) /* default MEA */
1300 #define OBD_MD_FLOSTLAYOUT (0x0080000000000000ULL) /* contain ost_layout */
1301 #define OBD_MD_FLPROJID (0x0100000000000000ULL) /* project ID */
1302 #define OBD_MD_SECCTX (0x0200000000000000ULL) /* embed security xattr */
1304 #define OBD_MD_FLALLQUOTA (OBD_MD_FLUSRQUOTA | \
1305 OBD_MD_FLGRPQUOTA | \
1308 #define OBD_MD_FLGETATTR (OBD_MD_FLID | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1309 OBD_MD_FLCTIME | OBD_MD_FLSIZE | OBD_MD_FLBLKSZ | \
1310 OBD_MD_FLMODE | OBD_MD_FLTYPE | OBD_MD_FLUID | \
1311 OBD_MD_FLGID | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1312 OBD_MD_FLPARENT | OBD_MD_FLRDEV | OBD_MD_FLGROUP | \
1315 #define OBD_MD_FLXATTRALL (OBD_MD_FLXATTR | OBD_MD_FLXATTRLS)
1317 /* don't forget obdo_fid which is way down at the bottom so it can
1318 * come after the definition of llog_cookie */
1322 HSS_CLEARMASK = 0x02,
1323 HSS_ARCHIVE_ID = 0x04,
1326 struct hsm_state_set {
1328 __u32 hss_archive_id;
1330 __u64 hss_clearmask;
1333 /* ost_body.data values for OST_BRW */
1335 #define OBD_BRW_READ 0x01
1336 #define OBD_BRW_WRITE 0x02
1337 #define OBD_BRW_RWMASK (OBD_BRW_READ | OBD_BRW_WRITE)
1338 #define OBD_BRW_NDELAY 0x04 /* Non-delay RPC should be issued for
1339 * this page. Non-delay RPCs have bit
1340 * rq_no_delay set. */
1341 #define OBD_BRW_SYNC 0x08 /* this page is a part of synchronous
1342 * transfer and is not accounted in
1344 #define OBD_BRW_CHECK 0x10
1345 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
1346 #define OBD_BRW_GRANTED 0x40 /* the ost manages this */
1347 #define OBD_BRW_NOCACHE 0x80 /* this page is a part of non-cached IO */
1348 #define OBD_BRW_NOQUOTA 0x100
1349 #define OBD_BRW_SRVLOCK 0x200 /* Client holds no lock over this page */
1350 #define OBD_BRW_ASYNC 0x400 /* Server may delay commit to disk */
1351 #define OBD_BRW_MEMALLOC 0x800 /* Client runs in the "kswapd" context */
1352 #define OBD_BRW_OVER_USRQUOTA 0x1000 /* Running out of user quota */
1353 #define OBD_BRW_OVER_GRPQUOTA 0x2000 /* Running out of group quota */
1354 #define OBD_BRW_SOFT_SYNC 0x4000 /* This flag notifies the server
1355 * that the client is running low on
1356 * space for unstable pages; asking
1357 * it to sync quickly */
1358 #define OBD_BRW_OVER_PRJQUOTA 0x8000 /* Running out of project quota */
1360 #define OBD_BRW_OVER_ALLQUOTA (OBD_BRW_OVER_USRQUOTA | \
1361 OBD_BRW_OVER_GRPQUOTA | \
1362 OBD_BRW_OVER_PRJQUOTA)
1364 #define OBD_BRW_LOCAL1 0x80000000UL /*
1365 * osd-ldiskfs internal,
1366 * page mapped to real block
1369 #define OBD_BRW_LOCALS (OBD_BRW_LOCAL1)
1371 #define OBD_MAX_GRANT 0x7fffffffUL /* Max grant allowed to one client: 2 GiB */
1373 #define OBD_OBJECT_EOF LUSTRE_EOF
1375 #define OST_MIN_PRECREATE 32
1376 #define OST_MAX_PRECREATE 20000
1379 struct ost_id ioo_oid; /* object ID, if multi-obj BRW */
1380 __u32 ioo_max_brw; /* low 16 bits were o_mode before 2.4,
1381 * now (PTLRPC_BULK_OPS_COUNT - 1) in
1382 * high 16 bits in 2.4 and later */
1383 __u32 ioo_bufcnt; /* number of niobufs for this object */
1386 /* NOTE: IOOBJ_MAX_BRW_BITS defines the _offset_ of the max_brw field in
1387 * ioo_max_brw, NOT the maximum number of bits in PTLRPC_BULK_OPS_BITS.
1388 * That said, ioo_max_brw is a 32-bit field so the limit is also 16 bits. */
1389 #define IOOBJ_MAX_BRW_BITS 16
1390 #define ioobj_max_brw_get(ioo) (((ioo)->ioo_max_brw >> IOOBJ_MAX_BRW_BITS) + 1)
1391 #define ioobj_max_brw_set(ioo, num) \
1392 do { (ioo)->ioo_max_brw = ((num) - 1) << IOOBJ_MAX_BRW_BITS; } while (0)
1394 /* multiple of 8 bytes => can array */
1395 struct niobuf_remote {
1401 /* lock value block communicated between the filter and llite */
1403 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1404 * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1405 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1406 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1407 #define OST_LVB_IS_ERR(blocks) \
1408 ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1409 #define OST_LVB_SET_ERR(blocks, rc) \
1410 do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1411 #define OST_LVB_GET_ERR(blocks) (int)(blocks - OST_LVB_ERR_INIT)
1434 * lquota data structures
1437 #ifndef QUOTABLOCK_BITS
1438 # define QUOTABLOCK_BITS LUSTRE_QUOTABLOCK_BITS
1441 #ifndef QUOTABLOCK_SIZE
1442 # define QUOTABLOCK_SIZE LUSTRE_QUOTABLOCK_SIZE
1446 # define toqb lustre_stoqb
1449 /* The lquota_id structure is an union of all the possible identifier types that
1450 * can be used with quota, this includes:
1453 * - a FID which can be used for per-directory quota in the future */
1455 struct lu_fid qid_fid; /* FID for per-directory quota */
1456 __u64 qid_uid; /* user identifier */
1457 __u64 qid_gid; /* group identifier */
1458 __u64 qid_projid; /* project identifier */
1461 /* quotactl management */
1462 struct obd_quotactl {
1464 __u32 qc_type; /* see Q_* flag below */
1467 struct obd_dqinfo qc_dqinfo;
1468 struct obd_dqblk qc_dqblk;
1471 #define Q_COPY(out, in, member) (out)->member = (in)->member
1473 #define QCTL_COPY(out, in) \
1475 Q_COPY(out, in, qc_cmd); \
1476 Q_COPY(out, in, qc_type); \
1477 Q_COPY(out, in, qc_id); \
1478 Q_COPY(out, in, qc_stat); \
1479 Q_COPY(out, in, qc_dqinfo); \
1480 Q_COPY(out, in, qc_dqblk); \
1483 /* Body of quota request used for quota acquire/release RPCs between quota
1484 * master (aka QMT) and slaves (ak QSD). */
1486 struct lu_fid qb_fid; /* FID of global index packing the pool ID
1487 * and type (data or metadata) as well as
1488 * the quota type (user or group). */
1489 union lquota_id qb_id; /* uid or gid or directory FID */
1490 __u32 qb_flags; /* see below */
1492 __u64 qb_count; /* acquire/release count (kbytes/inodes) */
1493 __u64 qb_usage; /* current slave usage (kbytes/inodes) */
1494 __u64 qb_slv_ver; /* slave index file version */
1495 struct lustre_handle qb_lockh; /* per-ID lock handle */
1496 struct lustre_handle qb_glb_lockh; /* global lock handle */
1497 __u64 qb_padding1[4];
1500 /* When the quota_body is used in the reply of quota global intent
1501 * lock (IT_QUOTA_CONN) reply, qb_fid contains slave index file FID. */
1502 #define qb_slv_fid qb_fid
1503 /* qb_usage is the current qunit (in kbytes/inodes) when quota_body is used in
1505 #define qb_qunit qb_usage
1507 #define QUOTA_DQACQ_FL_ACQ 0x1 /* acquire quota */
1508 #define QUOTA_DQACQ_FL_PREACQ 0x2 /* pre-acquire */
1509 #define QUOTA_DQACQ_FL_REL 0x4 /* release quota */
1510 #define QUOTA_DQACQ_FL_REPORT 0x8 /* report usage */
1512 /* Quota types currently supported */
1514 LQUOTA_TYPE_USR = 0x00, /* maps to USRQUOTA */
1515 LQUOTA_TYPE_GRP = 0x01, /* maps to GRPQUOTA */
1516 LQUOTA_TYPE_PRJ = 0x02, /* maps to PRJQUOTA */
1520 /* There are 2 different resource types on which a quota limit can be enforced:
1521 * - inodes on the MDTs
1522 * - blocks on the OSTs */
1524 LQUOTA_RES_MD = 0x01, /* skip 0 to avoid null oid in FID */
1525 LQUOTA_RES_DT = 0x02,
1527 LQUOTA_FIRST_RES = LQUOTA_RES_MD
1529 #define LQUOTA_NR_RES (LQUOTA_LAST_RES - LQUOTA_FIRST_RES + 1)
1532 * Space accounting support
1533 * Format of an accounting record, providing disk usage information for a given
1536 struct lquota_acct_rec { /* 16 bytes */
1537 __u64 bspace; /* current space in use */
1538 __u64 ispace; /* current # inodes in use */
1542 * Global quota index support
1543 * Format of a global record, providing global quota settings for a given quota
1546 struct lquota_glb_rec { /* 32 bytes */
1547 __u64 qbr_hardlimit; /* quota hard limit, in #inodes or kbytes */
1548 __u64 qbr_softlimit; /* quota soft limit, in #inodes or kbytes */
1549 __u64 qbr_time; /* grace time, in seconds */
1550 __u64 qbr_granted; /* how much is granted to slaves, in #inodes or
1555 * Slave index support
1556 * Format of a slave record, recording how much space is granted to a given
1559 struct lquota_slv_rec { /* 8 bytes */
1560 __u64 qsr_granted; /* space granted to the slave for the key=ID,
1561 * in #inodes or kbytes */
1564 /* Data structures associated with the quota locks */
1566 /* Glimpse descriptor used for the index & per-ID quota locks */
1567 struct ldlm_gl_lquota_desc {
1568 union lquota_id gl_id; /* quota ID subject to the glimpse */
1569 __u64 gl_flags; /* see LQUOTA_FL* below */
1570 __u64 gl_ver; /* new index version */
1571 __u64 gl_hardlimit; /* new hardlimit or qunit value */
1572 __u64 gl_softlimit; /* new softlimit */
1576 #define gl_qunit gl_hardlimit /* current qunit value used when
1577 * glimpsing per-ID quota locks */
1579 /* quota glimpse flags */
1580 #define LQUOTA_FL_EDQUOT 0x1 /* user/group out of quota space on QMT */
1582 /* LVB used with quota (global and per-ID) locks */
1584 __u64 lvb_flags; /* see LQUOTA_FL* above */
1585 __u64 lvb_id_may_rel; /* space that might be released later */
1586 __u64 lvb_id_rel; /* space released by the slave for this ID */
1587 __u64 lvb_id_qunit; /* current qunit value */
1591 /* LVB used with global quota lock */
1592 #define lvb_glb_ver lvb_id_may_rel /* current version of the global index */
1600 #define QUOTA_FIRST_OPC QUOTA_DQACQ
1609 MDS_GETATTR_NAME = 34,
1614 MDS_DISCONNECT = 39,
1617 MDS_PIN = 42, /* obsolete, never used in a release */
1618 MDS_UNPIN = 43, /* obsolete, never used in a release */
1620 MDS_DONE_WRITING = 45, /* obsolete since 2.8.0 */
1622 MDS_QUOTACHECK = 47, /* not used since 2.4 */
1625 MDS_SETXATTR = 50, /* obsolete, now it's MDS_REINT op */
1627 MDS_IS_SUBDIR = 52, /* obsolete, never used in a release */
1629 MDS_HSM_STATE_GET = 54,
1630 MDS_HSM_STATE_SET = 55,
1631 MDS_HSM_ACTION = 56,
1632 MDS_HSM_PROGRESS = 57,
1633 MDS_HSM_REQUEST = 58,
1634 MDS_HSM_CT_REGISTER = 59,
1635 MDS_HSM_CT_UNREGISTER = 60,
1636 MDS_SWAP_LAYOUTS = 61,
1640 #define MDS_FIRST_OPC MDS_GETATTR
1643 /* opcodes for object update */
1649 #define OUT_UPDATE_FIRST_OPC OUT_UPDATE
1669 /* the disposition of the intent outlines what was executed */
1670 #define DISP_IT_EXECD 0x00000001
1671 #define DISP_LOOKUP_EXECD 0x00000002
1672 #define DISP_LOOKUP_NEG 0x00000004
1673 #define DISP_LOOKUP_POS 0x00000008
1674 #define DISP_OPEN_CREATE 0x00000010
1675 #define DISP_OPEN_OPEN 0x00000020
1676 #define DISP_ENQ_COMPLETE 0x00400000 /* obsolete and unused */
1677 #define DISP_ENQ_OPEN_REF 0x00800000
1678 #define DISP_ENQ_CREATE_REF 0x01000000
1679 #define DISP_OPEN_LOCK 0x02000000
1680 #define DISP_OPEN_LEASE 0x04000000
1681 #define DISP_OPEN_STRIPE 0x08000000
1682 #define DISP_OPEN_DENY 0x10000000
1684 /* INODE LOCK PARTS */
1685 #define MDS_INODELOCK_LOOKUP 0x000001 /* For namespace, dentry etc, and also
1686 * was used to protect permission (mode,
1687 * owner, group etc) before 2.4. */
1688 #define MDS_INODELOCK_UPDATE 0x000002 /* size, links, timestamps */
1689 #define MDS_INODELOCK_OPEN 0x000004 /* For opened files */
1690 #define MDS_INODELOCK_LAYOUT 0x000008 /* for layout */
1692 /* The PERM bit is added int 2.4, and it is used to protect permission(mode,
1693 * owner, group, acl etc), so to separate the permission from LOOKUP lock.
1694 * Because for remote directories(in DNE), these locks will be granted by
1695 * different MDTs(different ldlm namespace).
1697 * For local directory, MDT will always grant UPDATE_LOCK|PERM_LOCK together.
1698 * For Remote directory, the master MDT, where the remote directory is, will
1699 * grant UPDATE_LOCK|PERM_LOCK, and the remote MDT, where the name entry is,
1700 * will grant LOOKUP_LOCK. */
1701 #define MDS_INODELOCK_PERM 0x000010
1702 #define MDS_INODELOCK_XATTR 0x000020 /* extended attributes */
1703 #define MDS_INODELOCK_DOM 0x000040 /* Data for data-on-mdt files */
1705 #define MDS_INODELOCK_MAXSHIFT 6
1706 /* This FULL lock is useful to take on unlink sort of operations */
1707 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
1708 /* DOM lock shouldn't be canceled early, use this macro for ELC */
1709 #define MDS_INODELOCK_ELC (MDS_INODELOCK_FULL & ~MDS_INODELOCK_DOM)
1711 /* NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
1712 * but was moved into name[1] along with the OID to avoid consuming the
1713 * name[2,3] fields that need to be used for the quota id (also a FID). */
1715 LUSTRE_RES_ID_SEQ_OFF = 0,
1716 LUSTRE_RES_ID_VER_OID_OFF = 1,
1717 LUSTRE_RES_ID_WAS_VER_OFF = 2, /* see note above */
1718 LUSTRE_RES_ID_QUOTA_SEQ_OFF = 2,
1719 LUSTRE_RES_ID_QUOTA_VER_OID_OFF = 3,
1720 LUSTRE_RES_ID_HSH_OFF = 3
1723 #define MDS_STATUS_CONN 1
1724 #define MDS_STATUS_LOV 2
1727 /* these should be identical to their EXT4_*_FL counterparts, they are
1728 * redefined here only to avoid dragging in fs/ext4/ext4.h */
1729 LUSTRE_SYNC_FL = 0x00000008, /* Synchronous updates */
1730 LUSTRE_IMMUTABLE_FL = 0x00000010, /* Immutable file */
1731 LUSTRE_APPEND_FL = 0x00000020, /* file writes may only append */
1732 LUSTRE_NODUMP_FL = 0x00000040, /* do not dump file */
1733 LUSTRE_NOATIME_FL = 0x00000080, /* do not update atime */
1734 LUSTRE_INDEX_FL = 0x00001000, /* hash-indexed directory */
1735 LUSTRE_DIRSYNC_FL = 0x00010000, /* dirsync behaviour (dir only) */
1736 LUSTRE_TOPDIR_FL = 0x00020000, /* Top of directory hierarchies*/
1737 LUSTRE_DIRECTIO_FL = 0x00100000, /* Use direct i/o */
1738 LUSTRE_INLINE_DATA_FL = 0x10000000, /* Inode has inline data. */
1739 LUSTRE_PROJINHERIT_FL = 0x20000000, /* Create with parents projid */
1741 /* These flags will not be identical to any EXT4_*_FL counterparts,
1742 * and only reserved for lustre purpose. Note: these flags might
1743 * be conflict with some of EXT4 flags, so
1744 * 1. these conflict flags needs to be removed when the flag is
1745 * wired by la_flags see osd_attr_get().
1746 * 2. If these flags needs to be stored into inode, they will be
1747 * stored in LMA. see LMAI_XXXX */
1748 LUSTRE_ORPHAN_FL = 0x00002000,
1749 LUSTRE_SET_SYNC_FL = 0x00040000, /* Synchronous setattr on OSTs */
1751 LUSTRE_LMA_FL_MASKS = LUSTRE_ORPHAN_FL,
1754 #ifndef FS_XFLAG_SYNC
1755 #define FS_XFLAG_SYNC 0x00000020 /* all writes synchronous */
1757 #ifndef FS_XFLAG_NOATIME
1758 #define FS_XFLAG_NOATIME 0x00000040 /* do not update access time */
1760 #ifndef FS_XFLAG_IMMUTABLE
1761 #define FS_XFLAG_IMMUTABLE 0x00000008 /* file cannot be modified */
1763 #ifndef FS_XFLAG_APPEND
1764 #define FS_XFLAG_APPEND 0x00000010 /* all writes append */
1766 #ifndef FS_XFLAG_PROJINHERIT
1767 #define FS_XFLAG_PROJINHERIT 0x00000200 /* create with parents projid */
1771 /* Convert wire LUSTRE_*_FL to corresponding client local VFS S_* values
1772 * for the client inode i_flags. The LUSTRE_*_FL are the Lustre wire
1773 * protocol equivalents of LDISKFS_*_FL values stored on disk, while
1774 * the S_* flags are kernel-internal values that change between kernel
1775 * versions. These flags are set/cleared via FSFILT_IOC_{GET,SET}_FLAGS.
1776 * See b=16526 for a full history. */
1777 static inline int ll_ext_to_inode_flags(int flags)
1779 return (((flags & LUSTRE_SYNC_FL) ? S_SYNC : 0) |
1780 ((flags & LUSTRE_NOATIME_FL) ? S_NOATIME : 0) |
1781 ((flags & LUSTRE_APPEND_FL) ? S_APPEND : 0) |
1782 #if defined(S_DIRSYNC)
1783 ((flags & LUSTRE_DIRSYNC_FL) ? S_DIRSYNC : 0) |
1785 ((flags & LUSTRE_IMMUTABLE_FL) ? S_IMMUTABLE : 0));
1788 static inline int ll_inode_to_ext_flags(int iflags)
1790 return (((iflags & S_SYNC) ? LUSTRE_SYNC_FL : 0) |
1791 ((iflags & S_NOATIME) ? LUSTRE_NOATIME_FL : 0) |
1792 ((iflags & S_APPEND) ? LUSTRE_APPEND_FL : 0) |
1793 #if defined(S_DIRSYNC)
1794 ((iflags & S_DIRSYNC) ? LUSTRE_DIRSYNC_FL : 0) |
1796 ((iflags & S_IMMUTABLE) ? LUSTRE_IMMUTABLE_FL : 0));
1799 static inline int ll_xflags_to_inode_flags(int xflags)
1801 return ((xflags & FS_XFLAG_SYNC) ? S_SYNC : 0) |
1802 ((xflags & FS_XFLAG_NOATIME) ? S_NOATIME : 0) |
1803 ((xflags & FS_XFLAG_APPEND) ? S_APPEND : 0) |
1804 ((xflags & FS_XFLAG_IMMUTABLE) ? S_IMMUTABLE : 0);
1807 static inline int ll_inode_flags_to_xflags(int flags)
1809 return ((flags & S_SYNC) ? FS_XFLAG_SYNC : 0) |
1810 ((flags & S_NOATIME) ? FS_XFLAG_NOATIME : 0) |
1811 ((flags & S_APPEND) ? FS_XFLAG_APPEND : 0) |
1812 ((flags & S_IMMUTABLE) ? FS_XFLAG_IMMUTABLE : 0);
1816 /* 64 possible states */
1817 enum md_transient_state {
1818 MS_RESTORE = (1 << 0), /* restore is running */
1822 struct lu_fid mbo_fid1;
1823 struct lu_fid mbo_fid2;
1824 struct lustre_handle mbo_open_handle;
1826 __u64 mbo_size; /* Offset, in the case of MDS_READPAGE */
1830 __u64 mbo_blocks; /* XID, in the case of MDS_READPAGE */
1831 __u64 mbo_version; /* was mbo_ioepoch before 2.11 */
1832 __u64 mbo_t_state; /* transient file state defined in
1833 * enum md_transient_state
1834 * was "ino" until 2.4.0 */
1837 __u32 mbo_capability;
1841 __u32 mbo_flags; /* LUSTRE_*_FL file attributes */
1843 __u32 mbo_nlink; /* #bytes to read in the case of MDS_READPAGE */
1844 __u32 mbo_layout_gen; /* was "generation" until 2.4.0 */
1846 __u32 mbo_eadatasize;
1848 __u32 mbo_max_mdsize;
1849 __u32 mbo_unused3; /* was max_cookiesize until 2.8 */
1850 __u32 mbo_uid_h; /* high 32-bits of uid, for FUID */
1851 __u32 mbo_gid_h; /* high 32-bits of gid, for FUID */
1853 __u64 mbo_dom_size; /* size of DOM component */
1854 __u64 mbo_dom_blocks; /* blocks consumed by DOM component */
1855 __u64 mbo_padding_8; /* also fix lustre_swab_mdt_body */
1856 __u64 mbo_padding_9;
1857 __u64 mbo_padding_10;
1860 struct mdt_ioepoch {
1861 struct lustre_handle mio_open_handle;
1862 __u64 mio_unused1; /* was ioepoch */
1863 __u32 mio_unused2; /* was flags */
1867 /* permissions for md_perm.mp_perm */
1869 CFS_SETUID_PERM = 0x01,
1870 CFS_SETGID_PERM = 0x02,
1871 CFS_SETGRP_PERM = 0x04,
1874 struct mdt_rec_setattr {
1884 __u32 sa_padding_1_h;
1885 struct lu_fid sa_fid;
1894 __u32 sa_attr_flags;
1896 __u32 sa_bias; /* some operation flags */
1903 * Attribute flags used in mdt_rec_setattr::sa_valid.
1904 * The kernel's #defines for ATTR_* should not be used over the network
1905 * since the client and MDS may run different kernels (see bug 13828)
1906 * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1908 #define MDS_ATTR_MODE 0x1ULL /* = 1 */
1909 #define MDS_ATTR_UID 0x2ULL /* = 2 */
1910 #define MDS_ATTR_GID 0x4ULL /* = 4 */
1911 #define MDS_ATTR_SIZE 0x8ULL /* = 8 */
1912 #define MDS_ATTR_ATIME 0x10ULL /* = 16 */
1913 #define MDS_ATTR_MTIME 0x20ULL /* = 32 */
1914 #define MDS_ATTR_CTIME 0x40ULL /* = 64 */
1915 #define MDS_ATTR_ATIME_SET 0x80ULL /* = 128 */
1916 #define MDS_ATTR_MTIME_SET 0x100ULL /* = 256 */
1917 #define MDS_ATTR_FORCE 0x200ULL /* = 512, Not a change, but a change it */
1918 #define MDS_ATTR_ATTR_FLAG 0x400ULL /* = 1024 */
1919 #define MDS_ATTR_KILL_SUID 0x800ULL /* = 2048 */
1920 #define MDS_ATTR_KILL_SGID 0x1000ULL /* = 4096 */
1921 #define MDS_ATTR_CTIME_SET 0x2000ULL /* = 8192 */
1922 #define MDS_ATTR_FROM_OPEN 0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
1923 #define MDS_ATTR_BLOCKS 0x8000ULL /* = 32768 */
1924 #define MDS_ATTR_PROJID 0x10000ULL /* = 65536 */
1925 #define MDS_ATTR_LSIZE 0x20000ULL /* = 131072 */
1926 #define MDS_ATTR_LBLOCKS 0x40000ULL /* = 262144 */
1927 #define MDS_ATTR_OVERRIDE 0x2000000ULL /* = 33554432 */
1930 /* MDS_CHECK_SPLIT = 1 << 0, obsolete before 2.3.58 */
1931 MDS_CROSS_REF = 1 << 1,
1932 /* MDS_VTX_BYPASS = 1 << 2, obsolete since 2.3.54 */
1933 MDS_PERM_BYPASS = 1 << 3,
1934 /* MDS_SOM = 1 << 4, obsolete since 2.8.0 */
1935 MDS_QUOTA_IGNORE = 1 << 5,
1936 /* MDS_CLOSE_CLEANUP = 1 << 6, obsolete since 2.3.51 */
1937 MDS_KEEP_ORPHAN = 1 << 7,
1938 MDS_RECOV_OPEN = 1 << 8,
1939 MDS_DATA_MODIFIED = 1 << 9,
1940 MDS_CREATE_VOLATILE = 1 << 10,
1941 MDS_OWNEROVERRIDE = 1 << 11,
1942 MDS_HSM_RELEASE = 1 << 12,
1943 MDS_CLOSE_MIGRATE = 1 << 13,
1944 MDS_CLOSE_LAYOUT_SWAP = 1 << 14,
1945 MDS_CLOSE_LAYOUT_MERGE = 1 << 15,
1946 MDS_CLOSE_RESYNC_DONE = 1 << 16,
1947 MDS_CLOSE_LAYOUT_SPLIT = 1 << 17,
1948 MDS_TRUNC_KEEP_LEASE = 1 << 18,
1951 #define MDS_CLOSE_INTENT (MDS_HSM_RELEASE | MDS_CLOSE_LAYOUT_SWAP | \
1952 MDS_CLOSE_LAYOUT_MERGE | MDS_CLOSE_LAYOUT_SPLIT | \
1953 MDS_CLOSE_RESYNC_DONE)
1955 /* instance of mdt_reint_rec */
1956 struct mdt_rec_create {
1964 __u32 cr_suppgid1_h;
1966 __u32 cr_suppgid2_h;
1967 struct lu_fid cr_fid1;
1968 struct lu_fid cr_fid2;
1969 struct lustre_handle cr_open_handle_old; /* in case of open replay */
1973 __u64 cr_padding_1; /* rr_blocks */
1976 /* use of helpers set/get_mrc_cr_flags() is needed to access
1977 * 64 bits cr_flags [cr_flags_l, cr_flags_h], this is done to
1978 * extend cr_flags size without breaking 1.8 compat */
1979 __u32 cr_flags_l; /* for use with open, low 32 bits */
1980 __u32 cr_flags_h; /* for use with open, high 32 bits */
1981 __u32 cr_umask; /* umask for create */
1982 __u32 cr_padding_4; /* rr_padding_4 */
1985 /* instance of mdt_reint_rec */
1986 struct mdt_rec_link {
1994 __u32 lk_suppgid1_h;
1996 __u32 lk_suppgid2_h;
1997 struct lu_fid lk_fid1;
1998 struct lu_fid lk_fid2;
2000 __u64 lk_padding_1; /* rr_atime */
2001 __u64 lk_padding_2; /* rr_ctime */
2002 __u64 lk_padding_3; /* rr_size */
2003 __u64 lk_padding_4; /* rr_blocks */
2005 __u32 lk_padding_5; /* rr_mode */
2006 __u32 lk_padding_6; /* rr_flags */
2007 __u32 lk_padding_7; /* rr_padding_2 */
2008 __u32 lk_padding_8; /* rr_padding_3 */
2009 __u32 lk_padding_9; /* rr_padding_4 */
2012 /* instance of mdt_reint_rec */
2013 struct mdt_rec_unlink {
2021 __u32 ul_suppgid1_h;
2023 __u32 ul_suppgid2_h;
2024 struct lu_fid ul_fid1;
2025 struct lu_fid ul_fid2;
2027 __u64 ul_padding_2; /* rr_atime */
2028 __u64 ul_padding_3; /* rr_ctime */
2029 __u64 ul_padding_4; /* rr_size */
2030 __u64 ul_padding_5; /* rr_blocks */
2033 __u32 ul_padding_6; /* rr_flags */
2034 __u32 ul_padding_7; /* rr_padding_2 */
2035 __u32 ul_padding_8; /* rr_padding_3 */
2036 __u32 ul_padding_9; /* rr_padding_4 */
2039 /* instance of mdt_reint_rec */
2040 struct mdt_rec_rename {
2048 __u32 rn_suppgid1_h;
2050 __u32 rn_suppgid2_h;
2051 struct lu_fid rn_fid1;
2052 struct lu_fid rn_fid2;
2054 __u64 rn_padding_1; /* rr_atime */
2055 __u64 rn_padding_2; /* rr_ctime */
2056 __u64 rn_padding_3; /* rr_size */
2057 __u64 rn_padding_4; /* rr_blocks */
2058 __u32 rn_bias; /* some operation flags */
2059 __u32 rn_mode; /* cross-ref rename has mode */
2060 __u32 rn_padding_5; /* rr_flags */
2061 __u32 rn_padding_6; /* rr_padding_2 */
2062 __u32 rn_padding_7; /* rr_padding_3 */
2063 __u32 rn_padding_8; /* rr_padding_4 */
2066 /* instance of mdt_reint_rec */
2067 struct mdt_rec_setxattr {
2075 __u32 sx_suppgid1_h;
2077 __u32 sx_suppgid2_h;
2078 struct lu_fid sx_fid;
2079 __u64 sx_padding_1; /* These three are rr_fid2 */
2084 __u64 sx_padding_5; /* rr_ctime */
2085 __u64 sx_padding_6; /* rr_size */
2086 __u64 sx_padding_7; /* rr_blocks */
2089 __u32 sx_padding_8; /* rr_flags */
2090 __u32 sx_padding_9; /* rr_padding_2 */
2091 __u32 sx_padding_10; /* rr_padding_3 */
2092 __u32 sx_padding_11; /* rr_padding_4 */
2095 /* instance of mdt_reint_rec
2096 * FLR: for file resync MDS_REINT_RESYNC RPC. */
2097 struct mdt_rec_resync {
2105 __u32 rs_suppgid1_h;
2107 __u32 rs_suppgid2_h;
2108 struct lu_fid rs_fid;
2109 __u8 rs_padding0[sizeof(struct lu_fid)];
2110 struct lustre_handle rs_lease_handle; /* rr_mtime */
2111 __s64 rs_padding1; /* rr_atime */
2112 __s64 rs_padding2; /* rr_ctime */
2113 __u64 rs_padding3; /* rr_size */
2114 __u64 rs_padding4; /* rr_blocks */
2116 __u32 rs_padding5; /* rr_mode */
2117 __u32 rs_padding6; /* rr_flags */
2118 __u32 rs_padding7; /* rr_flags_h */
2119 __u32 rs_padding8; /* rr_umask */
2121 __u16 rs_padding9; /* rr_padding_4 */
2125 * mdt_rec_reint is the template for all mdt_reint_xxx structures.
2126 * Do NOT change the size of various members, otherwise the value
2127 * will be broken in lustre_swab_mdt_rec_reint().
2129 * If you add new members in other mdt_reint_xxx structres and need to use the
2130 * rr_padding_x fields, then update lustre_swab_mdt_rec_reint() also.
2132 struct mdt_rec_reint {
2140 __u32 rr_suppgid1_h;
2142 __u32 rr_suppgid2_h;
2143 struct lu_fid rr_fid1;
2144 struct lu_fid rr_fid2;
2156 __u16 rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
2159 /* lmv structures */
2161 __u32 ld_tgt_count; /* how many MDS's */
2162 __u32 ld_active_tgt_count; /* how many active */
2163 __u32 ld_default_stripe_count; /* how many objects are used */
2164 __u32 ld_pattern; /* default hash pattern */
2165 __u64 ld_default_hash_size;
2166 __u64 ld_padding_1; /* also fix lustre_swab_lmv_desc */
2167 __u32 ld_padding_2; /* also fix lustre_swab_lmv_desc */
2168 __u32 ld_qos_maxage; /* in second */
2169 __u32 ld_padding_3; /* also fix lustre_swab_lmv_desc */
2170 __u32 ld_padding_4; /* also fix lustre_swab_lmv_desc */
2171 struct obd_uuid ld_uuid;
2174 /* LMV layout EA, and it will be stored both in master and slave object */
2175 struct lmv_mds_md_v1 {
2177 __u32 lmv_stripe_count;
2178 __u32 lmv_master_mdt_index; /* On master object, it is master
2179 * MDT index, on slave object, it
2180 * is stripe index of the slave obj */
2181 __u32 lmv_hash_type; /* dir stripe policy, i.e. indicate
2182 * which hash function to be used,
2183 * Note: only lower 16 bits is being
2184 * used for now. Higher 16 bits will
2185 * be used to mark the object status,
2186 * for example migrating or dead. */
2187 __u32 lmv_layout_version; /* increased each time layout changed,
2188 * by directory migration, restripe
2190 __u32 lmv_migrate_offset; /* once this is set, it means this
2191 * directory is been migrated, stripes
2192 * before this offset belong to target,
2193 * from this to source. */
2194 __u32 lmv_migrate_hash; /* hash type of source stripes of
2195 * migrating directory */
2198 char lmv_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
2199 struct lu_fid lmv_stripe_fids[0]; /* FIDs for each stripe */
2202 #define LMV_MAGIC_V1 0x0CD20CD0 /* normal stripe lmv magic */
2203 #define LMV_MAGIC LMV_MAGIC_V1
2205 /* #define LMV_USER_MAGIC 0x0CD30CD0 */
2206 #define LMV_MAGIC_STRIPE 0x0CD40CD0 /* magic for dir sub_stripe */
2208 /* Right now only the lower part(0-16bits) of lmv_hash_type is being used,
2209 * and the higher part will be the flag to indicate the status of object,
2210 * for example the object is being migrated. And the hash function
2211 * might be interpreted differently with different flags. */
2212 #define LMV_HASH_TYPE_MASK 0x0000ffff
2214 #define LMV_HASH_FLAG_MIGRATION 0x80000000
2216 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 12, 53, 0)
2217 /* Since lustre 2.8, this flag will not be needed, instead this DEAD
2218 * and orphan flags will be stored in LMA (see LMAI_ORPHAN)
2219 * Keep this flag just for LFSCK, because it still might meet such
2220 * flag when it checks the old FS */
2221 #define LMV_HASH_FLAG_DEAD 0x40000000
2223 #define LMV_HASH_FLAG_BAD_TYPE 0x20000000
2225 /* The striped directory has ever lost its master LMV EA, then LFSCK
2226 * re-generated it. This flag is used to indicate such case. It is an
2228 #define LMV_HASH_FLAG_LOST_LMV 0x10000000
2231 * The FNV-1a hash algorithm is as follows:
2232 * hash = FNV_offset_basis
2233 * for each octet_of_data to be hashed
2234 * hash = hash XOR octet_of_data
2235 * hash = hash × FNV_prime
2237 * http://en.wikipedia.org/wiki/Fowler–Noll–Vo_hash_function#FNV-1a_hash
2239 * http://www.isthe.com/chongo/tech/comp/fnv/index.html#FNV-reference-source
2240 * FNV_prime is 2^40 + 2^8 + 0xb3 = 0x100000001b3ULL
2242 #define LUSTRE_FNV_1A_64_PRIME 0x100000001b3ULL
2243 #define LUSTRE_FNV_1A_64_OFFSET_BIAS 0xcbf29ce484222325ULL
2244 static inline __u64 lustre_hash_fnv_1a_64(const void *buf, size_t size)
2246 __u64 hash = LUSTRE_FNV_1A_64_OFFSET_BIAS;
2247 const unsigned char *p = buf;
2250 for (i = 0; i < size; i++) {
2252 hash *= LUSTRE_FNV_1A_64_PRIME;
2260 struct lmv_mds_md_v1 lmv_md_v1;
2261 struct lmv_user_md lmv_user_md;
2264 static inline int lmv_mds_md_size(int stripe_count, unsigned int lmm_magic)
2266 switch (lmm_magic) {
2268 struct lmv_mds_md_v1 *lmm1;
2270 return sizeof(*lmm1) + stripe_count *
2271 sizeof(lmm1->lmv_stripe_fids[0]);
2278 static inline int lmv_mds_md_stripe_count_get(const union lmv_mds_md *lmm)
2280 switch (__le32_to_cpu(lmm->lmv_magic)) {
2282 return __le32_to_cpu(lmm->lmv_md_v1.lmv_stripe_count);
2283 case LMV_USER_MAGIC:
2284 return __le32_to_cpu(lmm->lmv_user_md.lum_stripe_count);
2290 static inline int lmv_mds_md_hash_type_get(const union lmv_mds_md *lmm)
2292 switch (__le32_to_cpu(lmm->lmv_magic)) {
2294 return __le32_to_cpu(lmm->lmv_md_v1.lmv_hash_type);
2295 case LMV_USER_MAGIC:
2296 return __le32_to_cpu(lmm->lmv_user_md.lum_hash_type);
2306 FLD_FIRST_OPC = FLD_QUERY
2312 SEQ_FIRST_OPC = SEQ_QUERY
2316 SEQ_ALLOC_SUPER = 0,
2328 LFSCK_NOTIFY = 1101,
2331 LFSCK_FIRST_OPC = LFSCK_NOTIFY
2335 * LOV data structures
2338 #define LOV_MAX_UUID_BUFFER_SIZE 8192
2339 /* The size of the buffer the lov/mdc reserves for the
2340 * array of UUIDs returned by the MDS. With the current
2341 * protocol, this will limit the max number of OSTs per LOV */
2343 #define LOV_DESC_MAGIC 0xB0CCDE5C
2344 #define LOV_DESC_QOS_MAXAGE_DEFAULT 5 /* Seconds */
2345 #define LOV_DESC_STRIPE_SIZE_DEFAULT (1 << LNET_MTU_BITS)
2347 /* LOV settings descriptor (should only contain static info) */
2349 __u32 ld_tgt_count; /* how many OBD's */
2350 __u32 ld_active_tgt_count; /* how many active */
2351 __s32 ld_default_stripe_count; /* how many objects are used */
2352 __u32 ld_pattern; /* default PATTERN_RAID0 */
2353 __u64 ld_default_stripe_size; /* in bytes */
2354 __s64 ld_default_stripe_offset; /* starting OST index */
2355 __u32 ld_padding_0; /* unused */
2356 __u32 ld_qos_maxage; /* in second */
2357 __u32 ld_padding_1; /* also fix lustre_swab_lov_desc */
2358 __u32 ld_padding_2; /* also fix lustre_swab_lov_desc */
2359 struct obd_uuid ld_uuid;
2362 #define ld_magic ld_active_tgt_count /* for swabbing from llogs */
2367 /* opcodes -- MUST be distinct from OST/MDS opcodes */
2372 LDLM_BL_CALLBACK = 104,
2373 LDLM_CP_CALLBACK = 105,
2374 LDLM_GL_CALLBACK = 106,
2375 LDLM_SET_INFO = 107,
2378 #define LDLM_FIRST_OPC LDLM_ENQUEUE
2380 #define RES_NAME_SIZE 4
2381 struct ldlm_res_id {
2382 __u64 name[RES_NAME_SIZE];
2385 #define DLDLMRES "[%#llx:%#llx:%#llx].%#llx"
2386 #define PLDLMRES(res) (unsigned long long)(res)->lr_name.name[0], \
2387 (unsigned long long)(res)->lr_name.name[1], \
2388 (unsigned long long)(res)->lr_name.name[2], \
2389 (unsigned long long)(res)->lr_name.name[3]
2405 #define LCK_MODE_NUM 8
2415 #define LDLM_MIN_TYPE LDLM_PLAIN
2417 struct ldlm_extent {
2423 static inline bool ldlm_extent_equal(const struct ldlm_extent *ex1,
2424 const struct ldlm_extent *ex2)
2426 return ex1->start == ex2->start && ex1->end == ex2->end;
2429 struct ldlm_inodebits {
2432 __u64 try_bits; /* optional bits to try */
2433 __u64 cancel_bits; /* for lock convert */
2437 struct ldlm_flock_wire {
2445 /* it's important that the fields of the ldlm_extent structure match
2446 * the first fields of the ldlm_flock structure because there is only
2447 * one ldlm_swab routine to process the ldlm_policy_data_t union. if
2448 * this ever changes we will need to swab the union differently based
2449 * on the resource type. */
2451 union ldlm_wire_policy_data {
2452 struct ldlm_extent l_extent;
2453 struct ldlm_flock_wire l_flock;
2454 struct ldlm_inodebits l_inodebits;
2457 struct barrier_lvb {
2463 struct ldlm_gl_barrier_desc {
2469 union ldlm_gl_desc {
2470 struct ldlm_gl_lquota_desc lquota_desc;
2471 struct ldlm_gl_barrier_desc barrier_desc;
2474 enum ldlm_intent_flags {
2475 IT_OPEN = 0x00000001,
2476 IT_CREAT = 0x00000002,
2477 IT_OPEN_CREAT = IT_OPEN | IT_CREAT, /* To allow case label. */
2478 IT_READDIR = 0x00000004, /* Used by mdc, not put on the wire. */
2479 IT_GETATTR = 0x00000008,
2480 IT_LOOKUP = 0x00000010,
2481 /* IT_UNLINK = 0x00000020, Obsolete. */
2482 /* IT_TRUNC = 0x00000040, Obsolete. */
2483 IT_GETXATTR = 0x00000080,
2484 /* IT_EXEC = 0x00000100, Obsolete. */
2485 /* IT_PIN = 0x00000200, Obsolete. */
2486 IT_LAYOUT = 0x00000400,
2487 IT_QUOTA_DQACQ = 0x00000800,
2488 IT_QUOTA_CONN = 0x00001000,
2489 /* IT_SETXATTR = 0x00002000, Obsolete. */
2490 IT_GLIMPSE = 0x00004000,
2491 IT_BRW = 0x00008000,
2494 struct ldlm_intent {
2498 struct ldlm_resource_desc {
2499 enum ldlm_type lr_type;
2500 __u32 lr_pad; /* also fix lustre_swab_ldlm_resource_desc */
2501 struct ldlm_res_id lr_name;
2504 struct ldlm_lock_desc {
2505 struct ldlm_resource_desc l_resource;
2506 enum ldlm_mode l_req_mode;
2507 enum ldlm_mode l_granted_mode;
2508 union ldlm_wire_policy_data l_policy_data;
2511 #define LDLM_LOCKREQ_HANDLES 2
2512 #define LDLM_ENQUEUE_CANCEL_OFF 1
2514 struct ldlm_request {
2515 __u32 lock_flags; /* LDLM_FL_*, see lustre_dlm_flags.h */
2516 __u32 lock_count; /* number of locks in lock_handle[] */
2517 struct ldlm_lock_desc lock_desc;/* lock descriptor */
2518 struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
2523 __u32 lock_padding; /* also fix lustre_swab_ldlm_reply */
2524 struct ldlm_lock_desc lock_desc;
2525 struct lustre_handle lock_handle;
2526 __u64 lock_policy_res1;
2527 __u64 lock_policy_res2;
2530 #define ldlm_flags_to_wire(flags) ((__u32)(flags))
2531 #define ldlm_flags_from_wire(flags) ((__u64)(flags))
2534 * Opcodes for mountconf (mgs and mgc)
2538 MGS_DISCONNECT = 251,
2539 MGS_EXCEPTION = 252, /* node died, etc. */
2540 MGS_TARGET_REG = 253, /* whenever target starts up */
2541 MGS_TARGET_DEL = 254,
2543 MGS_CONFIG_READ = 256,
2545 MGS_FIRST_OPC = MGS_CONNECT
2548 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
2549 #define MGS_PARAM_MAXLEN 1024
2550 #define KEY_SET_INFO "set_info"
2552 struct mgs_send_param {
2553 char mgs_param[MGS_PARAM_MAXLEN];
2557 /* We pass this info to the MGS so it can write config logs */
2558 #define MTI_NAME_MAXLEN 64
2559 #define MTI_PARAM_MAXLEN 4096
2560 #define MTI_NIDS_MAX 32
2561 struct mgs_target_info {
2562 __u32 mti_lustre_ver;
2563 __u32 mti_stripe_index;
2564 __u32 mti_config_ver;
2565 __u32 mti_flags; /* LDD_F_* */
2566 __u32 mti_nid_count;
2567 __u32 mti_instance; /* Running instance of target */
2568 char mti_fsname[MTI_NAME_MAXLEN];
2569 char mti_svname[MTI_NAME_MAXLEN];
2570 char mti_uuid[sizeof(struct obd_uuid)];
2571 __u64 mti_nids[MTI_NIDS_MAX]; /* host nids (lnet_nid_t) */
2572 char mti_params[MTI_PARAM_MAXLEN];
2575 struct mgs_nidtbl_entry {
2576 __u64 mne_version; /* table version of this entry */
2577 __u32 mne_instance; /* target instance # */
2578 __u32 mne_index; /* target index */
2579 __u32 mne_length; /* length of this entry - by bytes */
2580 __u8 mne_type; /* target type LDD_F_SV_TYPE_OST/MDT */
2581 __u8 mne_nid_type; /* type of nid(mbz). for ipv6. */
2582 __u8 mne_nid_size; /* size of each NID, by bytes */
2583 __u8 mne_nid_count; /* # of NIDs in buffer */
2585 lnet_nid_t nids[0]; /* variable size buffer for NIDs. */
2590 CONFIG_T_CONFIG = 0,
2591 CONFIG_T_SPTLRPC = 1,
2592 CONFIG_T_RECOVER = 2,
2593 CONFIG_T_PARAMS = 3,
2594 CONFIG_T_NODEMAP = 4,
2595 CONFIG_T_BARRIER = 5,
2599 struct mgs_config_body {
2600 char mcb_name[MTI_NAME_MAXLEN]; /* logname */
2601 __u64 mcb_offset; /* next index of config log to request */
2602 __u16 mcb_type; /* type of log: CONFIG_T_[CONFIG|RECOVER] */
2603 __u8 mcb_nm_cur_pass;
2604 __u8 mcb_bits; /* bits unit size of config log */
2605 __u32 mcb_units; /* # of units for bulk transfer */
2608 struct mgs_config_res {
2609 __u64 mcr_offset; /* index of last config log */
2611 __u64 mcr_size; /* size of the log */
2612 __u64 mcr_nm_cur_pass; /* current nodemap config pass */
2616 /* Config marker flags (in config log) */
2617 #define CM_START 0x01
2619 #define CM_SKIP 0x04
2620 #define CM_UPGRADE146 0x08
2621 #define CM_EXCLUDE 0x10
2622 #define CM_START_SKIP (CM_START | CM_SKIP)
2625 __u32 cm_step; /* aka config version */
2627 __u32 cm_vers; /* lustre release version number */
2628 __u32 cm_padding; /* 64 bit align */
2629 __s64 cm_createtime; /*when this record was first created */
2630 __s64 cm_canceltime; /*when this record is no longer valid*/
2631 char cm_tgtname[MTI_NAME_MAXLEN];
2632 char cm_comment[MTI_NAME_MAXLEN];
2636 * Opcodes for multiple servers.
2640 /* OBD_LOG_CANCEL = 401, obsolete since 1.5 */
2641 /* OBD_QC_CALLBACK = 402, obsolete since 2.4 */
2644 OBD_FIRST_OPC = OBD_PING
2648 * llog contexts indices.
2650 * There is compatibility problem with indexes below, they are not
2651 * continuous and must keep their numbers for compatibility needs.
2652 * See LU-5218 for details.
2655 LLOG_CONFIG_ORIG_CTXT = 0,
2656 LLOG_CONFIG_REPL_CTXT = 1,
2657 LLOG_MDS_OST_ORIG_CTXT = 2,
2658 LLOG_MDS_OST_REPL_CTXT = 3, /* kept just to avoid re-assignment */
2659 LLOG_SIZE_ORIG_CTXT = 4,
2660 LLOG_SIZE_REPL_CTXT = 5,
2661 LLOG_TEST_ORIG_CTXT = 8,
2662 LLOG_TEST_REPL_CTXT = 9, /* kept just to avoid re-assignment */
2663 LLOG_CHANGELOG_ORIG_CTXT = 12, /**< changelog generation on mdd */
2664 LLOG_CHANGELOG_REPL_CTXT = 13, /**< changelog access on clients */
2665 /* for multiple changelog consumers */
2666 LLOG_CHANGELOG_USER_ORIG_CTXT = 14,
2667 LLOG_AGENT_ORIG_CTXT = 15, /**< agent requests generation on cdt */
2668 LLOG_UPDATELOG_ORIG_CTXT = 16, /* update log */
2669 LLOG_UPDATELOG_REPL_CTXT = 17, /* update log */
2673 /** Identifier for a single log object */
2675 struct ost_id lgl_oi;
2677 } __attribute__((packed));
2679 /** Records written to the CATALOGS list */
2680 #define CATLIST "CATALOGS"
2682 struct llog_logid lci_logid;
2686 } __attribute__((packed));
2688 /* Log data record types - there is no specific reason that these need to
2689 * be related to the RPC opcodes, but no reason not to (may be handy later?)
2691 #define LLOG_OP_MAGIC 0x10600000
2692 #define LLOG_OP_MASK 0xfff00000
2695 LLOG_PAD_MAGIC = LLOG_OP_MAGIC | 0x00000,
2696 OST_SZ_REC = LLOG_OP_MAGIC | 0x00f00,
2697 /* OST_RAID1_REC = LLOG_OP_MAGIC | 0x01000, never used */
2698 MDS_UNLINK_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) |
2699 REINT_UNLINK, /* obsolete after 2.5.0 */
2700 MDS_UNLINK64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2702 /* MDS_SETATTR_REC = LLOG_OP_MAGIC | 0x12401, obsolete 1.8.0 */
2703 MDS_SETATTR64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2705 OBD_CFG_REC = LLOG_OP_MAGIC | 0x20000,
2706 /* PTL_CFG_REC = LLOG_OP_MAGIC | 0x30000, obsolete 1.4.0 */
2707 LLOG_GEN_REC = LLOG_OP_MAGIC | 0x40000,
2708 /* LLOG_JOIN_REC = LLOG_OP_MAGIC | 0x50000, obsolete 1.8.0 */
2709 CHANGELOG_REC = LLOG_OP_MAGIC | 0x60000,
2710 CHANGELOG_USER_REC = LLOG_OP_MAGIC | 0x70000,
2711 HSM_AGENT_REC = LLOG_OP_MAGIC | 0x80000,
2712 UPDATE_REC = LLOG_OP_MAGIC | 0xa0000,
2713 LLOG_HDR_MAGIC = LLOG_OP_MAGIC | 0x45539,
2714 LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
2717 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
2718 (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == __swab32(LLOG_OP_MAGIC))
2720 /** Log record header - stored in little endian order.
2721 * Each record must start with this struct, end with a llog_rec_tail,
2722 * and be a multiple of 256 bits in size.
2724 struct llog_rec_hdr {
2731 struct llog_rec_tail {
2736 /* Where data follow just after header */
2737 #define REC_DATA(ptr) \
2738 ((void *)((char *)ptr + sizeof(struct llog_rec_hdr)))
2740 #define REC_DATA_LEN(rec) \
2741 (rec->lrh_len - sizeof(struct llog_rec_hdr) - \
2742 sizeof(struct llog_rec_tail))
2744 struct llog_logid_rec {
2745 struct llog_rec_hdr lid_hdr;
2746 struct llog_logid lid_id;
2750 struct llog_rec_tail lid_tail;
2751 } __attribute__((packed));
2753 struct llog_unlink_rec {
2754 struct llog_rec_hdr lur_hdr;
2758 struct llog_rec_tail lur_tail;
2759 } __attribute__((packed));
2761 struct llog_unlink64_rec {
2762 struct llog_rec_hdr lur_hdr;
2763 struct lu_fid lur_fid;
2764 __u32 lur_count; /* to destroy the lost precreated */
2768 struct llog_rec_tail lur_tail;
2769 } __attribute__((packed));
2771 struct llog_setattr64_rec {
2772 struct llog_rec_hdr lsr_hdr;
2773 struct ost_id lsr_oi;
2779 struct llog_rec_tail lsr_tail;
2780 } __attribute__((packed));
2782 /* Extended to support project quota */
2783 struct llog_setattr64_rec_v2 {
2784 struct llog_rec_hdr lsr_hdr;
2785 struct ost_id lsr_oi;
2792 __u32 lsr_layout_version;
2795 struct llog_rec_tail lsr_tail;
2796 } __attribute__((packed));
2798 struct llog_size_change_rec {
2799 struct llog_rec_hdr lsc_hdr;
2800 struct ll_fid lsc_fid;
2805 struct llog_rec_tail lsc_tail;
2806 } __attribute__((packed));
2808 #define CHANGELOG_MAGIC 0xca103000
2810 /** \a changelog_rec_type's that can't be masked */
2811 #define CHANGELOG_MINMASK (1 << CL_MARK)
2812 /** bits covering all \a changelog_rec_type's */
2813 #define CHANGELOG_ALLMASK 0XFFFFFFFF
2814 /** default \a changelog_rec_type mask. Allow all of them, except
2815 * CL_ATIME since it can really be time consuming, and not necessary
2817 * Remove also CL_OPEN, CL_GETXATTR and CL_DN_OPEN from default list as it can
2818 * be costly and only necessary for audit purpose.
2820 #define CHANGELOG_DEFMASK (CHANGELOG_ALLMASK & \
2821 ~(1 << CL_ATIME | 1 << CL_OPEN | 1 << CL_GETXATTR | \
2824 /* changelog llog name, needed by client replicators */
2825 #define CHANGELOG_CATALOG "changelog_catalog"
2827 struct changelog_setinfo {
2830 } __attribute__((packed));
2832 /** changelog record */
2833 struct llog_changelog_rec {
2834 struct llog_rec_hdr cr_hdr;
2835 struct changelog_rec cr; /**< Variable length field */
2836 struct llog_rec_tail cr_do_not_use; /**< for_sizeof_only */
2837 } __attribute__((packed));
2839 #define CHANGELOG_USER_PREFIX "cl"
2841 struct llog_changelog_user_rec {
2842 struct llog_rec_hdr cur_hdr;
2844 /* only intended to be used in relative time comparisons to
2845 * detect idle users */
2848 struct llog_rec_tail cur_tail;
2849 } __attribute__((packed));
2851 enum agent_req_status {
2859 static inline const char *agent_req_status2name(enum agent_req_status ars)
2877 struct llog_agent_req_rec {
2878 struct llog_rec_hdr arr_hdr; /**< record header */
2879 __u32 arr_status; /**< status of the request */
2881 * agent_req_status */
2882 __u32 arr_archive_id; /**< backend archive number */
2883 __u64 arr_flags; /**< req flags */
2884 __u64 arr_compound_id; /**< compound cookie, ignored */
2885 __u64 arr_req_create; /**< req. creation time */
2886 __u64 arr_req_change; /**< req. status change time */
2887 struct hsm_action_item arr_hai; /**< req. to the agent */
2888 struct llog_rec_tail arr_tail; /**< record tail for_sizezof_only */
2889 } __attribute__((packed));
2891 /* Old llog gen for compatibility */
2895 } __attribute__((packed));
2897 struct llog_gen_rec {
2898 struct llog_rec_hdr lgr_hdr;
2899 struct llog_gen lgr_gen;
2903 struct llog_rec_tail lgr_tail;
2906 /* flags for the logs */
2908 LLOG_F_ZAP_WHEN_EMPTY = 0x1,
2909 LLOG_F_IS_CAT = 0x2,
2910 LLOG_F_IS_PLAIN = 0x4,
2911 LLOG_F_EXT_JOBID = 0x8,
2912 LLOG_F_IS_FIXSIZE = 0x10,
2913 LLOG_F_EXT_EXTRA_FLAGS = 0x20,
2914 LLOG_F_EXT_X_UIDGID = 0x40,
2915 LLOG_F_EXT_X_NID = 0x80,
2916 LLOG_F_EXT_X_OMODE = 0x100,
2917 LLOG_F_EXT_X_XATTR = 0x200,
2919 /* Note: Flags covered by LLOG_F_EXT_MASK will be inherited from
2920 * catlog to plain log, so do not add LLOG_F_IS_FIXSIZE here,
2921 * because the catlog record is usually fixed size, but its plain
2922 * log record can be variable */
2923 LLOG_F_EXT_MASK = LLOG_F_EXT_JOBID | LLOG_F_EXT_EXTRA_FLAGS |
2924 LLOG_F_EXT_X_UIDGID | LLOG_F_EXT_X_NID |
2925 LLOG_F_EXT_X_OMODE | LLOG_F_EXT_X_XATTR,
2928 /* means first record of catalog */
2930 LLOG_CAT_FIRST = -1,
2933 /* On-disk header structure of each log object, stored in little endian order */
2934 #define LLOG_MIN_CHUNK_SIZE 8192
2935 #define LLOG_HEADER_SIZE (96) /* sizeof (llog_log_hdr) + sizeof(llh_tail)
2936 * - sizeof(llh_bitmap) */
2937 #define LLOG_BITMAP_BYTES (LLOG_MIN_CHUNK_SIZE - LLOG_HEADER_SIZE)
2938 #define LLOG_MIN_REC_SIZE (24) /* round(llog_rec_hdr + llog_rec_tail) */
2940 struct llog_log_hdr {
2941 struct llog_rec_hdr llh_hdr;
2942 __s64 llh_timestamp;
2944 __u32 llh_bitmap_offset;
2947 /* for a catalog the first/oldest and still in-use plain slot is just
2948 * next to it. It will serve as the upper limit after Catalog has
2951 struct obd_uuid llh_tgtuuid;
2952 __u32 llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32)-23];
2953 /* These fields must always be at the end of the llog_log_hdr.
2954 * Note: llh_bitmap size is variable because llog chunk size could be
2955 * bigger than LLOG_MIN_CHUNK_SIZE, i.e. sizeof(llog_log_hdr) > 8192
2956 * bytes, and the real size is stored in llh_hdr.lrh_len, which means
2957 * llh_tail should only be refered by LLOG_HDR_TAIL().
2958 * But this structure is also used by client/server llog interface
2959 * (see llog_client.c), it will be kept in its original way to avoid
2960 * compatiblity issue. */
2961 __u32 llh_bitmap[LLOG_BITMAP_BYTES / sizeof(__u32)];
2962 struct llog_rec_tail llh_tail;
2963 } __attribute__((packed));
2964 #undef LLOG_HEADER_SIZE
2965 #undef LLOG_BITMAP_BYTES
2967 #define LLOG_HDR_BITMAP_SIZE(llh) (__u32)((llh->llh_hdr.lrh_len - \
2968 llh->llh_bitmap_offset - \
2969 sizeof(llh->llh_tail)) * 8)
2970 #define LLOG_HDR_BITMAP(llh) (__u32 *)((char *)(llh) + \
2971 (llh)->llh_bitmap_offset)
2972 #define LLOG_HDR_TAIL(llh) ((struct llog_rec_tail *)((char *)llh + \
2973 llh->llh_hdr.lrh_len - \
2974 sizeof(llh->llh_tail)))
2976 /** log cookies are used to reference a specific log file and a record therein,
2977 and pass record offset from llog_process_thread to llog_write */
2978 struct llog_cookie {
2980 struct llog_logid lgc_lgl;
2986 } __attribute__((packed));
2988 /** llog protocol */
2989 enum llogd_rpc_ops {
2990 LLOG_ORIGIN_HANDLE_CREATE = 501,
2991 LLOG_ORIGIN_HANDLE_NEXT_BLOCK = 502,
2992 LLOG_ORIGIN_HANDLE_READ_HEADER = 503,
2993 /* LLOG_ORIGIN_HANDLE_WRITE_REC = 504, Obsolete by 2.1. */
2994 /* LLOG_ORIGIN_HANDLE_CLOSE = 505, Obsolete by 1.8. */
2995 /* LLOG_ORIGIN_CONNECT = 506, Obsolete by 2.4. */
2996 /* LLOG_CATINFO = 507, Obsolete by 2.3. */
2997 LLOG_ORIGIN_HANDLE_PREV_BLOCK = 508,
2998 LLOG_ORIGIN_HANDLE_DESTROY = 509, /* Obsolete by 2.11. */
3000 LLOG_FIRST_OPC = LLOG_ORIGIN_HANDLE_CREATE
3004 struct llog_logid lgd_logid;
3006 __u32 lgd_llh_flags;
3008 __u32 lgd_saved_index;
3010 __u64 lgd_cur_offset;
3011 } __attribute__((packed));
3013 struct llogd_conn_body {
3014 struct llog_gen lgdc_gen;
3015 struct llog_logid lgdc_logid;
3016 __u32 lgdc_ctxt_idx;
3017 } __attribute__((packed));
3019 /* Note: 64-bit types are 64-bit aligned in structure */
3021 __u64 o_valid; /* hot fields in this obdo */
3024 __u64 o_size; /* o_size-o_blocks == ost_lvb */
3028 __u64 o_blocks; /* brw: cli sent cached bytes */
3031 /* 32-bit fields start here: keep an even number of them via padding */
3032 __u32 o_blksize; /* optimal IO blocksize */
3033 __u32 o_mode; /* brw: cli sent cache remain */
3037 __u32 o_nlink; /* brw: checksum */
3039 __u32 o_misc; /* brw: o_dropped */
3041 __u64 o_ioepoch; /* epoch in ost writes */
3042 __u32 o_stripe_idx; /* holds stripe idx */
3044 struct lustre_handle o_handle; /* brw: lock handle to prolong
3046 /* Originally, the field is llog_cookie for destroy with unlink cookie
3047 * from MDS, it is obsolete in 2.8. Then reuse it by client to transfer
3048 * layout and PFL information in IO, setattr RPCs. Since llog_cookie is
3049 * not used on wire any longer, remove it from the obdo, then it can be
3050 * enlarged freely in the further without affect related RPCs.
3052 * sizeof(ost_layout) + sieof(__u32) == sizeof(llog_cookie). */
3053 struct ost_layout o_layout;
3054 __u32 o_layout_version;
3058 __u64 o_data_version; /* getattr: sum of iversion for
3060 * brw: grant space consumed on
3061 * the client for the write */
3063 __u32 o_padding_4; /* also fix
3064 * lustre_swab_obdo() */
3069 #define o_dirty o_blocks
3070 #define o_undirty o_mode
3071 #define o_dropped o_misc
3072 #define o_cksum o_nlink
3073 #define o_grant_used o_data_version
3075 struct lfsck_request {
3087 __u16 lr_async_windows;
3089 struct lu_fid lr_fid;
3090 struct lu_fid lr_fid2;
3098 struct lfsck_reply {
3105 LE_LASTID_REBUILDING = 1,
3106 LE_LASTID_REBUILT = 2,
3112 /* LE_FID_ACCESSED = 8, moved to lfsck_events_local */
3114 LE_CONDITIONAL_DESTROY = 10,
3115 LE_PAIRS_VERIFY = 11,
3116 LE_SET_LMV_MASTER = 15,
3117 LE_SET_LMV_SLAVE = 16,
3120 enum lfsck_event_flags {
3121 LEF_TO_OST = 0x00000001,
3122 LEF_FROM_OST = 0x00000002,
3123 LEF_SET_LMV_HASH = 0x00000004,
3124 LEF_SET_LMV_ALL = 0x00000008,
3125 LEF_RECHECK_NAME_HASH = 0x00000010,
3126 LEF_QUERY_ALL = 0x00000020,
3129 /* request structure for OST's */
3134 /* Key for FIEMAP to be used in get_info calls */
3135 struct ll_fiemap_info_key {
3137 struct obdo lfik_oa;
3138 struct fiemap lfik_fiemap;
3141 #define IDX_INFO_MAGIC 0x3D37CC37
3143 /* Index file transfer through the network. The server serializes the index into
3144 * a byte stream which is sent to the client via a bulk transfer */
3148 /* reply: see idx_info_flags below */
3151 /* request & reply: number of lu_idxpage (to be) transferred */
3155 /* request: requested attributes passed down to the iterator API */
3158 /* request & reply: index file identifier (FID) */
3159 struct lu_fid ii_fid;
3161 /* reply: version of the index file before starting to walk the index.
3162 * Please note that the version can be modified at any time during the
3166 /* request: hash to start with:
3167 * reply: hash of the first entry of the first lu_idxpage and hash
3168 * of the entry to read next if any */
3169 __u64 ii_hash_start;
3172 /* reply: size of keys in lu_idxpages, minimal one if II_FL_VARKEY is
3176 /* reply: size of records in lu_idxpages, minimal one if II_FL_VARREC
3185 #define II_END_OFF MDS_DIR_END_OFF /* all entries have been read */
3187 /* List of flags used in idx_info::ii_flags */
3188 enum idx_info_flags {
3189 II_FL_NOHASH = 1 << 0, /* client doesn't care about hash value */
3190 II_FL_VARKEY = 1 << 1, /* keys can be of variable size */
3191 II_FL_VARREC = 1 << 2, /* records can be of variable size */
3192 II_FL_NONUNQ = 1 << 3, /* index supports non-unique keys */
3193 II_FL_NOKEY = 1 << 4, /* client doesn't care about key */
3196 #define LIP_MAGIC 0x8A6D6B6C
3198 /* 4KB (= LU_PAGE_SIZE) container gathering key/record pairs */
3200 /* 16-byte header */
3203 __u16 lip_nr; /* number of entries in the container */
3204 __u64 lip_pad0; /* additional padding for future use */
3206 /* key/record pairs are stored in the remaining 4080 bytes.
3207 * depending upon the flags in idx_info::ii_flags, each key/record
3208 * pair might be preceded by:
3210 * - the key size (II_FL_VARKEY is set)
3211 * - the record size (II_FL_VARREC is set)
3213 * For the time being, we only support fixed-size key & record. */
3214 char lip_entries[0];
3217 #define LIP_HDR_SIZE (offsetof(struct lu_idxpage, lip_entries))
3219 /* Gather all possible type associated with a 4KB container */
3221 struct lu_dirpage lp_dir; /* for MDS_READPAGE */
3222 struct lu_idxpage lp_idx; /* for OBD_IDX_READ */
3223 char lp_array[LU_PAGE_SIZE];
3226 /* security opcodes */
3229 SEC_CTX_INIT_CONT = 802,
3232 SEC_FIRST_OPC = SEC_CTX_INIT
3236 * capa related definitions
3238 #define CAPA_HMAC_MAX_LEN 64
3239 #define CAPA_HMAC_KEY_MAX_LEN 56
3241 /* NB take care when changing the sequence of elements this struct,
3242 * because the offset info is used in find_capa() */
3243 struct lustre_capa {
3244 struct lu_fid lc_fid; /** fid */
3245 __u64 lc_opc; /** operations allowed */
3246 __u64 lc_uid; /** file owner */
3247 __u64 lc_gid; /** file group */
3248 __u32 lc_flags; /** HMAC algorithm & flags */
3249 __u32 lc_keyid; /** key# used for the capability */
3250 __u32 lc_timeout; /** capa timeout value (sec) */
3251 __u32 lc_expiry; /** expiry time (sec) */
3252 __u8 lc_hmac[CAPA_HMAC_MAX_LEN]; /** HMAC */
3253 } __attribute__((packed));
3255 /** lustre_capa::lc_opc */
3257 CAPA_OPC_BODY_WRITE = 1<<0, /**< write object data */
3258 CAPA_OPC_BODY_READ = 1<<1, /**< read object data */
3259 CAPA_OPC_INDEX_LOOKUP = 1<<2, /**< lookup object fid */
3260 CAPA_OPC_INDEX_INSERT = 1<<3, /**< insert object fid */
3261 CAPA_OPC_INDEX_DELETE = 1<<4, /**< delete object fid */
3262 CAPA_OPC_OSS_WRITE = 1<<5, /**< write oss object data */
3263 CAPA_OPC_OSS_READ = 1<<6, /**< read oss object data */
3264 CAPA_OPC_OSS_TRUNC = 1<<7, /**< truncate oss object */
3265 CAPA_OPC_OSS_DESTROY = 1<<8, /**< destroy oss object */
3266 CAPA_OPC_META_WRITE = 1<<9, /**< write object meta data */
3267 CAPA_OPC_META_READ = 1<<10, /**< read object meta data */
3270 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
3271 #define CAPA_OPC_MDS_ONLY \
3272 (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
3273 CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
3274 #define CAPA_OPC_OSS_ONLY \
3275 (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC | \
3276 CAPA_OPC_OSS_DESTROY)
3277 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
3278 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
3280 /* lustre_capa::lc_hmac_alg */
3282 CAPA_HMAC_ALG_SHA1 = 1, /**< sha1 algorithm */
3286 #define CAPA_FL_MASK 0x00ffffff
3287 #define CAPA_HMAC_ALG_MASK 0xff000000
3289 struct lustre_capa_key {
3290 __u64 lk_seq; /**< mds# */
3291 __u32 lk_keyid; /**< key# */
3293 __u8 lk_key[CAPA_HMAC_KEY_MAX_LEN]; /**< key */
3294 } __attribute__((packed));
3296 /** The link ea holds 1 \a link_ea_entry for each hardlink */
3297 #define LINK_EA_MAGIC 0x11EAF1DFUL
3298 struct link_ea_header {
3301 __u64 leh_len; /* total size */
3302 __u32 leh_overflow_time;
3306 /** Hardlink data is name and parent fid.
3307 * Stored in this crazy struct for maximum packing and endian-neutrality
3309 struct link_ea_entry {
3310 /** __u16 stored big-endian, unaligned */
3311 unsigned char lee_reclen[2];
3312 unsigned char lee_parent_fid[sizeof(struct lu_fid)];
3314 }__attribute__((packed));
3316 /** fid2path request/reply structure */
3317 struct getinfo_fid2path {
3318 struct lu_fid gf_fid;
3324 struct lu_fid gf_root_fid[0];
3326 } __attribute__((packed));
3328 /** path2parent request/reply structures */
3330 struct lu_fid gp_fid; /**< parent FID */
3331 __u32 gp_linkno; /**< hardlink number */
3332 __u32 gp_name_size; /**< size of the name field */
3333 char gp_name[0]; /**< zero-terminated link name */
3334 } __attribute__((packed));
3336 enum layout_intent_opc {
3337 LAYOUT_INTENT_ACCESS = 0, /** generic access */
3338 LAYOUT_INTENT_READ = 1, /** not used */
3339 LAYOUT_INTENT_WRITE = 2, /** write file, for comp layout */
3340 LAYOUT_INTENT_GLIMPSE = 3, /** not used */
3341 LAYOUT_INTENT_TRUNC = 4, /** truncate file, for comp layout */
3342 LAYOUT_INTENT_RELEASE = 5, /** reserved for HSM release */
3343 LAYOUT_INTENT_RESTORE = 6, /** reserved for HSM restore */
3346 /* enqueue layout lock with intent */
3347 struct layout_intent {
3348 __u32 li_opc; /* intent operation for enqueue, read, write etc */
3350 struct lu_extent li_extent;
3351 } __attribute__((packed));
3354 * On the wire version of hsm_progress structure.
3356 * Contains the userspace hsm_progress and some internal fields.
3358 struct hsm_progress_kernel {
3359 /* Field taken from struct hsm_progress */
3360 struct lu_fid hpk_fid;
3362 struct hsm_extent hpk_extent;
3364 __u16 hpk_errval; /* positive val */
3366 /* Additional fields */
3367 __u64 hpk_data_version;
3369 } __attribute__((packed));
3372 * OUT_UPDATE RPC Format
3374 * During the cross-ref operation, the Master MDT, which the client send the
3375 * request to, will disassembly the operation into object updates, then OSP
3376 * will send these updates to the remote MDT to be executed.
3378 * An UPDATE_OBJ RPC does a list of updates. Each update belongs to an
3379 * operation and does a type of modification to an object.
3387 * update (ub_count-th)
3389 * ub_count must be less than or equal to UPDATE_PER_RPC_MAX.
3394 * rc [+ buffers] (1st)
3395 * rc [+ buffers] (2st)
3397 * rc [+ buffers] (nr_count-th)
3399 * ur_count must be less than or equal to UPDATE_PER_RPC_MAX and should usually
3400 * be equal to ub_count.
3404 * Type of each update, if adding/deleting update, please also update
3405 * update_opcode in lustre/target/out_lib.c.
3417 OUT_INDEX_LOOKUP = 9,
3418 OUT_INDEX_INSERT = 10,
3419 OUT_INDEX_DELETE = 11,
3425 OUT_XATTR_LIST = 17,
3430 UPDATE_FL_OST = 0x00000001, /* op from OST (not MDT) */
3431 UPDATE_FL_SYNC = 0x00000002, /* commit before replying */
3432 UPDATE_FL_COMMITTED = 0x00000004, /* op committed globally */
3433 UPDATE_FL_NOLOG = 0x00000008 /* for idempotent updates */
3436 struct object_update_param {
3437 __u16 oup_len; /* length of this parameter */
3444 struct object_update {
3445 __u16 ou_type; /* enum update_type */
3446 __u16 ou_params_count; /* update parameters count */
3447 __u32 ou_result_size; /* how many bytes can return */
3448 __u32 ou_flags; /* enum update_flag */
3449 __u32 ou_padding1; /* padding 1 */
3450 __u64 ou_batchid; /* op transno on master */
3451 struct lu_fid ou_fid; /* object to be updated */
3452 struct object_update_param ou_params[0]; /* update params */
3455 #define UPDATE_REQUEST_MAGIC_V1 0xBDDE0001
3456 #define UPDATE_REQUEST_MAGIC_V2 0xBDDE0002
3457 #define UPDATE_REQUEST_MAGIC UPDATE_REQUEST_MAGIC_V2
3458 /* Hold object_updates sending to the remote OUT in single RPC */
3459 struct object_update_request {
3461 __u16 ourq_count; /* number of ourq_updates[] */
3463 struct object_update ourq_updates[0];
3466 #define OUT_UPDATE_HEADER_MAGIC 0xBDDF0001
3467 #define OUT_UPDATE_MAX_INLINE_SIZE 4096
3468 /* Header for updates request between MDTs */
3469 struct out_update_header {
3472 __u32 ouh_inline_length;
3473 __u32 ouh_reply_size;
3474 __u32 ouh_inline_data[0];
3477 struct out_update_buffer {
3482 /* the result of object update */
3483 struct object_update_result {
3490 #define UPDATE_REPLY_MAGIC_V1 0x00BD0001
3491 #define UPDATE_REPLY_MAGIC_V2 0x00BD0002
3492 #define UPDATE_REPLY_MAGIC UPDATE_REPLY_MAGIC_V2
3493 /* Hold object_update_results being replied from the remote OUT. */
3494 struct object_update_reply {
3501 /* read update result */
3502 struct out_read_reply {
3509 /** layout swap request structure
3510 * fid1 and fid2 are in mdt_body
3512 struct mdc_swap_layouts {
3514 } __attribute__((packed));
3516 #define INLINE_RESYNC_ARRAY_SIZE 15
3517 struct close_data_resync_done {
3519 __u32 resync_ids_inline[INLINE_RESYNC_ARRAY_SIZE];
3523 struct lustre_handle cd_handle;
3524 struct lu_fid cd_fid;
3525 __u64 cd_data_version;
3527 __u64 cd_reserved[8];
3528 struct close_data_resync_done cd_resync;
3534 /* Update llog format */
3536 struct lu_fid uop_fid;
3538 __u16 uop_param_count;
3539 __u16 uop_params_off[0];
3543 struct update_op uops_op[0];
3546 struct update_params {
3547 struct object_update_param up_params[0];
3550 enum update_records_flag {
3551 UPDATE_RECORD_CONTINUE = 1 >> 0,
3554 * This is the update record format used to store the updates in
3555 * disk. All updates of the operation will be stored in ur_ops.
3556 * All of parameters for updates of the operation will be stored
3558 * To save the space of the record, parameters in ur_ops will only
3559 * remember their offset in ur_params, so to avoid storing duplicate
3560 * parameters in ur_params, which can help us save a lot space for
3561 * operation like creating striped directory.
3563 struct update_records {
3564 __u64 ur_master_transno;
3567 /* If the operation includes multiple updates, then ur_index
3568 * means the index of the update inside the whole updates. */
3570 __u32 ur_update_count;
3571 __u32 ur_param_count;
3572 struct update_ops ur_ops;
3573 /* Note ur_ops has a variable size, so comment out
3574 * the following ur_params, in case some use it directly
3575 * update_records->ur_params
3577 * struct update_params ur_params;
3581 struct llog_update_record {
3582 struct llog_rec_hdr lur_hdr;
3583 struct update_records lur_update_rec;
3584 /* Note ur_update_rec has a variable size, so comment out
3585 * the following ur_tail, in case someone use it directly
3587 * struct llog_rec_tail lur_tail;
3591 /* sepol string format is:
3592 * <1-digit for SELinux status>:<policy name>:<policy version>:<policy hash>
3594 /* Max length of the sepol string
3595 * Should be large enough to contain a sha512sum of the policy
3597 #define SELINUX_MODE_LEN 1
3598 #define SELINUX_POLICY_VER_LEN 3 /* 3 chars to leave room for the future */
3599 #define SELINUX_POLICY_HASH_LEN 64
3600 #define LUSTRE_NODEMAP_SEPOL_LENGTH (SELINUX_MODE_LEN + NAME_MAX + \
3601 SELINUX_POLICY_VER_LEN + \
3602 SELINUX_POLICY_HASH_LEN + 3)
3604 /* nodemap records, uses 32 byte record length */
3605 #define LUSTRE_NODEMAP_NAME_LENGTH 16
3606 struct nodemap_cluster_rec {
3607 char ncr_name[LUSTRE_NODEMAP_NAME_LENGTH + 1];
3611 __u32 ncr_squash_uid;
3612 __u32 ncr_squash_gid;
3615 /* lnet_nid_t is 8 bytes */
3616 struct nodemap_range_rec {
3617 lnet_nid_t nrr_start_nid;
3618 lnet_nid_t nrr_end_nid;
3623 struct nodemap_id_rec {
3631 struct nodemap_global_rec {
3642 struct nodemap_cluster_rec ncr;
3643 struct nodemap_range_rec nrr;
3644 struct nodemap_id_rec nir;
3645 struct nodemap_global_rec ngr;
3648 /* This is the lu_ladvise struct which goes out on the wire.
3649 * Corresponds to the userspace arg llapi_lu_ladvise.
3650 * value[1-4] are unspecified fields, used differently by different advices */
3652 __u16 lla_advice; /* advice type */
3653 __u16 lla_value1; /* values for different advice types */
3655 __u64 lla_start; /* first byte of extent for advice */
3656 __u64 lla_end; /* last byte of extent for advice */
3661 /* This is the ladvise_hdr which goes on the wire, corresponds to the userspace
3662 * arg llapi_ladvise_hdr.
3663 * value[1-3] are unspecified fields, used differently by different advices */
3664 struct ladvise_hdr {
3665 __u32 lah_magic; /* LADVISE_MAGIC */
3666 __u32 lah_count; /* number of advices */
3667 __u64 lah_flags; /* from enum ladvise_flag */
3668 __u32 lah_value1; /* unused */
3669 __u32 lah_value2; /* unused */
3670 __u64 lah_value3; /* unused */
3671 struct lu_ladvise lah_advise[0]; /* advices in this header */
3674 #if defined(__cplusplus)