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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/lustre/lustre_idl.h
38 * Lustre wire protocol definitions.
41 /** \defgroup lustreidl lustreidl
43 * Lustre wire protocol definitions.
45 * ALL structs passing over the wire should be declared here. Structs
46 * that are used in interfaces with userspace should go in lustre_user.h.
48 * All structs being declared here should be built from simple fixed-size
49 * types (__u8, __u16, __u32, __u64) or be built from other types or
50 * structs also declared in this file. Similarly, all flags and magic
51 * values in those structs should also be declared here. This ensures
52 * that the Lustre wire protocol is not influenced by external dependencies.
54 * The only other acceptable items in this file are VERY SIMPLE accessor
55 * functions to avoid callers grubbing inside the structures, and the
56 * prototypes of the swabber functions for each struct. Nothing that
57 * depends on external functions or definitions should be in here.
59 * Structs must be properly aligned to put 64-bit values on an 8-byte
60 * boundary. Any structs being added here must also be added to
61 * utils/wirecheck.c and "make newwiretest" run to regenerate the
62 * utils/wiretest.c sources. This allows us to verify that wire structs
63 * have the proper alignment/size on all architectures.
65 * DO NOT CHANGE any of the structs, flags, values declared here and used
66 * in released Lustre versions. Some structs may have padding fields that
67 * can be used. Some structs might allow addition at the end (verify this
68 * in the code to ensure that new/old clients that see this larger struct
69 * do not fail, otherwise you need to implement protocol compatibility).
71 * We assume all nodes are either little-endian or big-endian, and we
72 * always send messages in the sender's native format. The receiver
73 * detects the message format by checking the 'magic' field of the message
74 * (see lustre_msg_swabbed() below).
76 * Each wire type has corresponding 'lustre_swab_xxxtypexxx()' routines,
77 * implemented either here, inline (trivial implementations) or in
78 * ptlrpc/pack_generic.c. These 'swabbers' convert the type from "other"
79 * endian, in-place in the message buffer.
81 * A swabber takes a single pointer argument. The caller must already have
82 * verified that the length of the message buffer >= sizeof (type).
84 * For variable length types, a second 'lustre_swab_v_xxxtypexxx()' routine
85 * may be defined that swabs just the variable part, after the caller has
86 * verified that the message buffer is large enough.
91 #ifndef _LUSTRE_IDL_H_
92 #define _LUSTRE_IDL_H_
94 #include <libcfs/libcfs.h> /* for LPUX64, etc */
95 #include <lnet/types.h>
96 #include <lustre/lustre_user.h> /* Defn's shared with user-space. */
97 #include <lustre/lustre_errno.h>
98 #include <lustre_ver.h>
103 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
104 * FOO_REPLY_PORTAL is for incoming replies on the FOO
105 * FOO_BULK_PORTAL is for incoming bulk on the FOO
108 #define CONNMGR_REQUEST_PORTAL 1
109 #define CONNMGR_REPLY_PORTAL 2
110 //#define OSC_REQUEST_PORTAL 3
111 #define OSC_REPLY_PORTAL 4
112 //#define OSC_BULK_PORTAL 5
113 #define OST_IO_PORTAL 6
114 #define OST_CREATE_PORTAL 7
115 #define OST_BULK_PORTAL 8
116 //#define MDC_REQUEST_PORTAL 9
117 #define MDC_REPLY_PORTAL 10
118 //#define MDC_BULK_PORTAL 11
119 #define MDS_REQUEST_PORTAL 12
120 //#define MDS_REPLY_PORTAL 13
121 #define MDS_BULK_PORTAL 14
122 #define LDLM_CB_REQUEST_PORTAL 15
123 #define LDLM_CB_REPLY_PORTAL 16
124 #define LDLM_CANCEL_REQUEST_PORTAL 17
125 #define LDLM_CANCEL_REPLY_PORTAL 18
126 //#define PTLBD_REQUEST_PORTAL 19
127 //#define PTLBD_REPLY_PORTAL 20
128 //#define PTLBD_BULK_PORTAL 21
129 #define MDS_SETATTR_PORTAL 22
130 #define MDS_READPAGE_PORTAL 23
131 #define OUT_PORTAL 24
132 #define MGC_REPLY_PORTAL 25
133 #define MGS_REQUEST_PORTAL 26
134 #define MGS_REPLY_PORTAL 27
135 #define OST_REQUEST_PORTAL 28
136 #define FLD_REQUEST_PORTAL 29
137 #define SEQ_METADATA_PORTAL 30
138 #define SEQ_DATA_PORTAL 31
139 #define SEQ_CONTROLLER_PORTAL 32
140 #define MGS_BULK_PORTAL 33
142 /* Portal 63 is reserved for the Cray Inc DVS - nic@cray.com, roe@cray.com, n8851@cray.com */
145 #define PTL_RPC_MSG_REQUEST 4711
146 #define PTL_RPC_MSG_ERR 4712
147 #define PTL_RPC_MSG_REPLY 4713
149 /* DON'T use swabbed values of MAGIC as magic! */
150 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
151 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
153 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
155 #define PTLRPC_MSG_VERSION 0x00000003
156 #define LUSTRE_VERSION_MASK 0xffff0000
157 #define LUSTRE_OBD_VERSION 0x00010000
158 #define LUSTRE_MDS_VERSION 0x00020000
159 #define LUSTRE_OST_VERSION 0x00030000
160 #define LUSTRE_DLM_VERSION 0x00040000
161 #define LUSTRE_LOG_VERSION 0x00050000
162 #define LUSTRE_MGS_VERSION 0x00060000
165 * Describes a range of sequence, lsr_start is included but lsr_end is
167 * Same structure is used in fld module where lsr_index field holds mdt id
170 struct lu_seq_range {
177 struct lu_seq_range_array {
180 struct lu_seq_range lsra_lsr[0];
183 #define LU_SEQ_RANGE_MDT 0x0
184 #define LU_SEQ_RANGE_OST 0x1
185 #define LU_SEQ_RANGE_ANY 0x3
187 #define LU_SEQ_RANGE_MASK 0x3
189 static inline unsigned fld_range_type(const struct lu_seq_range *range)
191 return range->lsr_flags & LU_SEQ_RANGE_MASK;
194 static inline bool fld_range_is_ost(const struct lu_seq_range *range)
196 return fld_range_type(range) == LU_SEQ_RANGE_OST;
199 static inline bool fld_range_is_mdt(const struct lu_seq_range *range)
201 return fld_range_type(range) == LU_SEQ_RANGE_MDT;
205 * This all range is only being used when fld client sends fld query request,
206 * but it does not know whether the seq is MDT or OST, so it will send req
207 * with ALL type, which means either seq type gotten from lookup can be
210 static inline unsigned fld_range_is_any(const struct lu_seq_range *range)
212 return fld_range_type(range) == LU_SEQ_RANGE_ANY;
215 static inline void fld_range_set_type(struct lu_seq_range *range,
218 range->lsr_flags |= flags;
221 static inline void fld_range_set_mdt(struct lu_seq_range *range)
223 fld_range_set_type(range, LU_SEQ_RANGE_MDT);
226 static inline void fld_range_set_ost(struct lu_seq_range *range)
228 fld_range_set_type(range, LU_SEQ_RANGE_OST);
231 static inline void fld_range_set_any(struct lu_seq_range *range)
233 fld_range_set_type(range, LU_SEQ_RANGE_ANY);
237 * returns width of given range \a r
240 static inline __u64 range_space(const struct lu_seq_range *range)
242 return range->lsr_end - range->lsr_start;
246 * initialize range to zero
249 static inline void range_init(struct lu_seq_range *range)
251 memset(range, 0, sizeof(*range));
255 * check if given seq id \a s is within given range \a r
258 static inline bool range_within(const struct lu_seq_range *range,
261 return s >= range->lsr_start && s < range->lsr_end;
264 static inline bool range_is_sane(const struct lu_seq_range *range)
266 return range->lsr_end >= range->lsr_start;
269 static inline bool range_is_zero(const struct lu_seq_range *range)
271 return range->lsr_start == 0 && range->lsr_end == 0;
274 static inline bool range_is_exhausted(const struct lu_seq_range *range)
276 return range_space(range) == 0;
279 /* return 0 if two range have the same location */
280 static inline int range_compare_loc(const struct lu_seq_range *r1,
281 const struct lu_seq_range *r2)
283 return r1->lsr_index != r2->lsr_index ||
284 r1->lsr_flags != r2->lsr_flags;
287 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x):%x:%s"
289 #define PRANGE(range) \
290 (range)->lsr_start, \
292 (range)->lsr_index, \
293 fld_range_is_mdt(range) ? "mdt" : "ost"
296 /** \defgroup lu_fid lu_fid
300 * Flags for lustre_mdt_attrs::lma_compat and lustre_mdt_attrs::lma_incompat.
301 * Deprecated since HSM and SOM attributes are now stored in separate on-disk
305 LMAC_HSM = 0x00000001,
306 /* LMAC_SOM = 0x00000002, obsolete since 2.8.0 */
307 LMAC_NOT_IN_OI = 0x00000004, /* the object does NOT need OI mapping */
308 LMAC_FID_ON_OST = 0x00000008, /* For OST-object, its OI mapping is
309 * under /O/<seq>/d<x>. */
313 * Masks for all features that should be supported by a Lustre version to
314 * access a specific file.
315 * This information is stored in lustre_mdt_attrs::lma_incompat.
318 LMAI_RELEASED = 0x00000001, /* file is released */
319 LMAI_AGENT = 0x00000002, /* agent inode */
320 LMAI_REMOTE_PARENT = 0x00000004, /* the parent of the object
321 is on the remote MDT */
322 LMAI_STRIPED = 0x00000008, /* striped directory inode */
324 #define LMA_INCOMPAT_SUPP (LMAI_AGENT | LMAI_REMOTE_PARENT | LMAI_STRIPED)
326 extern void lustre_lma_swab(struct lustre_mdt_attrs *lma);
327 extern void lustre_lma_init(struct lustre_mdt_attrs *lma,
328 const struct lu_fid *fid,
329 __u32 compat, __u32 incompat);
331 /* copytool uses a 32b bitmask field to encode archive-Ids during register
333 * archive num = 0 => all
334 * archive num from 1 to 32
336 #define LL_HSM_MAX_ARCHIVE (sizeof(__u32) * 8)
339 * HSM on-disk attributes stored in a separate xattr.
342 /** Bitfield for supported data in this structure. For future use. */
345 /** HSM flags, see hsm_flags enum below */
347 /** backend archive id associated with the file */
349 /** version associated with the last archiving, if any */
352 extern void lustre_hsm_swab(struct hsm_attrs *attrs);
358 /** LASTID file has zero OID */
359 LUSTRE_FID_LASTID_OID = 0UL,
360 /** initial fid id value */
361 LUSTRE_FID_INIT_OID = 1UL
364 /** returns fid object sequence */
365 static inline __u64 fid_seq(const struct lu_fid *fid)
370 /** returns fid object id */
371 static inline __u32 fid_oid(const struct lu_fid *fid)
376 /** returns fid object version */
377 static inline __u32 fid_ver(const struct lu_fid *fid)
382 static inline void fid_zero(struct lu_fid *fid)
384 memset(fid, 0, sizeof(*fid));
387 static inline __u64 fid_ver_oid(const struct lu_fid *fid)
389 return ((__u64)fid_ver(fid) << 32 | fid_oid(fid));
393 * Note that reserved SEQ numbers below 12 will conflict with ldiskfs
394 * inodes in the IGIF namespace, so these reserved SEQ numbers can be
395 * used for other purposes and not risk collisions with existing inodes.
397 * Different FID Format
398 * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs#NEW.0
401 FID_SEQ_OST_MDT0 = 0,
402 FID_SEQ_LLOG = 1, /* unnamed llogs */
404 FID_SEQ_UNUSED_START = 3,
405 FID_SEQ_UNUSED_END = 9,
406 FID_SEQ_LLOG_NAME = 10, /* named llogs */
409 FID_SEQ_IGIF_MAX = 0x0ffffffffULL,
410 FID_SEQ_IDIF = 0x100000000ULL,
411 FID_SEQ_IDIF_MAX = 0x1ffffffffULL,
412 /* Normal FID sequence starts from this value, i.e. 1<<33 */
413 FID_SEQ_START = 0x200000000ULL,
414 /* sequence for local pre-defined FIDs listed in local_oid */
415 FID_SEQ_LOCAL_FILE = 0x200000001ULL,
416 FID_SEQ_DOT_LUSTRE = 0x200000002ULL,
417 /* sequence is used for local named objects FIDs generated
418 * by local_object_storage library */
419 FID_SEQ_LOCAL_NAME = 0x200000003ULL,
420 /* Because current FLD will only cache the fid sequence, instead
421 * of oid on the client side, if the FID needs to be exposed to
422 * clients sides, it needs to make sure all of fids under one
423 * sequence will be located in one MDT. */
424 FID_SEQ_SPECIAL = 0x200000004ULL,
425 FID_SEQ_QUOTA = 0x200000005ULL,
426 FID_SEQ_QUOTA_GLB = 0x200000006ULL,
427 FID_SEQ_ROOT = 0x200000007ULL, /* Located on MDT0 */
428 FID_SEQ_LAYOUT_RBTREE = 0x200000008ULL,
429 /* sequence is used for update logs of cross-MDT operation */
430 FID_SEQ_UPDATE_LOG = 0x200000009ULL,
431 /* Sequence is used for the directory under which update logs
433 FID_SEQ_UPDATE_LOG_DIR = 0x20000000aULL,
434 FID_SEQ_NORMAL = 0x200000400ULL,
435 FID_SEQ_LOV_DEFAULT = 0xffffffffffffffffULL
438 #define OBIF_OID_MAX_BITS 32
439 #define OBIF_MAX_OID (1ULL << OBIF_OID_MAX_BITS)
440 #define OBIF_OID_MASK ((1ULL << OBIF_OID_MAX_BITS) - 1)
441 #define IDIF_OID_MAX_BITS 48
442 #define IDIF_MAX_OID (1ULL << IDIF_OID_MAX_BITS)
443 #define IDIF_OID_MASK ((1ULL << IDIF_OID_MAX_BITS) - 1)
445 /** OID for FID_SEQ_SPECIAL */
447 /* Big Filesystem Lock to serialize rename operations */
448 FID_OID_SPECIAL_BFL = 1UL,
451 /** OID for FID_SEQ_DOT_LUSTRE */
452 enum dot_lustre_oid {
453 FID_OID_DOT_LUSTRE = 1UL,
454 FID_OID_DOT_LUSTRE_OBF = 2UL,
455 FID_OID_DOT_LUSTRE_LPF = 3UL,
458 /** OID for FID_SEQ_ROOT */
461 FID_OID_ECHO_ROOT = 2UL,
464 static inline bool fid_seq_is_mdt0(__u64 seq)
466 return seq == FID_SEQ_OST_MDT0;
469 static inline bool fid_seq_is_mdt(__u64 seq)
471 return seq == FID_SEQ_OST_MDT0 || seq >= FID_SEQ_NORMAL;
474 static inline bool fid_seq_is_echo(__u64 seq)
476 return seq == FID_SEQ_ECHO;
479 static inline bool fid_is_echo(const struct lu_fid *fid)
481 return fid_seq_is_echo(fid_seq(fid));
484 static inline bool fid_seq_is_llog(__u64 seq)
486 return seq == FID_SEQ_LLOG;
489 static inline bool fid_is_llog(const struct lu_fid *fid)
491 /* file with OID == 0 is not llog but contains last oid */
492 return fid_seq_is_llog(fid_seq(fid)) && fid_oid(fid) > 0;
495 static inline bool fid_seq_is_rsvd(__u64 seq)
497 return seq > FID_SEQ_OST_MDT0 && seq <= FID_SEQ_RSVD;
500 static inline bool fid_seq_is_special(__u64 seq)
502 return seq == FID_SEQ_SPECIAL;
505 static inline bool fid_seq_is_local_file(__u64 seq)
507 return seq == FID_SEQ_LOCAL_FILE ||
508 seq == FID_SEQ_LOCAL_NAME;
511 static inline bool fid_seq_is_root(__u64 seq)
513 return seq == FID_SEQ_ROOT;
516 static inline bool fid_seq_is_dot(__u64 seq)
518 return seq == FID_SEQ_DOT_LUSTRE;
521 static inline bool fid_seq_is_default(__u64 seq)
523 return seq == FID_SEQ_LOV_DEFAULT;
526 static inline bool fid_is_mdt0(const struct lu_fid *fid)
528 return fid_seq_is_mdt0(fid_seq(fid));
531 static inline void lu_root_fid(struct lu_fid *fid)
533 fid->f_seq = FID_SEQ_ROOT;
534 fid->f_oid = FID_OID_ROOT;
538 static inline void lu_echo_root_fid(struct lu_fid *fid)
540 fid->f_seq = FID_SEQ_ROOT;
541 fid->f_oid = FID_OID_ECHO_ROOT;
545 static inline void lu_update_log_fid(struct lu_fid *fid, __u32 index)
547 fid->f_seq = FID_SEQ_UPDATE_LOG;
552 static inline void lu_update_log_dir_fid(struct lu_fid *fid, __u32 index)
554 fid->f_seq = FID_SEQ_UPDATE_LOG_DIR;
560 * Check if a fid is igif or not.
561 * \param fid the fid to be tested.
562 * \return true if the fid is an igif; otherwise false.
564 static inline bool fid_seq_is_igif(__u64 seq)
566 return seq >= FID_SEQ_IGIF && seq <= FID_SEQ_IGIF_MAX;
569 static inline bool fid_is_igif(const struct lu_fid *fid)
571 return fid_seq_is_igif(fid_seq(fid));
575 * Check if a fid is idif or not.
576 * \param fid the fid to be tested.
577 * \return true if the fid is an idif; otherwise false.
579 static inline bool fid_seq_is_idif(__u64 seq)
581 return seq >= FID_SEQ_IDIF && seq <= FID_SEQ_IDIF_MAX;
584 static inline bool fid_is_idif(const struct lu_fid *fid)
586 return fid_seq_is_idif(fid_seq(fid));
589 static inline bool fid_is_local_file(const struct lu_fid *fid)
591 return fid_seq_is_local_file(fid_seq(fid));
594 static inline bool fid_seq_is_norm(__u64 seq)
596 return (seq >= FID_SEQ_NORMAL);
599 static inline bool fid_is_norm(const struct lu_fid *fid)
601 return fid_seq_is_norm(fid_seq(fid));
604 static inline int fid_is_layout_rbtree(const struct lu_fid *fid)
606 return fid_seq(fid) == FID_SEQ_LAYOUT_RBTREE;
609 static inline bool fid_seq_is_update_log(__u64 seq)
611 return seq == FID_SEQ_UPDATE_LOG;
614 static inline bool fid_is_update_log(const struct lu_fid *fid)
616 return fid_seq_is_update_log(fid_seq(fid));
619 static inline bool fid_seq_is_update_log_dir(__u64 seq)
621 return seq == FID_SEQ_UPDATE_LOG_DIR;
624 static inline bool fid_is_update_log_dir(const struct lu_fid *fid)
626 return fid_seq_is_update_log_dir(fid_seq(fid));
629 /* convert an OST objid into an IDIF FID SEQ number */
630 static inline __u64 fid_idif_seq(__u64 id, __u32 ost_idx)
632 return FID_SEQ_IDIF | (ost_idx << 16) | ((id >> 32) & 0xffff);
635 /* convert a packed IDIF FID into an OST objid */
636 static inline __u64 fid_idif_id(__u64 seq, __u32 oid, __u32 ver)
638 return ((__u64)ver << 48) | ((seq & 0xffff) << 32) | oid;
641 static inline __u32 idif_ost_idx(__u64 seq)
643 return (seq >> 16) & 0xffff;
646 /* extract ost index from IDIF FID */
647 static inline __u32 fid_idif_ost_idx(const struct lu_fid *fid)
649 return idif_ost_idx(fid_seq(fid));
652 /* extract OST sequence (group) from a wire ost_id (id/seq) pair */
653 static inline __u64 ostid_seq(const struct ost_id *ostid)
655 if (fid_seq_is_mdt0(ostid->oi.oi_seq))
656 return FID_SEQ_OST_MDT0;
658 if (unlikely(fid_seq_is_default(ostid->oi.oi_seq)))
659 return FID_SEQ_LOV_DEFAULT;
661 if (fid_is_idif(&ostid->oi_fid))
662 return FID_SEQ_OST_MDT0;
664 return fid_seq(&ostid->oi_fid);
667 /* extract OST objid from a wire ost_id (id/seq) pair */
668 static inline __u64 ostid_id(const struct ost_id *ostid)
670 if (fid_seq_is_mdt0(ostid->oi.oi_seq))
671 return ostid->oi.oi_id & IDIF_OID_MASK;
673 if (unlikely(fid_seq_is_default(ostid->oi.oi_seq)))
674 return ostid->oi.oi_id;
676 if (fid_is_idif(&ostid->oi_fid))
677 return fid_idif_id(fid_seq(&ostid->oi_fid),
678 fid_oid(&ostid->oi_fid), 0);
680 return fid_oid(&ostid->oi_fid);
683 static inline void ostid_set_seq(struct ost_id *oi, __u64 seq)
685 if (fid_seq_is_mdt0(seq) || fid_seq_is_default(seq)) {
688 oi->oi_fid.f_seq = seq;
689 /* Note: if f_oid + f_ver is zero, we need init it
690 * to be 1, otherwise, ostid_seq will treat this
691 * as old ostid (oi_seq == 0) */
692 if (oi->oi_fid.f_oid == 0 && oi->oi_fid.f_ver == 0)
693 oi->oi_fid.f_oid = LUSTRE_FID_INIT_OID;
697 static inline void ostid_set_seq_mdt0(struct ost_id *oi)
699 ostid_set_seq(oi, FID_SEQ_OST_MDT0);
702 static inline void ostid_set_seq_echo(struct ost_id *oi)
704 ostid_set_seq(oi, FID_SEQ_ECHO);
707 static inline void ostid_set_seq_llog(struct ost_id *oi)
709 ostid_set_seq(oi, FID_SEQ_LLOG);
713 * Note: we need check oi_seq to decide where to set oi_id,
714 * so oi_seq should always be set ahead of oi_id.
716 static inline void ostid_set_id(struct ost_id *oi, __u64 oid)
718 if (fid_seq_is_mdt0(oi->oi.oi_seq)) {
719 if (oid >= IDIF_MAX_OID) {
720 CERROR("Bad "LPU64" to set "DOSTID"\n",
725 } else if (fid_is_idif(&oi->oi_fid)) {
726 if (oid >= IDIF_MAX_OID) {
727 CERROR("Bad "LPU64" to set "DOSTID"\n",
731 oi->oi_fid.f_seq = fid_idif_seq(oid,
732 fid_idif_ost_idx(&oi->oi_fid));
733 oi->oi_fid.f_oid = oid;
734 oi->oi_fid.f_ver = oid >> 48;
736 if (oid > OBIF_MAX_OID) {
737 CERROR("Bad "LPU64" to set "DOSTID"\n",
741 oi->oi_fid.f_oid = oid;
745 static inline int fid_set_id(struct lu_fid *fid, __u64 oid)
747 if (unlikely(fid_seq_is_igif(fid->f_seq))) {
748 CERROR("bad IGIF, "DFID"\n", PFID(fid));
752 if (fid_is_idif(fid)) {
753 if (oid >= IDIF_MAX_OID) {
754 CERROR("Bad "LPU64" to set "DFID"\n",
758 fid->f_seq = fid_idif_seq(oid, fid_idif_ost_idx(fid));
760 fid->f_ver = oid >> 48;
762 if (oid > OBIF_MAX_OID) {
763 CERROR("Bad "LPU64" to set "DFID"\n",
773 * Unpack an OST object id/seq (group) into a FID. This is needed for
774 * converting all obdo, lmm, lsm, etc. 64-bit id/seq pairs into proper
775 * FIDs. Note that if an id/seq is already in FID/IDIF format it will
776 * be passed through unchanged. Only legacy OST objects in "group 0"
777 * will be mapped into the IDIF namespace so that they can fit into the
778 * struct lu_fid fields without loss. For reference see:
779 * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs
781 static inline int ostid_to_fid(struct lu_fid *fid, const struct ost_id *ostid,
784 __u64 seq = ostid_seq(ostid);
786 if (ost_idx > 0xffff) {
787 CERROR("bad ost_idx, "DOSTID" ost_idx:%u\n", POSTID(ostid),
792 if (fid_seq_is_mdt0(seq)) {
793 __u64 oid = ostid_id(ostid);
795 /* This is a "legacy" (old 1.x/2.early) OST object in "group 0"
796 * that we map into the IDIF namespace. It allows up to 2^48
797 * objects per OST, as this is the object namespace that has
798 * been in production for years. This can handle create rates
799 * of 1M objects/s/OST for 9 years, or combinations thereof. */
800 if (oid >= IDIF_MAX_OID) {
801 CERROR("bad MDT0 id(1), "DOSTID" ost_idx:%u\n",
802 POSTID(ostid), ost_idx);
805 fid->f_seq = fid_idif_seq(oid, ost_idx);
806 /* truncate to 32 bits by assignment */
808 /* in theory, not currently used */
809 fid->f_ver = oid >> 48;
810 } else if (likely(!fid_seq_is_default(seq)))
811 /* if (fid_seq_is_idif(seq) || fid_seq_is_norm(seq)) */ {
812 /* This is either an IDIF object, which identifies objects across
813 * all OSTs, or a regular FID. The IDIF namespace maps legacy
814 * OST objects into the FID namespace. In both cases, we just
815 * pass the FID through, no conversion needed. */
816 if (ostid->oi_fid.f_ver != 0) {
817 CERROR("bad MDT0 id(2), "DOSTID" ost_idx:%u\n",
818 POSTID(ostid), ost_idx);
821 *fid = ostid->oi_fid;
827 /* pack any OST FID into an ostid (id/seq) for the wire/disk */
828 static inline int fid_to_ostid(const struct lu_fid *fid, struct ost_id *ostid)
830 if (unlikely(fid_seq_is_igif(fid->f_seq))) {
831 CERROR("bad IGIF, "DFID"\n", PFID(fid));
835 if (fid_is_idif(fid)) {
836 ostid_set_seq_mdt0(ostid);
837 ostid_set_id(ostid, fid_idif_id(fid_seq(fid), fid_oid(fid),
840 ostid->oi_fid = *fid;
846 /* Check whether the fid is for LAST_ID */
847 static inline bool fid_is_last_id(const struct lu_fid *fid)
849 return fid_oid(fid) == 0 && fid_seq(fid) != FID_SEQ_UPDATE_LOG &&
850 fid_seq(fid) != FID_SEQ_UPDATE_LOG_DIR;
854 * Get inode number from an igif.
855 * \param fid an igif to get inode number from.
856 * \return inode number for the igif.
858 static inline ino_t lu_igif_ino(const struct lu_fid *fid)
863 extern void lustre_swab_ost_id(struct ost_id *oid);
866 * Get inode generation from an igif.
867 * \param fid an igif to get inode generation from.
868 * \return inode generation for the igif.
870 static inline __u32 lu_igif_gen(const struct lu_fid *fid)
876 * Build igif from the inode number/generation.
878 static inline void lu_igif_build(struct lu_fid *fid, __u32 ino, __u32 gen)
886 * Fids are transmitted across network (in the sender byte-ordering),
887 * and stored on disk in big-endian order.
889 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
891 dst->f_seq = cpu_to_le64(fid_seq(src));
892 dst->f_oid = cpu_to_le32(fid_oid(src));
893 dst->f_ver = cpu_to_le32(fid_ver(src));
896 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
898 dst->f_seq = le64_to_cpu(fid_seq(src));
899 dst->f_oid = le32_to_cpu(fid_oid(src));
900 dst->f_ver = le32_to_cpu(fid_ver(src));
903 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
905 dst->f_seq = cpu_to_be64(fid_seq(src));
906 dst->f_oid = cpu_to_be32(fid_oid(src));
907 dst->f_ver = cpu_to_be32(fid_ver(src));
910 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
912 dst->f_seq = be64_to_cpu(fid_seq(src));
913 dst->f_oid = be32_to_cpu(fid_oid(src));
914 dst->f_ver = be32_to_cpu(fid_ver(src));
917 static inline bool fid_is_sane(const struct lu_fid *fid)
919 return fid != NULL &&
920 ((fid_seq(fid) >= FID_SEQ_START && fid_ver(fid) == 0) ||
921 fid_is_igif(fid) || fid_is_idif(fid) ||
922 fid_seq_is_rsvd(fid_seq(fid)));
925 extern void lustre_swab_lu_fid(struct lu_fid *fid);
926 extern void lustre_swab_lu_seq_range(struct lu_seq_range *range);
928 static inline bool lu_fid_eq(const struct lu_fid *f0, const struct lu_fid *f1)
930 return memcmp(f0, f1, sizeof *f0) == 0;
933 #define __diff_normalize(val0, val1) \
935 typeof(val0) __val0 = (val0); \
936 typeof(val1) __val1 = (val1); \
938 (__val0 == __val1 ? 0 : __val0 > __val1 ? +1 : -1); \
941 static inline int lu_fid_cmp(const struct lu_fid *f0,
942 const struct lu_fid *f1)
945 __diff_normalize(fid_seq(f0), fid_seq(f1)) ?:
946 __diff_normalize(fid_oid(f0), fid_oid(f1)) ?:
947 __diff_normalize(fid_ver(f0), fid_ver(f1));
950 static inline void ostid_cpu_to_le(const struct ost_id *src_oi,
951 struct ost_id *dst_oi)
953 if (fid_seq_is_mdt0(src_oi->oi.oi_seq)) {
954 dst_oi->oi.oi_id = cpu_to_le64(src_oi->oi.oi_id);
955 dst_oi->oi.oi_seq = cpu_to_le64(src_oi->oi.oi_seq);
957 fid_cpu_to_le(&dst_oi->oi_fid, &src_oi->oi_fid);
961 static inline void ostid_le_to_cpu(const struct ost_id *src_oi,
962 struct ost_id *dst_oi)
964 if (fid_seq_is_mdt0(src_oi->oi.oi_seq)) {
965 dst_oi->oi.oi_id = le64_to_cpu(src_oi->oi.oi_id);
966 dst_oi->oi.oi_seq = le64_to_cpu(src_oi->oi.oi_seq);
968 fid_le_to_cpu(&dst_oi->oi_fid, &src_oi->oi_fid);
972 struct lu_orphan_rec {
973 /* The MDT-object's FID referenced by the orphan OST-object */
974 struct lu_fid lor_fid;
979 struct lu_orphan_ent {
980 /* The orphan OST-object's FID */
981 struct lu_fid loe_key;
982 struct lu_orphan_rec loe_rec;
984 void lustre_swab_orphan_ent(struct lu_orphan_ent *ent);
987 void lustre_swab_update_ops(struct update_ops *uops, unsigned int op_count);
991 /** \defgroup lu_dir lu_dir
995 * Enumeration of possible directory entry attributes.
997 * Attributes follow directory entry header in the order they appear in this
1000 enum lu_dirent_attrs {
1003 LUDA_64BITHASH = 0x0004,
1005 /* The following attrs are used for MDT internal only,
1006 * not visible to client */
1008 /* Verify the dirent consistency */
1009 LUDA_VERIFY = 0x8000,
1010 /* Only check but not repair the dirent inconsistency */
1011 LUDA_VERIFY_DRYRUN = 0x4000,
1012 /* The dirent has been repaired, or to be repaired (dryrun). */
1013 LUDA_REPAIR = 0x2000,
1014 /* The system is upgraded, has beed or to be repaired (dryrun). */
1015 LUDA_UPGRADE = 0x1000,
1016 /* Ignore this record, go to next directly. */
1017 LUDA_IGNORE = 0x0800,
1020 #define LU_DIRENT_ATTRS_MASK 0xf800
1023 * Layout of readdir pages, as transmitted on wire.
1026 /** valid if LUDA_FID is set. */
1027 struct lu_fid lde_fid;
1028 /** a unique entry identifier: a hash or an offset. */
1030 /** total record length, including all attributes. */
1034 /** optional variable size attributes following this entry.
1035 * taken from enum lu_dirent_attrs.
1038 /** name is followed by the attributes indicated in ->ldp_attrs, in
1039 * their natural order. After the last attribute, padding bytes are
1040 * added to make ->lde_reclen a multiple of 8.
1046 * Definitions of optional directory entry attributes formats.
1048 * Individual attributes do not have their length encoded in a generic way. It
1049 * is assumed that consumer of an attribute knows its format. This means that
1050 * it is impossible to skip over an unknown attribute, except by skipping over all
1051 * remaining attributes (by using ->lde_reclen), which is not too
1052 * constraining, because new server versions will append new attributes at
1053 * the end of an entry.
1057 * Fid directory attribute: a fid of an object referenced by the entry. This
1058 * will be almost always requested by the client and supplied by the server.
1060 * Aligned to 8 bytes.
1062 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
1067 * Aligned to 2 bytes.
1074 __u64 ldp_hash_start;
1078 struct lu_dirent ldp_entries[0];
1081 enum lu_dirpage_flags {
1083 * dirpage contains no entry.
1087 * last entry's lde_hash equals ldp_hash_end.
1089 LDF_COLLIDE = 1 << 1
1092 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
1094 if (le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
1097 return dp->ldp_entries;
1100 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
1102 struct lu_dirent *next;
1104 if (le16_to_cpu(ent->lde_reclen) != 0)
1105 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
1112 static inline size_t lu_dirent_calc_size(size_t namelen, __u16 attr)
1116 if (attr & LUDA_TYPE) {
1117 const size_t align = sizeof(struct luda_type) - 1;
1118 size = (sizeof(struct lu_dirent) + namelen + align) & ~align;
1119 size += sizeof(struct luda_type);
1121 size = sizeof(struct lu_dirent) + namelen;
1123 return (size + 7) & ~7;
1126 #define MDS_DIR_END_OFF 0xfffffffffffffffeULL
1129 * MDS_READPAGE page size
1131 * This is the directory page size packed in MDS_READPAGE RPC.
1132 * It's different than PAGE_CACHE_SIZE because the client needs to
1133 * access the struct lu_dirpage header packed at the beginning of
1134 * the "page" and without this there isn't any way to know find the
1135 * lu_dirpage header is if client and server PAGE_CACHE_SIZE differ.
1137 #define LU_PAGE_SHIFT 12
1138 #define LU_PAGE_SIZE (1UL << LU_PAGE_SHIFT)
1139 #define LU_PAGE_MASK (~(LU_PAGE_SIZE - 1))
1141 #define LU_PAGE_COUNT (1 << (PAGE_CACHE_SHIFT - LU_PAGE_SHIFT))
1145 struct lustre_handle {
1148 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
1150 static inline bool lustre_handle_is_used(const struct lustre_handle *lh)
1152 return lh->cookie != 0;
1155 static inline bool lustre_handle_equal(const struct lustre_handle *lh1,
1156 const struct lustre_handle *lh2)
1158 return lh1->cookie == lh2->cookie;
1161 static inline void lustre_handle_copy(struct lustre_handle *tgt,
1162 const struct lustre_handle *src)
1164 tgt->cookie = src->cookie;
1167 /* flags for lm_flags */
1168 #define MSGHDR_AT_SUPPORT 0x1
1169 #define MSGHDR_CKSUM_INCOMPAT18 0x2
1171 #define lustre_msg lustre_msg_v2
1172 /* we depend on this structure to be 8-byte aligned */
1173 /* this type is only endian-adjusted in lustre_unpack_msg() */
1174 struct lustre_msg_v2 {
1183 __u32 lm_buflens[0];
1186 /* without gss, ptlrpc_body is put at the first buffer. */
1187 #define PTLRPC_NUM_VERSIONS 4
1188 struct ptlrpc_body_v3 {
1189 struct lustre_handle pb_handle;
1194 __u64 pb_last_xid; /* highest replied XID without lower unreplied XID */
1195 __u16 pb_tag; /* virtual slot idx for multiple modifying RPCs */
1198 __u64 pb_last_committed;
1203 __u32 pb_timeout; /* for req, the deadline, for rep, the service est */
1204 __u32 pb_service_time; /* for rep, actual service time */
1207 /* VBR: pre-versions */
1208 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1209 __u64 pb_mbits; /**< match bits for bulk request */
1210 /* padding for future needs */
1211 __u64 pb_padding64_0;
1212 __u64 pb_padding64_1;
1213 __u64 pb_padding64_2;
1214 char pb_jobid[LUSTRE_JOBID_SIZE];
1216 #define ptlrpc_body ptlrpc_body_v3
1218 struct ptlrpc_body_v2 {
1219 struct lustre_handle pb_handle;
1224 __u64 pb_last_xid; /* highest replied XID without lower unreplied XID */
1225 __u16 pb_tag; /* virtual slot idx for multiple modifying RPCs */
1228 __u64 pb_last_committed;
1233 __u32 pb_timeout; /* for req, the deadline, for rep, the service est */
1234 __u32 pb_service_time; /* for rep, actual service time, also used for
1235 net_latency of req */
1238 /* VBR: pre-versions */
1239 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1240 __u64 pb_mbits; /**< unused in V2 */
1241 /* padding for future needs */
1242 __u64 pb_padding64_0;
1243 __u64 pb_padding64_1;
1244 __u64 pb_padding64_2;
1247 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
1249 /* message body offset for lustre_msg_v2 */
1250 /* ptlrpc body offset in all request/reply messages */
1251 #define MSG_PTLRPC_BODY_OFF 0
1253 /* normal request/reply message record offset */
1254 #define REQ_REC_OFF 1
1255 #define REPLY_REC_OFF 1
1257 /* ldlm request message body offset */
1258 #define DLM_LOCKREQ_OFF 1 /* lockreq offset */
1259 #define DLM_REQ_REC_OFF 2 /* normal dlm request record offset */
1261 /* ldlm intent lock message body offset */
1262 #define DLM_INTENT_IT_OFF 2 /* intent lock it offset */
1263 #define DLM_INTENT_REC_OFF 3 /* intent lock record offset */
1265 /* ldlm reply message body offset */
1266 #define DLM_LOCKREPLY_OFF 1 /* lockrep offset */
1267 #define DLM_REPLY_REC_OFF 2 /* reply record offset */
1269 /** only use in req->rq_{req,rep}_swab_mask */
1270 #define MSG_PTLRPC_HEADER_OFF 31
1272 /* Flags that are operation-specific go in the top 16 bits. */
1273 #define MSG_OP_FLAG_MASK 0xffff0000
1274 #define MSG_OP_FLAG_SHIFT 16
1276 /* Flags that apply to all requests are in the bottom 16 bits */
1277 #define MSG_GEN_FLAG_MASK 0x0000ffff
1278 #define MSG_LAST_REPLAY 0x0001
1279 #define MSG_RESENT 0x0002
1280 #define MSG_REPLAY 0x0004
1281 /* #define MSG_AT_SUPPORT 0x0008
1282 * This was used in early prototypes of adaptive timeouts, and while there
1283 * shouldn't be any users of that code there also isn't a need for using this
1284 * bits. Defer usage until at least 1.10 to avoid potential conflict. */
1285 #define MSG_DELAY_REPLAY 0x0010
1286 #define MSG_VERSION_REPLAY 0x0020
1287 #define MSG_REQ_REPLAY_DONE 0x0040
1288 #define MSG_LOCK_REPLAY_DONE 0x0080
1291 * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
1294 #define MSG_CONNECT_RECOVERING 0x00000001
1295 #define MSG_CONNECT_RECONNECT 0x00000002
1296 #define MSG_CONNECT_REPLAYABLE 0x00000004
1297 //#define MSG_CONNECT_PEER 0x8
1298 #define MSG_CONNECT_LIBCLIENT 0x00000010
1299 #define MSG_CONNECT_INITIAL 0x00000020
1300 #define MSG_CONNECT_ASYNC 0x00000040
1301 #define MSG_CONNECT_NEXT_VER 0x00000080 /* use next version of lustre_msg */
1302 #define MSG_CONNECT_TRANSNO 0x00000100 /* report transno */
1305 #define OBD_CONNECT_RDONLY 0x1ULL /*client has read-only access*/
1306 #define OBD_CONNECT_INDEX 0x2ULL /*connect specific LOV idx */
1307 #define OBD_CONNECT_MDS 0x4ULL /*connect from MDT to OST */
1308 #define OBD_CONNECT_GRANT 0x8ULL /*OSC gets grant at connect */
1309 #define OBD_CONNECT_SRVLOCK 0x10ULL /*server takes locks for cli */
1310 #define OBD_CONNECT_VERSION 0x20ULL /*Lustre versions in ocd */
1311 #define OBD_CONNECT_REQPORTAL 0x40ULL /*Separate non-IO req portal */
1312 #define OBD_CONNECT_ACL 0x80ULL /*access control lists */
1313 #define OBD_CONNECT_XATTR 0x100ULL /*client use extended attr */
1314 #define OBD_CONNECT_CROW 0x200ULL /*MDS+OST create obj on write*/
1315 #define OBD_CONNECT_TRUNCLOCK 0x400ULL /*locks on server for punch */
1316 #define OBD_CONNECT_TRANSNO 0x800ULL /*replay sends init transno */
1317 #define OBD_CONNECT_IBITS 0x1000ULL /*support for inodebits locks*/
1318 #define OBD_CONNECT_JOIN 0x2000ULL /*files can be concatenated.
1319 *We do not support JOIN FILE
1320 *anymore, reserve this flags
1321 *just for preventing such bit
1323 #define OBD_CONNECT_ATTRFID 0x4000ULL /*Server can GetAttr By Fid*/
1324 #define OBD_CONNECT_NODEVOH 0x8000ULL /*No open hndl on specl nodes*/
1325 #define OBD_CONNECT_RMT_CLIENT 0x10000ULL /*Remote client */
1326 #define OBD_CONNECT_RMT_CLIENT_FORCE 0x20000ULL /*Remote client by force */
1327 #define OBD_CONNECT_BRW_SIZE 0x40000ULL /*Max bytes per rpc */
1328 #define OBD_CONNECT_QUOTA64 0x80000ULL /*Not used since 2.4 */
1329 #define OBD_CONNECT_MDS_CAPA 0x100000ULL /*MDS capability */
1330 #define OBD_CONNECT_OSS_CAPA 0x200000ULL /*OSS capability */
1331 #define OBD_CONNECT_CANCELSET 0x400000ULL /*Early batched cancels. */
1332 #define OBD_CONNECT_SOM 0x800000ULL /*Size on MDS */
1333 #define OBD_CONNECT_AT 0x1000000ULL /*client uses AT */
1334 #define OBD_CONNECT_LRU_RESIZE 0x2000000ULL /*LRU resize feature. */
1335 #define OBD_CONNECT_MDS_MDS 0x4000000ULL /*MDS-MDS connection */
1336 #define OBD_CONNECT_REAL 0x8000000ULL /*real connection */
1337 #define OBD_CONNECT_CHANGE_QS 0x10000000ULL /*Not used since 2.4 */
1338 #define OBD_CONNECT_CKSUM 0x20000000ULL /*support several cksum algos*/
1339 #define OBD_CONNECT_FID 0x40000000ULL /*FID is supported by server */
1340 #define OBD_CONNECT_VBR 0x80000000ULL /*version based recovery */
1341 #define OBD_CONNECT_LOV_V3 0x100000000ULL /*client supports LOV v3 EA */
1342 #define OBD_CONNECT_GRANT_SHRINK 0x200000000ULL /* support grant shrink */
1343 #define OBD_CONNECT_SKIP_ORPHAN 0x400000000ULL /* don't reuse orphan objids */
1344 #define OBD_CONNECT_MAX_EASIZE 0x800000000ULL /* preserved for large EA */
1345 #define OBD_CONNECT_FULL20 0x1000000000ULL /* it is 2.0 client */
1346 #define OBD_CONNECT_LAYOUTLOCK 0x2000000000ULL /* client uses layout lock */
1347 #define OBD_CONNECT_64BITHASH 0x4000000000ULL /* client supports 64-bits
1349 #define OBD_CONNECT_MAXBYTES 0x8000000000ULL /* max stripe size */
1350 #define OBD_CONNECT_IMP_RECOV 0x10000000000ULL /* imp recovery support */
1351 #define OBD_CONNECT_JOBSTATS 0x20000000000ULL /* jobid in ptlrpc_body */
1352 #define OBD_CONNECT_UMASK 0x40000000000ULL /* create uses client umask */
1353 #define OBD_CONNECT_EINPROGRESS 0x80000000000ULL /* client handles -EINPROGRESS
1354 * RPC error properly */
1355 #define OBD_CONNECT_GRANT_PARAM 0x100000000000ULL/* extra grant params used for
1356 * finer space reservation */
1357 #define OBD_CONNECT_FLOCK_OWNER 0x200000000000ULL /* for the fixed 1.8
1358 * policy and 2.x server */
1359 #define OBD_CONNECT_LVB_TYPE 0x400000000000ULL /* variable type of LVB */
1360 #define OBD_CONNECT_NANOSEC_TIME 0x800000000000ULL /* nanosecond timestamps */
1361 #define OBD_CONNECT_LIGHTWEIGHT 0x1000000000000ULL/* lightweight connection */
1362 #define OBD_CONNECT_SHORTIO 0x2000000000000ULL/* short io */
1363 #define OBD_CONNECT_PINGLESS 0x4000000000000ULL/* pings not required */
1364 #define OBD_CONNECT_FLOCK_DEAD 0x8000000000000ULL/* improved flock deadlock detection */
1365 #define OBD_CONNECT_DISP_STRIPE 0x10000000000000ULL/* create stripe disposition*/
1366 #define OBD_CONNECT_OPEN_BY_FID 0x20000000000000ULL /* open by fid won't pack
1368 #define OBD_CONNECT_LFSCK 0x40000000000000ULL/* support online LFSCK */
1369 #define OBD_CONNECT_UNLINK_CLOSE 0x100000000000000ULL/* close file in unlink */
1370 #define OBD_CONNECT_MULTIMODRPCS 0x200000000000000ULL /* support multiple modify
1372 #define OBD_CONNECT_DIR_STRIPE 0x400000000000000ULL /* striped DNE dir */
1373 /** bulk matchbits is sent within ptlrpc_body */
1374 #define OBD_CONNECT_BULK_MBITS 0x2000000000000000ULL
1376 * Please DO NOT add flag values here before first ensuring that this same
1377 * flag value is not in use on some other branch. Please clear any such
1378 * changes with senior engineers before starting to use a new flag. Then,
1379 * submit a small patch against EVERY branch that ONLY adds the new flag,
1380 * updates obd_connect_names[] for lprocfs_rd_connect_flags(), adds the
1381 * flag to check_obd_connect_data(), and updates wiretests accordingly, so it
1382 * can be approved and landed easily to reserve the flag for future use. */
1384 /* The MNE_SWAB flag is overloading the MDS_MDS bit only for the MGS
1385 * connection. It is a temporary bug fix for Imperative Recovery interop
1386 * between 2.2 and 2.3 x86/ppc nodes, and can be removed when interop for
1387 * 2.2 clients/servers is no longer needed. LU-1252/LU-1644. */
1388 #define OBD_CONNECT_MNE_SWAB OBD_CONNECT_MDS_MDS
1390 #define OCD_HAS_FLAG(ocd, flg) \
1391 (!!((ocd)->ocd_connect_flags & OBD_CONNECT_##flg))
1394 #ifdef HAVE_LRU_RESIZE_SUPPORT
1395 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
1397 #define LRU_RESIZE_CONNECT_FLAG 0
1400 #define MDT_CONNECT_SUPPORTED (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
1401 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
1402 OBD_CONNECT_IBITS | \
1403 OBD_CONNECT_NODEVOH | OBD_CONNECT_ATTRFID | \
1404 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1405 OBD_CONNECT_RMT_CLIENT | \
1406 OBD_CONNECT_RMT_CLIENT_FORCE | \
1407 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_MDS_MDS | \
1408 OBD_CONNECT_FID | LRU_RESIZE_CONNECT_FLAG | \
1409 OBD_CONNECT_VBR | OBD_CONNECT_LOV_V3 | \
1410 OBD_CONNECT_FULL20 | \
1411 OBD_CONNECT_64BITHASH | OBD_CONNECT_JOBSTATS | \
1412 OBD_CONNECT_EINPROGRESS | \
1413 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_UMASK | \
1414 OBD_CONNECT_LVB_TYPE | OBD_CONNECT_LAYOUTLOCK |\
1415 OBD_CONNECT_PINGLESS | OBD_CONNECT_MAX_EASIZE |\
1416 OBD_CONNECT_FLOCK_DEAD | \
1417 OBD_CONNECT_DISP_STRIPE | OBD_CONNECT_LFSCK | \
1418 OBD_CONNECT_OPEN_BY_FID | \
1419 OBD_CONNECT_DIR_STRIPE | \
1420 OBD_CONNECT_BULK_MBITS | \
1421 OBD_CONNECT_MULTIMODRPCS)
1423 #define OST_CONNECT_SUPPORTED (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
1424 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
1425 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
1426 OBD_CONNECT_BRW_SIZE | \
1427 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1428 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_CKSUM | \
1429 OBD_CONNECT_RMT_CLIENT | \
1430 OBD_CONNECT_RMT_CLIENT_FORCE | OBD_CONNECT_VBR | \
1431 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
1432 OBD_CONNECT_GRANT_SHRINK | OBD_CONNECT_FULL20 | \
1433 OBD_CONNECT_64BITHASH | OBD_CONNECT_MAXBYTES | \
1434 OBD_CONNECT_MAX_EASIZE | \
1435 OBD_CONNECT_EINPROGRESS | \
1436 OBD_CONNECT_JOBSTATS | \
1437 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_LVB_TYPE|\
1438 OBD_CONNECT_LAYOUTLOCK | OBD_CONNECT_FID | \
1439 OBD_CONNECT_PINGLESS | OBD_CONNECT_LFSCK | \
1440 OBD_CONNECT_BULK_MBITS)
1441 #define ECHO_CONNECT_SUPPORTED (0)
1442 #define MGS_CONNECT_SUPPORTED (OBD_CONNECT_VERSION | OBD_CONNECT_AT | \
1443 OBD_CONNECT_FULL20 | OBD_CONNECT_IMP_RECOV | \
1444 OBD_CONNECT_MNE_SWAB | OBD_CONNECT_PINGLESS |\
1445 OBD_CONNECT_BULK_MBITS)
1447 /* Features required for this version of the client to work with server */
1448 #define CLIENT_CONNECT_MDT_REQD (OBD_CONNECT_IBITS | OBD_CONNECT_FID | \
1451 /* This structure is used for both request and reply.
1453 * If we eventually have separate connect data for different types, which we
1454 * almost certainly will, then perhaps we stick a union in here. */
1455 struct obd_connect_data {
1456 __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1457 __u32 ocd_version; /* lustre release version number */
1458 __u32 ocd_grant; /* initial cache grant amount (bytes) */
1459 __u32 ocd_index; /* LOV index to connect to */
1460 __u32 ocd_brw_size; /* Maximum BRW size in bytes */
1461 __u64 ocd_ibits_known; /* inode bits this client understands */
1462 __u8 ocd_blocksize; /* log2 of the backend filesystem blocksize */
1463 __u8 ocd_inodespace; /* log2 of the per-inode space consumption */
1464 __u16 ocd_grant_extent; /* per-extent grant overhead, in 1K blocks */
1465 __u32 ocd_unused; /* also fix lustre_swab_connect */
1466 __u64 ocd_transno; /* first transno from client to be replayed */
1467 __u32 ocd_group; /* MDS group on OST */
1468 __u32 ocd_cksum_types; /* supported checksum algorithms */
1469 __u32 ocd_max_easize; /* How big LOV EA can be on MDS */
1470 __u32 ocd_instance; /* instance # of this target */
1471 __u64 ocd_maxbytes; /* Maximum stripe size in bytes */
1472 /* Fields after ocd_maxbytes are only accessible by the receiver
1473 * if the corresponding flag in ocd_connect_flags is set. Accessing
1474 * any field after ocd_maxbytes on the receiver without a valid flag
1475 * may result in out-of-bound memory access and kernel oops. */
1476 __u16 ocd_maxmodrpcs; /* Maximum modify RPCs in parallel */
1477 __u16 padding0; /* added 2.1.0. also fix lustre_swab_connect */
1478 __u32 padding1; /* added 2.1.0. also fix lustre_swab_connect */
1479 __u64 padding2; /* added 2.1.0. also fix lustre_swab_connect */
1480 __u64 padding3; /* added 2.1.0. also fix lustre_swab_connect */
1481 __u64 padding4; /* added 2.1.0. also fix lustre_swab_connect */
1482 __u64 padding5; /* added 2.1.0. also fix lustre_swab_connect */
1483 __u64 padding6; /* added 2.1.0. also fix lustre_swab_connect */
1484 __u64 padding7; /* added 2.1.0. also fix lustre_swab_connect */
1485 __u64 padding8; /* added 2.1.0. also fix lustre_swab_connect */
1486 __u64 padding9; /* added 2.1.0. also fix lustre_swab_connect */
1487 __u64 paddingA; /* added 2.1.0. also fix lustre_swab_connect */
1488 __u64 paddingB; /* added 2.1.0. also fix lustre_swab_connect */
1489 __u64 paddingC; /* added 2.1.0. also fix lustre_swab_connect */
1490 __u64 paddingD; /* added 2.1.0. also fix lustre_swab_connect */
1491 __u64 paddingE; /* added 2.1.0. also fix lustre_swab_connect */
1492 __u64 paddingF; /* added 2.1.0. also fix lustre_swab_connect */
1495 * Please DO NOT use any fields here before first ensuring that this same
1496 * field is not in use on some other branch. Please clear any such changes
1497 * with senior engineers before starting to use a new field. Then, submit
1498 * a small patch against EVERY branch that ONLY adds the new field along with
1499 * the matching OBD_CONNECT flag, so that can be approved and landed easily to
1500 * reserve the flag for future use. */
1503 extern void lustre_swab_connect(struct obd_connect_data *ocd);
1506 * Supported checksum algorithms. Up to 32 checksum types are supported.
1507 * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
1508 * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
1509 * algorithm and also the OBD_FL_CKSUM* flags.
1512 OBD_CKSUM_CRC32 = 0x00000001,
1513 OBD_CKSUM_ADLER = 0x00000002,
1514 OBD_CKSUM_CRC32C= 0x00000004,
1518 * OST requests: OBDO & OBD request records
1523 OST_REPLY = 0, /* reply ? */
1539 OST_QUOTACHECK = 18, /* not used since 2.4 */
1541 OST_QUOTA_ADJUST_QUNIT = 20, /* not used since 2.4 */
1544 #define OST_FIRST_OPC OST_REPLY
1547 OBD_FL_INLINEDATA = 0x00000001,
1548 OBD_FL_OBDMDEXISTS = 0x00000002,
1549 OBD_FL_DELORPHAN = 0x00000004, /* if set in o_flags delete orphans */
1550 OBD_FL_NORPC = 0x00000008, /* set in o_flags do in OSC not OST */
1551 OBD_FL_IDONLY = 0x00000010, /* set in o_flags only adjust obj id*/
1552 OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
1553 OBD_FL_DEBUG_CHECK = 0x00000040, /* echo client/server debug check */
1554 OBD_FL_NO_USRQUOTA = 0x00000100, /* the object's owner is over quota */
1555 OBD_FL_NO_GRPQUOTA = 0x00000200, /* the object's group is over quota */
1556 OBD_FL_CREATE_CROW = 0x00000400, /* object should be create on write */
1557 OBD_FL_SRVLOCK = 0x00000800, /* delegate DLM locking to server */
1558 OBD_FL_CKSUM_CRC32 = 0x00001000, /* CRC32 checksum type */
1559 OBD_FL_CKSUM_ADLER = 0x00002000, /* ADLER checksum type */
1560 OBD_FL_CKSUM_CRC32C = 0x00004000, /* CRC32C checksum type */
1561 OBD_FL_CKSUM_RSVD2 = 0x00008000, /* for future cksum types */
1562 OBD_FL_CKSUM_RSVD3 = 0x00010000, /* for future cksum types */
1563 OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
1564 OBD_FL_MMAP = 0x00040000, /* object is mmapped on the client.
1565 * XXX: obsoleted - reserved for old
1566 * clients prior than 2.2 */
1567 OBD_FL_RECOV_RESEND = 0x00080000, /* recoverable resent */
1568 OBD_FL_NOSPC_BLK = 0x00100000, /* no more block space on OST */
1569 OBD_FL_FLUSH = 0x00200000, /* flush pages on the OST */
1570 OBD_FL_SHORT_IO = 0x00400000, /* short io request */
1572 /* Note that while these checksum values are currently separate bits,
1573 * in 2.x we can actually allow all values from 1-31 if we wanted. */
1574 OBD_FL_CKSUM_ALL = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER |
1575 OBD_FL_CKSUM_CRC32C,
1577 /* mask for local-only flag, which won't be sent over network */
1578 OBD_FL_LOCAL_MASK = 0xF0000000,
1582 * All LOV EA magics should have the same postfix, if some new version
1583 * Lustre instroduces new LOV EA magic, then when down-grade to an old
1584 * Lustre, even though the old version system does not recognizes such
1585 * new magic, it still can distinguish the corrupted cases by checking
1586 * the magic's postfix.
1588 #define LOV_MAGIC_MAGIC 0x0BD0
1589 #define LOV_MAGIC_MASK 0xFFFF
1591 #define LOV_MAGIC_V1 (0x0BD10000 | LOV_MAGIC_MAGIC)
1592 #define LOV_MAGIC_JOIN_V1 (0x0BD20000 | LOV_MAGIC_MAGIC)
1593 #define LOV_MAGIC_V3 (0x0BD30000 | LOV_MAGIC_MAGIC)
1594 #define LOV_MAGIC_MIGRATE (0x0BD40000 | LOV_MAGIC_MAGIC)
1595 /* reserved for specifying OSTs */
1596 #define LOV_MAGIC_SPECIFIC (0x0BD50000 | LOV_MAGIC_MAGIC)
1597 #define LOV_MAGIC LOV_MAGIC_V1
1600 * magic for fully defined striping
1601 * the idea is that we should have different magics for striping "hints"
1602 * (struct lov_user_md_v[13]) and defined ready-to-use striping (struct
1603 * lov_mds_md_v[13]). at the moment the magics are used in wire protocol,
1604 * we can't just change it w/o long way preparation, but we still need a
1605 * mechanism to allow LOD to differentiate hint versus ready striping.
1606 * so, at the moment we do a trick: MDT knows what to expect from request
1607 * depending on the case (replay uses ready striping, non-replay req uses
1608 * hints), so MDT replaces magic with appropriate one and now LOD can
1609 * easily understand what's inside -bzzz
1611 #define LOV_MAGIC_V1_DEF 0x0CD10BD0
1612 #define LOV_MAGIC_V3_DEF 0x0CD30BD0
1614 #define lov_pattern(pattern) (pattern & ~LOV_PATTERN_F_MASK)
1615 #define lov_pattern_flags(pattern) (pattern & LOV_PATTERN_F_MASK)
1617 #define lov_ost_data lov_ost_data_v1
1618 struct lov_ost_data_v1 { /* per-stripe data structure (little-endian)*/
1619 struct ost_id l_ost_oi; /* OST object ID */
1620 __u32 l_ost_gen; /* generation of this l_ost_idx */
1621 __u32 l_ost_idx; /* OST index in LOV (lov_tgt_desc->tgts) */
1624 #define lov_mds_md lov_mds_md_v1
1625 struct lov_mds_md_v1 { /* LOV EA mds/wire data (little-endian) */
1626 __u32 lmm_magic; /* magic number = LOV_MAGIC_V1 */
1627 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1628 struct ost_id lmm_oi; /* LOV object ID */
1629 __u32 lmm_stripe_size; /* size of stripe in bytes */
1630 /* lmm_stripe_count used to be __u32 */
1631 __u16 lmm_stripe_count; /* num stripes in use for this object */
1632 __u16 lmm_layout_gen; /* layout generation number */
1633 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1637 * Sigh, because pre-2.4 uses
1638 * struct lov_mds_md_v1 {
1640 * __u64 lmm_object_id;
1641 * __u64 lmm_object_seq;
1644 * to identify the LOV(MDT) object, and lmm_object_seq will
1645 * be normal_fid, which make it hard to combine these conversion
1646 * to ostid_to FID. so we will do lmm_oi/fid conversion separately
1648 * We can tell the lmm_oi by this way,
1649 * 1.8: lmm_object_id = {inode}, lmm_object_gr = 0
1650 * 2.1: lmm_object_id = {oid < 128k}, lmm_object_seq = FID_SEQ_NORMAL
1651 * 2.4: lmm_oi.f_seq = FID_SEQ_NORMAL, lmm_oi.f_oid = {oid < 128k},
1654 * But currently lmm_oi/lsm_oi does not have any "real" usages,
1655 * except for printing some information, and the user can always
1656 * get the real FID from LMA, besides this multiple case check might
1657 * make swab more complicate. So we will keep using id/seq for lmm_oi.
1660 static inline void fid_to_lmm_oi(const struct lu_fid *fid,
1663 oi->oi.oi_id = fid_oid(fid);
1664 oi->oi.oi_seq = fid_seq(fid);
1667 static inline void lmm_oi_set_seq(struct ost_id *oi, __u64 seq)
1669 oi->oi.oi_seq = seq;
1672 static inline void lmm_oi_set_id(struct ost_id *oi, __u64 oid)
1677 static inline __u64 lmm_oi_id(const struct ost_id *oi)
1679 return oi->oi.oi_id;
1682 static inline __u64 lmm_oi_seq(const struct ost_id *oi)
1684 return oi->oi.oi_seq;
1687 static inline void lmm_oi_le_to_cpu(struct ost_id *dst_oi,
1688 const struct ost_id *src_oi)
1690 dst_oi->oi.oi_id = le64_to_cpu(src_oi->oi.oi_id);
1691 dst_oi->oi.oi_seq = le64_to_cpu(src_oi->oi.oi_seq);
1694 static inline void lmm_oi_cpu_to_le(struct ost_id *dst_oi,
1695 const struct ost_id *src_oi)
1697 dst_oi->oi.oi_id = cpu_to_le64(src_oi->oi.oi_id);
1698 dst_oi->oi.oi_seq = cpu_to_le64(src_oi->oi.oi_seq);
1701 /* extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm); */
1703 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
1704 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
1706 /* This is the default MDT reply size allocated, should the striping be bigger,
1707 * it will be reallocated in mdt_fix_reply.
1708 * 100 stripes is a bit less than 2.5k of data */
1709 #define DEF_REP_MD_SIZE (sizeof(struct lov_mds_md) + \
1710 100 * sizeof(struct lov_ost_data))
1712 #define XATTR_NAME_ACL_ACCESS "system.posix_acl_access"
1713 #define XATTR_NAME_ACL_DEFAULT "system.posix_acl_default"
1714 #define XATTR_USER_PREFIX "user."
1715 #define XATTR_TRUSTED_PREFIX "trusted."
1716 #define XATTR_SECURITY_PREFIX "security."
1718 #define XATTR_NAME_LOV "trusted.lov"
1719 #define XATTR_NAME_LMA "trusted.lma"
1720 #define XATTR_NAME_LMV "trusted.lmv"
1721 #define XATTR_NAME_DEFAULT_LMV "trusted.dmv"
1722 #define XATTR_NAME_LINK "trusted.link"
1723 #define XATTR_NAME_FID "trusted.fid"
1724 #define XATTR_NAME_VERSION "trusted.version"
1725 #define XATTR_NAME_SOM "trusted.som"
1726 #define XATTR_NAME_HSM "trusted.hsm"
1727 #define XATTR_NAME_LFSCK_BITMAP "trusted.lfsck_bitmap"
1728 #define XATTR_NAME_DUMMY "trusted.dummy"
1730 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 8, 53, 0)
1731 # define XATTR_NAME_LFSCK_NAMESPACE_OLD "trusted.lfsck_namespace"
1734 #define XATTR_NAME_LFSCK_NAMESPACE "trusted.lfsck_ns"
1735 #define XATTR_NAME_MAX_LEN 32 /* increase this, if there is longer name. */
1737 struct lov_mds_md_v3 { /* LOV EA mds/wire data (little-endian) */
1738 __u32 lmm_magic; /* magic number = LOV_MAGIC_V3 */
1739 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1740 struct ost_id lmm_oi; /* LOV object ID */
1741 __u32 lmm_stripe_size; /* size of stripe in bytes */
1742 /* lmm_stripe_count used to be __u32 */
1743 __u16 lmm_stripe_count; /* num stripes in use for this object */
1744 __u16 lmm_layout_gen; /* layout generation number */
1745 char lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* must be 32bit aligned */
1746 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1749 static inline __u32 lov_mds_md_size(__u16 stripes, __u32 lmm_magic)
1751 if (lmm_magic == LOV_MAGIC_V3)
1752 return sizeof(struct lov_mds_md_v3) +
1753 stripes * sizeof(struct lov_ost_data_v1);
1755 return sizeof(struct lov_mds_md_v1) +
1756 stripes * sizeof(struct lov_ost_data_v1);
1760 lov_mds_md_max_stripe_count(size_t buf_size, __u32 lmm_magic)
1762 switch (lmm_magic) {
1763 case LOV_MAGIC_V1: {
1764 struct lov_mds_md_v1 lmm;
1766 if (buf_size < sizeof(lmm))
1769 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1771 case LOV_MAGIC_V3: {
1772 struct lov_mds_md_v3 lmm;
1774 if (buf_size < sizeof(lmm))
1777 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1784 #define OBD_MD_FLID (0x00000001ULL) /* object ID */
1785 #define OBD_MD_FLATIME (0x00000002ULL) /* access time */
1786 #define OBD_MD_FLMTIME (0x00000004ULL) /* data modification time */
1787 #define OBD_MD_FLCTIME (0x00000008ULL) /* change time */
1788 #define OBD_MD_FLSIZE (0x00000010ULL) /* size */
1789 #define OBD_MD_FLBLOCKS (0x00000020ULL) /* allocated blocks count */
1790 #define OBD_MD_FLBLKSZ (0x00000040ULL) /* block size */
1791 #define OBD_MD_FLMODE (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1792 #define OBD_MD_FLTYPE (0x00000100ULL) /* object type (mode & S_IFMT) */
1793 #define OBD_MD_FLUID (0x00000200ULL) /* user ID */
1794 #define OBD_MD_FLGID (0x00000400ULL) /* group ID */
1795 #define OBD_MD_FLFLAGS (0x00000800ULL) /* flags word */
1796 #define OBD_MD_FLNLINK (0x00002000ULL) /* link count */
1797 #define OBD_MD_FLGENER (0x00004000ULL) /* generation number */
1798 /*#define OBD_MD_FLINLINE (0x00008000ULL) inline data. used until 1.6.5 */
1799 #define OBD_MD_FLRDEV (0x00010000ULL) /* device number */
1800 #define OBD_MD_FLEASIZE (0x00020000ULL) /* extended attribute data */
1801 #define OBD_MD_LINKNAME (0x00040000ULL) /* symbolic link target */
1802 #define OBD_MD_FLHANDLE (0x00080000ULL) /* file/lock handle */
1803 #define OBD_MD_FLCKSUM (0x00100000ULL) /* bulk data checksum */
1804 #define OBD_MD_FLQOS (0x00200000ULL) /* quality of service stats */
1805 /*#define OBD_MD_FLOSCOPQ (0x00400000ULL) osc opaque data, never used */
1806 /* OBD_MD_FLCOOKIE (0x00800000ULL) obsolete in 2.8 */
1807 #define OBD_MD_FLGROUP (0x01000000ULL) /* group */
1808 #define OBD_MD_FLFID (0x02000000ULL) /* ->ost write inline fid */
1809 #define OBD_MD_FLEPOCH (0x04000000ULL) /* ->ost write with ioepoch */
1810 /* ->mds if epoch opens or closes */
1811 #define OBD_MD_FLGRANT (0x08000000ULL) /* ost preallocation space grant */
1812 #define OBD_MD_FLDIREA (0x10000000ULL) /* dir's extended attribute data */
1813 #define OBD_MD_FLUSRQUOTA (0x20000000ULL) /* over quota flags sent from ost */
1814 #define OBD_MD_FLGRPQUOTA (0x40000000ULL) /* over quota flags sent from ost */
1815 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1817 #define OBD_MD_MDS (0x0000000100000000ULL) /* where an inode lives on */
1818 #define OBD_MD_REINT (0x0000000200000000ULL) /* reintegrate oa */
1819 #define OBD_MD_MEA (0x0000000400000000ULL) /* CMD split EA */
1820 #define OBD_MD_TSTATE (0x0000000800000000ULL) /* transient state field */
1822 #define OBD_MD_FLXATTR (0x0000001000000000ULL) /* xattr */
1823 #define OBD_MD_FLXATTRLS (0x0000002000000000ULL) /* xattr list */
1824 #define OBD_MD_FLXATTRRM (0x0000004000000000ULL) /* xattr remove */
1825 #define OBD_MD_FLACL (0x0000008000000000ULL) /* ACL */
1826 #define OBD_MD_FLRMTPERM (0x0000010000000000ULL) /* remote permission */
1827 #define OBD_MD_FLMDSCAPA (0x0000020000000000ULL) /* MDS capability */
1828 #define OBD_MD_FLOSSCAPA (0x0000040000000000ULL) /* OSS capability */
1829 #define OBD_MD_FLCKSPLIT (0x0000080000000000ULL) /* Check split on server */
1830 #define OBD_MD_FLCROSSREF (0x0000100000000000ULL) /* Cross-ref case */
1831 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1832 * under lock; for xattr
1833 * requests means the
1834 * client holds the lock */
1835 #define OBD_MD_FLOBJCOUNT (0x0000400000000000ULL) /* for multiple destroy */
1837 #define OBD_MD_FLRMTLSETFACL (0x0001000000000000ULL) /* lfs lsetfacl case */
1838 #define OBD_MD_FLRMTLGETFACL (0x0002000000000000ULL) /* lfs lgetfacl case */
1839 #define OBD_MD_FLRMTRSETFACL (0x0004000000000000ULL) /* lfs rsetfacl case */
1840 #define OBD_MD_FLRMTRGETFACL (0x0008000000000000ULL) /* lfs rgetfacl case */
1842 #define OBD_MD_FLDATAVERSION (0x0010000000000000ULL) /* iversion sum */
1843 #define OBD_MD_CLOSE_INTENT_EXECED (0x0020000000000000ULL) /* close intent
1846 #define OBD_MD_DEFAULT_MEA (0x0040000000000000ULL) /* default MEA */
1848 #define OBD_MD_FLGETATTR (OBD_MD_FLID | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1849 OBD_MD_FLCTIME | OBD_MD_FLSIZE | OBD_MD_FLBLKSZ | \
1850 OBD_MD_FLMODE | OBD_MD_FLTYPE | OBD_MD_FLUID | \
1851 OBD_MD_FLGID | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1852 OBD_MD_FLGENER | OBD_MD_FLRDEV | OBD_MD_FLGROUP)
1854 #define OBD_MD_FLXATTRALL (OBD_MD_FLXATTR | OBD_MD_FLXATTRLS)
1856 /* don't forget obdo_fid which is way down at the bottom so it can
1857 * come after the definition of llog_cookie */
1861 HSS_CLEARMASK = 0x02,
1862 HSS_ARCHIVE_ID = 0x04,
1865 struct hsm_state_set {
1867 __u32 hss_archive_id;
1869 __u64 hss_clearmask;
1872 extern void lustre_swab_hsm_user_state(struct hsm_user_state *hus);
1873 extern void lustre_swab_hsm_state_set(struct hsm_state_set *hss);
1875 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
1877 /* ost_body.data values for OST_BRW */
1879 #define OBD_BRW_READ 0x01
1880 #define OBD_BRW_WRITE 0x02
1881 #define OBD_BRW_RWMASK (OBD_BRW_READ | OBD_BRW_WRITE)
1882 #define OBD_BRW_SYNC 0x08 /* this page is a part of synchronous
1883 * transfer and is not accounted in
1885 #define OBD_BRW_CHECK 0x10
1886 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
1887 #define OBD_BRW_GRANTED 0x40 /* the ost manages this */
1888 #define OBD_BRW_NOCACHE 0x80 /* this page is a part of non-cached IO */
1889 #define OBD_BRW_NOQUOTA 0x100
1890 #define OBD_BRW_SRVLOCK 0x200 /* Client holds no lock over this page */
1891 #define OBD_BRW_ASYNC 0x400 /* Server may delay commit to disk */
1892 #define OBD_BRW_MEMALLOC 0x800 /* Client runs in the "kswapd" context */
1893 #define OBD_BRW_OVER_USRQUOTA 0x1000 /* Running out of user quota */
1894 #define OBD_BRW_OVER_GRPQUOTA 0x2000 /* Running out of group quota */
1895 #define OBD_BRW_SOFT_SYNC 0x4000 /* This flag notifies the server
1896 * that the client is running low on
1897 * space for unstable pages; asking
1898 * it to sync quickly */
1900 #define OBD_OBJECT_EOF LUSTRE_EOF
1902 #define OST_MIN_PRECREATE 32
1903 #define OST_MAX_PRECREATE 20000
1906 struct ost_id ioo_oid; /* object ID, if multi-obj BRW */
1907 __u32 ioo_max_brw; /* low 16 bits were o_mode before 2.4,
1908 * now (PTLRPC_BULK_OPS_COUNT - 1) in
1909 * high 16 bits in 2.4 and later */
1910 __u32 ioo_bufcnt; /* number of niobufs for this object */
1913 #define IOOBJ_MAX_BRW_BITS 16
1914 #define IOOBJ_TYPE_MASK ((1U << IOOBJ_MAX_BRW_BITS) - 1)
1915 #define ioobj_max_brw_get(ioo) (((ioo)->ioo_max_brw >> IOOBJ_MAX_BRW_BITS) + 1)
1916 #define ioobj_max_brw_set(ioo, num) \
1917 do { (ioo)->ioo_max_brw = ((num) - 1) << IOOBJ_MAX_BRW_BITS; } while (0)
1919 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
1921 /* multiple of 8 bytes => can array */
1922 struct niobuf_remote {
1928 void lustre_swab_niobuf_remote(struct niobuf_remote *nbr);
1930 /* lock value block communicated between the filter and llite */
1932 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1933 * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1934 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1935 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1936 #define OST_LVB_IS_ERR(blocks) \
1937 ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1938 #define OST_LVB_SET_ERR(blocks, rc) \
1939 do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1940 #define OST_LVB_GET_ERR(blocks) (int)(blocks - OST_LVB_ERR_INIT)
1950 extern void lustre_swab_ost_lvb_v1(struct ost_lvb_v1 *lvb);
1964 extern void lustre_swab_ost_lvb(struct ost_lvb *lvb);
1967 * lquota data structures
1970 #ifndef QUOTABLOCK_BITS
1971 # define QUOTABLOCK_BITS LUSTRE_QUOTABLOCK_BITS
1974 #ifndef QUOTABLOCK_SIZE
1975 # define QUOTABLOCK_SIZE LUSTRE_QUOTABLOCK_SIZE
1979 # define toqb lustre_stoqb
1982 /* The lquota_id structure is an union of all the possible identifier types that
1983 * can be used with quota, this includes:
1986 * - a FID which can be used for per-directory quota in the future */
1988 struct lu_fid qid_fid; /* FID for per-directory quota */
1989 __u64 qid_uid; /* user identifier */
1990 __u64 qid_gid; /* group identifier */
1993 /* quotactl management */
1994 struct obd_quotactl {
1996 __u32 qc_type; /* see Q_* flag below */
1999 struct obd_dqinfo qc_dqinfo;
2000 struct obd_dqblk qc_dqblk;
2003 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
2005 #define Q_COPY(out, in, member) (out)->member = (in)->member
2007 #define QCTL_COPY(out, in) \
2009 Q_COPY(out, in, qc_cmd); \
2010 Q_COPY(out, in, qc_type); \
2011 Q_COPY(out, in, qc_id); \
2012 Q_COPY(out, in, qc_stat); \
2013 Q_COPY(out, in, qc_dqinfo); \
2014 Q_COPY(out, in, qc_dqblk); \
2017 /* Body of quota request used for quota acquire/release RPCs between quota
2018 * master (aka QMT) and slaves (ak QSD). */
2020 struct lu_fid qb_fid; /* FID of global index packing the pool ID
2021 * and type (data or metadata) as well as
2022 * the quota type (user or group). */
2023 union lquota_id qb_id; /* uid or gid or directory FID */
2024 __u32 qb_flags; /* see below */
2026 __u64 qb_count; /* acquire/release count (kbytes/inodes) */
2027 __u64 qb_usage; /* current slave usage (kbytes/inodes) */
2028 __u64 qb_slv_ver; /* slave index file version */
2029 struct lustre_handle qb_lockh; /* per-ID lock handle */
2030 struct lustre_handle qb_glb_lockh; /* global lock handle */
2031 __u64 qb_padding1[4];
2034 /* When the quota_body is used in the reply of quota global intent
2035 * lock (IT_QUOTA_CONN) reply, qb_fid contains slave index file FID. */
2036 #define qb_slv_fid qb_fid
2037 /* qb_usage is the current qunit (in kbytes/inodes) when quota_body is used in
2039 #define qb_qunit qb_usage
2041 #define QUOTA_DQACQ_FL_ACQ 0x1 /* acquire quota */
2042 #define QUOTA_DQACQ_FL_PREACQ 0x2 /* pre-acquire */
2043 #define QUOTA_DQACQ_FL_REL 0x4 /* release quota */
2044 #define QUOTA_DQACQ_FL_REPORT 0x8 /* report usage */
2046 extern void lustre_swab_quota_body(struct quota_body *b);
2048 /* Quota types currently supported */
2050 LQUOTA_TYPE_USR = 0x00, /* maps to USRQUOTA */
2051 LQUOTA_TYPE_GRP = 0x01, /* maps to GRPQUOTA */
2055 /* There are 2 different resource types on which a quota limit can be enforced:
2056 * - inodes on the MDTs
2057 * - blocks on the OSTs */
2059 LQUOTA_RES_MD = 0x01, /* skip 0 to avoid null oid in FID */
2060 LQUOTA_RES_DT = 0x02,
2062 LQUOTA_FIRST_RES = LQUOTA_RES_MD
2064 #define LQUOTA_NR_RES (LQUOTA_LAST_RES - LQUOTA_FIRST_RES + 1)
2067 * Space accounting support
2068 * Format of an accounting record, providing disk usage information for a given
2071 struct lquota_acct_rec { /* 16 bytes */
2072 __u64 bspace; /* current space in use */
2073 __u64 ispace; /* current # inodes in use */
2077 * Global quota index support
2078 * Format of a global record, providing global quota settings for a given quota
2081 struct lquota_glb_rec { /* 32 bytes */
2082 __u64 qbr_hardlimit; /* quota hard limit, in #inodes or kbytes */
2083 __u64 qbr_softlimit; /* quota soft limit, in #inodes or kbytes */
2084 __u64 qbr_time; /* grace time, in seconds */
2085 __u64 qbr_granted; /* how much is granted to slaves, in #inodes or
2090 * Slave index support
2091 * Format of a slave record, recording how much space is granted to a given
2094 struct lquota_slv_rec { /* 8 bytes */
2095 __u64 qsr_granted; /* space granted to the slave for the key=ID,
2096 * in #inodes or kbytes */
2099 /* Data structures associated with the quota locks */
2101 /* Glimpse descriptor used for the index & per-ID quota locks */
2102 struct ldlm_gl_lquota_desc {
2103 union lquota_id gl_id; /* quota ID subject to the glimpse */
2104 __u64 gl_flags; /* see LQUOTA_FL* below */
2105 __u64 gl_ver; /* new index version */
2106 __u64 gl_hardlimit; /* new hardlimit or qunit value */
2107 __u64 gl_softlimit; /* new softlimit */
2111 #define gl_qunit gl_hardlimit /* current qunit value used when
2112 * glimpsing per-ID quota locks */
2114 /* quota glimpse flags */
2115 #define LQUOTA_FL_EDQUOT 0x1 /* user/group out of quota space on QMT */
2117 /* LVB used with quota (global and per-ID) locks */
2119 __u64 lvb_flags; /* see LQUOTA_FL* above */
2120 __u64 lvb_id_may_rel; /* space that might be released later */
2121 __u64 lvb_id_rel; /* space released by the slave for this ID */
2122 __u64 lvb_id_qunit; /* current qunit value */
2126 extern void lustre_swab_lquota_lvb(struct lquota_lvb *lvb);
2128 /* LVB used with global quota lock */
2129 #define lvb_glb_ver lvb_id_may_rel /* current version of the global index */
2137 #define QUOTA_FIRST_OPC QUOTA_DQACQ
2146 MDS_GETATTR_NAME = 34,
2151 MDS_DISCONNECT = 39,
2154 MDS_PIN = 42, /* obsolete, never used in a release */
2155 MDS_UNPIN = 43, /* obsolete, never used in a release */
2157 MDS_DONE_WRITING = 45, /* obsolete since 2.8.0 */
2159 MDS_QUOTACHECK = 47, /* not used since 2.4 */
2162 MDS_SETXATTR = 50, /* obsolete, now it's MDS_REINT op */
2164 MDS_IS_SUBDIR = 52, /* obsolete, never used in a release */
2166 MDS_HSM_STATE_GET = 54,
2167 MDS_HSM_STATE_SET = 55,
2168 MDS_HSM_ACTION = 56,
2169 MDS_HSM_PROGRESS = 57,
2170 MDS_HSM_REQUEST = 58,
2171 MDS_HSM_CT_REGISTER = 59,
2172 MDS_HSM_CT_UNREGISTER = 60,
2173 MDS_SWAP_LAYOUTS = 61,
2177 #define MDS_FIRST_OPC MDS_GETATTR
2180 /* opcodes for object update */
2186 #define OUT_UPDATE_FIRST_OPC OUT_UPDATE
2203 } mds_reint_t, mdt_reint_t;
2205 extern void lustre_swab_generic_32s (__u32 *val);
2207 /* the disposition of the intent outlines what was executed */
2208 #define DISP_IT_EXECD 0x00000001
2209 #define DISP_LOOKUP_EXECD 0x00000002
2210 #define DISP_LOOKUP_NEG 0x00000004
2211 #define DISP_LOOKUP_POS 0x00000008
2212 #define DISP_OPEN_CREATE 0x00000010
2213 #define DISP_OPEN_OPEN 0x00000020
2214 #define DISP_ENQ_COMPLETE 0x00400000 /* obsolete and unused */
2215 #define DISP_ENQ_OPEN_REF 0x00800000
2216 #define DISP_ENQ_CREATE_REF 0x01000000
2217 #define DISP_OPEN_LOCK 0x02000000
2218 #define DISP_OPEN_LEASE 0x04000000
2219 #define DISP_OPEN_STRIPE 0x08000000
2220 #define DISP_OPEN_DENY 0x10000000
2222 /* INODE LOCK PARTS */
2223 #define MDS_INODELOCK_LOOKUP 0x000001 /* For namespace, dentry etc, and also
2224 * was used to protect permission (mode,
2225 * owner, group etc) before 2.4. */
2226 #define MDS_INODELOCK_UPDATE 0x000002 /* size, links, timestamps */
2227 #define MDS_INODELOCK_OPEN 0x000004 /* For opened files */
2228 #define MDS_INODELOCK_LAYOUT 0x000008 /* for layout */
2230 /* The PERM bit is added int 2.4, and it is used to protect permission(mode,
2231 * owner, group, acl etc), so to separate the permission from LOOKUP lock.
2232 * Because for remote directories(in DNE), these locks will be granted by
2233 * different MDTs(different ldlm namespace).
2235 * For local directory, MDT will always grant UPDATE_LOCK|PERM_LOCK together.
2236 * For Remote directory, the master MDT, where the remote directory is, will
2237 * grant UPDATE_LOCK|PERM_LOCK, and the remote MDT, where the name entry is,
2238 * will grant LOOKUP_LOCK. */
2239 #define MDS_INODELOCK_PERM 0x000010
2240 #define MDS_INODELOCK_XATTR 0x000020 /* extended attributes */
2242 #define MDS_INODELOCK_MAXSHIFT 5
2243 /* This FULL lock is useful to take on unlink sort of operations */
2244 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
2246 extern void lustre_swab_ll_fid (struct ll_fid *fid);
2248 /* NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
2249 * but was moved into name[1] along with the OID to avoid consuming the
2250 * name[2,3] fields that need to be used for the quota id (also a FID). */
2252 LUSTRE_RES_ID_SEQ_OFF = 0,
2253 LUSTRE_RES_ID_VER_OID_OFF = 1,
2254 LUSTRE_RES_ID_WAS_VER_OFF = 2, /* see note above */
2255 LUSTRE_RES_ID_QUOTA_SEQ_OFF = 2,
2256 LUSTRE_RES_ID_QUOTA_VER_OID_OFF = 3,
2257 LUSTRE_RES_ID_HSH_OFF = 3
2260 #define MDS_STATUS_CONN 1
2261 #define MDS_STATUS_LOV 2
2263 #define LUSTRE_BFLAG_UNCOMMITTED_WRITES 0x1
2265 /* these should be identical to their EXT4_*_FL counterparts, they are
2266 * redefined here only to avoid dragging in fs/ext4/ext4.h */
2267 #define LUSTRE_SYNC_FL 0x00000008 /* Synchronous updates */
2268 #define LUSTRE_IMMUTABLE_FL 0x00000010 /* Immutable file */
2269 #define LUSTRE_APPEND_FL 0x00000020 /* writes to file may only append */
2270 #define LUSTRE_NOATIME_FL 0x00000080 /* do not update atime */
2271 #define LUSTRE_DIRSYNC_FL 0x00010000 /* dirsync behaviour (dir only) */
2274 /* Convert wire LUSTRE_*_FL to corresponding client local VFS S_* values
2275 * for the client inode i_flags. The LUSTRE_*_FL are the Lustre wire
2276 * protocol equivalents of LDISKFS_*_FL values stored on disk, while
2277 * the S_* flags are kernel-internal values that change between kernel
2278 * versions. These flags are set/cleared via FSFILT_IOC_{GET,SET}_FLAGS.
2279 * See b=16526 for a full history. */
2280 static inline int ll_ext_to_inode_flags(int flags)
2282 return (((flags & LUSTRE_SYNC_FL) ? S_SYNC : 0) |
2283 ((flags & LUSTRE_NOATIME_FL) ? S_NOATIME : 0) |
2284 ((flags & LUSTRE_APPEND_FL) ? S_APPEND : 0) |
2285 #if defined(S_DIRSYNC)
2286 ((flags & LUSTRE_DIRSYNC_FL) ? S_DIRSYNC : 0) |
2288 ((flags & LUSTRE_IMMUTABLE_FL) ? S_IMMUTABLE : 0));
2291 static inline int ll_inode_to_ext_flags(int iflags)
2293 return (((iflags & S_SYNC) ? LUSTRE_SYNC_FL : 0) |
2294 ((iflags & S_NOATIME) ? LUSTRE_NOATIME_FL : 0) |
2295 ((iflags & S_APPEND) ? LUSTRE_APPEND_FL : 0) |
2296 #if defined(S_DIRSYNC)
2297 ((iflags & S_DIRSYNC) ? LUSTRE_DIRSYNC_FL : 0) |
2299 ((iflags & S_IMMUTABLE) ? LUSTRE_IMMUTABLE_FL : 0));
2303 /* 64 possible states */
2304 enum md_transient_state {
2305 MS_RESTORE = (1 << 0), /* restore is running */
2309 struct lu_fid mbo_fid1;
2310 struct lu_fid mbo_fid2;
2311 struct lustre_handle mbo_handle;
2313 __u64 mbo_size; /* Offset, in the case of MDS_READPAGE */
2317 __u64 mbo_blocks; /* XID, in the case of MDS_READPAGE */
2319 __u64 mbo_t_state; /* transient file state defined in
2320 * enum md_transient_state
2321 * was "ino" until 2.4.0 */
2324 __u32 mbo_capability;
2330 __u32 mbo_nlink; /* #bytes to read in the case of MDS_READPAGE */
2331 __u32 mbo_unused2; /* was "generation" until 2.4.0 */
2333 __u32 mbo_eadatasize;
2335 __u32 mbo_max_mdsize;
2336 __u32 mbo_unused3; /* was max_cookiesize until 2.8 */
2337 __u32 mbo_uid_h; /* high 32-bits of uid, for FUID */
2338 __u32 mbo_gid_h; /* high 32-bits of gid, for FUID */
2339 __u32 mbo_padding_5; /* also fix lustre_swab_mdt_body */
2340 __u64 mbo_padding_6;
2341 __u64 mbo_padding_7;
2342 __u64 mbo_padding_8;
2343 __u64 mbo_padding_9;
2344 __u64 mbo_padding_10;
2347 extern void lustre_swab_mdt_body (struct mdt_body *b);
2349 struct mdt_ioepoch {
2350 struct lustre_handle mio_handle;
2351 __u64 mio_unused1; /* was ioepoch */
2352 __u32 mio_unused2; /* was flags */
2356 extern void lustre_swab_mdt_ioepoch (struct mdt_ioepoch *b);
2358 /* permissions for md_perm.mp_perm */
2360 CFS_SETUID_PERM = 0x01,
2361 CFS_SETGID_PERM = 0x02,
2362 CFS_SETGRP_PERM = 0x04,
2363 CFS_RMTACL_PERM = 0x08,
2364 CFS_RMTOWN_PERM = 0x10
2367 /* inode access permission for remote user, the inode info are omitted,
2368 * for client knows them. */
2369 struct mdt_remote_perm {
2376 __u32 rp_access_perm; /* MAY_READ/WRITE/EXEC */
2380 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
2382 struct mdt_rec_setattr {
2392 __u32 sa_padding_1_h;
2393 struct lu_fid sa_fid;
2402 __u32 sa_attr_flags;
2404 __u32 sa_bias; /* some operation flags */
2410 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
2413 * Attribute flags used in mdt_rec_setattr::sa_valid.
2414 * The kernel's #defines for ATTR_* should not be used over the network
2415 * since the client and MDS may run different kernels (see bug 13828)
2416 * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
2418 #define MDS_ATTR_MODE 0x1ULL /* = 1 */
2419 #define MDS_ATTR_UID 0x2ULL /* = 2 */
2420 #define MDS_ATTR_GID 0x4ULL /* = 4 */
2421 #define MDS_ATTR_SIZE 0x8ULL /* = 8 */
2422 #define MDS_ATTR_ATIME 0x10ULL /* = 16 */
2423 #define MDS_ATTR_MTIME 0x20ULL /* = 32 */
2424 #define MDS_ATTR_CTIME 0x40ULL /* = 64 */
2425 #define MDS_ATTR_ATIME_SET 0x80ULL /* = 128 */
2426 #define MDS_ATTR_MTIME_SET 0x100ULL /* = 256 */
2427 #define MDS_ATTR_FORCE 0x200ULL /* = 512, Not a change, but a change it */
2428 #define MDS_ATTR_ATTR_FLAG 0x400ULL /* = 1024 */
2429 #define MDS_ATTR_KILL_SUID 0x800ULL /* = 2048 */
2430 #define MDS_ATTR_KILL_SGID 0x1000ULL /* = 4096 */
2431 #define MDS_ATTR_CTIME_SET 0x2000ULL /* = 8192 */
2432 #define MDS_ATTR_FROM_OPEN 0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
2433 #define MDS_ATTR_BLOCKS 0x8000ULL /* = 32768 */
2436 #define FMODE_READ 00000001
2437 #define FMODE_WRITE 00000002
2440 #define MDS_FMODE_CLOSED 00000000
2441 #define MDS_FMODE_EXEC 00000004
2442 /* MDS_FMODE_EPOCH 01000000 obsolete since 2.8.0 */
2443 /* MDS_FMODE_TRUNC 02000000 obsolete since 2.8.0 */
2444 /* MDS_FMODE_SOM 04000000 obsolete since 2.8.0 */
2446 #define MDS_OPEN_CREATED 00000010
2447 #define MDS_OPEN_CROSS 00000020
2449 #define MDS_OPEN_CREAT 00000100
2450 #define MDS_OPEN_EXCL 00000200
2451 #define MDS_OPEN_TRUNC 00001000
2452 #define MDS_OPEN_APPEND 00002000
2453 #define MDS_OPEN_SYNC 00010000
2454 #define MDS_OPEN_DIRECTORY 00200000
2456 #define MDS_OPEN_BY_FID 040000000 /* open_by_fid for known object */
2457 #define MDS_OPEN_DELAY_CREATE 0100000000 /* delay initial object create */
2458 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
2459 #define MDS_OPEN_JOIN_FILE 0400000000 /* open for join file.
2460 * We do not support JOIN FILE
2461 * anymore, reserve this flags
2462 * just for preventing such bit
2465 #define MDS_OPEN_LOCK 04000000000 /* This open requires open lock */
2466 #define MDS_OPEN_HAS_EA 010000000000 /* specify object create pattern */
2467 #define MDS_OPEN_HAS_OBJS 020000000000 /* Just set the EA the obj exist */
2468 #define MDS_OPEN_NORESTORE 0100000000000ULL /* Do not restore file at open */
2469 #define MDS_OPEN_NEWSTRIPE 0200000000000ULL /* New stripe needed (restripe or
2471 #define MDS_OPEN_VOLATILE 0400000000000ULL /* File is volatile = created
2473 #define MDS_OPEN_LEASE 01000000000000ULL /* Open the file and grant lease
2474 * delegation, succeed if it's not
2475 * being opened with conflict mode.
2477 #define MDS_OPEN_RELEASE 02000000000000ULL /* Open the file for HSM release */
2479 /* lustre internal open flags, which should not be set from user space */
2480 #define MDS_OPEN_FL_INTERNAL (MDS_OPEN_HAS_EA | MDS_OPEN_HAS_OBJS | \
2481 MDS_OPEN_OWNEROVERRIDE | MDS_OPEN_LOCK | \
2482 MDS_OPEN_BY_FID | MDS_OPEN_LEASE | \
2485 /* permission for create non-directory file */
2486 #define MAY_CREATE (1 << 7)
2487 /* permission for create directory file */
2488 #define MAY_LINK (1 << 8)
2489 /* permission for delete from the directory */
2490 #define MAY_UNLINK (1 << 9)
2491 /* source's permission for rename */
2492 #define MAY_RENAME_SRC (1 << 10)
2493 /* target's permission for rename */
2494 #define MAY_RENAME_TAR (1 << 11)
2495 /* part (parent's) VTX permission check */
2496 #define MAY_VTX_PART (1 << 12)
2497 /* full VTX permission check */
2498 #define MAY_VTX_FULL (1 << 13)
2499 /* lfs rgetfacl permission check */
2500 #define MAY_RGETFACL (1 << 14)
2503 MDS_CHECK_SPLIT = 1 << 0,
2504 MDS_CROSS_REF = 1 << 1,
2505 MDS_VTX_BYPASS = 1 << 2,
2506 MDS_PERM_BYPASS = 1 << 3,
2507 /* MDS_SOM = 1 << 4, obsolete since 2.8.0 */
2508 MDS_QUOTA_IGNORE = 1 << 5,
2509 /* Was MDS_CLOSE_CLEANUP (1 << 6), No more used */
2510 MDS_KEEP_ORPHAN = 1 << 7,
2511 MDS_RECOV_OPEN = 1 << 8,
2512 MDS_DATA_MODIFIED = 1 << 9,
2513 MDS_CREATE_VOLATILE = 1 << 10,
2514 MDS_OWNEROVERRIDE = 1 << 11,
2515 MDS_HSM_RELEASE = 1 << 12,
2516 MDS_RENAME_MIGRATE = 1 << 13,
2517 MDS_CLOSE_LAYOUT_SWAP = 1 << 14,
2520 /* instance of mdt_reint_rec */
2521 struct mdt_rec_create {
2529 __u32 cr_suppgid1_h;
2531 __u32 cr_suppgid2_h;
2532 struct lu_fid cr_fid1;
2533 struct lu_fid cr_fid2;
2534 struct lustre_handle cr_old_handle; /* handle in case of open replay */
2538 __u64 cr_padding_1; /* rr_blocks */
2541 /* use of helpers set/get_mrc_cr_flags() is needed to access
2542 * 64 bits cr_flags [cr_flags_l, cr_flags_h], this is done to
2543 * extend cr_flags size without breaking 1.8 compat */
2544 __u32 cr_flags_l; /* for use with open, low 32 bits */
2545 __u32 cr_flags_h; /* for use with open, high 32 bits */
2546 __u32 cr_umask; /* umask for create */
2547 __u32 cr_padding_4; /* rr_padding_4 */
2550 static inline void set_mrc_cr_flags(struct mdt_rec_create *mrc, __u64 flags)
2552 mrc->cr_flags_l = (__u32)(flags & 0xFFFFFFFFUll);
2553 mrc->cr_flags_h = (__u32)(flags >> 32);
2556 static inline __u64 get_mrc_cr_flags(struct mdt_rec_create *mrc)
2558 return ((__u64)(mrc->cr_flags_l) | ((__u64)mrc->cr_flags_h << 32));
2561 /* instance of mdt_reint_rec */
2562 struct mdt_rec_link {
2570 __u32 lk_suppgid1_h;
2572 __u32 lk_suppgid2_h;
2573 struct lu_fid lk_fid1;
2574 struct lu_fid lk_fid2;
2576 __u64 lk_padding_1; /* rr_atime */
2577 __u64 lk_padding_2; /* rr_ctime */
2578 __u64 lk_padding_3; /* rr_size */
2579 __u64 lk_padding_4; /* rr_blocks */
2581 __u32 lk_padding_5; /* rr_mode */
2582 __u32 lk_padding_6; /* rr_flags */
2583 __u32 lk_padding_7; /* rr_padding_2 */
2584 __u32 lk_padding_8; /* rr_padding_3 */
2585 __u32 lk_padding_9; /* rr_padding_4 */
2588 /* instance of mdt_reint_rec */
2589 struct mdt_rec_unlink {
2597 __u32 ul_suppgid1_h;
2599 __u32 ul_suppgid2_h;
2600 struct lu_fid ul_fid1;
2601 struct lu_fid ul_fid2;
2603 __u64 ul_padding_2; /* rr_atime */
2604 __u64 ul_padding_3; /* rr_ctime */
2605 __u64 ul_padding_4; /* rr_size */
2606 __u64 ul_padding_5; /* rr_blocks */
2609 __u32 ul_padding_6; /* rr_flags */
2610 __u32 ul_padding_7; /* rr_padding_2 */
2611 __u32 ul_padding_8; /* rr_padding_3 */
2612 __u32 ul_padding_9; /* rr_padding_4 */
2615 /* instance of mdt_reint_rec */
2616 struct mdt_rec_rename {
2624 __u32 rn_suppgid1_h;
2626 __u32 rn_suppgid2_h;
2627 struct lu_fid rn_fid1;
2628 struct lu_fid rn_fid2;
2630 __u64 rn_padding_1; /* rr_atime */
2631 __u64 rn_padding_2; /* rr_ctime */
2632 __u64 rn_padding_3; /* rr_size */
2633 __u64 rn_padding_4; /* rr_blocks */
2634 __u32 rn_bias; /* some operation flags */
2635 __u32 rn_mode; /* cross-ref rename has mode */
2636 __u32 rn_padding_5; /* rr_flags */
2637 __u32 rn_padding_6; /* rr_padding_2 */
2638 __u32 rn_padding_7; /* rr_padding_3 */
2639 __u32 rn_padding_8; /* rr_padding_4 */
2642 /* instance of mdt_reint_rec */
2643 struct mdt_rec_setxattr {
2651 __u32 sx_suppgid1_h;
2653 __u32 sx_suppgid2_h;
2654 struct lu_fid sx_fid;
2655 __u64 sx_padding_1; /* These three are rr_fid2 */
2660 __u64 sx_padding_5; /* rr_ctime */
2661 __u64 sx_padding_6; /* rr_size */
2662 __u64 sx_padding_7; /* rr_blocks */
2665 __u32 sx_padding_8; /* rr_flags */
2666 __u32 sx_padding_9; /* rr_padding_2 */
2667 __u32 sx_padding_10; /* rr_padding_3 */
2668 __u32 sx_padding_11; /* rr_padding_4 */
2672 * mdt_rec_reint is the template for all mdt_reint_xxx structures.
2673 * Do NOT change the size of various members, otherwise the value
2674 * will be broken in lustre_swab_mdt_rec_reint().
2676 * If you add new members in other mdt_reint_xxx structres and need to use the
2677 * rr_padding_x fields, then update lustre_swab_mdt_rec_reint() also.
2679 struct mdt_rec_reint {
2687 __u32 rr_suppgid1_h;
2689 __u32 rr_suppgid2_h;
2690 struct lu_fid rr_fid1;
2691 struct lu_fid rr_fid2;
2702 __u32 rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
2705 extern void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
2707 /* lmv structures */
2709 __u32 ld_tgt_count; /* how many MDS's */
2710 __u32 ld_active_tgt_count; /* how many active */
2711 __u32 ld_default_stripe_count; /* how many objects are used */
2712 __u32 ld_pattern; /* default hash pattern */
2713 __u64 ld_default_hash_size;
2714 __u64 ld_padding_1; /* also fix lustre_swab_lmv_desc */
2715 __u32 ld_padding_2; /* also fix lustre_swab_lmv_desc */
2716 __u32 ld_qos_maxage; /* in second */
2717 __u32 ld_padding_3; /* also fix lustre_swab_lmv_desc */
2718 __u32 ld_padding_4; /* also fix lustre_swab_lmv_desc */
2719 struct obd_uuid ld_uuid;
2722 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
2724 /* LMV layout EA, and it will be stored both in master and slave object */
2725 struct lmv_mds_md_v1 {
2727 __u32 lmv_stripe_count;
2728 __u32 lmv_master_mdt_index; /* On master object, it is master
2729 * MDT index, on slave object, it
2730 * is stripe index of the slave obj */
2731 __u32 lmv_hash_type; /* dir stripe policy, i.e. indicate
2732 * which hash function to be used,
2733 * Note: only lower 16 bits is being
2734 * used for now. Higher 16 bits will
2735 * be used to mark the object status,
2736 * for example migrating or dead. */
2737 __u32 lmv_layout_version; /* Used for directory restriping */
2741 char lmv_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
2742 struct lu_fid lmv_stripe_fids[0]; /* FIDs for each stripe */
2745 #define LMV_MAGIC_V1 0x0CD20CD0 /* normal stripe lmv magic */
2746 #define LMV_MAGIC LMV_MAGIC_V1
2748 /* #define LMV_USER_MAGIC 0x0CD30CD0 */
2749 #define LMV_MAGIC_STRIPE 0x0CD40CD0 /* magic for dir sub_stripe */
2751 /* Right now only the lower part(0-16bits) of lmv_hash_type is being used,
2752 * and the higher part will be the flag to indicate the status of object,
2753 * for example the object is being migrated. And the hash function
2754 * might be interpreted differently with different flags. */
2755 #define LMV_HASH_TYPE_MASK 0x0000ffff
2757 #define LMV_HASH_FLAG_MIGRATION 0x80000000
2758 #define LMV_HASH_FLAG_DEAD 0x40000000
2759 #define LMV_HASH_FLAG_BAD_TYPE 0x20000000
2761 /* The striped directory has ever lost its master LMV EA, then LFSCK
2762 * re-generated it. This flag is used to indicate such case. It is an
2764 #define LMV_HASH_FLAG_LOST_LMV 0x10000000
2767 * The FNV-1a hash algorithm is as follows:
2768 * hash = FNV_offset_basis
2769 * for each octet_of_data to be hashed
2770 * hash = hash XOR octet_of_data
2771 * hash = hash × FNV_prime
2773 * http://en.wikipedia.org/wiki/Fowler–Noll–Vo_hash_function#FNV-1a_hash
2775 * http://www.isthe.com/chongo/tech/comp/fnv/index.html#FNV-reference-source
2776 * FNV_prime is 2^40 + 2^8 + 0xb3 = 0x100000001b3ULL
2778 #define LUSTRE_FNV_1A_64_PRIME 0x100000001b3ULL
2779 #define LUSTRE_FNV_1A_64_OFFSET_BIAS 0xcbf29ce484222325ULL
2780 static inline __u64 lustre_hash_fnv_1a_64(const void *buf, size_t size)
2782 __u64 hash = LUSTRE_FNV_1A_64_OFFSET_BIAS;
2783 const unsigned char *p = buf;
2786 for (i = 0; i < size; i++) {
2788 hash *= LUSTRE_FNV_1A_64_PRIME;
2796 struct lmv_mds_md_v1 lmv_md_v1;
2797 struct lmv_user_md lmv_user_md;
2800 extern void lustre_swab_lmv_mds_md(union lmv_mds_md *lmm);
2802 static inline int lmv_mds_md_size(int stripe_count, unsigned int lmm_magic)
2804 switch (lmm_magic) {
2806 struct lmv_mds_md_v1 *lmm1;
2808 return sizeof(*lmm1) + stripe_count *
2809 sizeof(lmm1->lmv_stripe_fids[0]);
2816 static inline int lmv_mds_md_stripe_count_get(const union lmv_mds_md *lmm)
2818 switch (le32_to_cpu(lmm->lmv_magic)) {
2820 return le32_to_cpu(lmm->lmv_md_v1.lmv_stripe_count);
2821 case LMV_USER_MAGIC:
2822 return le32_to_cpu(lmm->lmv_user_md.lum_stripe_count);
2828 static inline int lmv_mds_md_stripe_count_set(union lmv_mds_md *lmm,
2829 unsigned int stripe_count)
2831 switch (le32_to_cpu(lmm->lmv_magic)) {
2833 lmm->lmv_md_v1.lmv_stripe_count = cpu_to_le32(stripe_count);
2835 case LMV_USER_MAGIC:
2836 lmm->lmv_user_md.lum_stripe_count = cpu_to_le32(stripe_count);
2848 FLD_FIRST_OPC = FLD_QUERY
2854 SEQ_FIRST_OPC = SEQ_QUERY
2858 SEQ_ALLOC_SUPER = 0,
2870 LFSCK_NOTIFY = 1101,
2873 LFSCK_FIRST_OPC = LFSCK_NOTIFY
2877 * LOV data structures
2880 #define LOV_MAX_UUID_BUFFER_SIZE 8192
2881 /* The size of the buffer the lov/mdc reserves for the
2882 * array of UUIDs returned by the MDS. With the current
2883 * protocol, this will limit the max number of OSTs per LOV */
2885 #define LOV_DESC_MAGIC 0xB0CCDE5C
2886 #define LOV_DESC_QOS_MAXAGE_DEFAULT 5 /* Seconds */
2887 #define LOV_DESC_STRIPE_SIZE_DEFAULT (1 << LNET_MTU_BITS)
2889 /* LOV settings descriptor (should only contain static info) */
2891 __u32 ld_tgt_count; /* how many OBD's */
2892 __u32 ld_active_tgt_count; /* how many active */
2893 __u32 ld_default_stripe_count; /* how many objects are used */
2894 __u32 ld_pattern; /* default PATTERN_RAID0 */
2895 __u64 ld_default_stripe_size; /* in bytes */
2896 __u64 ld_default_stripe_offset; /* in bytes */
2897 __u32 ld_padding_0; /* unused */
2898 __u32 ld_qos_maxage; /* in second */
2899 __u32 ld_padding_1; /* also fix lustre_swab_lov_desc */
2900 __u32 ld_padding_2; /* also fix lustre_swab_lov_desc */
2901 struct obd_uuid ld_uuid;
2904 #define ld_magic ld_active_tgt_count /* for swabbing from llogs */
2906 extern void lustre_swab_lov_desc (struct lov_desc *ld);
2911 /* opcodes -- MUST be distinct from OST/MDS opcodes */
2916 LDLM_BL_CALLBACK = 104,
2917 LDLM_CP_CALLBACK = 105,
2918 LDLM_GL_CALLBACK = 106,
2919 LDLM_SET_INFO = 107,
2922 #define LDLM_FIRST_OPC LDLM_ENQUEUE
2924 #define RES_NAME_SIZE 4
2925 struct ldlm_res_id {
2926 __u64 name[RES_NAME_SIZE];
2929 #define DLDLMRES "["LPX64":"LPX64":"LPX64"]."LPX64i
2930 #define PLDLMRES(res) (res)->lr_name.name[0], (res)->lr_name.name[1], \
2931 (res)->lr_name.name[2], (res)->lr_name.name[3]
2933 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
2935 static inline bool ldlm_res_eq(const struct ldlm_res_id *res0,
2936 const struct ldlm_res_id *res1)
2938 return memcmp(res0, res1, sizeof(*res0)) == 0;
2955 #define LCK_MODE_NUM 8
2965 #define LDLM_MIN_TYPE LDLM_PLAIN
2967 struct ldlm_extent {
2973 static inline int ldlm_extent_overlap(const struct ldlm_extent *ex1,
2974 const struct ldlm_extent *ex2)
2976 return ex1->start <= ex2->end && ex2->start <= ex1->end;
2979 /* check if @ex1 contains @ex2 */
2980 static inline int ldlm_extent_contain(const struct ldlm_extent *ex1,
2981 const struct ldlm_extent *ex2)
2983 return ex1->start <= ex2->start && ex1->end >= ex2->end;
2986 struct ldlm_inodebits {
2990 struct ldlm_flock_wire {
2998 /* it's important that the fields of the ldlm_extent structure match
2999 * the first fields of the ldlm_flock structure because there is only
3000 * one ldlm_swab routine to process the ldlm_policy_data_t union. if
3001 * this ever changes we will need to swab the union differently based
3002 * on the resource type. */
3005 struct ldlm_extent l_extent;
3006 struct ldlm_flock_wire l_flock;
3007 struct ldlm_inodebits l_inodebits;
3008 } ldlm_wire_policy_data_t;
3010 extern void lustre_swab_ldlm_policy_data (ldlm_wire_policy_data_t *d);
3012 union ldlm_gl_desc {
3013 struct ldlm_gl_lquota_desc lquota_desc;
3016 extern void lustre_swab_gl_desc(union ldlm_gl_desc *);
3018 struct ldlm_intent {
3022 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
3024 struct ldlm_resource_desc {
3025 ldlm_type_t lr_type;
3026 __u32 lr_padding; /* also fix lustre_swab_ldlm_resource_desc */
3027 struct ldlm_res_id lr_name;
3030 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
3032 struct ldlm_lock_desc {
3033 struct ldlm_resource_desc l_resource;
3034 ldlm_mode_t l_req_mode;
3035 ldlm_mode_t l_granted_mode;
3036 ldlm_wire_policy_data_t l_policy_data;
3039 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
3041 #define LDLM_LOCKREQ_HANDLES 2
3042 #define LDLM_ENQUEUE_CANCEL_OFF 1
3044 struct ldlm_request {
3047 struct ldlm_lock_desc lock_desc;
3048 struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
3051 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
3053 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
3054 * Otherwise, 2 are available. */
3055 #define ldlm_request_bufsize(count,type) \
3057 int _avail = LDLM_LOCKREQ_HANDLES; \
3058 _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
3059 sizeof(struct ldlm_request) + \
3060 (count > _avail ? count - _avail : 0) * \
3061 sizeof(struct lustre_handle); \
3066 __u32 lock_padding; /* also fix lustre_swab_ldlm_reply */
3067 struct ldlm_lock_desc lock_desc;
3068 struct lustre_handle lock_handle;
3069 __u64 lock_policy_res1;
3070 __u64 lock_policy_res2;
3073 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
3075 #define ldlm_flags_to_wire(flags) ((__u32)(flags))
3076 #define ldlm_flags_from_wire(flags) ((__u64)(flags))
3079 * Opcodes for mountconf (mgs and mgc)
3084 MGS_EXCEPTION, /* node died, etc. */
3085 MGS_TARGET_REG, /* whenever target starts up */
3091 #define MGS_FIRST_OPC MGS_CONNECT
3093 #define MGS_PARAM_MAXLEN 1024
3094 #define KEY_SET_INFO "set_info"
3096 struct mgs_send_param {
3097 char mgs_param[MGS_PARAM_MAXLEN];
3100 /* We pass this info to the MGS so it can write config logs */
3101 #define MTI_NAME_MAXLEN 64
3102 #define MTI_PARAM_MAXLEN 4096
3103 #define MTI_NIDS_MAX 32
3104 struct mgs_target_info {
3105 __u32 mti_lustre_ver;
3106 __u32 mti_stripe_index;
3107 __u32 mti_config_ver;
3109 __u32 mti_nid_count;
3110 __u32 mti_instance; /* Running instance of target */
3111 char mti_fsname[MTI_NAME_MAXLEN];
3112 char mti_svname[MTI_NAME_MAXLEN];
3113 char mti_uuid[sizeof(struct obd_uuid)];
3114 __u64 mti_nids[MTI_NIDS_MAX]; /* host nids (lnet_nid_t)*/
3115 char mti_params[MTI_PARAM_MAXLEN];
3117 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
3119 struct mgs_nidtbl_entry {
3120 __u64 mne_version; /* table version of this entry */
3121 __u32 mne_instance; /* target instance # */
3122 __u32 mne_index; /* target index */
3123 __u32 mne_length; /* length of this entry - by bytes */
3124 __u8 mne_type; /* target type LDD_F_SV_TYPE_OST/MDT */
3125 __u8 mne_nid_type; /* type of nid(mbz). for ipv6. */
3126 __u8 mne_nid_size; /* size of each NID, by bytes */
3127 __u8 mne_nid_count; /* # of NIDs in buffer */
3129 lnet_nid_t nids[0]; /* variable size buffer for NIDs. */
3132 extern void lustre_swab_mgs_nidtbl_entry(struct mgs_nidtbl_entry *oinfo);
3134 struct mgs_config_body {
3135 char mcb_name[MTI_NAME_MAXLEN]; /* logname */
3136 __u64 mcb_offset; /* next index of config log to request */
3137 __u16 mcb_type; /* type of log: CONFIG_T_[CONFIG|RECOVER] */
3139 __u8 mcb_bits; /* bits unit size of config log */
3140 __u32 mcb_units; /* # of units for bulk transfer */
3142 extern void lustre_swab_mgs_config_body(struct mgs_config_body *body);
3144 struct mgs_config_res {
3145 __u64 mcr_offset; /* index of last config log */
3146 __u64 mcr_size; /* size of the log */
3148 extern void lustre_swab_mgs_config_res(struct mgs_config_res *body);
3150 /* Config marker flags (in config log) */
3151 #define CM_START 0x01
3153 #define CM_SKIP 0x04
3154 #define CM_UPGRADE146 0x08
3155 #define CM_EXCLUDE 0x10
3156 #define CM_START_SKIP (CM_START | CM_SKIP)
3159 __u32 cm_step; /* aka config version */
3161 __u32 cm_vers; /* lustre release version number */
3162 __u32 cm_padding; /* 64 bit align */
3163 __s64 cm_createtime; /*when this record was first created */
3164 __s64 cm_canceltime; /*when this record is no longer valid*/
3165 char cm_tgtname[MTI_NAME_MAXLEN];
3166 char cm_comment[MTI_NAME_MAXLEN];
3169 extern void lustre_swab_cfg_marker(struct cfg_marker *marker,
3170 int swab, int size);
3173 * Opcodes for multiple servers.
3179 OBD_QC_CALLBACK, /* not used since 2.4 */
3183 #define OBD_FIRST_OPC OBD_PING
3186 * llog contexts indices.
3188 * There is compatibility problem with indexes below, they are not
3189 * continuous and must keep their numbers for compatibility needs.
3190 * See LU-5218 for details.
3193 LLOG_CONFIG_ORIG_CTXT = 0,
3194 LLOG_CONFIG_REPL_CTXT = 1,
3195 LLOG_MDS_OST_ORIG_CTXT = 2,
3196 LLOG_MDS_OST_REPL_CTXT = 3, /* kept just to avoid re-assignment */
3197 LLOG_SIZE_ORIG_CTXT = 4,
3198 LLOG_SIZE_REPL_CTXT = 5,
3199 LLOG_TEST_ORIG_CTXT = 8,
3200 LLOG_TEST_REPL_CTXT = 9, /* kept just to avoid re-assignment */
3201 LLOG_CHANGELOG_ORIG_CTXT = 12, /**< changelog generation on mdd */
3202 LLOG_CHANGELOG_REPL_CTXT = 13, /**< changelog access on clients */
3203 /* for multiple changelog consumers */
3204 LLOG_CHANGELOG_USER_ORIG_CTXT = 14,
3205 LLOG_AGENT_ORIG_CTXT = 15, /**< agent requests generation on cdt */
3206 LLOG_UPDATELOG_ORIG_CTXT = 16, /* update log */
3207 LLOG_UPDATELOG_REPL_CTXT = 17, /* update log */
3211 /** Identifier for a single log object */
3213 struct ost_id lgl_oi;
3215 } __attribute__((packed));
3217 /** Records written to the CATALOGS list */
3218 #define CATLIST "CATALOGS"
3220 struct llog_logid lci_logid;
3224 } __attribute__((packed));
3226 /* Log data record types - there is no specific reason that these need to
3227 * be related to the RPC opcodes, but no reason not to (may be handy later?)
3229 #define LLOG_OP_MAGIC 0x10600000
3230 #define LLOG_OP_MASK 0xfff00000
3233 LLOG_PAD_MAGIC = LLOG_OP_MAGIC | 0x00000,
3234 OST_SZ_REC = LLOG_OP_MAGIC | 0x00f00,
3235 /* OST_RAID1_REC = LLOG_OP_MAGIC | 0x01000, never used */
3236 MDS_UNLINK_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) |
3237 REINT_UNLINK, /* obsolete after 2.5.0 */
3238 MDS_UNLINK64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
3240 /* MDS_SETATTR_REC = LLOG_OP_MAGIC | 0x12401, obsolete 1.8.0 */
3241 MDS_SETATTR64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
3243 OBD_CFG_REC = LLOG_OP_MAGIC | 0x20000,
3244 /* PTL_CFG_REC = LLOG_OP_MAGIC | 0x30000, obsolete 1.4.0 */
3245 LLOG_GEN_REC = LLOG_OP_MAGIC | 0x40000,
3246 /* LLOG_JOIN_REC = LLOG_OP_MAGIC | 0x50000, obsolete 1.8.0 */
3247 CHANGELOG_REC = LLOG_OP_MAGIC | 0x60000,
3248 CHANGELOG_USER_REC = LLOG_OP_MAGIC | 0x70000,
3249 HSM_AGENT_REC = LLOG_OP_MAGIC | 0x80000,
3250 UPDATE_REC = LLOG_OP_MAGIC | 0xa0000,
3251 LLOG_HDR_MAGIC = LLOG_OP_MAGIC | 0x45539,
3252 LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
3255 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
3256 (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == __swab32(LLOG_OP_MAGIC))
3258 /** Log record header - stored in little endian order.
3259 * Each record must start with this struct, end with a llog_rec_tail,
3260 * and be a multiple of 256 bits in size.
3262 struct llog_rec_hdr {
3269 struct llog_rec_tail {
3274 /* Where data follow just after header */
3275 #define REC_DATA(ptr) \
3276 ((void *)((char *)ptr + sizeof(struct llog_rec_hdr)))
3278 #define REC_DATA_LEN(rec) \
3279 (rec->lrh_len - sizeof(struct llog_rec_hdr) - \
3280 sizeof(struct llog_rec_tail))
3282 static inline void *rec_tail(struct llog_rec_hdr *rec)
3284 return (void *)((char *)rec + rec->lrh_len -
3285 sizeof(struct llog_rec_tail));
3288 struct llog_logid_rec {
3289 struct llog_rec_hdr lid_hdr;
3290 struct llog_logid lid_id;
3294 struct llog_rec_tail lid_tail;
3295 } __attribute__((packed));
3297 struct llog_unlink_rec {
3298 struct llog_rec_hdr lur_hdr;
3302 struct llog_rec_tail lur_tail;
3303 } __attribute__((packed));
3305 struct llog_unlink64_rec {
3306 struct llog_rec_hdr lur_hdr;
3307 struct lu_fid lur_fid;
3308 __u32 lur_count; /* to destroy the lost precreated */
3312 struct llog_rec_tail lur_tail;
3313 } __attribute__((packed));
3315 struct llog_setattr64_rec {
3316 struct llog_rec_hdr lsr_hdr;
3317 struct ost_id lsr_oi;
3323 struct llog_rec_tail lsr_tail;
3324 } __attribute__((packed));
3326 struct llog_size_change_rec {
3327 struct llog_rec_hdr lsc_hdr;
3328 struct ll_fid lsc_fid;
3333 struct llog_rec_tail lsc_tail;
3334 } __attribute__((packed));
3336 #define CHANGELOG_MAGIC 0xca103000
3338 /** \a changelog_rec_type's that can't be masked */
3339 #define CHANGELOG_MINMASK (1 << CL_MARK)
3340 /** bits covering all \a changelog_rec_type's */
3341 #define CHANGELOG_ALLMASK 0XFFFFFFFF
3342 /** default \a changelog_rec_type mask. Allow all of them, except
3343 * CL_ATIME since it can really be time consuming, and not necessary
3344 * under normal use. */
3345 #define CHANGELOG_DEFMASK (CHANGELOG_ALLMASK & ~(1 << CL_ATIME))
3347 /* changelog llog name, needed by client replicators */
3348 #define CHANGELOG_CATALOG "changelog_catalog"
3350 struct changelog_setinfo {
3353 } __attribute__((packed));
3355 /** changelog record */
3356 struct llog_changelog_rec {
3357 struct llog_rec_hdr cr_hdr;
3358 struct changelog_rec cr; /**< Variable length field */
3359 struct llog_rec_tail cr_do_not_use; /**< for_sizeof_only */
3360 } __attribute__((packed));
3362 #define CHANGELOG_USER_PREFIX "cl"
3364 struct llog_changelog_user_rec {
3365 struct llog_rec_hdr cur_hdr;
3369 struct llog_rec_tail cur_tail;
3370 } __attribute__((packed));
3372 enum agent_req_status {
3380 static inline const char *agent_req_status2name(enum agent_req_status ars)
3398 static inline bool agent_req_in_final_state(enum agent_req_status ars)
3400 return ((ars == ARS_SUCCEED) || (ars == ARS_FAILED) ||
3401 (ars == ARS_CANCELED));
3404 struct llog_agent_req_rec {
3405 struct llog_rec_hdr arr_hdr; /**< record header */
3406 __u32 arr_status; /**< status of the request */
3408 * agent_req_status */
3409 __u32 arr_archive_id; /**< backend archive number */
3410 __u64 arr_flags; /**< req flags */
3411 __u64 arr_compound_id; /**< compound cookie */
3412 __u64 arr_req_create; /**< req. creation time */
3413 __u64 arr_req_change; /**< req. status change time */
3414 struct hsm_action_item arr_hai; /**< req. to the agent */
3415 struct llog_rec_tail arr_tail; /**< record tail for_sizezof_only */
3416 } __attribute__((packed));
3418 /* Old llog gen for compatibility */
3422 } __attribute__((packed));
3424 struct llog_gen_rec {
3425 struct llog_rec_hdr lgr_hdr;
3426 struct llog_gen lgr_gen;
3430 struct llog_rec_tail lgr_tail;
3433 /* flags for the logs */
3435 LLOG_F_ZAP_WHEN_EMPTY = 0x1,
3436 LLOG_F_IS_CAT = 0x2,
3437 LLOG_F_IS_PLAIN = 0x4,
3438 LLOG_F_EXT_JOBID = 0x8,
3440 LLOG_F_EXT_MASK = LLOG_F_EXT_JOBID,
3443 /* On-disk header structure of each log object, stored in little endian order */
3444 #define LLOG_MIN_CHUNK_SIZE 8192
3445 #define LLOG_HEADER_SIZE (96) /* sizeof (llog_log_hdr) + sizeof(llh_tail)
3446 * - sizeof(llh_bitmap) */
3447 #define LLOG_BITMAP_BYTES (LLOG_MIN_CHUNK_SIZE - LLOG_HEADER_SIZE)
3448 #define LLOG_MIN_REC_SIZE (24) /* round(llog_rec_hdr + llog_rec_tail) */
3450 struct llog_log_hdr {
3451 struct llog_rec_hdr llh_hdr;
3452 __s64 llh_timestamp;
3454 __u32 llh_bitmap_offset;
3458 /* for a catalog the first plain slot is next to it */
3459 struct obd_uuid llh_tgtuuid;
3460 __u32 llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32)-23];
3461 /* These fields must always be at the end of the llog_log_hdr.
3462 * Note: llh_bitmap size is variable because llog chunk size could be
3463 * bigger than LLOG_MIN_CHUNK_SIZE, i.e. sizeof(llog_log_hdr) > 8192
3464 * bytes, and the real size is stored in llh_hdr.lrh_len, which means
3465 * llh_tail should only be refered by LLOG_HDR_TAIL().
3466 * But this structure is also used by client/server llog interface
3467 * (see llog_client.c), it will be kept in its original way to avoid
3468 * compatiblity issue. */
3469 __u32 llh_bitmap[LLOG_BITMAP_BYTES / sizeof(__u32)];
3470 struct llog_rec_tail llh_tail;
3471 } __attribute__((packed));
3472 #undef LLOG_HEADER_SIZE
3473 #undef LLOG_BITMAP_BYTES
3475 #define LLOG_HDR_BITMAP_SIZE(llh) (__u32)((llh->llh_hdr.lrh_len - \
3476 llh->llh_bitmap_offset - \
3477 sizeof(llh->llh_tail)) * 8)
3478 #define LLOG_HDR_BITMAP(llh) (__u32 *)((char *)(llh) + \
3479 (llh)->llh_bitmap_offset)
3480 #define LLOG_HDR_TAIL(llh) ((struct llog_rec_tail *)((char *)llh + \
3481 llh->llh_hdr.lrh_len - \
3482 sizeof(llh->llh_tail)))
3484 /** log cookies are used to reference a specific log file and a record therein */
3485 struct llog_cookie {
3486 struct llog_logid lgc_lgl;
3490 } __attribute__((packed));
3492 /** llog protocol */
3493 enum llogd_rpc_ops {
3494 LLOG_ORIGIN_HANDLE_CREATE = 501,
3495 LLOG_ORIGIN_HANDLE_NEXT_BLOCK = 502,
3496 LLOG_ORIGIN_HANDLE_READ_HEADER = 503,
3497 LLOG_ORIGIN_HANDLE_WRITE_REC = 504,
3498 LLOG_ORIGIN_HANDLE_CLOSE = 505,
3499 LLOG_ORIGIN_CONNECT = 506,
3500 LLOG_CATINFO = 507, /* deprecated */
3501 LLOG_ORIGIN_HANDLE_PREV_BLOCK = 508,
3502 LLOG_ORIGIN_HANDLE_DESTROY = 509, /* for destroy llog object*/
3504 LLOG_FIRST_OPC = LLOG_ORIGIN_HANDLE_CREATE
3508 struct llog_logid lgd_logid;
3510 __u32 lgd_llh_flags;
3512 __u32 lgd_saved_index;
3514 __u64 lgd_cur_offset;
3515 } __attribute__((packed));
3517 struct llogd_conn_body {
3518 struct llog_gen lgdc_gen;
3519 struct llog_logid lgdc_logid;
3520 __u32 lgdc_ctxt_idx;
3521 } __attribute__((packed));
3523 /* Note: 64-bit types are 64-bit aligned in structure */
3525 __u64 o_valid; /* hot fields in this obdo */
3528 __u64 o_size; /* o_size-o_blocks == ost_lvb */
3532 __u64 o_blocks; /* brw: cli sent cached bytes */
3535 /* 32-bit fields start here: keep an even number of them via padding */
3536 __u32 o_blksize; /* optimal IO blocksize */
3537 __u32 o_mode; /* brw: cli sent cache remain */
3541 __u32 o_nlink; /* brw: checksum */
3543 __u32 o_misc; /* brw: o_dropped */
3545 __u64 o_ioepoch; /* epoch in ost writes */
3546 __u32 o_stripe_idx; /* holds stripe idx */
3548 struct lustre_handle o_handle; /* brw: lock handle to prolong
3550 struct llog_cookie o_lcookie; /* destroy: unlink cookie from
3551 * MDS, obsolete in 2.8, reused
3556 __u64 o_data_version; /* getattr: sum of iversion for
3558 * brw: grant space consumed on
3559 * the client for the write */
3565 #define o_dirty o_blocks
3566 #define o_undirty o_mode
3567 #define o_dropped o_misc
3568 #define o_cksum o_nlink
3569 #define o_grant_used o_data_version
3571 struct lfsck_request {
3584 __u16 lr_async_windows;
3586 struct lu_fid lr_fid;
3587 struct lu_fid lr_fid2;
3588 struct lu_fid lr_fid3;
3593 void lustre_swab_lfsck_request(struct lfsck_request *lr);
3595 struct lfsck_reply {
3601 void lustre_swab_lfsck_reply(struct lfsck_reply *lr);
3604 LE_LASTID_REBUILDING = 1,
3605 LE_LASTID_REBUILT = 2,
3611 LE_FID_ACCESSED = 8,
3613 LE_CONDITIONAL_DESTROY = 10,
3614 LE_PAIRS_VERIFY = 11,
3615 LE_SKIP_NLINK_DECLARE = 13,
3617 LE_SET_LMV_MASTER = 15,
3618 LE_SET_LMV_SLAVE = 16,
3621 enum lfsck_event_flags {
3622 LEF_TO_OST = 0x00000001,
3623 LEF_FROM_OST = 0x00000002,
3624 LEF_SET_LMV_HASH = 0x00000004,
3625 LEF_SET_LMV_ALL = 0x00000008,
3626 LEF_RECHECK_NAME_HASH = 0x00000010,
3629 static inline void lustre_set_wire_obdo(const struct obd_connect_data *ocd,
3631 const struct obdo *lobdo)
3634 wobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
3638 if (unlikely(!(ocd->ocd_connect_flags & OBD_CONNECT_FID)) &&
3639 fid_seq_is_echo(ostid_seq(&lobdo->o_oi))) {
3640 /* Currently OBD_FL_OSTID will only be used when 2.4 echo
3641 * client communicate with pre-2.4 server */
3642 wobdo->o_oi.oi.oi_id = fid_oid(&lobdo->o_oi.oi_fid);
3643 wobdo->o_oi.oi.oi_seq = fid_seq(&lobdo->o_oi.oi_fid);
3647 static inline void lustre_get_wire_obdo(const struct obd_connect_data *ocd,
3649 const struct obdo *wobdo)
3651 __u32 local_flags = 0;
3653 if (lobdo->o_valid & OBD_MD_FLFLAGS)
3654 local_flags = lobdo->o_flags & OBD_FL_LOCAL_MASK;
3657 if (local_flags != 0) {
3658 lobdo->o_valid |= OBD_MD_FLFLAGS;
3659 lobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
3660 lobdo->o_flags |= local_flags;
3665 if (unlikely(!(ocd->ocd_connect_flags & OBD_CONNECT_FID)) &&
3666 fid_seq_is_echo(wobdo->o_oi.oi.oi_seq)) {
3668 lobdo->o_oi.oi_fid.f_seq = wobdo->o_oi.oi.oi_seq;
3669 lobdo->o_oi.oi_fid.f_oid = wobdo->o_oi.oi.oi_id;
3670 lobdo->o_oi.oi_fid.f_ver = 0;
3674 extern void lustre_swab_obdo (struct obdo *o);
3676 /* request structure for OST's */
3681 /* Key for FIEMAP to be used in get_info calls */
3682 struct ll_fiemap_info_key {
3684 struct obdo lfik_oa;
3685 struct fiemap lfik_fiemap;
3688 extern void lustre_swab_ost_body (struct ost_body *b);
3689 extern void lustre_swab_ost_last_id(__u64 *id);
3690 extern void lustre_swab_fiemap(struct fiemap *fiemap);
3692 extern void lustre_swab_lov_user_md_v1(struct lov_user_md_v1 *lum);
3693 extern void lustre_swab_lov_user_md_v3(struct lov_user_md_v3 *lum);
3694 extern void lustre_swab_lov_user_md_objects(struct lov_user_ost_data *lod,
3696 extern void lustre_swab_lov_mds_md(struct lov_mds_md *lmm);
3697 void lustre_print_user_md(unsigned int level, struct lov_user_md *lum,
3701 extern void lustre_swab_llogd_body (struct llogd_body *d);
3702 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
3703 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
3704 extern void lustre_swab_llog_rec(struct llog_rec_hdr *rec);
3705 extern void lustre_swab_llog_id(struct llog_logid *lid);
3708 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
3710 /* Functions for dumping PTLRPC fields */
3711 void dump_rniobuf(struct niobuf_remote *rnb);
3712 void dump_ioo(struct obd_ioobj *nb);
3713 void dump_obdo(struct obdo *oa);
3714 void dump_ost_body(struct ost_body *ob);
3715 void dump_rcs(__u32 *rc);
3717 #define IDX_INFO_MAGIC 0x3D37CC37
3719 /* Index file transfer through the network. The server serializes the index into
3720 * a byte stream which is sent to the client via a bulk transfer */
3724 /* reply: see idx_info_flags below */
3727 /* request & reply: number of lu_idxpage (to be) transferred */
3731 /* request: requested attributes passed down to the iterator API */
3734 /* request & reply: index file identifier (FID) */
3735 struct lu_fid ii_fid;
3737 /* reply: version of the index file before starting to walk the index.
3738 * Please note that the version can be modified at any time during the
3742 /* request: hash to start with:
3743 * reply: hash of the first entry of the first lu_idxpage and hash
3744 * of the entry to read next if any */
3745 __u64 ii_hash_start;
3748 /* reply: size of keys in lu_idxpages, minimal one if II_FL_VARKEY is
3752 /* reply: size of records in lu_idxpages, minimal one if II_FL_VARREC
3760 extern void lustre_swab_idx_info(struct idx_info *ii);
3762 #define II_END_OFF MDS_DIR_END_OFF /* all entries have been read */
3764 /* List of flags used in idx_info::ii_flags */
3765 enum idx_info_flags {
3766 II_FL_NOHASH = 1 << 0, /* client doesn't care about hash value */
3767 II_FL_VARKEY = 1 << 1, /* keys can be of variable size */
3768 II_FL_VARREC = 1 << 2, /* records can be of variable size */
3769 II_FL_NONUNQ = 1 << 3, /* index supports non-unique keys */
3770 II_FL_NOKEY = 1 << 4, /* client doesn't care about key */
3773 #define LIP_MAGIC 0x8A6D6B6C
3775 /* 4KB (= LU_PAGE_SIZE) container gathering key/record pairs */
3777 /* 16-byte header */
3780 __u16 lip_nr; /* number of entries in the container */
3781 __u64 lip_pad0; /* additional padding for future use */
3783 /* key/record pairs are stored in the remaining 4080 bytes.
3784 * depending upon the flags in idx_info::ii_flags, each key/record
3785 * pair might be preceded by:
3787 * - the key size (II_FL_VARKEY is set)
3788 * - the record size (II_FL_VARREC is set)
3790 * For the time being, we only support fixed-size key & record. */
3791 char lip_entries[0];
3793 extern void lustre_swab_lip_header(struct lu_idxpage *lip);
3795 #define LIP_HDR_SIZE (offsetof(struct lu_idxpage, lip_entries))
3797 /* Gather all possible type associated with a 4KB container */
3799 struct lu_dirpage lp_dir; /* for MDS_READPAGE */
3800 struct lu_idxpage lp_idx; /* for OBD_IDX_READ */
3801 char lp_array[LU_PAGE_SIZE];
3804 /* security opcodes */
3807 SEC_CTX_INIT_CONT = 802,
3810 SEC_FIRST_OPC = SEC_CTX_INIT
3814 * capa related definitions
3816 #define CAPA_HMAC_MAX_LEN 64
3817 #define CAPA_HMAC_KEY_MAX_LEN 56
3819 /* NB take care when changing the sequence of elements this struct,
3820 * because the offset info is used in find_capa() */
3821 struct lustre_capa {
3822 struct lu_fid lc_fid; /** fid */
3823 __u64 lc_opc; /** operations allowed */
3824 __u64 lc_uid; /** file owner */
3825 __u64 lc_gid; /** file group */
3826 __u32 lc_flags; /** HMAC algorithm & flags */
3827 __u32 lc_keyid; /** key# used for the capability */
3828 __u32 lc_timeout; /** capa timeout value (sec) */
3829 __u32 lc_expiry; /** expiry time (sec) */
3830 __u8 lc_hmac[CAPA_HMAC_MAX_LEN]; /** HMAC */
3831 } __attribute__((packed));
3833 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
3835 /** lustre_capa::lc_opc */
3837 CAPA_OPC_BODY_WRITE = 1<<0, /**< write object data */
3838 CAPA_OPC_BODY_READ = 1<<1, /**< read object data */
3839 CAPA_OPC_INDEX_LOOKUP = 1<<2, /**< lookup object fid */
3840 CAPA_OPC_INDEX_INSERT = 1<<3, /**< insert object fid */
3841 CAPA_OPC_INDEX_DELETE = 1<<4, /**< delete object fid */
3842 CAPA_OPC_OSS_WRITE = 1<<5, /**< write oss object data */
3843 CAPA_OPC_OSS_READ = 1<<6, /**< read oss object data */
3844 CAPA_OPC_OSS_TRUNC = 1<<7, /**< truncate oss object */
3845 CAPA_OPC_OSS_DESTROY = 1<<8, /**< destroy oss object */
3846 CAPA_OPC_META_WRITE = 1<<9, /**< write object meta data */
3847 CAPA_OPC_META_READ = 1<<10, /**< read object meta data */
3850 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
3851 #define CAPA_OPC_MDS_ONLY \
3852 (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
3853 CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
3854 #define CAPA_OPC_OSS_ONLY \
3855 (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC | \
3856 CAPA_OPC_OSS_DESTROY)
3857 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
3858 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
3860 static inline bool lovea_slot_is_dummy(const struct lov_ost_data_v1 *obj)
3862 /* zero area does not care about the bytes-order. */
3863 if (obj->l_ost_oi.oi.oi_id == 0 && obj->l_ost_oi.oi.oi_seq == 0 &&
3864 obj->l_ost_idx == 0 && obj->l_ost_gen == 0)
3870 /* lustre_capa::lc_hmac_alg */
3872 CAPA_HMAC_ALG_SHA1 = 1, /**< sha1 algorithm */
3876 #define CAPA_FL_MASK 0x00ffffff
3877 #define CAPA_HMAC_ALG_MASK 0xff000000
3879 struct lustre_capa_key {
3880 __u64 lk_seq; /**< mds# */
3881 __u32 lk_keyid; /**< key# */
3883 __u8 lk_key[CAPA_HMAC_KEY_MAX_LEN]; /**< key */
3884 } __attribute__((packed));
3886 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
3888 /** The link ea holds 1 \a link_ea_entry for each hardlink */
3889 #define LINK_EA_MAGIC 0x11EAF1DFUL
3890 struct link_ea_header {
3893 __u64 leh_len; /* total size */
3899 /** Hardlink data is name and parent fid.
3900 * Stored in this crazy struct for maximum packing and endian-neutrality
3902 struct link_ea_entry {
3903 /** __u16 stored big-endian, unaligned */
3904 unsigned char lee_reclen[2];
3905 unsigned char lee_parent_fid[sizeof(struct lu_fid)];
3907 }__attribute__((packed));
3909 /** fid2path request/reply structure */
3910 struct getinfo_fid2path {
3911 struct lu_fid gf_fid;
3916 } __attribute__((packed));
3918 void lustre_swab_fid2path (struct getinfo_fid2path *gf);
3920 /** path2parent request/reply structures */
3922 struct lu_fid gp_fid; /**< parent FID */
3923 __u32 gp_linkno; /**< hardlink number */
3924 __u32 gp_name_size; /**< size of the name field */
3925 char gp_name[0]; /**< zero-terminated link name */
3926 } __attribute__((packed));
3929 LAYOUT_INTENT_ACCESS = 0,
3930 LAYOUT_INTENT_READ = 1,
3931 LAYOUT_INTENT_WRITE = 2,
3932 LAYOUT_INTENT_GLIMPSE = 3,
3933 LAYOUT_INTENT_TRUNC = 4,
3934 LAYOUT_INTENT_RELEASE = 5,
3935 LAYOUT_INTENT_RESTORE = 6
3938 /* enqueue layout lock with intent */
3939 struct layout_intent {
3940 __u32 li_opc; /* intent operation for enqueue, read, write etc */
3946 void lustre_swab_layout_intent(struct layout_intent *li);
3949 * On the wire version of hsm_progress structure.
3951 * Contains the userspace hsm_progress and some internal fields.
3953 struct hsm_progress_kernel {
3954 /* Field taken from struct hsm_progress */
3957 struct hsm_extent hpk_extent;
3959 __u16 hpk_errval; /* positive val */
3961 /* Additional fields */
3962 __u64 hpk_data_version;
3964 } __attribute__((packed));
3966 extern void lustre_swab_hsm_user_state(struct hsm_user_state *hus);
3967 extern void lustre_swab_hsm_current_action(struct hsm_current_action *action);
3968 extern void lustre_swab_hsm_progress_kernel(struct hsm_progress_kernel *hpk);
3969 extern void lustre_swab_hsm_user_state(struct hsm_user_state *hus);
3970 extern void lustre_swab_hsm_user_item(struct hsm_user_item *hui);
3971 extern void lustre_swab_hsm_request(struct hsm_request *hr);
3974 * OUT_UPDATE RPC Format
3976 * During the cross-ref operation, the Master MDT, which the client send the
3977 * request to, will disassembly the operation into object updates, then OSP
3978 * will send these updates to the remote MDT to be executed.
3980 * An UPDATE_OBJ RPC does a list of updates. Each update belongs to an
3981 * operation and does a type of modification to an object.
3989 * update (ub_count-th)
3991 * ub_count must be less than or equal to UPDATE_PER_RPC_MAX.
3996 * rc [+ buffers] (1st)
3997 * rc [+ buffers] (2st)
3999 * rc [+ buffers] (nr_count-th)
4001 * ur_count must be less than or equal to UPDATE_PER_RPC_MAX and should usually
4002 * be equal to ub_count.
4006 * Type of each update, if adding/deleting update, please also update
4007 * update_opcode in lustre/target/out_lib.c.
4019 OUT_INDEX_LOOKUP = 9,
4020 OUT_INDEX_INSERT = 10,
4021 OUT_INDEX_DELETE = 11,
4030 UPDATE_FL_OST = 0x00000001, /* op from OST (not MDT) */
4031 UPDATE_FL_SYNC = 0x00000002, /* commit before replying */
4032 UPDATE_FL_COMMITTED = 0x00000004, /* op committed globally */
4033 UPDATE_FL_NOLOG = 0x00000008 /* for idempotent updates */
4036 struct object_update_param {
4037 __u16 oup_len; /* length of this parameter */
4043 static inline size_t
4044 object_update_param_size(const struct object_update_param *param)
4046 return cfs_size_round(sizeof(*param) + param->oup_len);
4050 struct object_update {
4051 __u16 ou_type; /* enum update_type */
4052 __u16 ou_params_count; /* update parameters count */
4053 __u32 ou_master_index; /* master MDT/OST index */
4054 __u32 ou_flags; /* enum update_flag */
4055 __u32 ou_padding1; /* padding 1 */
4056 __u64 ou_batchid; /* op transno on master */
4057 struct lu_fid ou_fid; /* object to be updated */
4058 struct object_update_param ou_params[0]; /* update params */
4061 #define UPDATE_REQUEST_MAGIC_V1 0xBDDE0001
4062 #define UPDATE_REQUEST_MAGIC_V2 0xBDDE0002
4063 #define UPDATE_REQUEST_MAGIC UPDATE_REQUEST_MAGIC_V2
4064 /* Hold object_updates sending to the remote OUT in single RPC */
4065 struct object_update_request {
4067 __u16 ourq_count; /* number of ourq_updates[] */
4069 struct object_update ourq_updates[0];
4072 #define OUT_UPDATE_HEADER_MAGIC 0xBDDF0001
4073 /* Header for updates request between MDTs */
4074 struct out_update_header {
4079 struct out_update_buffer {
4084 void lustre_swab_object_update(struct object_update *ou);
4085 void lustre_swab_object_update_request(struct object_update_request *our);
4086 void lustre_swab_out_update_header(struct out_update_header *ouh);
4087 void lustre_swab_out_update_buffer(struct out_update_buffer *oub);
4089 static inline size_t
4090 object_update_params_size(const struct object_update *update)
4092 const struct object_update_param *param;
4093 size_t total_size = 0;
4096 param = &update->ou_params[0];
4097 for (i = 0; i < update->ou_params_count; i++) {
4098 size_t size = object_update_param_size(param);
4100 param = (struct object_update_param *)((char *)param + size);
4107 static inline size_t
4108 object_update_size(const struct object_update *update)
4110 return offsetof(struct object_update, ou_params[0]) +
4111 object_update_params_size(update);
4114 static inline struct object_update *
4115 object_update_request_get(const struct object_update_request *our,
4116 unsigned int index, size_t *size)
4121 if (index >= our->ourq_count)
4124 ptr = (void *)&our->ourq_updates[0];
4125 for (i = 0; i < index; i++)
4126 ptr += object_update_size(ptr);
4129 *size = object_update_size(ptr);
4135 /* the result of object update */
4136 struct object_update_result {
4143 #define UPDATE_REPLY_MAGIC_V1 0x00BD0001
4144 #define UPDATE_REPLY_MAGIC_V2 0x00BD0002
4145 #define UPDATE_REPLY_MAGIC UPDATE_REPLY_MAGIC_V2
4146 /* Hold object_update_results being replied from the remote OUT. */
4147 struct object_update_reply {
4154 void lustre_swab_object_update_result(struct object_update_result *our);
4155 void lustre_swab_object_update_reply(struct object_update_reply *our);
4157 static inline struct object_update_result *
4158 object_update_result_get(const struct object_update_reply *reply,
4159 unsigned int index, size_t *size)
4161 __u16 count = reply->ourp_count;
4168 ptr = (char *)reply +
4169 cfs_size_round(offsetof(struct object_update_reply,
4171 for (i = 0; i < index; i++) {
4172 if (reply->ourp_lens[i] == 0)
4175 ptr += cfs_size_round(reply->ourp_lens[i]);
4179 *size = reply->ourp_lens[index];
4184 /* read update result */
4185 struct out_read_reply {
4192 static inline void orr_cpu_to_le(struct out_read_reply *orr_dst,
4193 const struct out_read_reply *orr_src)
4195 orr_dst->orr_size = cpu_to_le32(orr_src->orr_size);
4196 orr_dst->orr_padding = cpu_to_le32(orr_src->orr_padding);
4197 orr_dst->orr_offset = cpu_to_le64(orr_dst->orr_offset);
4200 static inline void orr_le_to_cpu(struct out_read_reply *orr_dst,
4201 const struct out_read_reply *orr_src)
4203 orr_dst->orr_size = le32_to_cpu(orr_src->orr_size);
4204 orr_dst->orr_padding = le32_to_cpu(orr_src->orr_padding);
4205 orr_dst->orr_offset = le64_to_cpu(orr_dst->orr_offset);
4208 /** layout swap request structure
4209 * fid1 and fid2 are in mdt_body
4211 struct mdc_swap_layouts {
4215 void lustre_swab_swap_layouts(struct mdc_swap_layouts *msl);
4218 struct lustre_handle cd_handle;
4219 struct lu_fid cd_fid;
4220 __u64 cd_data_version;
4221 __u64 cd_reserved[8];
4224 void lustre_swab_close_data(struct close_data *data);