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, 2016, 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>
93 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
94 * FOO_REPLY_PORTAL is for incoming replies on the FOO
95 * FOO_BULK_PORTAL is for incoming bulk on the FOO
98 #define CONNMGR_REQUEST_PORTAL 1
99 #define CONNMGR_REPLY_PORTAL 2
100 //#define OSC_REQUEST_PORTAL 3
101 #define OSC_REPLY_PORTAL 4
102 //#define OSC_BULK_PORTAL 5
103 #define OST_IO_PORTAL 6
104 #define OST_CREATE_PORTAL 7
105 #define OST_BULK_PORTAL 8
106 //#define MDC_REQUEST_PORTAL 9
107 #define MDC_REPLY_PORTAL 10
108 //#define MDC_BULK_PORTAL 11
109 #define MDS_REQUEST_PORTAL 12
110 #define MDS_IO_PORTAL 13
111 #define MDS_BULK_PORTAL 14
112 #define LDLM_CB_REQUEST_PORTAL 15
113 #define LDLM_CB_REPLY_PORTAL 16
114 #define LDLM_CANCEL_REQUEST_PORTAL 17
115 #define LDLM_CANCEL_REPLY_PORTAL 18
116 //#define PTLBD_REQUEST_PORTAL 19
117 //#define PTLBD_REPLY_PORTAL 20
118 //#define PTLBD_BULK_PORTAL 21
119 #define MDS_SETATTR_PORTAL 22
120 #define MDS_READPAGE_PORTAL 23
121 #define OUT_PORTAL 24
122 #define MGC_REPLY_PORTAL 25
123 #define MGS_REQUEST_PORTAL 26
124 #define MGS_REPLY_PORTAL 27
125 #define OST_REQUEST_PORTAL 28
126 #define FLD_REQUEST_PORTAL 29
127 #define SEQ_METADATA_PORTAL 30
128 #define SEQ_DATA_PORTAL 31
129 #define SEQ_CONTROLLER_PORTAL 32
130 #define MGS_BULK_PORTAL 33
132 /* Portal 63 is reserved for the Cray Inc DVS - nic@cray.com, roe@cray.com, n8851@cray.com */
135 #define PTL_RPC_MSG_REQUEST 4711
136 #define PTL_RPC_MSG_ERR 4712
137 #define PTL_RPC_MSG_REPLY 4713
139 /* DON'T use swabbed values of MAGIC as magic! */
140 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
141 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
143 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
145 #define PTLRPC_MSG_VERSION 0x00000003
146 #define LUSTRE_VERSION_MASK 0xffff0000
147 #define LUSTRE_OBD_VERSION 0x00010000
148 #define LUSTRE_MDS_VERSION 0x00020000
149 #define LUSTRE_OST_VERSION 0x00030000
150 #define LUSTRE_DLM_VERSION 0x00040000
151 #define LUSTRE_LOG_VERSION 0x00050000
152 #define LUSTRE_MGS_VERSION 0x00060000
155 * Describes a range of sequence, lsr_start is included but lsr_end is
157 * Same structure is used in fld module where lsr_index field holds mdt id
160 struct lu_seq_range {
167 struct lu_seq_range_array {
170 struct lu_seq_range lsra_lsr[0];
173 #define LU_SEQ_RANGE_MDT 0x0
174 #define LU_SEQ_RANGE_OST 0x1
175 #define LU_SEQ_RANGE_ANY 0x3
177 #define LU_SEQ_RANGE_MASK 0x3
179 /** \defgroup lu_fid lu_fid
182 extern void lustre_lma_swab(struct lustre_mdt_attrs *lma);
183 extern void lustre_lma_init(struct lustre_mdt_attrs *lma,
184 const struct lu_fid *fid,
185 __u32 compat, __u32 incompat);
186 extern void lustre_loa_swab(struct lustre_ost_attrs *loa,
188 extern void lustre_loa_init(struct lustre_ost_attrs *loa,
189 const struct lu_fid *fid,
190 __u32 compat, __u32 incompat);
192 /* copytool uses a 32b bitmask field to encode archive-Ids during register
194 * archive num = 0 => all
195 * archive num from 1 to 32
197 #define LL_HSM_MAX_ARCHIVE (sizeof(__u32) * 8)
200 * HSM on-disk attributes stored in a separate xattr.
203 /** Bitfield for supported data in this structure. For future use. */
206 /** HSM flags, see hsm_flags enum below */
208 /** backend archive id associated with the file */
210 /** version associated with the last archiving, if any */
213 extern void lustre_hsm_swab(struct hsm_attrs *attrs);
219 /** LASTID file has zero OID */
220 LUSTRE_FID_LASTID_OID = 0UL,
221 /** initial fid id value */
222 LUSTRE_FID_INIT_OID = 1UL
226 * Different FID Format
227 * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs#NEW.0
230 * File IDentifier generated by client from range allocated by the seq service.
231 * First 0x400 sequences [2^33, 2^33 + 0x400] are reserved for system use. Note
232 * that on ldiskfs MDTs that IGIF FIDs can use inode numbers starting at 12,
233 * but this is in the IGIF SEQ rangeand does not conflict with assigned FIDs.
236 * Inode and Generation In FID, a surrogate FID used to globally identify an
237 * existing object on OLD formatted MDT file system. This would only be used on
238 * MDT0 in a DNE filesystem, because there are not expected to be any OLD
239 * formatted DNE filesystems. Belongs to a sequence in [12, 2^32 - 1] range,
240 * where sequence number is inode number, and inode generation is used as OID.
241 * NOTE: This assumes no more than 2^32-1 inodes exist in the MDT filesystem,
242 * which is the maximum possible for an ldiskfs backend. NOTE: This assumes
243 * that the reserved ext3/ext4/ldiskfs inode numbers [0-11] are never visible
244 * to clients, which has always been true.
247 * Object ID in FID, a surrogate FID used to globally identify an existing
248 * object on OLD formatted OST file system. Belongs to a sequence in
249 * [2^32, 2^33 - 1]. Sequence number is calculated as:
250 * 1 << 32 | (ost_index << 16) | ((objid >> 32) & 0xffff)
251 * that is, SEQ consists of 16-bit OST index, and higher 16 bits of object ID.
252 * The generation of unique SEQ values per OST allows the IDIF FIDs to be
253 * identified in the FLD correctly. The OID field is calculated as:
255 * that is, it consists of lower 32 bits of object ID. NOTE This assumes that
256 * no more than 2^48-1 objects have ever been created on an OST, and that no
257 * more than 65535 OSTs are in use. Both are very reasonable assumptions (can
258 * uniquely map all objects on an OST that created 1M objects per second for 9
259 * years, or combinations thereof).
262 * Surrogate FID used to identify an existing object on OLD formatted OST
263 * filesystem. Belongs to the reserved sequence 0, and is used internally prior
264 * to the introduction of FID-on-OST, at which point IDIF will be used to
265 * identify objects as residing on a specific OST.
268 * For Lustre Log objects the object sequence 1 is used. This is compatible with
269 * both OLD and NEW.1 namespaces, as this SEQ number is in the ext3/ldiskfs
270 * reserved inode range and does not conflict with IGIF sequence numbers.
273 * For testing OST IO performance the object sequence 2 is used. This is
274 * compatible with both OLD and NEW.1 namespaces, as this SEQ number is in the
275 * ext3/ldiskfs reserved inode range and does not conflict with IGIF sequence
278 * OST_MDT1 .. OST_MAX:
279 * For testing with multiple MDTs the object sequence 3 through 9 is used,
280 * allowing direct mapping of MDTs 1 through 7 respectively, for a total of 8
281 * MDTs including OST_MDT0. This matches the legacy CMD project "group"
282 * mappings. However, this SEQ range is only for testing prior to any production
283 * DNE release, as the objects in this range conflict across all OSTs, as the
284 * OST index is not part of the FID.
287 * For compatibility with existing OLD OST network protocol structures, the FID
288 * must map onto the o_id and o_gr in a manner that ensures existing objects are
289 * identified consistently for IO, as well as onto the lock namespace to ensure
290 * both IDIFs map onto the same objects for IO as well as resources in the DLM.
293 * resource[] = {o_id, o_seq, 0, 0}; // o_seq == 0 for production releases
295 * DLM NEW.1 FID (this is the same for both the MDT and OST):
296 * resource[] = {SEQ, OID, VER, HASH};
298 * Note that for mapping IDIF values to DLM resource names the o_id may be
299 * larger than the 2^33 reserved sequence numbers for IDIF, so it is possible
300 * for the o_id numbers to overlap FID SEQ numbers in the resource. However, in
301 * all production releases the OLD o_seq field is always zero, and all valid FID
302 * OID values are non-zero, so the lock resources will not collide.
304 * For objects within the IDIF range, group extraction (non-CMD) will be:
305 * o_id = (fid->f_seq & 0x7fff) << 16 | fid->f_oid;
306 * o_seq = 0; // formerly group number
310 * Note that reserved SEQ numbers below 12 will conflict with ldiskfs
311 * inodes in the IGIF namespace, so these reserved SEQ numbers can be
312 * used for other purposes and not risk collisions with existing inodes.
315 FID_SEQ_OST_MDT0 = 0,
316 FID_SEQ_LLOG = 1, /* unnamed llogs */
318 FID_SEQ_UNUSED_START = 3,
319 FID_SEQ_UNUSED_END = 9,
320 FID_SEQ_LLOG_NAME = 10, /* named llogs */
323 FID_SEQ_IGIF_MAX = 0x0ffffffffULL,
324 FID_SEQ_IDIF = 0x100000000ULL,
325 FID_SEQ_IDIF_MAX = 0x1ffffffffULL,
326 /* Normal FID sequence starts from this value, i.e. 1<<33 */
327 FID_SEQ_START = 0x200000000ULL,
328 /* sequence for local pre-defined FIDs listed in local_oid */
329 FID_SEQ_LOCAL_FILE = 0x200000001ULL,
330 FID_SEQ_DOT_LUSTRE = 0x200000002ULL,
331 /* sequence is used for local named objects FIDs generated
332 * by local_object_storage library */
333 FID_SEQ_LOCAL_NAME = 0x200000003ULL,
334 /* Because current FLD will only cache the fid sequence, instead
335 * of oid on the client side, if the FID needs to be exposed to
336 * clients sides, it needs to make sure all of fids under one
337 * sequence will be located in one MDT. */
338 FID_SEQ_SPECIAL = 0x200000004ULL,
339 FID_SEQ_QUOTA = 0x200000005ULL,
340 FID_SEQ_QUOTA_GLB = 0x200000006ULL,
341 FID_SEQ_ROOT = 0x200000007ULL, /* Located on MDT0 */
342 FID_SEQ_LAYOUT_RBTREE = 0x200000008ULL,
343 /* sequence is used for update logs of cross-MDT operation */
344 FID_SEQ_UPDATE_LOG = 0x200000009ULL,
345 /* Sequence is used for the directory under which update logs
347 FID_SEQ_UPDATE_LOG_DIR = 0x20000000aULL,
348 FID_SEQ_NORMAL = 0x200000400ULL,
349 FID_SEQ_LOV_DEFAULT = 0xffffffffffffffffULL
352 #define OBIF_OID_MAX_BITS 32
353 #define OBIF_MAX_OID (1ULL << OBIF_OID_MAX_BITS)
354 #define OBIF_OID_MASK ((1ULL << OBIF_OID_MAX_BITS) - 1)
355 #define IDIF_OID_MAX_BITS 48
356 #define IDIF_MAX_OID (1ULL << IDIF_OID_MAX_BITS)
357 #define IDIF_OID_MASK ((1ULL << IDIF_OID_MAX_BITS) - 1)
359 /** OID for FID_SEQ_SPECIAL */
361 /* Big Filesystem Lock to serialize rename operations */
362 FID_OID_SPECIAL_BFL = 1UL,
365 /** OID for FID_SEQ_DOT_LUSTRE */
366 enum dot_lustre_oid {
367 FID_OID_DOT_LUSTRE = 1UL,
368 FID_OID_DOT_LUSTRE_OBF = 2UL,
369 FID_OID_DOT_LUSTRE_LPF = 3UL,
372 /** OID for FID_SEQ_ROOT */
375 FID_OID_ECHO_ROOT = 2UL,
378 struct lu_orphan_rec {
379 /* The MDT-object's FID referenced by the orphan OST-object */
380 struct lu_fid lor_fid;
385 struct lu_orphan_ent {
386 /* The orphan OST-object's FID */
387 struct lu_fid loe_key;
388 struct lu_orphan_rec loe_rec;
391 struct lu_orphan_rec_v2 {
392 struct lu_orphan_rec lor_rec;
393 struct ost_layout lor_layout;
397 struct lu_orphan_ent_v2 {
398 /* The orphan OST-object's FID */
399 struct lu_fid loe_key;
400 struct lu_orphan_rec_v2 loe_rec;
405 /** \defgroup lu_dir lu_dir
409 * Enumeration of possible directory entry attributes.
411 * Attributes follow directory entry header in the order they appear in this
414 enum lu_dirent_attrs {
417 LUDA_64BITHASH = 0x0004,
419 /* The following attrs are used for MDT internal only,
420 * not visible to client */
422 /* Something in the record is unknown, to be verified in further. */
423 LUDA_UNKNOWN = 0x0400,
424 /* Ignore this record, go to next directly. */
425 LUDA_IGNORE = 0x0800,
426 /* The system is upgraded, has beed or to be repaired (dryrun). */
427 LUDA_UPGRADE = 0x1000,
428 /* The dirent has been repaired, or to be repaired (dryrun). */
429 LUDA_REPAIR = 0x2000,
430 /* Only check but not repair the dirent inconsistency */
431 LUDA_VERIFY_DRYRUN = 0x4000,
432 /* Verify the dirent consistency */
433 LUDA_VERIFY = 0x8000,
436 #define LU_DIRENT_ATTRS_MASK 0xff00
439 * Layout of readdir pages, as transmitted on wire.
442 /** valid if LUDA_FID is set. */
443 struct lu_fid lde_fid;
444 /** a unique entry identifier: a hash or an offset. */
446 /** total record length, including all attributes. */
450 /** optional variable size attributes following this entry.
451 * taken from enum lu_dirent_attrs.
454 /** name is followed by the attributes indicated in ->ldp_attrs, in
455 * their natural order. After the last attribute, padding bytes are
456 * added to make ->lde_reclen a multiple of 8.
462 * Definitions of optional directory entry attributes formats.
464 * Individual attributes do not have their length encoded in a generic way. It
465 * is assumed that consumer of an attribute knows its format. This means that
466 * it is impossible to skip over an unknown attribute, except by skipping over all
467 * remaining attributes (by using ->lde_reclen), which is not too
468 * constraining, because new server versions will append new attributes at
469 * the end of an entry.
473 * Fid directory attribute: a fid of an object referenced by the entry. This
474 * will be almost always requested by the client and supplied by the server.
476 * Aligned to 8 bytes.
478 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
483 * Aligned to 2 bytes.
490 __u64 ldp_hash_start;
494 struct lu_dirent ldp_entries[0];
497 enum lu_dirpage_flags {
499 * dirpage contains no entry.
503 * last entry's lde_hash equals ldp_hash_end.
508 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
510 if (__le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
513 return dp->ldp_entries;
516 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
518 struct lu_dirent *next;
520 if (__le16_to_cpu(ent->lde_reclen) != 0)
521 next = ((void *)ent) + __le16_to_cpu(ent->lde_reclen);
528 static inline size_t lu_dirent_calc_size(size_t namelen, __u16 attr)
532 if (attr & LUDA_TYPE) {
533 const size_t align = sizeof(struct luda_type) - 1;
534 size = (sizeof(struct lu_dirent) + namelen + align) & ~align;
535 size += sizeof(struct luda_type);
537 size = sizeof(struct lu_dirent) + namelen;
539 return (size + 7) & ~7;
542 #define MDS_DIR_END_OFF 0xfffffffffffffffeULL
545 * MDS_READPAGE page size
547 * This is the directory page size packed in MDS_READPAGE RPC.
548 * It's different than PAGE_SIZE because the client needs to
549 * access the struct lu_dirpage header packed at the beginning of
550 * the "page" and without this there isn't any way to know find the
551 * lu_dirpage header is if client and server PAGE_SIZE differ.
553 #define LU_PAGE_SHIFT 12
554 #define LU_PAGE_SIZE (1UL << LU_PAGE_SHIFT)
555 #define LU_PAGE_MASK (~(LU_PAGE_SIZE - 1))
557 #define LU_PAGE_COUNT (1 << (PAGE_SHIFT - LU_PAGE_SHIFT))
561 struct lustre_handle {
564 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
566 static inline bool lustre_handle_is_used(const struct lustre_handle *lh)
568 return lh->cookie != 0;
571 static inline bool lustre_handle_equal(const struct lustre_handle *lh1,
572 const struct lustre_handle *lh2)
574 return lh1->cookie == lh2->cookie;
577 static inline void lustre_handle_copy(struct lustre_handle *tgt,
578 const struct lustre_handle *src)
580 tgt->cookie = src->cookie;
583 struct lustre_handle_array {
585 struct lustre_handle handles[0];
588 /* flags for lm_flags */
589 #define MSGHDR_AT_SUPPORT 0x1
590 #define MSGHDR_CKSUM_INCOMPAT18 0x2
592 #define lustre_msg lustre_msg_v2
593 /* we depend on this structure to be 8-byte aligned */
594 /* this type is only endian-adjusted in lustre_unpack_msg() */
595 struct lustre_msg_v2 {
607 /* without gss, ptlrpc_body is put at the first buffer. */
608 #define PTLRPC_NUM_VERSIONS 4
609 struct ptlrpc_body_v3 {
610 struct lustre_handle pb_handle;
615 __u64 pb_last_xid; /* highest replied XID without lower unreplied XID */
616 __u16 pb_tag; /* virtual slot idx for multiple modifying RPCs */
619 __u64 pb_last_committed;
624 __u32 pb_timeout; /* for req, the deadline, for rep, the service est */
625 __u32 pb_service_time; /* for rep, actual service time */
628 /* VBR: pre-versions */
629 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
630 __u64 pb_mbits; /**< match bits for bulk request */
631 /* padding for future needs */
632 __u64 pb_padding64_0;
633 __u64 pb_padding64_1;
634 __u64 pb_padding64_2;
635 char pb_jobid[LUSTRE_JOBID_SIZE];
637 #define ptlrpc_body ptlrpc_body_v3
639 struct ptlrpc_body_v2 {
640 struct lustre_handle pb_handle;
645 __u64 pb_last_xid; /* highest replied XID without lower unreplied XID */
646 __u16 pb_tag; /* virtual slot idx for multiple modifying RPCs */
649 __u64 pb_last_committed;
654 __u32 pb_timeout; /* for req, the deadline, for rep, the service est */
655 __u32 pb_service_time; /* for rep, actual service time, also used for
656 net_latency of req */
659 /* VBR: pre-versions */
660 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
661 __u64 pb_mbits; /**< unused in V2 */
662 /* padding for future needs */
663 __u64 pb_padding64_0;
664 __u64 pb_padding64_1;
665 __u64 pb_padding64_2;
668 /* message body offset for lustre_msg_v2 */
669 /* ptlrpc body offset in all request/reply messages */
670 #define MSG_PTLRPC_BODY_OFF 0
672 /* normal request/reply message record offset */
673 #define REQ_REC_OFF 1
674 #define REPLY_REC_OFF 1
676 /* ldlm request message body offset */
677 #define DLM_LOCKREQ_OFF 1 /* lockreq offset */
678 #define DLM_REQ_REC_OFF 2 /* normal dlm request record offset */
680 /* ldlm intent lock message body offset */
681 #define DLM_INTENT_IT_OFF 2 /* intent lock it offset */
682 #define DLM_INTENT_REC_OFF 3 /* intent lock record offset */
684 /* ldlm reply message body offset */
685 #define DLM_LOCKREPLY_OFF 1 /* lockrep offset */
686 #define DLM_REPLY_REC_OFF 2 /* reply record offset */
688 /** only use in req->rq_{req,rep}_swab_mask */
689 #define MSG_PTLRPC_HEADER_OFF 31
691 /* Flags that are operation-specific go in the top 16 bits. */
692 #define MSG_OP_FLAG_MASK 0xffff0000
693 #define MSG_OP_FLAG_SHIFT 16
695 /* Flags that apply to all requests are in the bottom 16 bits */
696 #define MSG_GEN_FLAG_MASK 0x0000ffff
697 #define MSG_LAST_REPLAY 0x0001
698 #define MSG_RESENT 0x0002
699 #define MSG_REPLAY 0x0004
700 /* #define MSG_AT_SUPPORT 0x0008
701 * This was used in early prototypes of adaptive timeouts, and while there
702 * shouldn't be any users of that code there also isn't a need for using this
703 * bits. Defer usage until at least 1.10 to avoid potential conflict. */
704 #define MSG_DELAY_REPLAY 0x0010
705 #define MSG_VERSION_REPLAY 0x0020
706 #define MSG_REQ_REPLAY_DONE 0x0040
707 #define MSG_LOCK_REPLAY_DONE 0x0080
710 * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
713 #define MSG_CONNECT_RECOVERING 0x00000001
714 #define MSG_CONNECT_RECONNECT 0x00000002
715 #define MSG_CONNECT_REPLAYABLE 0x00000004
716 /* #define MSG_CONNECT_PEER 0x00000008 removed 1.5 */
717 #define MSG_CONNECT_LIBCLIENT 0x00000010
718 #define MSG_CONNECT_INITIAL 0x00000020
719 #define MSG_CONNECT_ASYNC 0x00000040
720 #define MSG_CONNECT_NEXT_VER 0x00000080 /* use next version of lustre_msg */
721 #define MSG_CONNECT_TRANSNO 0x00000100 /* report transno */
724 #define OBD_CONNECT_RDONLY 0x1ULL /*client has read-only access*/
725 #define OBD_CONNECT_INDEX 0x2ULL /*connect specific LOV idx */
726 #define OBD_CONNECT_MDS 0x4ULL /*connect from MDT to OST */
727 #define OBD_CONNECT_GRANT 0x8ULL /*OSC gets grant at connect */
728 #define OBD_CONNECT_SRVLOCK 0x10ULL /*server takes locks for cli */
729 #define OBD_CONNECT_VERSION 0x20ULL /*Lustre versions in ocd */
730 #define OBD_CONNECT_REQPORTAL 0x40ULL /*Separate non-IO req portal */
731 #define OBD_CONNECT_ACL 0x80ULL /*access control lists */
732 #define OBD_CONNECT_XATTR 0x100ULL /*client use extended attr */
733 #define OBD_CONNECT_LARGE_ACL 0x200ULL /* more than 32 ACL entries */
734 #define OBD_CONNECT_TRUNCLOCK 0x400ULL /*locks on server for punch */
735 #define OBD_CONNECT_TRANSNO 0x800ULL /*replay sends init transno */
736 #define OBD_CONNECT_IBITS 0x1000ULL /*support for inodebits locks*/
737 #define OBD_CONNECT_BARRIER 0x2000ULL /* write barrier */
738 #define OBD_CONNECT_ATTRFID 0x4000ULL /*Server can GetAttr By Fid*/
739 #define OBD_CONNECT_NODEVOH 0x8000ULL /*No open hndl on specl nodes*/
740 #define OBD_CONNECT_RMT_CLIENT 0x10000ULL /* Remote client, never used
741 * in production. Removed in
742 * 2.9. Keep this flag to
745 #define OBD_CONNECT_RMT_CLIENT_FORCE 0x20000ULL /* Remote client by force,
746 * never used in production.
747 * Removed in 2.9. Keep this
748 * flag to avoid reusing.
750 #define OBD_CONNECT_BRW_SIZE 0x40000ULL /*Max bytes per rpc */
751 #define OBD_CONNECT_QUOTA64 0x80000ULL /*Not used since 2.4 */
752 #define OBD_CONNECT_MDS_CAPA 0x100000ULL /*MDS capability */
753 #define OBD_CONNECT_OSS_CAPA 0x200000ULL /*OSS capability */
754 #define OBD_CONNECT_CANCELSET 0x400000ULL /*Early batched cancels. */
755 #define OBD_CONNECT_SOM 0x800000ULL /*Size on MDS */
756 #define OBD_CONNECT_AT 0x1000000ULL /*client uses AT */
757 #define OBD_CONNECT_LRU_RESIZE 0x2000000ULL /*LRU resize feature. */
758 #define OBD_CONNECT_MDS_MDS 0x4000000ULL /*MDS-MDS connection */
759 #define OBD_CONNECT_REAL 0x8000000ULL /* obsolete since 2.8 */
760 #define OBD_CONNECT_CHANGE_QS 0x10000000ULL /*Not used since 2.4 */
761 #define OBD_CONNECT_CKSUM 0x20000000ULL /*support several cksum algos*/
762 #define OBD_CONNECT_FID 0x40000000ULL /*FID is supported by server */
763 #define OBD_CONNECT_VBR 0x80000000ULL /*version based recovery */
764 #define OBD_CONNECT_LOV_V3 0x100000000ULL /*client supports LOV v3 EA */
765 #define OBD_CONNECT_GRANT_SHRINK 0x200000000ULL /* support grant shrink */
766 #define OBD_CONNECT_SKIP_ORPHAN 0x400000000ULL /* don't reuse orphan objids */
767 #define OBD_CONNECT_MAX_EASIZE 0x800000000ULL /* preserved for large EA */
768 #define OBD_CONNECT_FULL20 0x1000000000ULL /* it is 2.0 client */
769 #define OBD_CONNECT_LAYOUTLOCK 0x2000000000ULL /* client uses layout lock */
770 #define OBD_CONNECT_64BITHASH 0x4000000000ULL /* client supports 64-bits
772 #define OBD_CONNECT_MAXBYTES 0x8000000000ULL /* max stripe size */
773 #define OBD_CONNECT_IMP_RECOV 0x10000000000ULL /* imp recovery support */
774 #define OBD_CONNECT_JOBSTATS 0x20000000000ULL /* jobid in ptlrpc_body */
775 #define OBD_CONNECT_UMASK 0x40000000000ULL /* create uses client umask */
776 #define OBD_CONNECT_EINPROGRESS 0x80000000000ULL /* client handles -EINPROGRESS
777 * RPC error properly */
778 #define OBD_CONNECT_GRANT_PARAM 0x100000000000ULL/* extra grant params used for
779 * finer space reservation */
780 #define OBD_CONNECT_FLOCK_OWNER 0x200000000000ULL /* for the fixed 1.8
781 * policy and 2.x server */
782 #define OBD_CONNECT_LVB_TYPE 0x400000000000ULL /* variable type of LVB */
783 #define OBD_CONNECT_NANOSEC_TIME 0x800000000000ULL /* nanosecond timestamps */
784 #define OBD_CONNECT_LIGHTWEIGHT 0x1000000000000ULL/* lightweight connection */
785 #define OBD_CONNECT_SHORTIO 0x2000000000000ULL/* short io */
786 #define OBD_CONNECT_PINGLESS 0x4000000000000ULL/* pings not required */
787 #define OBD_CONNECT_FLOCK_DEAD 0x8000000000000ULL/* improved flock deadlock detection */
788 #define OBD_CONNECT_DISP_STRIPE 0x10000000000000ULL/* create stripe disposition*/
789 #define OBD_CONNECT_OPEN_BY_FID 0x20000000000000ULL /* open by fid won't pack
791 #define OBD_CONNECT_LFSCK 0x40000000000000ULL/* support online LFSCK */
792 #define OBD_CONNECT_UNLINK_CLOSE 0x100000000000000ULL/* close file in unlink */
793 #define OBD_CONNECT_MULTIMODRPCS 0x200000000000000ULL /* support multiple modify
795 #define OBD_CONNECT_DIR_STRIPE 0x400000000000000ULL /* striped DNE dir */
796 #define OBD_CONNECT_SUBTREE 0x800000000000000ULL /* fileset mount */
797 #define OBD_CONNECT_LOCKAHEAD_OLD 0x1000000000000000ULL /* Old Cray lockahead */
799 /** bulk matchbits is sent within ptlrpc_body */
800 #define OBD_CONNECT_BULK_MBITS 0x2000000000000000ULL
801 #define OBD_CONNECT_OBDOPACK 0x4000000000000000ULL /* compact OUT obdo */
802 #define OBD_CONNECT_FLAGS2 0x8000000000000000ULL /* second flags word */
803 /* ocd_connect_flags2 flags */
804 #define OBD_CONNECT2_FILE_SECCTX 0x1ULL /* set file security context at create */
805 #define OBD_CONNECT2_LOCKAHEAD 0x2ULL /* ladvise lockahead v2 */
808 * Please DO NOT add flag values here before first ensuring that this same
809 * flag value is not in use on some other branch. Please clear any such
810 * changes with senior engineers before starting to use a new flag. Then,
811 * submit a small patch against EVERY branch that ONLY adds the new flag,
812 * updates obd_connect_names[] for lprocfs_rd_connect_flags(), adds the
813 * flag to check_obd_connect_data(), and updates wiretests accordingly, so it
814 * can be approved and landed easily to reserve the flag for future use. */
816 /* The MNE_SWAB flag is overloading the MDS_MDS bit only for the MGS
817 * connection. It is a temporary bug fix for Imperative Recovery interop
818 * between 2.2 and 2.3 x86/ppc nodes, and can be removed when interop for
819 * 2.2 clients/servers is no longer needed. LU-1252/LU-1644. */
820 #define OBD_CONNECT_MNE_SWAB OBD_CONNECT_MDS_MDS
822 #define OCD_HAS_FLAG(ocd, flg) \
823 (!!((ocd)->ocd_connect_flags & OBD_CONNECT_##flg))
826 #ifdef HAVE_LRU_RESIZE_SUPPORT
827 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
829 #define LRU_RESIZE_CONNECT_FLAG 0
832 #define MDT_CONNECT_SUPPORTED (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
833 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
834 OBD_CONNECT_IBITS | OBD_CONNECT_NODEVOH | \
835 OBD_CONNECT_ATTRFID | OBD_CONNECT_CANCELSET | \
836 OBD_CONNECT_AT | OBD_CONNECT_BRW_SIZE | \
837 OBD_CONNECT_MDS_MDS | OBD_CONNECT_FID | \
838 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_VBR | \
839 OBD_CONNECT_LOV_V3 | OBD_CONNECT_FULL20 | \
840 OBD_CONNECT_64BITHASH | OBD_CONNECT_JOBSTATS | \
841 OBD_CONNECT_EINPROGRESS | \
842 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_UMASK | \
843 OBD_CONNECT_LVB_TYPE | OBD_CONNECT_LAYOUTLOCK |\
844 OBD_CONNECT_PINGLESS | OBD_CONNECT_MAX_EASIZE |\
845 OBD_CONNECT_FLOCK_DEAD | \
846 OBD_CONNECT_DISP_STRIPE | OBD_CONNECT_LFSCK | \
847 OBD_CONNECT_OPEN_BY_FID | \
848 OBD_CONNECT_DIR_STRIPE | OBD_CONNECT_GRANT | \
849 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_SRVLOCK | \
850 OBD_CONNECT_BULK_MBITS | OBD_CONNECT_CKSUM | \
851 OBD_CONNECT_MULTIMODRPCS | \
852 OBD_CONNECT_SUBTREE | OBD_CONNECT_LARGE_ACL | \
853 OBD_CONNECT_GRANT_PARAM | \
856 #define MDT_CONNECT_SUPPORTED2 OBD_CONNECT2_FILE_SECCTX
858 #define OST_CONNECT_SUPPORTED (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
859 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
860 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
861 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_CANCELSET | \
862 OBD_CONNECT_AT | LRU_RESIZE_CONNECT_FLAG | \
863 OBD_CONNECT_CKSUM | OBD_CONNECT_VBR | \
864 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
865 OBD_CONNECT_GRANT_SHRINK | OBD_CONNECT_FULL20 |\
866 OBD_CONNECT_64BITHASH | OBD_CONNECT_MAXBYTES | \
867 OBD_CONNECT_MAX_EASIZE | \
868 OBD_CONNECT_EINPROGRESS | \
869 OBD_CONNECT_JOBSTATS | \
870 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_LVB_TYPE|\
871 OBD_CONNECT_LAYOUTLOCK | OBD_CONNECT_FID | \
872 OBD_CONNECT_PINGLESS | OBD_CONNECT_LFSCK | \
873 OBD_CONNECT_BULK_MBITS | \
874 OBD_CONNECT_GRANT_PARAM | OBD_CONNECT_FLAGS2)
876 #define OST_CONNECT_SUPPORTED2 OBD_CONNECT2_LOCKAHEAD
878 #define ECHO_CONNECT_SUPPORTED 0
879 #define ECHO_CONNECT_SUPPORTED2 0
881 #define MGS_CONNECT_SUPPORTED (OBD_CONNECT_VERSION | OBD_CONNECT_AT | \
882 OBD_CONNECT_FULL20 | OBD_CONNECT_IMP_RECOV | \
883 OBD_CONNECT_MNE_SWAB | OBD_CONNECT_PINGLESS |\
884 OBD_CONNECT_BULK_MBITS | OBD_CONNECT_BARRIER)
886 #define MGS_CONNECT_SUPPORTED2 0
888 /* Features required for this version of the client to work with server */
889 #define CLIENT_CONNECT_MDT_REQD (OBD_CONNECT_IBITS | OBD_CONNECT_FID | \
892 /* This structure is used for both request and reply.
894 * If we eventually have separate connect data for different types, which we
895 * almost certainly will, then perhaps we stick a union in here. */
896 struct obd_connect_data {
897 __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
898 __u32 ocd_version; /* lustre release version number */
899 __u32 ocd_grant; /* initial cache grant amount (bytes) */
900 __u32 ocd_index; /* LOV index to connect to */
901 __u32 ocd_brw_size; /* Maximum BRW size in bytes */
902 __u64 ocd_ibits_known; /* inode bits this client understands */
903 __u8 ocd_grant_blkbits; /* log2 of the backend filesystem blocksize */
904 __u8 ocd_grant_inobits; /* log2 of the per-inode space consumption */
905 __u16 ocd_grant_tax_kb; /* extent insertion overhead, in 1K blocks */
906 __u32 ocd_grant_max_blks;/* maximum number of blocks per extent */
907 __u64 ocd_transno; /* first transno from client to be replayed */
908 __u32 ocd_group; /* MDS group on OST */
909 __u32 ocd_cksum_types; /* supported checksum algorithms */
910 __u32 ocd_max_easize; /* How big LOV EA can be on MDS */
911 __u32 ocd_instance; /* instance # of this target */
912 __u64 ocd_maxbytes; /* Maximum stripe size in bytes */
913 /* Fields after ocd_maxbytes are only accessible by the receiver
914 * if the corresponding flag in ocd_connect_flags is set. Accessing
915 * any field after ocd_maxbytes on the receiver without a valid flag
916 * may result in out-of-bound memory access and kernel oops. */
917 __u16 ocd_maxmodrpcs; /* Maximum modify RPCs in parallel */
918 __u16 padding0; /* added 2.1.0. also fix lustre_swab_connect */
919 __u32 padding1; /* added 2.1.0. also fix lustre_swab_connect */
920 __u64 ocd_connect_flags2;
921 __u64 padding3; /* added 2.1.0. also fix lustre_swab_connect */
922 __u64 padding4; /* added 2.1.0. also fix lustre_swab_connect */
923 __u64 padding5; /* added 2.1.0. also fix lustre_swab_connect */
924 __u64 padding6; /* added 2.1.0. also fix lustre_swab_connect */
925 __u64 padding7; /* added 2.1.0. also fix lustre_swab_connect */
926 __u64 padding8; /* added 2.1.0. also fix lustre_swab_connect */
927 __u64 padding9; /* added 2.1.0. also fix lustre_swab_connect */
928 __u64 paddingA; /* added 2.1.0. also fix lustre_swab_connect */
929 __u64 paddingB; /* added 2.1.0. also fix lustre_swab_connect */
930 __u64 paddingC; /* added 2.1.0. also fix lustre_swab_connect */
931 __u64 paddingD; /* added 2.1.0. also fix lustre_swab_connect */
932 __u64 paddingE; /* added 2.1.0. also fix lustre_swab_connect */
933 __u64 paddingF; /* added 2.1.0. also fix lustre_swab_connect */
936 * Please DO NOT use any fields here before first ensuring that this same
937 * field is not in use on some other branch. Please clear any such changes
938 * with senior engineers before starting to use a new field. Then, submit
939 * a small patch against EVERY branch that ONLY adds the new field along with
940 * the matching OBD_CONNECT flag, so that can be approved and landed easily to
941 * reserve the flag for future use. */
944 * Supported checksum algorithms. Up to 32 checksum types are supported.
945 * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
946 * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
947 * algorithm and also the OBD_FL_CKSUM* flags.
949 typedef enum cksum_types {
950 OBD_CKSUM_CRC32 = 0x00000001,
951 OBD_CKSUM_ADLER = 0x00000002,
952 OBD_CKSUM_CRC32C= 0x00000004,
956 * OST requests: OBDO & OBD request records
961 OST_REPLY = 0, /* reply ? */
977 OST_QUOTACHECK = 18, /* not used since 2.4 */
979 OST_QUOTA_ADJUST_QUNIT = 20, /* not used since 2.4 */
981 OST_LAST_OPC /* must be < 33 to avoid MDS_GETATTR */
983 #define OST_FIRST_OPC OST_REPLY
986 OBD_FL_INLINEDATA = 0x00000001,
987 OBD_FL_OBDMDEXISTS = 0x00000002,
988 OBD_FL_DELORPHAN = 0x00000004, /* if set in o_flags delete orphans */
989 OBD_FL_NORPC = 0x00000008, /* set in o_flags do in OSC not OST */
990 OBD_FL_IDONLY = 0x00000010, /* set in o_flags only adjust obj id*/
991 OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
992 OBD_FL_DEBUG_CHECK = 0x00000040, /* echo client/server debug check */
993 OBD_FL_NO_PRJQUOTA = 0x00000080, /* the object's project is over
995 OBD_FL_NO_USRQUOTA = 0x00000100, /* the object's owner is over quota */
996 OBD_FL_NO_GRPQUOTA = 0x00000200, /* the object's group is over quota */
997 OBD_FL_CREATE_CROW = 0x00000400, /* object should be create on write */
998 OBD_FL_SRVLOCK = 0x00000800, /* delegate DLM locking to server */
999 OBD_FL_CKSUM_CRC32 = 0x00001000, /* CRC32 checksum type */
1000 OBD_FL_CKSUM_ADLER = 0x00002000, /* ADLER checksum type */
1001 OBD_FL_CKSUM_CRC32C = 0x00004000, /* CRC32C checksum type */
1002 OBD_FL_CKSUM_RSVD2 = 0x00008000, /* for future cksum types */
1003 OBD_FL_CKSUM_RSVD3 = 0x00010000, /* for future cksum types */
1004 OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
1005 OBD_FL_MMAP = 0x00040000, /* object is mmapped on the client.
1006 * XXX: obsoleted - reserved for old
1007 * clients prior than 2.2 */
1008 OBD_FL_RECOV_RESEND = 0x00080000, /* recoverable resent */
1009 OBD_FL_NOSPC_BLK = 0x00100000, /* no more block space on OST */
1010 OBD_FL_FLUSH = 0x00200000, /* flush pages on the OST */
1011 OBD_FL_SHORT_IO = 0x00400000, /* short io request */
1012 /* OBD_FL_LOCAL_MASK = 0xF0000000, was local-only flags until 2.10 */
1014 /* Note that while these checksum values are currently separate bits,
1015 * in 2.x we can actually allow all values from 1-31 if we wanted. */
1016 OBD_FL_CKSUM_ALL = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER |
1017 OBD_FL_CKSUM_CRC32C,
1021 * All LOV EA magics should have the same postfix, if some new version
1022 * Lustre instroduces new LOV EA magic, then when down-grade to an old
1023 * Lustre, even though the old version system does not recognizes such
1024 * new magic, it still can distinguish the corrupted cases by checking
1025 * the magic's postfix.
1027 #define LOV_MAGIC_MAGIC 0x0BD0
1028 #define LOV_MAGIC_MASK 0xFFFF
1030 #define LOV_MAGIC_V1 (0x0BD10000 | LOV_MAGIC_MAGIC)
1031 #define LOV_MAGIC_JOIN_V1 (0x0BD20000 | LOV_MAGIC_MAGIC)
1032 #define LOV_MAGIC_V3 (0x0BD30000 | LOV_MAGIC_MAGIC)
1033 #define LOV_MAGIC_MIGRATE (0x0BD40000 | LOV_MAGIC_MAGIC)
1034 /* reserved for specifying OSTs */
1035 #define LOV_MAGIC_SPECIFIC (0x0BD50000 | LOV_MAGIC_MAGIC)
1036 #define LOV_MAGIC LOV_MAGIC_V1
1037 #define LOV_MAGIC_COMP_V1 (0x0BD60000 | LOV_MAGIC_MAGIC)
1040 * magic for fully defined striping
1041 * the idea is that we should have different magics for striping "hints"
1042 * (struct lov_user_md_v[13]) and defined ready-to-use striping (struct
1043 * lov_mds_md_v[13]). at the moment the magics are used in wire protocol,
1044 * we can't just change it w/o long way preparation, but we still need a
1045 * mechanism to allow LOD to differentiate hint versus ready striping.
1046 * so, at the moment we do a trick: MDT knows what to expect from request
1047 * depending on the case (replay uses ready striping, non-replay req uses
1048 * hints), so MDT replaces magic with appropriate one and now LOD can
1049 * easily understand what's inside -bzzz
1051 * those *_DEF magics are only used on server side internally, they
1052 * won't be put on wire or disk.
1054 #define LOV_MAGIC_DEFINED 0x10000000
1055 #define LOV_MAGIC_V1_DEFINED (LOV_MAGIC_DEFINED | LOV_MAGIC_V1)
1056 #define LOV_MAGIC_V3_DEFINED (LOV_MAGIC_DEFINED | LOV_MAGIC_V3)
1057 #define LOV_MAGIC_COMP_V1_DEFINED (LOV_MAGIC_DEFINED | LOV_MAGIC_COMP_V1)
1059 #define lov_pattern(pattern) (pattern & ~LOV_PATTERN_F_MASK)
1060 #define lov_pattern_flags(pattern) (pattern & LOV_PATTERN_F_MASK)
1062 #define lov_ost_data lov_ost_data_v1
1063 struct lov_ost_data_v1 { /* per-stripe data structure (little-endian)*/
1064 struct ost_id l_ost_oi; /* OST object ID */
1065 __u32 l_ost_gen; /* generation of this l_ost_idx */
1066 __u32 l_ost_idx; /* OST index in LOV (lov_tgt_desc->tgts) */
1069 #define lov_mds_md lov_mds_md_v1
1070 struct lov_mds_md_v1 { /* LOV EA mds/wire data (little-endian) */
1071 __u32 lmm_magic; /* magic number = LOV_MAGIC_V1 */
1072 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1073 struct ost_id lmm_oi; /* LOV object ID */
1074 __u32 lmm_stripe_size; /* size of stripe in bytes */
1075 /* lmm_stripe_count used to be __u32 */
1076 __u16 lmm_stripe_count; /* num stripes in use for this object */
1077 __u16 lmm_layout_gen; /* layout generation number */
1078 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1081 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
1082 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
1084 /* This is the default MDT reply size allocated, should the striping be bigger,
1085 * it will be reallocated in mdt_fix_reply.
1086 * 100 stripes is a bit less than 2.5k of data */
1087 #define DEF_REP_MD_SIZE (sizeof(struct lov_mds_md) + \
1088 100 * sizeof(struct lov_ost_data))
1090 #define XATTR_NAME_ACL_ACCESS "system.posix_acl_access"
1091 #define XATTR_NAME_ACL_DEFAULT "system.posix_acl_default"
1092 #define XATTR_USER_PREFIX "user."
1093 #define XATTR_TRUSTED_PREFIX "trusted."
1094 #define XATTR_SECURITY_PREFIX "security."
1096 #define XATTR_NAME_SOM "trusted.som"
1097 #define XATTR_NAME_LOV "trusted.lov"
1098 #define XATTR_NAME_LMA "trusted.lma"
1099 #define XATTR_NAME_LMV "trusted.lmv"
1100 #define XATTR_NAME_DEFAULT_LMV "trusted.dmv"
1101 #define XATTR_NAME_LINK "trusted.link"
1102 #define XATTR_NAME_FID "trusted.fid"
1103 #define XATTR_NAME_VERSION "trusted.version"
1104 #define XATTR_NAME_SOM "trusted.som"
1105 #define XATTR_NAME_HSM "trusted.hsm"
1106 #define XATTR_NAME_LFSCK_BITMAP "trusted.lfsck_bitmap"
1107 #define XATTR_NAME_DUMMY "trusted.dummy"
1109 #define XATTR_NAME_LFSCK_NAMESPACE "trusted.lfsck_ns"
1110 #define XATTR_NAME_MAX_LEN 32 /* increase this, if there is longer name. */
1112 struct lov_mds_md_v3 { /* LOV EA mds/wire data (little-endian) */
1113 __u32 lmm_magic; /* magic number = LOV_MAGIC_V3 */
1114 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1115 struct ost_id lmm_oi; /* LOV object ID */
1116 __u32 lmm_stripe_size; /* size of stripe in bytes */
1117 /* lmm_stripe_count used to be __u32 */
1118 __u16 lmm_stripe_count; /* num stripes in use for this object */
1119 __u16 lmm_layout_gen; /* layout generation number */
1120 char lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* must be 32bit aligned */
1121 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1124 static inline __u32 lov_mds_md_size(__u16 stripes, __u32 lmm_magic)
1126 if (stripes == (__u16)-1)
1129 if (lmm_magic == LOV_MAGIC_V3)
1130 return sizeof(struct lov_mds_md_v3) +
1131 stripes * sizeof(struct lov_ost_data_v1);
1133 return sizeof(struct lov_mds_md_v1) +
1134 stripes * sizeof(struct lov_ost_data_v1);
1138 lov_mds_md_max_stripe_count(size_t buf_size, __u32 lmm_magic)
1140 switch (lmm_magic) {
1141 case LOV_MAGIC_V1: {
1142 struct lov_mds_md_v1 lmm;
1144 if (buf_size < sizeof(lmm))
1147 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1149 case LOV_MAGIC_V3: {
1150 struct lov_mds_md_v3 lmm;
1152 if (buf_size < sizeof(lmm))
1155 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1162 #define OBD_MD_FLID (0x00000001ULL) /* object ID */
1163 #define OBD_MD_FLATIME (0x00000002ULL) /* access time */
1164 #define OBD_MD_FLMTIME (0x00000004ULL) /* data modification time */
1165 #define OBD_MD_FLCTIME (0x00000008ULL) /* change time */
1166 #define OBD_MD_FLSIZE (0x00000010ULL) /* size */
1167 #define OBD_MD_FLBLOCKS (0x00000020ULL) /* allocated blocks count */
1168 #define OBD_MD_FLBLKSZ (0x00000040ULL) /* block size */
1169 #define OBD_MD_FLMODE (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1170 #define OBD_MD_FLTYPE (0x00000100ULL) /* object type (mode & S_IFMT) */
1171 #define OBD_MD_FLUID (0x00000200ULL) /* user ID */
1172 #define OBD_MD_FLGID (0x00000400ULL) /* group ID */
1173 #define OBD_MD_FLFLAGS (0x00000800ULL) /* flags word */
1174 #define OBD_MD_DOM_SIZE (0X00001000ULL) /* Data-on-MDT component size */
1175 #define OBD_MD_FLNLINK (0x00002000ULL) /* link count */
1176 #define OBD_MD_FLGENER (0x00004000ULL) /* generation number */
1177 #define OBD_MD_LAYOUT_VERSION (0x00008000ULL) /* layout version for
1179 #define OBD_MD_FLRDEV (0x00010000ULL) /* device number */
1180 #define OBD_MD_FLEASIZE (0x00020000ULL) /* extended attribute data */
1181 #define OBD_MD_LINKNAME (0x00040000ULL) /* symbolic link target */
1182 #define OBD_MD_FLHANDLE (0x00080000ULL) /* file/lock handle */
1183 #define OBD_MD_FLCKSUM (0x00100000ULL) /* bulk data checksum */
1184 #define OBD_MD_FLQOS (0x00200000ULL) /* quality of service stats */
1185 /* OBD_MD_FLCOOKIE (0x00800000ULL) obsolete in 2.8 */
1186 #define OBD_MD_FLPRJQUOTA (0x00400000ULL) /* over quota flags sent from ost */
1187 #define OBD_MD_FLGROUP (0x01000000ULL) /* group */
1188 #define OBD_MD_FLFID (0x02000000ULL) /* ->ost write inline fid */
1189 #define OBD_MD_FLEPOCH (0x04000000ULL) /* ->ost write with ioepoch */
1190 /* ->mds if epoch opens or closes */
1191 #define OBD_MD_FLGRANT (0x08000000ULL) /* ost preallocation space grant */
1192 #define OBD_MD_FLDIREA (0x10000000ULL) /* dir's extended attribute data */
1193 #define OBD_MD_FLUSRQUOTA (0x20000000ULL) /* over quota flags sent from ost */
1194 #define OBD_MD_FLGRPQUOTA (0x40000000ULL) /* over quota flags sent from ost */
1195 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1197 #define OBD_MD_MDS (0x0000000100000000ULL) /* where an inode lives on */
1198 #define OBD_MD_REINT (0x0000000200000000ULL) /* reintegrate oa */
1199 #define OBD_MD_MEA (0x0000000400000000ULL) /* CMD split EA */
1200 #define OBD_MD_TSTATE (0x0000000800000000ULL) /* transient state field */
1202 #define OBD_MD_FLXATTR (0x0000001000000000ULL) /* xattr */
1203 #define OBD_MD_FLXATTRLS (0x0000002000000000ULL) /* xattr list */
1204 #define OBD_MD_FLXATTRRM (0x0000004000000000ULL) /* xattr remove */
1205 #define OBD_MD_FLACL (0x0000008000000000ULL) /* ACL */
1206 /* OBD_MD_FLRMTPERM (0x0000010000000000ULL) remote perm, obsolete */
1207 #define OBD_MD_FLMDSCAPA (0x0000020000000000ULL) /* MDS capability */
1208 #define OBD_MD_FLOSSCAPA (0x0000040000000000ULL) /* OSS capability */
1209 #define OBD_MD_FLCKSPLIT (0x0000080000000000ULL) /* Check split on server */
1210 #define OBD_MD_FLCROSSREF (0x0000100000000000ULL) /* Cross-ref case */
1211 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1212 * under lock; for xattr
1213 * requests means the
1214 * client holds the lock */
1215 #define OBD_MD_FLOBJCOUNT (0x0000400000000000ULL) /* for multiple destroy */
1217 #define OBD_MD_FLDATAVERSION (0x0010000000000000ULL) /* iversion sum */
1218 #define OBD_MD_CLOSE_INTENT_EXECED (0x0020000000000000ULL) /* close intent
1221 #define OBD_MD_DEFAULT_MEA (0x0040000000000000ULL) /* default MEA */
1222 #define OBD_MD_FLOSTLAYOUT (0x0080000000000000ULL) /* contain ost_layout */
1223 #define OBD_MD_FLPROJID (0x0100000000000000ULL) /* project ID */
1225 #define OBD_MD_FLALLQUOTA (OBD_MD_FLUSRQUOTA | \
1226 OBD_MD_FLGRPQUOTA | \
1229 #define OBD_MD_FLGETATTR (OBD_MD_FLID | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1230 OBD_MD_FLCTIME | OBD_MD_FLSIZE | OBD_MD_FLBLKSZ | \
1231 OBD_MD_FLMODE | OBD_MD_FLTYPE | OBD_MD_FLUID | \
1232 OBD_MD_FLGID | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1233 OBD_MD_FLGENER | OBD_MD_FLRDEV | OBD_MD_FLGROUP | \
1236 #define OBD_MD_FLXATTRALL (OBD_MD_FLXATTR | OBD_MD_FLXATTRLS)
1238 /* don't forget obdo_fid which is way down at the bottom so it can
1239 * come after the definition of llog_cookie */
1243 HSS_CLEARMASK = 0x02,
1244 HSS_ARCHIVE_ID = 0x04,
1247 struct hsm_state_set {
1249 __u32 hss_archive_id;
1251 __u64 hss_clearmask;
1254 /* ost_body.data values for OST_BRW */
1256 #define OBD_BRW_READ 0x01
1257 #define OBD_BRW_WRITE 0x02
1258 #define OBD_BRW_RWMASK (OBD_BRW_READ | OBD_BRW_WRITE)
1259 #define OBD_BRW_NDELAY 0x04 /* Non-delay RPC should be issued for
1260 * this page. Non-delay RPCs have bit
1261 * rq_no_delay set. */
1262 #define OBD_BRW_SYNC 0x08 /* this page is a part of synchronous
1263 * transfer and is not accounted in
1265 #define OBD_BRW_CHECK 0x10
1266 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
1267 #define OBD_BRW_GRANTED 0x40 /* the ost manages this */
1268 #define OBD_BRW_NOCACHE 0x80 /* this page is a part of non-cached IO */
1269 #define OBD_BRW_NOQUOTA 0x100
1270 #define OBD_BRW_SRVLOCK 0x200 /* Client holds no lock over this page */
1271 #define OBD_BRW_ASYNC 0x400 /* Server may delay commit to disk */
1272 #define OBD_BRW_MEMALLOC 0x800 /* Client runs in the "kswapd" context */
1273 #define OBD_BRW_OVER_USRQUOTA 0x1000 /* Running out of user quota */
1274 #define OBD_BRW_OVER_GRPQUOTA 0x2000 /* Running out of group quota */
1275 #define OBD_BRW_SOFT_SYNC 0x4000 /* This flag notifies the server
1276 * that the client is running low on
1277 * space for unstable pages; asking
1278 * it to sync quickly */
1279 #define OBD_BRW_OVER_PRJQUOTA 0x8000 /* Running out of project quota */
1281 #define OBD_BRW_OVER_ALLQUOTA (OBD_BRW_OVER_USRQUOTA | \
1282 OBD_BRW_OVER_GRPQUOTA | \
1283 OBD_BRW_OVER_PRJQUOTA)
1285 #define OBD_BRW_LOCAL1 0x80000000UL /*
1286 * osd-ldiskfs internal,
1287 * page mapped to real block
1290 #define OBD_BRW_LOCALS (OBD_BRW_LOCAL1)
1292 #define OBD_OBJECT_EOF LUSTRE_EOF
1294 #define OST_MIN_PRECREATE 32
1295 #define OST_MAX_PRECREATE 20000
1298 struct ost_id ioo_oid; /* object ID, if multi-obj BRW */
1299 __u32 ioo_max_brw; /* low 16 bits were o_mode before 2.4,
1300 * now (PTLRPC_BULK_OPS_COUNT - 1) in
1301 * high 16 bits in 2.4 and later */
1302 __u32 ioo_bufcnt; /* number of niobufs for this object */
1305 /* NOTE: IOOBJ_MAX_BRW_BITS defines the _offset_ of the max_brw field in
1306 * ioo_max_brw, NOT the maximum number of bits in PTLRPC_BULK_OPS_BITS.
1307 * That said, ioo_max_brw is a 32-bit field so the limit is also 16 bits. */
1308 #define IOOBJ_MAX_BRW_BITS 16
1309 #define ioobj_max_brw_get(ioo) (((ioo)->ioo_max_brw >> IOOBJ_MAX_BRW_BITS) + 1)
1310 #define ioobj_max_brw_set(ioo, num) \
1311 do { (ioo)->ioo_max_brw = ((num) - 1) << IOOBJ_MAX_BRW_BITS; } while (0)
1313 /* multiple of 8 bytes => can array */
1314 struct niobuf_remote {
1320 /* lock value block communicated between the filter and llite */
1322 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1323 * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1324 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1325 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1326 #define OST_LVB_IS_ERR(blocks) \
1327 ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1328 #define OST_LVB_SET_ERR(blocks, rc) \
1329 do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1330 #define OST_LVB_GET_ERR(blocks) (int)(blocks - OST_LVB_ERR_INIT)
1353 * lquota data structures
1356 #ifndef QUOTABLOCK_BITS
1357 # define QUOTABLOCK_BITS LUSTRE_QUOTABLOCK_BITS
1360 #ifndef QUOTABLOCK_SIZE
1361 # define QUOTABLOCK_SIZE LUSTRE_QUOTABLOCK_SIZE
1365 # define toqb lustre_stoqb
1368 /* The lquota_id structure is an union of all the possible identifier types that
1369 * can be used with quota, this includes:
1372 * - a FID which can be used for per-directory quota in the future */
1374 struct lu_fid qid_fid; /* FID for per-directory quota */
1375 __u64 qid_uid; /* user identifier */
1376 __u64 qid_gid; /* group identifier */
1377 __u64 qid_projid; /* project identifier */
1380 /* quotactl management */
1381 struct obd_quotactl {
1383 __u32 qc_type; /* see Q_* flag below */
1386 struct obd_dqinfo qc_dqinfo;
1387 struct obd_dqblk qc_dqblk;
1390 #define Q_COPY(out, in, member) (out)->member = (in)->member
1392 #define QCTL_COPY(out, in) \
1394 Q_COPY(out, in, qc_cmd); \
1395 Q_COPY(out, in, qc_type); \
1396 Q_COPY(out, in, qc_id); \
1397 Q_COPY(out, in, qc_stat); \
1398 Q_COPY(out, in, qc_dqinfo); \
1399 Q_COPY(out, in, qc_dqblk); \
1402 /* Body of quota request used for quota acquire/release RPCs between quota
1403 * master (aka QMT) and slaves (ak QSD). */
1405 struct lu_fid qb_fid; /* FID of global index packing the pool ID
1406 * and type (data or metadata) as well as
1407 * the quota type (user or group). */
1408 union lquota_id qb_id; /* uid or gid or directory FID */
1409 __u32 qb_flags; /* see below */
1411 __u64 qb_count; /* acquire/release count (kbytes/inodes) */
1412 __u64 qb_usage; /* current slave usage (kbytes/inodes) */
1413 __u64 qb_slv_ver; /* slave index file version */
1414 struct lustre_handle qb_lockh; /* per-ID lock handle */
1415 struct lustre_handle qb_glb_lockh; /* global lock handle */
1416 __u64 qb_padding1[4];
1419 /* When the quota_body is used in the reply of quota global intent
1420 * lock (IT_QUOTA_CONN) reply, qb_fid contains slave index file FID. */
1421 #define qb_slv_fid qb_fid
1422 /* qb_usage is the current qunit (in kbytes/inodes) when quota_body is used in
1424 #define qb_qunit qb_usage
1426 #define QUOTA_DQACQ_FL_ACQ 0x1 /* acquire quota */
1427 #define QUOTA_DQACQ_FL_PREACQ 0x2 /* pre-acquire */
1428 #define QUOTA_DQACQ_FL_REL 0x4 /* release quota */
1429 #define QUOTA_DQACQ_FL_REPORT 0x8 /* report usage */
1431 /* Quota types currently supported */
1433 LQUOTA_TYPE_USR = 0x00, /* maps to USRQUOTA */
1434 LQUOTA_TYPE_GRP = 0x01, /* maps to GRPQUOTA */
1435 LQUOTA_TYPE_PRJ = 0x02, /* maps to PRJQUOTA */
1439 /* There are 2 different resource types on which a quota limit can be enforced:
1440 * - inodes on the MDTs
1441 * - blocks on the OSTs */
1443 LQUOTA_RES_MD = 0x01, /* skip 0 to avoid null oid in FID */
1444 LQUOTA_RES_DT = 0x02,
1446 LQUOTA_FIRST_RES = LQUOTA_RES_MD
1448 #define LQUOTA_NR_RES (LQUOTA_LAST_RES - LQUOTA_FIRST_RES + 1)
1451 * Space accounting support
1452 * Format of an accounting record, providing disk usage information for a given
1455 struct lquota_acct_rec { /* 16 bytes */
1456 __u64 bspace; /* current space in use */
1457 __u64 ispace; /* current # inodes in use */
1461 * Global quota index support
1462 * Format of a global record, providing global quota settings for a given quota
1465 struct lquota_glb_rec { /* 32 bytes */
1466 __u64 qbr_hardlimit; /* quota hard limit, in #inodes or kbytes */
1467 __u64 qbr_softlimit; /* quota soft limit, in #inodes or kbytes */
1468 __u64 qbr_time; /* grace time, in seconds */
1469 __u64 qbr_granted; /* how much is granted to slaves, in #inodes or
1474 * Slave index support
1475 * Format of a slave record, recording how much space is granted to a given
1478 struct lquota_slv_rec { /* 8 bytes */
1479 __u64 qsr_granted; /* space granted to the slave for the key=ID,
1480 * in #inodes or kbytes */
1483 /* Data structures associated with the quota locks */
1485 /* Glimpse descriptor used for the index & per-ID quota locks */
1486 struct ldlm_gl_lquota_desc {
1487 union lquota_id gl_id; /* quota ID subject to the glimpse */
1488 __u64 gl_flags; /* see LQUOTA_FL* below */
1489 __u64 gl_ver; /* new index version */
1490 __u64 gl_hardlimit; /* new hardlimit or qunit value */
1491 __u64 gl_softlimit; /* new softlimit */
1495 #define gl_qunit gl_hardlimit /* current qunit value used when
1496 * glimpsing per-ID quota locks */
1498 /* quota glimpse flags */
1499 #define LQUOTA_FL_EDQUOT 0x1 /* user/group out of quota space on QMT */
1501 /* LVB used with quota (global and per-ID) locks */
1503 __u64 lvb_flags; /* see LQUOTA_FL* above */
1504 __u64 lvb_id_may_rel; /* space that might be released later */
1505 __u64 lvb_id_rel; /* space released by the slave for this ID */
1506 __u64 lvb_id_qunit; /* current qunit value */
1510 /* LVB used with global quota lock */
1511 #define lvb_glb_ver lvb_id_may_rel /* current version of the global index */
1519 #define QUOTA_FIRST_OPC QUOTA_DQACQ
1528 MDS_GETATTR_NAME = 34,
1533 MDS_DISCONNECT = 39,
1536 MDS_PIN = 42, /* obsolete, never used in a release */
1537 MDS_UNPIN = 43, /* obsolete, never used in a release */
1539 MDS_DONE_WRITING = 45, /* obsolete since 2.8.0 */
1541 MDS_QUOTACHECK = 47, /* not used since 2.4 */
1544 MDS_SETXATTR = 50, /* obsolete, now it's MDS_REINT op */
1546 MDS_IS_SUBDIR = 52, /* obsolete, never used in a release */
1548 MDS_HSM_STATE_GET = 54,
1549 MDS_HSM_STATE_SET = 55,
1550 MDS_HSM_ACTION = 56,
1551 MDS_HSM_PROGRESS = 57,
1552 MDS_HSM_REQUEST = 58,
1553 MDS_HSM_CT_REGISTER = 59,
1554 MDS_HSM_CT_UNREGISTER = 60,
1555 MDS_SWAP_LAYOUTS = 61,
1559 #define MDS_FIRST_OPC MDS_GETATTR
1562 /* opcodes for object update */
1568 #define OUT_UPDATE_FIRST_OPC OUT_UPDATE
1587 /* the disposition of the intent outlines what was executed */
1588 #define DISP_IT_EXECD 0x00000001
1589 #define DISP_LOOKUP_EXECD 0x00000002
1590 #define DISP_LOOKUP_NEG 0x00000004
1591 #define DISP_LOOKUP_POS 0x00000008
1592 #define DISP_OPEN_CREATE 0x00000010
1593 #define DISP_OPEN_OPEN 0x00000020
1594 #define DISP_ENQ_COMPLETE 0x00400000 /* obsolete and unused */
1595 #define DISP_ENQ_OPEN_REF 0x00800000
1596 #define DISP_ENQ_CREATE_REF 0x01000000
1597 #define DISP_OPEN_LOCK 0x02000000
1598 #define DISP_OPEN_LEASE 0x04000000
1599 #define DISP_OPEN_STRIPE 0x08000000
1600 #define DISP_OPEN_DENY 0x10000000
1602 /* INODE LOCK PARTS */
1603 #define MDS_INODELOCK_LOOKUP 0x000001 /* For namespace, dentry etc, and also
1604 * was used to protect permission (mode,
1605 * owner, group etc) before 2.4. */
1606 #define MDS_INODELOCK_UPDATE 0x000002 /* size, links, timestamps */
1607 #define MDS_INODELOCK_OPEN 0x000004 /* For opened files */
1608 #define MDS_INODELOCK_LAYOUT 0x000008 /* for layout */
1610 /* The PERM bit is added int 2.4, and it is used to protect permission(mode,
1611 * owner, group, acl etc), so to separate the permission from LOOKUP lock.
1612 * Because for remote directories(in DNE), these locks will be granted by
1613 * different MDTs(different ldlm namespace).
1615 * For local directory, MDT will always grant UPDATE_LOCK|PERM_LOCK together.
1616 * For Remote directory, the master MDT, where the remote directory is, will
1617 * grant UPDATE_LOCK|PERM_LOCK, and the remote MDT, where the name entry is,
1618 * will grant LOOKUP_LOCK. */
1619 #define MDS_INODELOCK_PERM 0x000010
1620 #define MDS_INODELOCK_XATTR 0x000020 /* extended attributes */
1621 #define MDS_INODELOCK_DOM 0x000040 /* Data for data-on-mdt files */
1623 #define MDS_INODELOCK_MAXSHIFT 6
1624 /* This FULL lock is useful to take on unlink sort of operations */
1625 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
1626 /* DOM lock shouldn't be canceled early, use this macro for ELC */
1627 #define MDS_INODELOCK_ELC (MDS_INODELOCK_FULL & ~MDS_INODELOCK_DOM)
1629 /* NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
1630 * but was moved into name[1] along with the OID to avoid consuming the
1631 * name[2,3] fields that need to be used for the quota id (also a FID). */
1633 LUSTRE_RES_ID_SEQ_OFF = 0,
1634 LUSTRE_RES_ID_VER_OID_OFF = 1,
1635 LUSTRE_RES_ID_WAS_VER_OFF = 2, /* see note above */
1636 LUSTRE_RES_ID_QUOTA_SEQ_OFF = 2,
1637 LUSTRE_RES_ID_QUOTA_VER_OID_OFF = 3,
1638 LUSTRE_RES_ID_HSH_OFF = 3
1641 #define MDS_STATUS_CONN 1
1642 #define MDS_STATUS_LOV 2
1645 /* these should be identical to their EXT4_*_FL counterparts, they are
1646 * redefined here only to avoid dragging in fs/ext4/ext4.h */
1647 LUSTRE_SYNC_FL = 0x00000008, /* Synchronous updates */
1648 LUSTRE_IMMUTABLE_FL = 0x00000010, /* Immutable file */
1649 LUSTRE_APPEND_FL = 0x00000020, /* writes to file may only append */
1650 LUSTRE_NODUMP_FL = 0x00000040, /* do not dump file */
1651 LUSTRE_NOATIME_FL = 0x00000080, /* do not update atime */
1652 LUSTRE_INDEX_FL = 0x00001000, /* hash-indexed directory */
1653 LUSTRE_DIRSYNC_FL = 0x00010000, /* dirsync behaviour (dir only) */
1654 LUSTRE_TOPDIR_FL = 0x00020000, /* Top of directory hierarchies*/
1655 LUSTRE_DIRECTIO_FL = 0x00100000, /* Use direct i/o */
1656 LUSTRE_INLINE_DATA_FL = 0x10000000, /* Inode has inline data. */
1657 LUSTRE_PROJINHERIT_FL = 0x20000000, /* Create with parents projid */
1659 /* These flags will not be identical to any EXT4_*_FL counterparts,
1660 * and only reserved for lustre purpose. Note: these flags might
1661 * be conflict with some of EXT4 flags, so
1662 * 1. these conflict flags needs to be removed when the flag is
1663 * wired by la_flags see osd_attr_get().
1664 * 2. If these flags needs to be stored into inode, they will be
1665 * stored in LMA. see LMAI_XXXX */
1666 LUSTRE_ORPHAN_FL = 0x00002000,
1668 LUSTRE_LMA_FL_MASKS = LUSTRE_ORPHAN_FL,
1671 #ifndef FS_XFLAG_PROJINHERIT
1672 #define FS_XFLAG_PROJINHERIT 0x00000200 /* create with parents projid */
1676 /* Convert wire LUSTRE_*_FL to corresponding client local VFS S_* values
1677 * for the client inode i_flags. The LUSTRE_*_FL are the Lustre wire
1678 * protocol equivalents of LDISKFS_*_FL values stored on disk, while
1679 * the S_* flags are kernel-internal values that change between kernel
1680 * versions. These flags are set/cleared via FSFILT_IOC_{GET,SET}_FLAGS.
1681 * See b=16526 for a full history. */
1682 static inline int ll_ext_to_inode_flags(int flags)
1684 return (((flags & LUSTRE_SYNC_FL) ? S_SYNC : 0) |
1685 ((flags & LUSTRE_NOATIME_FL) ? S_NOATIME : 0) |
1686 ((flags & LUSTRE_APPEND_FL) ? S_APPEND : 0) |
1687 #if defined(S_DIRSYNC)
1688 ((flags & LUSTRE_DIRSYNC_FL) ? S_DIRSYNC : 0) |
1690 ((flags & LUSTRE_IMMUTABLE_FL) ? S_IMMUTABLE : 0) |
1691 ((flags & LUSTRE_PROJINHERIT_FL) ? FS_XFLAG_PROJINHERIT : 0));
1694 static inline int ll_inode_to_ext_flags(int iflags)
1696 return (((iflags & S_SYNC) ? LUSTRE_SYNC_FL : 0) |
1697 ((iflags & S_NOATIME) ? LUSTRE_NOATIME_FL : 0) |
1698 ((iflags & S_APPEND) ? LUSTRE_APPEND_FL : 0) |
1699 #if defined(S_DIRSYNC)
1700 ((iflags & S_DIRSYNC) ? LUSTRE_DIRSYNC_FL : 0) |
1702 ((iflags & S_IMMUTABLE) ? LUSTRE_IMMUTABLE_FL : 0) |
1703 ((iflags & FS_XFLAG_PROJINHERIT) ? LUSTRE_PROJINHERIT_FL : 0));
1707 /* 64 possible states */
1708 enum md_transient_state {
1709 MS_RESTORE = (1 << 0), /* restore is running */
1713 struct lu_fid mbo_fid1;
1714 struct lu_fid mbo_fid2;
1715 struct lustre_handle mbo_handle;
1717 __u64 mbo_size; /* Offset, in the case of MDS_READPAGE */
1721 __u64 mbo_blocks; /* XID, in the case of MDS_READPAGE */
1723 __u64 mbo_t_state; /* transient file state defined in
1724 * enum md_transient_state
1725 * was "ino" until 2.4.0 */
1728 __u32 mbo_capability;
1732 __u32 mbo_flags; /* LUSTRE_*_FL file attributes */
1734 __u32 mbo_nlink; /* #bytes to read in the case of MDS_READPAGE */
1735 __u32 mbo_unused2; /* was "generation" until 2.4.0 */
1737 __u32 mbo_eadatasize;
1739 __u32 mbo_max_mdsize;
1740 __u32 mbo_unused3; /* was max_cookiesize until 2.8 */
1741 __u32 mbo_uid_h; /* high 32-bits of uid, for FUID */
1742 __u32 mbo_gid_h; /* high 32-bits of gid, for FUID */
1744 __u64 mbo_dom_size; /* size of DOM component */
1745 __u64 mbo_dom_blocks; /* blocks consumed by DOM component */
1746 __u64 mbo_padding_8; /* also fix lustre_swab_mdt_body */
1747 __u64 mbo_padding_9;
1748 __u64 mbo_padding_10;
1751 struct mdt_ioepoch {
1752 struct lustre_handle mio_handle;
1753 __u64 mio_unused1; /* was ioepoch */
1754 __u32 mio_unused2; /* was flags */
1758 /* permissions for md_perm.mp_perm */
1760 CFS_SETUID_PERM = 0x01,
1761 CFS_SETGID_PERM = 0x02,
1762 CFS_SETGRP_PERM = 0x04,
1765 struct mdt_rec_setattr {
1775 __u32 sa_padding_1_h;
1776 struct lu_fid sa_fid;
1785 __u32 sa_attr_flags;
1787 __u32 sa_bias; /* some operation flags */
1794 * Attribute flags used in mdt_rec_setattr::sa_valid.
1795 * The kernel's #defines for ATTR_* should not be used over the network
1796 * since the client and MDS may run different kernels (see bug 13828)
1797 * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1799 #define MDS_ATTR_MODE 0x1ULL /* = 1 */
1800 #define MDS_ATTR_UID 0x2ULL /* = 2 */
1801 #define MDS_ATTR_GID 0x4ULL /* = 4 */
1802 #define MDS_ATTR_SIZE 0x8ULL /* = 8 */
1803 #define MDS_ATTR_ATIME 0x10ULL /* = 16 */
1804 #define MDS_ATTR_MTIME 0x20ULL /* = 32 */
1805 #define MDS_ATTR_CTIME 0x40ULL /* = 64 */
1806 #define MDS_ATTR_ATIME_SET 0x80ULL /* = 128 */
1807 #define MDS_ATTR_MTIME_SET 0x100ULL /* = 256 */
1808 #define MDS_ATTR_FORCE 0x200ULL /* = 512, Not a change, but a change it */
1809 #define MDS_ATTR_ATTR_FLAG 0x400ULL /* = 1024 */
1810 #define MDS_ATTR_KILL_SUID 0x800ULL /* = 2048 */
1811 #define MDS_ATTR_KILL_SGID 0x1000ULL /* = 4096 */
1812 #define MDS_ATTR_CTIME_SET 0x2000ULL /* = 8192 */
1813 #define MDS_ATTR_FROM_OPEN 0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
1814 #define MDS_ATTR_BLOCKS 0x8000ULL /* = 32768 */
1815 #define MDS_ATTR_PROJID 0x10000ULL /* = 65536 */
1818 #define FMODE_READ 00000001
1819 #define FMODE_WRITE 00000002
1822 #define MDS_FMODE_CLOSED 00000000
1823 #define MDS_FMODE_EXEC 00000004
1824 /* MDS_FMODE_EPOCH 01000000 obsolete since 2.8.0 */
1825 /* MDS_FMODE_TRUNC 02000000 obsolete since 2.8.0 */
1826 /* MDS_FMODE_SOM 04000000 obsolete since 2.8.0 */
1828 #define MDS_OPEN_CREATED 00000010
1829 #define MDS_OPEN_CROSS 00000020
1831 #define MDS_OPEN_CREAT 00000100
1832 #define MDS_OPEN_EXCL 00000200
1833 #define MDS_OPEN_TRUNC 00001000
1834 #define MDS_OPEN_APPEND 00002000
1835 #define MDS_OPEN_SYNC 00010000
1836 #define MDS_OPEN_DIRECTORY 00200000
1838 #define MDS_OPEN_BY_FID 040000000 /* open_by_fid for known object */
1839 #define MDS_OPEN_DELAY_CREATE 0100000000 /* delay initial object create */
1840 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1841 #define MDS_OPEN_JOIN_FILE 0400000000 /* open for join file.
1842 * We do not support JOIN FILE
1843 * anymore, reserve this flags
1844 * just for preventing such bit
1847 #define MDS_OPEN_LOCK 04000000000 /* This open requires open lock */
1848 #define MDS_OPEN_HAS_EA 010000000000 /* specify object create pattern */
1849 #define MDS_OPEN_HAS_OBJS 020000000000 /* Just set the EA the obj exist */
1850 #define MDS_OPEN_NORESTORE 0100000000000ULL /* Do not restore file at open */
1851 #define MDS_OPEN_NEWSTRIPE 0200000000000ULL /* New stripe needed (restripe or
1853 #define MDS_OPEN_VOLATILE 0400000000000ULL /* File is volatile = created
1855 #define MDS_OPEN_LEASE 01000000000000ULL /* Open the file and grant lease
1856 * delegation, succeed if it's not
1857 * being opened with conflict mode.
1859 #define MDS_OPEN_RELEASE 02000000000000ULL /* Open the file for HSM release */
1861 /* lustre internal open flags, which should not be set from user space */
1862 #define MDS_OPEN_FL_INTERNAL (MDS_OPEN_HAS_EA | MDS_OPEN_HAS_OBJS | \
1863 MDS_OPEN_OWNEROVERRIDE | MDS_OPEN_LOCK | \
1864 MDS_OPEN_BY_FID | MDS_OPEN_LEASE | \
1868 MDS_CHECK_SPLIT = 1 << 0,
1869 MDS_CROSS_REF = 1 << 1,
1870 MDS_VTX_BYPASS = 1 << 2,
1871 MDS_PERM_BYPASS = 1 << 3,
1872 /* MDS_SOM = 1 << 4, obsolete since 2.8.0 */
1873 MDS_QUOTA_IGNORE = 1 << 5,
1874 /* Was MDS_CLOSE_CLEANUP (1 << 6), No more used */
1875 MDS_KEEP_ORPHAN = 1 << 7,
1876 MDS_RECOV_OPEN = 1 << 8,
1877 MDS_DATA_MODIFIED = 1 << 9,
1878 MDS_CREATE_VOLATILE = 1 << 10,
1879 MDS_OWNEROVERRIDE = 1 << 11,
1880 MDS_HSM_RELEASE = 1 << 12,
1881 MDS_RENAME_MIGRATE = 1 << 13,
1882 MDS_CLOSE_LAYOUT_SWAP = 1 << 14,
1883 MDS_CLOSE_LAYOUT_MERGE = 1 << 15,
1886 #define MDS_CLOSE_INTENT (MDS_HSM_RELEASE | MDS_CLOSE_LAYOUT_SWAP | \
1887 MDS_CLOSE_LAYOUT_MERGE)
1889 /* instance of mdt_reint_rec */
1890 struct mdt_rec_create {
1898 __u32 cr_suppgid1_h;
1900 __u32 cr_suppgid2_h;
1901 struct lu_fid cr_fid1;
1902 struct lu_fid cr_fid2;
1903 struct lustre_handle cr_old_handle; /* handle in case of open replay */
1907 __u64 cr_padding_1; /* rr_blocks */
1910 /* use of helpers set/get_mrc_cr_flags() is needed to access
1911 * 64 bits cr_flags [cr_flags_l, cr_flags_h], this is done to
1912 * extend cr_flags size without breaking 1.8 compat */
1913 __u32 cr_flags_l; /* for use with open, low 32 bits */
1914 __u32 cr_flags_h; /* for use with open, high 32 bits */
1915 __u32 cr_umask; /* umask for create */
1916 __u32 cr_padding_4; /* rr_padding_4 */
1919 /* instance of mdt_reint_rec */
1920 struct mdt_rec_link {
1928 __u32 lk_suppgid1_h;
1930 __u32 lk_suppgid2_h;
1931 struct lu_fid lk_fid1;
1932 struct lu_fid lk_fid2;
1934 __u64 lk_padding_1; /* rr_atime */
1935 __u64 lk_padding_2; /* rr_ctime */
1936 __u64 lk_padding_3; /* rr_size */
1937 __u64 lk_padding_4; /* rr_blocks */
1939 __u32 lk_padding_5; /* rr_mode */
1940 __u32 lk_padding_6; /* rr_flags */
1941 __u32 lk_padding_7; /* rr_padding_2 */
1942 __u32 lk_padding_8; /* rr_padding_3 */
1943 __u32 lk_padding_9; /* rr_padding_4 */
1946 /* instance of mdt_reint_rec */
1947 struct mdt_rec_unlink {
1955 __u32 ul_suppgid1_h;
1957 __u32 ul_suppgid2_h;
1958 struct lu_fid ul_fid1;
1959 struct lu_fid ul_fid2;
1961 __u64 ul_padding_2; /* rr_atime */
1962 __u64 ul_padding_3; /* rr_ctime */
1963 __u64 ul_padding_4; /* rr_size */
1964 __u64 ul_padding_5; /* rr_blocks */
1967 __u32 ul_padding_6; /* rr_flags */
1968 __u32 ul_padding_7; /* rr_padding_2 */
1969 __u32 ul_padding_8; /* rr_padding_3 */
1970 __u32 ul_padding_9; /* rr_padding_4 */
1973 /* instance of mdt_reint_rec */
1974 struct mdt_rec_rename {
1982 __u32 rn_suppgid1_h;
1984 __u32 rn_suppgid2_h;
1985 struct lu_fid rn_fid1;
1986 struct lu_fid rn_fid2;
1988 __u64 rn_padding_1; /* rr_atime */
1989 __u64 rn_padding_2; /* rr_ctime */
1990 __u64 rn_padding_3; /* rr_size */
1991 __u64 rn_padding_4; /* rr_blocks */
1992 __u32 rn_bias; /* some operation flags */
1993 __u32 rn_mode; /* cross-ref rename has mode */
1994 __u32 rn_padding_5; /* rr_flags */
1995 __u32 rn_padding_6; /* rr_padding_2 */
1996 __u32 rn_padding_7; /* rr_padding_3 */
1997 __u32 rn_padding_8; /* rr_padding_4 */
2000 /* instance of mdt_reint_rec */
2001 struct mdt_rec_setxattr {
2009 __u32 sx_suppgid1_h;
2011 __u32 sx_suppgid2_h;
2012 struct lu_fid sx_fid;
2013 __u64 sx_padding_1; /* These three are rr_fid2 */
2018 __u64 sx_padding_5; /* rr_ctime */
2019 __u64 sx_padding_6; /* rr_size */
2020 __u64 sx_padding_7; /* rr_blocks */
2023 __u32 sx_padding_8; /* rr_flags */
2024 __u32 sx_padding_9; /* rr_padding_2 */
2025 __u32 sx_padding_10; /* rr_padding_3 */
2026 __u32 sx_padding_11; /* rr_padding_4 */
2030 * mdt_rec_reint is the template for all mdt_reint_xxx structures.
2031 * Do NOT change the size of various members, otherwise the value
2032 * will be broken in lustre_swab_mdt_rec_reint().
2034 * If you add new members in other mdt_reint_xxx structres and need to use the
2035 * rr_padding_x fields, then update lustre_swab_mdt_rec_reint() also.
2037 struct mdt_rec_reint {
2045 __u32 rr_suppgid1_h;
2047 __u32 rr_suppgid2_h;
2048 struct lu_fid rr_fid1;
2049 struct lu_fid rr_fid2;
2060 __u32 rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
2063 /* lmv structures */
2065 __u32 ld_tgt_count; /* how many MDS's */
2066 __u32 ld_active_tgt_count; /* how many active */
2067 __u32 ld_default_stripe_count; /* how many objects are used */
2068 __u32 ld_pattern; /* default hash pattern */
2069 __u64 ld_default_hash_size;
2070 __u64 ld_padding_1; /* also fix lustre_swab_lmv_desc */
2071 __u32 ld_padding_2; /* also fix lustre_swab_lmv_desc */
2072 __u32 ld_qos_maxage; /* in second */
2073 __u32 ld_padding_3; /* also fix lustre_swab_lmv_desc */
2074 __u32 ld_padding_4; /* also fix lustre_swab_lmv_desc */
2075 struct obd_uuid ld_uuid;
2078 /* LMV layout EA, and it will be stored both in master and slave object */
2079 struct lmv_mds_md_v1 {
2081 __u32 lmv_stripe_count;
2082 __u32 lmv_master_mdt_index; /* On master object, it is master
2083 * MDT index, on slave object, it
2084 * is stripe index of the slave obj */
2085 __u32 lmv_hash_type; /* dir stripe policy, i.e. indicate
2086 * which hash function to be used,
2087 * Note: only lower 16 bits is being
2088 * used for now. Higher 16 bits will
2089 * be used to mark the object status,
2090 * for example migrating or dead. */
2091 __u32 lmv_layout_version; /* Used for directory restriping */
2095 char lmv_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
2096 struct lu_fid lmv_stripe_fids[0]; /* FIDs for each stripe */
2099 #define LMV_MAGIC_V1 0x0CD20CD0 /* normal stripe lmv magic */
2100 #define LMV_MAGIC LMV_MAGIC_V1
2102 /* #define LMV_USER_MAGIC 0x0CD30CD0 */
2103 #define LMV_MAGIC_STRIPE 0x0CD40CD0 /* magic for dir sub_stripe */
2105 /* Right now only the lower part(0-16bits) of lmv_hash_type is being used,
2106 * and the higher part will be the flag to indicate the status of object,
2107 * for example the object is being migrated. And the hash function
2108 * might be interpreted differently with different flags. */
2109 #define LMV_HASH_TYPE_MASK 0x0000ffff
2111 #define LMV_HASH_FLAG_MIGRATION 0x80000000
2113 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 11, 56, 0)
2114 /* Since lustre 2.8, this flag will not be needed, instead this DEAD
2115 * and orphan flags will be stored in LMA (see LMAI_ORPHAN)
2116 * Keep this flag just for LFSCK, because it still might meet such
2117 * flag when it checks the old FS */
2118 #define LMV_HASH_FLAG_DEAD 0x40000000
2120 #define LMV_HASH_FLAG_BAD_TYPE 0x20000000
2122 /* The striped directory has ever lost its master LMV EA, then LFSCK
2123 * re-generated it. This flag is used to indicate such case. It is an
2125 #define LMV_HASH_FLAG_LOST_LMV 0x10000000
2128 * The FNV-1a hash algorithm is as follows:
2129 * hash = FNV_offset_basis
2130 * for each octet_of_data to be hashed
2131 * hash = hash XOR octet_of_data
2132 * hash = hash × FNV_prime
2134 * http://en.wikipedia.org/wiki/Fowler–Noll–Vo_hash_function#FNV-1a_hash
2136 * http://www.isthe.com/chongo/tech/comp/fnv/index.html#FNV-reference-source
2137 * FNV_prime is 2^40 + 2^8 + 0xb3 = 0x100000001b3ULL
2139 #define LUSTRE_FNV_1A_64_PRIME 0x100000001b3ULL
2140 #define LUSTRE_FNV_1A_64_OFFSET_BIAS 0xcbf29ce484222325ULL
2141 static inline __u64 lustre_hash_fnv_1a_64(const void *buf, size_t size)
2143 __u64 hash = LUSTRE_FNV_1A_64_OFFSET_BIAS;
2144 const unsigned char *p = buf;
2147 for (i = 0; i < size; i++) {
2149 hash *= LUSTRE_FNV_1A_64_PRIME;
2157 struct lmv_mds_md_v1 lmv_md_v1;
2158 struct lmv_user_md lmv_user_md;
2161 static inline int lmv_mds_md_size(int stripe_count, unsigned int lmm_magic)
2163 switch (lmm_magic) {
2165 struct lmv_mds_md_v1 *lmm1;
2167 return sizeof(*lmm1) + stripe_count *
2168 sizeof(lmm1->lmv_stripe_fids[0]);
2175 static inline int lmv_mds_md_stripe_count_get(const union lmv_mds_md *lmm)
2177 switch (__le32_to_cpu(lmm->lmv_magic)) {
2179 return __le32_to_cpu(lmm->lmv_md_v1.lmv_stripe_count);
2180 case LMV_USER_MAGIC:
2181 return __le32_to_cpu(lmm->lmv_user_md.lum_stripe_count);
2187 static inline int lmv_mds_md_hash_type_get(const union lmv_mds_md *lmm)
2189 switch (__le32_to_cpu(lmm->lmv_magic)) {
2191 return __le32_to_cpu(lmm->lmv_md_v1.lmv_hash_type);
2192 case LMV_USER_MAGIC:
2193 return __le32_to_cpu(lmm->lmv_user_md.lum_hash_type);
2203 FLD_FIRST_OPC = FLD_QUERY
2209 SEQ_FIRST_OPC = SEQ_QUERY
2213 SEQ_ALLOC_SUPER = 0,
2225 LFSCK_NOTIFY = 1101,
2228 LFSCK_FIRST_OPC = LFSCK_NOTIFY
2232 * LOV data structures
2235 #define LOV_MAX_UUID_BUFFER_SIZE 8192
2236 /* The size of the buffer the lov/mdc reserves for the
2237 * array of UUIDs returned by the MDS. With the current
2238 * protocol, this will limit the max number of OSTs per LOV */
2240 #define LOV_DESC_MAGIC 0xB0CCDE5C
2241 #define LOV_DESC_QOS_MAXAGE_DEFAULT 5 /* Seconds */
2242 #define LOV_DESC_STRIPE_SIZE_DEFAULT (1 << LNET_MTU_BITS)
2244 /* LOV settings descriptor (should only contain static info) */
2246 __u32 ld_tgt_count; /* how many OBD's */
2247 __u32 ld_active_tgt_count; /* how many active */
2248 __s32 ld_default_stripe_count; /* how many objects are used */
2249 __u32 ld_pattern; /* default PATTERN_RAID0 */
2250 __u64 ld_default_stripe_size; /* in bytes */
2251 __s64 ld_default_stripe_offset; /* starting OST index */
2252 __u32 ld_padding_0; /* unused */
2253 __u32 ld_qos_maxage; /* in second */
2254 __u32 ld_padding_1; /* also fix lustre_swab_lov_desc */
2255 __u32 ld_padding_2; /* also fix lustre_swab_lov_desc */
2256 struct obd_uuid ld_uuid;
2259 #define ld_magic ld_active_tgt_count /* for swabbing from llogs */
2264 /* opcodes -- MUST be distinct from OST/MDS opcodes */
2269 LDLM_BL_CALLBACK = 104,
2270 LDLM_CP_CALLBACK = 105,
2271 LDLM_GL_CALLBACK = 106,
2272 LDLM_SET_INFO = 107,
2275 #define LDLM_FIRST_OPC LDLM_ENQUEUE
2277 #define RES_NAME_SIZE 4
2278 struct ldlm_res_id {
2279 __u64 name[RES_NAME_SIZE];
2282 #define DLDLMRES "[%#llx:%#llx:%#llx].%#llx"
2283 #define PLDLMRES(res) (unsigned long long)(res)->lr_name.name[0], \
2284 (unsigned long long)(res)->lr_name.name[1], \
2285 (unsigned long long)(res)->lr_name.name[2], \
2286 (unsigned long long)(res)->lr_name.name[3]
2289 typedef enum ldlm_mode {
2302 #define LCK_MODE_NUM 8
2304 typedef enum ldlm_type {
2312 #define LDLM_MIN_TYPE LDLM_PLAIN
2314 struct ldlm_extent {
2320 static inline bool ldlm_extent_equal(const struct ldlm_extent *ex1,
2321 const struct ldlm_extent *ex2)
2323 return ex1->start == ex2->start && ex1->end == ex2->end;
2326 struct ldlm_inodebits {
2328 __u64 try_bits; /* optional bits to try */
2331 struct ldlm_flock_wire {
2339 /* it's important that the fields of the ldlm_extent structure match
2340 * the first fields of the ldlm_flock structure because there is only
2341 * one ldlm_swab routine to process the ldlm_policy_data_t union. if
2342 * this ever changes we will need to swab the union differently based
2343 * on the resource type. */
2345 typedef union ldlm_wire_policy_data {
2346 struct ldlm_extent l_extent;
2347 struct ldlm_flock_wire l_flock;
2348 struct ldlm_inodebits l_inodebits;
2349 } ldlm_wire_policy_data_t;
2351 struct barrier_lvb {
2357 struct ldlm_gl_barrier_desc {
2363 union ldlm_gl_desc {
2364 struct ldlm_gl_lquota_desc lquota_desc;
2365 struct ldlm_gl_barrier_desc barrier_desc;
2368 enum ldlm_intent_flags {
2369 IT_OPEN = 0x00000001,
2370 IT_CREAT = 0x00000002,
2371 IT_OPEN_CREAT = 0x00000003,
2372 IT_READDIR = 0x00000004,
2373 IT_GETATTR = 0x00000008,
2374 IT_LOOKUP = 0x00000010,
2375 IT_UNLINK = 0x00000020,
2376 IT_TRUNC = 0x00000040,
2377 IT_GETXATTR = 0x00000080,
2378 IT_EXEC = 0x00000100,
2379 IT_PIN = 0x00000200,
2380 IT_LAYOUT = 0x00000400,
2381 IT_QUOTA_DQACQ = 0x00000800,
2382 IT_QUOTA_CONN = 0x00001000,
2383 IT_SETXATTR = 0x00002000,
2384 IT_GLIMPSE = 0x00004000,
2385 IT_BRW = 0x00008000,
2388 struct ldlm_intent {
2392 struct ldlm_resource_desc {
2393 enum ldlm_type lr_type;
2394 __u32 lr_pad; /* also fix lustre_swab_ldlm_resource_desc */
2395 struct ldlm_res_id lr_name;
2398 struct ldlm_lock_desc {
2399 struct ldlm_resource_desc l_resource;
2400 enum ldlm_mode l_req_mode;
2401 enum ldlm_mode l_granted_mode;
2402 union ldlm_wire_policy_data l_policy_data;
2405 #define LDLM_LOCKREQ_HANDLES 2
2406 #define LDLM_ENQUEUE_CANCEL_OFF 1
2408 struct ldlm_request {
2411 struct ldlm_lock_desc lock_desc;
2412 struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
2417 __u32 lock_padding; /* also fix lustre_swab_ldlm_reply */
2418 struct ldlm_lock_desc lock_desc;
2419 struct lustre_handle lock_handle;
2420 __u64 lock_policy_res1;
2421 __u64 lock_policy_res2;
2424 #define ldlm_flags_to_wire(flags) ((__u32)(flags))
2425 #define ldlm_flags_from_wire(flags) ((__u64)(flags))
2428 * Opcodes for mountconf (mgs and mgc)
2433 MGS_EXCEPTION, /* node died, etc. */
2434 MGS_TARGET_REG, /* whenever target starts up */
2440 #define MGS_FIRST_OPC MGS_CONNECT
2442 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 13, 53, 0)
2443 #define MGS_PARAM_MAXLEN 1024
2444 #define KEY_SET_INFO "set_info"
2446 struct mgs_send_param {
2447 char mgs_param[MGS_PARAM_MAXLEN];
2451 /* We pass this info to the MGS so it can write config logs */
2452 #define MTI_NAME_MAXLEN 64
2453 #define MTI_PARAM_MAXLEN 4096
2454 #define MTI_NIDS_MAX 32
2455 struct mgs_target_info {
2456 __u32 mti_lustre_ver;
2457 __u32 mti_stripe_index;
2458 __u32 mti_config_ver;
2460 __u32 mti_nid_count;
2461 __u32 mti_instance; /* Running instance of target */
2462 char mti_fsname[MTI_NAME_MAXLEN];
2463 char mti_svname[MTI_NAME_MAXLEN];
2464 char mti_uuid[sizeof(struct obd_uuid)];
2465 __u64 mti_nids[MTI_NIDS_MAX]; /* host nids (lnet_nid_t)*/
2466 char mti_params[MTI_PARAM_MAXLEN];
2469 struct mgs_nidtbl_entry {
2470 __u64 mne_version; /* table version of this entry */
2471 __u32 mne_instance; /* target instance # */
2472 __u32 mne_index; /* target index */
2473 __u32 mne_length; /* length of this entry - by bytes */
2474 __u8 mne_type; /* target type LDD_F_SV_TYPE_OST/MDT */
2475 __u8 mne_nid_type; /* type of nid(mbz). for ipv6. */
2476 __u8 mne_nid_size; /* size of each NID, by bytes */
2477 __u8 mne_nid_count; /* # of NIDs in buffer */
2479 lnet_nid_t nids[0]; /* variable size buffer for NIDs. */
2484 CONFIG_T_CONFIG = 0,
2485 CONFIG_T_SPTLRPC = 1,
2486 CONFIG_T_RECOVER = 2,
2487 CONFIG_T_PARAMS = 3,
2488 CONFIG_T_NODEMAP = 4,
2489 CONFIG_T_BARRIER = 5,
2493 struct mgs_config_body {
2494 char mcb_name[MTI_NAME_MAXLEN]; /* logname */
2495 __u64 mcb_offset; /* next index of config log to request */
2496 __u16 mcb_type; /* type of log: CONFIG_T_[CONFIG|RECOVER] */
2497 __u8 mcb_nm_cur_pass;
2498 __u8 mcb_bits; /* bits unit size of config log */
2499 __u32 mcb_units; /* # of units for bulk transfer */
2502 struct mgs_config_res {
2503 __u64 mcr_offset; /* index of last config log */
2505 __u64 mcr_size; /* size of the log */
2506 __u64 mcr_nm_cur_pass; /* current nodemap config pass */
2510 /* Config marker flags (in config log) */
2511 #define CM_START 0x01
2513 #define CM_SKIP 0x04
2514 #define CM_UPGRADE146 0x08
2515 #define CM_EXCLUDE 0x10
2516 #define CM_START_SKIP (CM_START | CM_SKIP)
2519 __u32 cm_step; /* aka config version */
2521 __u32 cm_vers; /* lustre release version number */
2522 __u32 cm_padding; /* 64 bit align */
2523 __s64 cm_createtime; /*when this record was first created */
2524 __s64 cm_canceltime; /*when this record is no longer valid*/
2525 char cm_tgtname[MTI_NAME_MAXLEN];
2526 char cm_comment[MTI_NAME_MAXLEN];
2530 * Opcodes for multiple servers.
2536 OBD_QC_CALLBACK, /* not used since 2.4 */
2540 #define OBD_FIRST_OPC OBD_PING
2543 * llog contexts indices.
2545 * There is compatibility problem with indexes below, they are not
2546 * continuous and must keep their numbers for compatibility needs.
2547 * See LU-5218 for details.
2550 LLOG_CONFIG_ORIG_CTXT = 0,
2551 LLOG_CONFIG_REPL_CTXT = 1,
2552 LLOG_MDS_OST_ORIG_CTXT = 2,
2553 LLOG_MDS_OST_REPL_CTXT = 3, /* kept just to avoid re-assignment */
2554 LLOG_SIZE_ORIG_CTXT = 4,
2555 LLOG_SIZE_REPL_CTXT = 5,
2556 LLOG_TEST_ORIG_CTXT = 8,
2557 LLOG_TEST_REPL_CTXT = 9, /* kept just to avoid re-assignment */
2558 LLOG_CHANGELOG_ORIG_CTXT = 12, /**< changelog generation on mdd */
2559 LLOG_CHANGELOG_REPL_CTXT = 13, /**< changelog access on clients */
2560 /* for multiple changelog consumers */
2561 LLOG_CHANGELOG_USER_ORIG_CTXT = 14,
2562 LLOG_AGENT_ORIG_CTXT = 15, /**< agent requests generation on cdt */
2563 LLOG_UPDATELOG_ORIG_CTXT = 16, /* update log */
2564 LLOG_UPDATELOG_REPL_CTXT = 17, /* update log */
2568 /** Identifier for a single log object */
2570 struct ost_id lgl_oi;
2572 } __attribute__((packed));
2574 /** Records written to the CATALOGS list */
2575 #define CATLIST "CATALOGS"
2577 struct llog_logid lci_logid;
2581 } __attribute__((packed));
2583 /* Log data record types - there is no specific reason that these need to
2584 * be related to the RPC opcodes, but no reason not to (may be handy later?)
2586 #define LLOG_OP_MAGIC 0x10600000
2587 #define LLOG_OP_MASK 0xfff00000
2590 LLOG_PAD_MAGIC = LLOG_OP_MAGIC | 0x00000,
2591 OST_SZ_REC = LLOG_OP_MAGIC | 0x00f00,
2592 /* OST_RAID1_REC = LLOG_OP_MAGIC | 0x01000, never used */
2593 MDS_UNLINK_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) |
2594 REINT_UNLINK, /* obsolete after 2.5.0 */
2595 MDS_UNLINK64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2597 /* MDS_SETATTR_REC = LLOG_OP_MAGIC | 0x12401, obsolete 1.8.0 */
2598 MDS_SETATTR64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2600 OBD_CFG_REC = LLOG_OP_MAGIC | 0x20000,
2601 /* PTL_CFG_REC = LLOG_OP_MAGIC | 0x30000, obsolete 1.4.0 */
2602 LLOG_GEN_REC = LLOG_OP_MAGIC | 0x40000,
2603 /* LLOG_JOIN_REC = LLOG_OP_MAGIC | 0x50000, obsolete 1.8.0 */
2604 CHANGELOG_REC = LLOG_OP_MAGIC | 0x60000,
2605 CHANGELOG_USER_REC = LLOG_OP_MAGIC | 0x70000,
2606 HSM_AGENT_REC = LLOG_OP_MAGIC | 0x80000,
2607 UPDATE_REC = LLOG_OP_MAGIC | 0xa0000,
2608 LLOG_HDR_MAGIC = LLOG_OP_MAGIC | 0x45539,
2609 LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
2612 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
2613 (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == __swab32(LLOG_OP_MAGIC))
2615 /** Log record header - stored in little endian order.
2616 * Each record must start with this struct, end with a llog_rec_tail,
2617 * and be a multiple of 256 bits in size.
2619 struct llog_rec_hdr {
2626 struct llog_rec_tail {
2631 /* Where data follow just after header */
2632 #define REC_DATA(ptr) \
2633 ((void *)((char *)ptr + sizeof(struct llog_rec_hdr)))
2635 #define REC_DATA_LEN(rec) \
2636 (rec->lrh_len - sizeof(struct llog_rec_hdr) - \
2637 sizeof(struct llog_rec_tail))
2639 struct llog_logid_rec {
2640 struct llog_rec_hdr lid_hdr;
2641 struct llog_logid lid_id;
2645 struct llog_rec_tail lid_tail;
2646 } __attribute__((packed));
2648 struct llog_unlink_rec {
2649 struct llog_rec_hdr lur_hdr;
2653 struct llog_rec_tail lur_tail;
2654 } __attribute__((packed));
2656 struct llog_unlink64_rec {
2657 struct llog_rec_hdr lur_hdr;
2658 struct lu_fid lur_fid;
2659 __u32 lur_count; /* to destroy the lost precreated */
2663 struct llog_rec_tail lur_tail;
2664 } __attribute__((packed));
2666 struct llog_setattr64_rec {
2667 struct llog_rec_hdr lsr_hdr;
2668 struct ost_id lsr_oi;
2674 struct llog_rec_tail lsr_tail;
2675 } __attribute__((packed));
2677 /* Extended to support project quota */
2678 struct llog_setattr64_rec_v2 {
2679 struct llog_rec_hdr lsr_hdr;
2680 struct ost_id lsr_oi;
2687 __u32 lsr_layout_version;
2690 struct llog_rec_tail lsr_tail;
2691 } __attribute__((packed));
2693 struct llog_size_change_rec {
2694 struct llog_rec_hdr lsc_hdr;
2695 struct ll_fid lsc_fid;
2700 struct llog_rec_tail lsc_tail;
2701 } __attribute__((packed));
2703 #define CHANGELOG_MAGIC 0xca103000
2705 /** \a changelog_rec_type's that can't be masked */
2706 #define CHANGELOG_MINMASK (1 << CL_MARK)
2707 /** bits covering all \a changelog_rec_type's */
2708 #define CHANGELOG_ALLMASK 0XFFFFFFFF
2709 /** default \a changelog_rec_type mask. Allow all of them, except
2710 * CL_ATIME since it can really be time consuming, and not necessary
2711 * under normal use. */
2712 #define CHANGELOG_DEFMASK (CHANGELOG_ALLMASK & ~(1 << CL_ATIME))
2714 /* changelog llog name, needed by client replicators */
2715 #define CHANGELOG_CATALOG "changelog_catalog"
2717 struct changelog_setinfo {
2720 } __attribute__((packed));
2722 /** changelog record */
2723 struct llog_changelog_rec {
2724 struct llog_rec_hdr cr_hdr;
2725 struct changelog_rec cr; /**< Variable length field */
2726 struct llog_rec_tail cr_do_not_use; /**< for_sizeof_only */
2727 } __attribute__((packed));
2729 #define CHANGELOG_USER_PREFIX "cl"
2731 struct llog_changelog_user_rec {
2732 struct llog_rec_hdr cur_hdr;
2736 struct llog_rec_tail cur_tail;
2737 } __attribute__((packed));
2739 enum agent_req_status {
2747 static inline const char *agent_req_status2name(enum agent_req_status ars)
2765 struct llog_agent_req_rec {
2766 struct llog_rec_hdr arr_hdr; /**< record header */
2767 __u32 arr_status; /**< status of the request */
2769 * agent_req_status */
2770 __u32 arr_archive_id; /**< backend archive number */
2771 __u64 arr_flags; /**< req flags */
2772 __u64 arr_compound_id; /**< compound cookie */
2773 __u64 arr_req_create; /**< req. creation time */
2774 __u64 arr_req_change; /**< req. status change time */
2775 struct hsm_action_item arr_hai; /**< req. to the agent */
2776 struct llog_rec_tail arr_tail; /**< record tail for_sizezof_only */
2777 } __attribute__((packed));
2779 /* Old llog gen for compatibility */
2783 } __attribute__((packed));
2785 struct llog_gen_rec {
2786 struct llog_rec_hdr lgr_hdr;
2787 struct llog_gen lgr_gen;
2791 struct llog_rec_tail lgr_tail;
2794 /* flags for the logs */
2796 LLOG_F_ZAP_WHEN_EMPTY = 0x1,
2797 LLOG_F_IS_CAT = 0x2,
2798 LLOG_F_IS_PLAIN = 0x4,
2799 LLOG_F_EXT_JOBID = 0x8,
2800 LLOG_F_IS_FIXSIZE = 0x10,
2802 /* Note: Flags covered by LLOG_F_EXT_MASK will be inherited from
2803 * catlog to plain log, so do not add LLOG_F_IS_FIXSIZE here,
2804 * because the catlog record is usually fixed size, but its plain
2805 * log record can be variable */
2806 LLOG_F_EXT_MASK = LLOG_F_EXT_JOBID,
2809 /* On-disk header structure of each log object, stored in little endian order */
2810 #define LLOG_MIN_CHUNK_SIZE 8192
2811 #define LLOG_HEADER_SIZE (96) /* sizeof (llog_log_hdr) + sizeof(llh_tail)
2812 * - sizeof(llh_bitmap) */
2813 #define LLOG_BITMAP_BYTES (LLOG_MIN_CHUNK_SIZE - LLOG_HEADER_SIZE)
2814 #define LLOG_MIN_REC_SIZE (24) /* round(llog_rec_hdr + llog_rec_tail) */
2816 struct llog_log_hdr {
2817 struct llog_rec_hdr llh_hdr;
2818 __s64 llh_timestamp;
2820 __u32 llh_bitmap_offset;
2823 /* for a catalog the first/oldest and still in-use plain slot is just
2824 * next to it. It will serve as the upper limit after Catalog has
2827 struct obd_uuid llh_tgtuuid;
2828 __u32 llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32)-23];
2829 /* These fields must always be at the end of the llog_log_hdr.
2830 * Note: llh_bitmap size is variable because llog chunk size could be
2831 * bigger than LLOG_MIN_CHUNK_SIZE, i.e. sizeof(llog_log_hdr) > 8192
2832 * bytes, and the real size is stored in llh_hdr.lrh_len, which means
2833 * llh_tail should only be refered by LLOG_HDR_TAIL().
2834 * But this structure is also used by client/server llog interface
2835 * (see llog_client.c), it will be kept in its original way to avoid
2836 * compatiblity issue. */
2837 __u32 llh_bitmap[LLOG_BITMAP_BYTES / sizeof(__u32)];
2838 struct llog_rec_tail llh_tail;
2839 } __attribute__((packed));
2840 #undef LLOG_HEADER_SIZE
2841 #undef LLOG_BITMAP_BYTES
2843 #define LLOG_HDR_BITMAP_SIZE(llh) (__u32)((llh->llh_hdr.lrh_len - \
2844 llh->llh_bitmap_offset - \
2845 sizeof(llh->llh_tail)) * 8)
2846 #define LLOG_HDR_BITMAP(llh) (__u32 *)((char *)(llh) + \
2847 (llh)->llh_bitmap_offset)
2848 #define LLOG_HDR_TAIL(llh) ((struct llog_rec_tail *)((char *)llh + \
2849 llh->llh_hdr.lrh_len - \
2850 sizeof(llh->llh_tail)))
2852 /** log cookies are used to reference a specific log file and a record therein */
2853 struct llog_cookie {
2854 struct llog_logid lgc_lgl;
2858 } __attribute__((packed));
2860 /** llog protocol */
2861 enum llogd_rpc_ops {
2862 LLOG_ORIGIN_HANDLE_CREATE = 501,
2863 LLOG_ORIGIN_HANDLE_NEXT_BLOCK = 502,
2864 LLOG_ORIGIN_HANDLE_READ_HEADER = 503,
2865 LLOG_ORIGIN_HANDLE_WRITE_REC = 504,
2866 LLOG_ORIGIN_HANDLE_CLOSE = 505,
2867 LLOG_ORIGIN_CONNECT = 506,
2868 LLOG_CATINFO = 507, /* deprecated */
2869 LLOG_ORIGIN_HANDLE_PREV_BLOCK = 508,
2870 LLOG_ORIGIN_HANDLE_DESTROY = 509, /* for destroy llog object*/
2872 LLOG_FIRST_OPC = LLOG_ORIGIN_HANDLE_CREATE
2876 struct llog_logid lgd_logid;
2878 __u32 lgd_llh_flags;
2880 __u32 lgd_saved_index;
2882 __u64 lgd_cur_offset;
2883 } __attribute__((packed));
2885 struct llogd_conn_body {
2886 struct llog_gen lgdc_gen;
2887 struct llog_logid lgdc_logid;
2888 __u32 lgdc_ctxt_idx;
2889 } __attribute__((packed));
2891 /* Note: 64-bit types are 64-bit aligned in structure */
2893 __u64 o_valid; /* hot fields in this obdo */
2896 __u64 o_size; /* o_size-o_blocks == ost_lvb */
2900 __u64 o_blocks; /* brw: cli sent cached bytes */
2903 /* 32-bit fields start here: keep an even number of them via padding */
2904 __u32 o_blksize; /* optimal IO blocksize */
2905 __u32 o_mode; /* brw: cli sent cache remain */
2909 __u32 o_nlink; /* brw: checksum */
2911 __u32 o_misc; /* brw: o_dropped */
2913 __u64 o_ioepoch; /* epoch in ost writes */
2914 __u32 o_stripe_idx; /* holds stripe idx */
2916 struct lustre_handle o_handle; /* brw: lock handle to prolong
2918 /* Originally, the field is llog_cookie for destroy with unlink cookie
2919 * from MDS, it is obsolete in 2.8. Then reuse it by client to transfer
2920 * layout and PFL information in IO, setattr RPCs. Since llog_cookie is
2921 * not used on wire any longer, remove it from the obdo, then it can be
2922 * enlarged freely in the further without affect related RPCs.
2924 * sizeof(ost_layout) + sieof(__u32) == sizeof(llog_cookie). */
2925 struct ost_layout o_layout;
2926 __u32 o_layout_version;
2930 __u64 o_data_version; /* getattr: sum of iversion for
2932 * brw: grant space consumed on
2933 * the client for the write */
2935 __u32 o_padding_4; /* also fix
2936 * lustre_swab_obdo() */
2941 #define o_dirty o_blocks
2942 #define o_undirty o_mode
2943 #define o_dropped o_misc
2944 #define o_cksum o_nlink
2945 #define o_grant_used o_data_version
2947 struct lfsck_request {
2959 __u16 lr_async_windows;
2961 struct lu_fid lr_fid;
2962 struct lu_fid lr_fid2;
2970 struct lfsck_reply {
2977 LE_LASTID_REBUILDING = 1,
2978 LE_LASTID_REBUILT = 2,
2984 /* LE_FID_ACCESSED = 8, moved to lfsck_events_local */
2986 LE_CONDITIONAL_DESTROY = 10,
2987 LE_PAIRS_VERIFY = 11,
2988 LE_SET_LMV_MASTER = 15,
2989 LE_SET_LMV_SLAVE = 16,
2992 enum lfsck_event_flags {
2993 LEF_TO_OST = 0x00000001,
2994 LEF_FROM_OST = 0x00000002,
2995 LEF_SET_LMV_HASH = 0x00000004,
2996 LEF_SET_LMV_ALL = 0x00000008,
2997 LEF_RECHECK_NAME_HASH = 0x00000010,
2998 LEF_QUERY_ALL = 0x00000020,
3001 /* request structure for OST's */
3006 /* Key for FIEMAP to be used in get_info calls */
3007 struct ll_fiemap_info_key {
3009 struct obdo lfik_oa;
3010 struct fiemap lfik_fiemap;
3013 #define IDX_INFO_MAGIC 0x3D37CC37
3015 /* Index file transfer through the network. The server serializes the index into
3016 * a byte stream which is sent to the client via a bulk transfer */
3020 /* reply: see idx_info_flags below */
3023 /* request & reply: number of lu_idxpage (to be) transferred */
3027 /* request: requested attributes passed down to the iterator API */
3030 /* request & reply: index file identifier (FID) */
3031 struct lu_fid ii_fid;
3033 /* reply: version of the index file before starting to walk the index.
3034 * Please note that the version can be modified at any time during the
3038 /* request: hash to start with:
3039 * reply: hash of the first entry of the first lu_idxpage and hash
3040 * of the entry to read next if any */
3041 __u64 ii_hash_start;
3044 /* reply: size of keys in lu_idxpages, minimal one if II_FL_VARKEY is
3048 /* reply: size of records in lu_idxpages, minimal one if II_FL_VARREC
3057 #define II_END_OFF MDS_DIR_END_OFF /* all entries have been read */
3059 /* List of flags used in idx_info::ii_flags */
3060 enum idx_info_flags {
3061 II_FL_NOHASH = 1 << 0, /* client doesn't care about hash value */
3062 II_FL_VARKEY = 1 << 1, /* keys can be of variable size */
3063 II_FL_VARREC = 1 << 2, /* records can be of variable size */
3064 II_FL_NONUNQ = 1 << 3, /* index supports non-unique keys */
3065 II_FL_NOKEY = 1 << 4, /* client doesn't care about key */
3068 #define LIP_MAGIC 0x8A6D6B6C
3070 /* 4KB (= LU_PAGE_SIZE) container gathering key/record pairs */
3072 /* 16-byte header */
3075 __u16 lip_nr; /* number of entries in the container */
3076 __u64 lip_pad0; /* additional padding for future use */
3078 /* key/record pairs are stored in the remaining 4080 bytes.
3079 * depending upon the flags in idx_info::ii_flags, each key/record
3080 * pair might be preceded by:
3082 * - the key size (II_FL_VARKEY is set)
3083 * - the record size (II_FL_VARREC is set)
3085 * For the time being, we only support fixed-size key & record. */
3086 char lip_entries[0];
3089 #define LIP_HDR_SIZE (offsetof(struct lu_idxpage, lip_entries))
3091 /* Gather all possible type associated with a 4KB container */
3093 struct lu_dirpage lp_dir; /* for MDS_READPAGE */
3094 struct lu_idxpage lp_idx; /* for OBD_IDX_READ */
3095 char lp_array[LU_PAGE_SIZE];
3098 /* security opcodes */
3101 SEC_CTX_INIT_CONT = 802,
3104 SEC_FIRST_OPC = SEC_CTX_INIT
3108 * capa related definitions
3110 #define CAPA_HMAC_MAX_LEN 64
3111 #define CAPA_HMAC_KEY_MAX_LEN 56
3113 /* NB take care when changing the sequence of elements this struct,
3114 * because the offset info is used in find_capa() */
3115 struct lustre_capa {
3116 struct lu_fid lc_fid; /** fid */
3117 __u64 lc_opc; /** operations allowed */
3118 __u64 lc_uid; /** file owner */
3119 __u64 lc_gid; /** file group */
3120 __u32 lc_flags; /** HMAC algorithm & flags */
3121 __u32 lc_keyid; /** key# used for the capability */
3122 __u32 lc_timeout; /** capa timeout value (sec) */
3123 __u32 lc_expiry; /** expiry time (sec) */
3124 __u8 lc_hmac[CAPA_HMAC_MAX_LEN]; /** HMAC */
3125 } __attribute__((packed));
3127 /** lustre_capa::lc_opc */
3129 CAPA_OPC_BODY_WRITE = 1<<0, /**< write object data */
3130 CAPA_OPC_BODY_READ = 1<<1, /**< read object data */
3131 CAPA_OPC_INDEX_LOOKUP = 1<<2, /**< lookup object fid */
3132 CAPA_OPC_INDEX_INSERT = 1<<3, /**< insert object fid */
3133 CAPA_OPC_INDEX_DELETE = 1<<4, /**< delete object fid */
3134 CAPA_OPC_OSS_WRITE = 1<<5, /**< write oss object data */
3135 CAPA_OPC_OSS_READ = 1<<6, /**< read oss object data */
3136 CAPA_OPC_OSS_TRUNC = 1<<7, /**< truncate oss object */
3137 CAPA_OPC_OSS_DESTROY = 1<<8, /**< destroy oss object */
3138 CAPA_OPC_META_WRITE = 1<<9, /**< write object meta data */
3139 CAPA_OPC_META_READ = 1<<10, /**< read object meta data */
3142 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
3143 #define CAPA_OPC_MDS_ONLY \
3144 (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
3145 CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
3146 #define CAPA_OPC_OSS_ONLY \
3147 (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC | \
3148 CAPA_OPC_OSS_DESTROY)
3149 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
3150 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
3152 /* lustre_capa::lc_hmac_alg */
3154 CAPA_HMAC_ALG_SHA1 = 1, /**< sha1 algorithm */
3158 #define CAPA_FL_MASK 0x00ffffff
3159 #define CAPA_HMAC_ALG_MASK 0xff000000
3161 struct lustre_capa_key {
3162 __u64 lk_seq; /**< mds# */
3163 __u32 lk_keyid; /**< key# */
3165 __u8 lk_key[CAPA_HMAC_KEY_MAX_LEN]; /**< key */
3166 } __attribute__((packed));
3168 /** The link ea holds 1 \a link_ea_entry for each hardlink */
3169 #define LINK_EA_MAGIC 0x11EAF1DFUL
3170 struct link_ea_header {
3173 __u64 leh_len; /* total size */
3174 __u32 leh_overflow_time;
3178 /** Hardlink data is name and parent fid.
3179 * Stored in this crazy struct for maximum packing and endian-neutrality
3181 struct link_ea_entry {
3182 /** __u16 stored big-endian, unaligned */
3183 unsigned char lee_reclen[2];
3184 unsigned char lee_parent_fid[sizeof(struct lu_fid)];
3186 }__attribute__((packed));
3188 /** fid2path request/reply structure */
3189 struct getinfo_fid2path {
3190 struct lu_fid gf_fid;
3196 struct lu_fid gf_root_fid[0];
3198 } __attribute__((packed));
3200 /** path2parent request/reply structures */
3202 struct lu_fid gp_fid; /**< parent FID */
3203 __u32 gp_linkno; /**< hardlink number */
3204 __u32 gp_name_size; /**< size of the name field */
3205 char gp_name[0]; /**< zero-terminated link name */
3206 } __attribute__((packed));
3209 LAYOUT_INTENT_ACCESS = 0, /** generic access */
3210 LAYOUT_INTENT_READ = 1, /** not used */
3211 LAYOUT_INTENT_WRITE = 2, /** write file, for comp layout */
3212 LAYOUT_INTENT_GLIMPSE = 3, /** not used */
3213 LAYOUT_INTENT_TRUNC = 4, /** truncate file, for comp layout */
3214 LAYOUT_INTENT_RELEASE = 5, /** reserved for HSM release */
3215 LAYOUT_INTENT_RESTORE = 6, /** reserved for HSM restore */
3218 /* enqueue layout lock with intent */
3219 struct layout_intent {
3220 __u32 li_opc; /* intent operation for enqueue, read, write etc */
3222 struct lu_extent li_extent;
3223 } __attribute__((packed));
3226 * On the wire version of hsm_progress structure.
3228 * Contains the userspace hsm_progress and some internal fields.
3230 struct hsm_progress_kernel {
3231 /* Field taken from struct hsm_progress */
3234 struct hsm_extent hpk_extent;
3236 __u16 hpk_errval; /* positive val */
3238 /* Additional fields */
3239 __u64 hpk_data_version;
3241 } __attribute__((packed));
3244 * OUT_UPDATE RPC Format
3246 * During the cross-ref operation, the Master MDT, which the client send the
3247 * request to, will disassembly the operation into object updates, then OSP
3248 * will send these updates to the remote MDT to be executed.
3250 * An UPDATE_OBJ RPC does a list of updates. Each update belongs to an
3251 * operation and does a type of modification to an object.
3259 * update (ub_count-th)
3261 * ub_count must be less than or equal to UPDATE_PER_RPC_MAX.
3266 * rc [+ buffers] (1st)
3267 * rc [+ buffers] (2st)
3269 * rc [+ buffers] (nr_count-th)
3271 * ur_count must be less than or equal to UPDATE_PER_RPC_MAX and should usually
3272 * be equal to ub_count.
3276 * Type of each update, if adding/deleting update, please also update
3277 * update_opcode in lustre/target/out_lib.c.
3289 OUT_INDEX_LOOKUP = 9,
3290 OUT_INDEX_INSERT = 10,
3291 OUT_INDEX_DELETE = 11,
3301 UPDATE_FL_OST = 0x00000001, /* op from OST (not MDT) */
3302 UPDATE_FL_SYNC = 0x00000002, /* commit before replying */
3303 UPDATE_FL_COMMITTED = 0x00000004, /* op committed globally */
3304 UPDATE_FL_NOLOG = 0x00000008 /* for idempotent updates */
3307 struct object_update_param {
3308 __u16 oup_len; /* length of this parameter */
3315 struct object_update {
3316 __u16 ou_type; /* enum update_type */
3317 __u16 ou_params_count; /* update parameters count */
3318 __u32 ou_result_size; /* how many bytes can return */
3319 __u32 ou_flags; /* enum update_flag */
3320 __u32 ou_padding1; /* padding 1 */
3321 __u64 ou_batchid; /* op transno on master */
3322 struct lu_fid ou_fid; /* object to be updated */
3323 struct object_update_param ou_params[0]; /* update params */
3326 #define UPDATE_REQUEST_MAGIC_V1 0xBDDE0001
3327 #define UPDATE_REQUEST_MAGIC_V2 0xBDDE0002
3328 #define UPDATE_REQUEST_MAGIC UPDATE_REQUEST_MAGIC_V2
3329 /* Hold object_updates sending to the remote OUT in single RPC */
3330 struct object_update_request {
3332 __u16 ourq_count; /* number of ourq_updates[] */
3334 struct object_update ourq_updates[0];
3337 #define OUT_UPDATE_HEADER_MAGIC 0xBDDF0001
3338 #define OUT_UPDATE_MAX_INLINE_SIZE 4096
3339 /* Header for updates request between MDTs */
3340 struct out_update_header {
3343 __u32 ouh_inline_length;
3344 __u32 ouh_reply_size;
3345 __u32 ouh_inline_data[0];
3348 struct out_update_buffer {
3353 /* the result of object update */
3354 struct object_update_result {
3361 #define UPDATE_REPLY_MAGIC_V1 0x00BD0001
3362 #define UPDATE_REPLY_MAGIC_V2 0x00BD0002
3363 #define UPDATE_REPLY_MAGIC UPDATE_REPLY_MAGIC_V2
3364 /* Hold object_update_results being replied from the remote OUT. */
3365 struct object_update_reply {
3372 /* read update result */
3373 struct out_read_reply {
3380 /** layout swap request structure
3381 * fid1 and fid2 are in mdt_body
3383 struct mdc_swap_layouts {
3385 } __attribute__((packed));
3388 struct lustre_handle cd_handle;
3389 struct lu_fid cd_fid;
3390 __u64 cd_data_version;
3391 __u64 cd_reserved[8];
3394 /* Update llog format */
3396 struct lu_fid uop_fid;
3398 __u16 uop_param_count;
3399 __u16 uop_params_off[0];
3403 struct update_op uops_op[0];
3406 struct update_params {
3407 struct object_update_param up_params[0];
3410 enum update_records_flag {
3411 UPDATE_RECORD_CONTINUE = 1 >> 0,
3414 * This is the update record format used to store the updates in
3415 * disk. All updates of the operation will be stored in ur_ops.
3416 * All of parameters for updates of the operation will be stored
3418 * To save the space of the record, parameters in ur_ops will only
3419 * remember their offset in ur_params, so to avoid storing duplicate
3420 * parameters in ur_params, which can help us save a lot space for
3421 * operation like creating striped directory.
3423 struct update_records {
3424 __u64 ur_master_transno;
3427 /* If the operation includes multiple updates, then ur_index
3428 * means the index of the update inside the whole updates. */
3430 __u32 ur_update_count;
3431 __u32 ur_param_count;
3432 struct update_ops ur_ops;
3433 /* Note ur_ops has a variable size, so comment out
3434 * the following ur_params, in case some use it directly
3435 * update_records->ur_params
3437 * struct update_params ur_params;
3441 struct llog_update_record {
3442 struct llog_rec_hdr lur_hdr;
3443 struct update_records lur_update_rec;
3444 /* Note ur_update_rec has a variable size, so comment out
3445 * the following ur_tail, in case someone use it directly
3447 * struct llog_rec_tail lur_tail;
3451 /* nodemap records, uses 32 byte record length */
3452 #define LUSTRE_NODEMAP_NAME_LENGTH 16
3453 struct nodemap_cluster_rec {
3454 char ncr_name[LUSTRE_NODEMAP_NAME_LENGTH + 1];
3458 __u32 ncr_squash_uid;
3459 __u32 ncr_squash_gid;
3462 /* lnet_nid_t is 8 bytes */
3463 struct nodemap_range_rec {
3464 lnet_nid_t nrr_start_nid;
3465 lnet_nid_t nrr_end_nid;
3470 struct nodemap_id_rec {
3478 struct nodemap_global_rec {
3489 struct nodemap_cluster_rec ncr;
3490 struct nodemap_range_rec nrr;
3491 struct nodemap_id_rec nir;
3492 struct nodemap_global_rec ngr;
3495 /* This is the lu_ladvise struct which goes out on the wire.
3496 * Corresponds to the userspace arg llapi_lu_ladvise.
3497 * value[1-4] are unspecified fields, used differently by different advices */
3499 __u16 lla_advice; /* advice type */
3500 __u16 lla_value1; /* values for different advice types */
3502 __u64 lla_start; /* first byte of extent for advice */
3503 __u64 lla_end; /* last byte of extent for advice */
3508 /* This is the ladvise_hdr which goes on the wire, corresponds to the userspace
3509 * arg llapi_ladvise_hdr.
3510 * value[1-3] are unspecified fields, used differently by different advices */
3511 struct ladvise_hdr {
3512 __u32 lah_magic; /* LADVISE_MAGIC */
3513 __u32 lah_count; /* number of advices */
3514 __u64 lah_flags; /* from enum ladvise_flag */
3515 __u32 lah_value1; /* unused */
3516 __u32 lah_value2; /* unused */
3517 __u64 lah_value3; /* unused */
3518 struct lu_ladvise lah_advise[0]; /* advices in this header */