1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
33 * Copyright (c) 2011 Whamcloud, Inc.
36 * This file is part of Lustre, http://www.lustre.org/
37 * Lustre is a trademark of Sun Microsystems, Inc.
39 * lustre/include/lustre/lustre_idl.h
41 * Lustre wire protocol definitions.
44 /** \defgroup lustreidl lustreidl
46 * Lustre wire protocol definitions.
48 * ALL structs passing over the wire should be declared here. Structs
49 * that are used in interfaces with userspace should go in lustre_user.h.
51 * All structs being declared here should be built from simple fixed-size
52 * types (__u8, __u16, __u32, __u64) or be built from other types or
53 * structs also declared in this file. Similarly, all flags and magic
54 * values in those structs should also be declared here. This ensures
55 * that the Lustre wire protocol is not influenced by external dependencies.
57 * The only other acceptable items in this file are VERY SIMPLE accessor
58 * functions to avoid callers grubbing inside the structures, and the
59 * prototypes of the swabber functions for each struct. Nothing that
60 * depends on external functions or definitions should be in here.
62 * Structs must be properly aligned to put 64-bit values on an 8-byte
63 * boundary. Any structs being added here must also be added to
64 * utils/wirecheck.c and "make newwiretest" run to regenerate the
65 * utils/wiretest.c sources. This allows us to verify that wire structs
66 * have the proper alignment/size on all architectures.
68 * DO NOT CHANGE any of the structs, flags, values declared here and used
69 * in released Lustre versions. Some structs may have padding fields that
70 * can be used. Some structs might allow addition at the end (verify this
71 * in the code to ensure that new/old clients that see this larger struct
72 * do not fail, otherwise you need to implement protocol compatibility).
74 * We assume all nodes are either little-endian or big-endian, and we
75 * always send messages in the sender's native format. The receiver
76 * detects the message format by checking the 'magic' field of the message
77 * (see lustre_msg_swabbed() below).
79 * Each wire type has corresponding 'lustre_swab_xxxtypexxx()' routines,
80 * implemented either here, inline (trivial implementations) or in
81 * ptlrpc/pack_generic.c. These 'swabbers' convert the type from "other"
82 * endian, in-place in the message buffer.
84 * A swabber takes a single pointer argument. The caller must already have
85 * verified that the length of the message buffer >= sizeof (type).
87 * For variable length types, a second 'lustre_swab_v_xxxtypexxx()' routine
88 * may be defined that swabs just the variable part, after the caller has
89 * verified that the message buffer is large enough.
94 #ifndef _LUSTRE_IDL_H_
95 #define _LUSTRE_IDL_H_
97 #if !defined(LASSERT) && !defined(LPU64)
98 #include <libcfs/libcfs.h> /* for LASSERT, LPUX64, etc */
101 /* Defn's shared with user-space. */
102 #include <lustre/lustre_user.h>
107 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
108 * FOO_REPLY_PORTAL is for incoming replies on the FOO
109 * FOO_BULK_PORTAL is for incoming bulk on the FOO
112 #define CONNMGR_REQUEST_PORTAL 1
113 #define CONNMGR_REPLY_PORTAL 2
114 //#define OSC_REQUEST_PORTAL 3
115 #define OSC_REPLY_PORTAL 4
116 //#define OSC_BULK_PORTAL 5
117 #define OST_IO_PORTAL 6
118 #define OST_CREATE_PORTAL 7
119 #define OST_BULK_PORTAL 8
120 //#define MDC_REQUEST_PORTAL 9
121 #define MDC_REPLY_PORTAL 10
122 //#define MDC_BULK_PORTAL 11
123 #define MDS_REQUEST_PORTAL 12
124 //#define MDS_REPLY_PORTAL 13
125 #define MDS_BULK_PORTAL 14
126 #define LDLM_CB_REQUEST_PORTAL 15
127 #define LDLM_CB_REPLY_PORTAL 16
128 #define LDLM_CANCEL_REQUEST_PORTAL 17
129 #define LDLM_CANCEL_REPLY_PORTAL 18
130 //#define PTLBD_REQUEST_PORTAL 19
131 //#define PTLBD_REPLY_PORTAL 20
132 //#define PTLBD_BULK_PORTAL 21
133 #define MDS_SETATTR_PORTAL 22
134 #define MDS_READPAGE_PORTAL 23
135 #define MDS_MDS_PORTAL 24
137 #define MGC_REPLY_PORTAL 25
138 #define MGS_REQUEST_PORTAL 26
139 #define MGS_REPLY_PORTAL 27
140 #define OST_REQUEST_PORTAL 28
141 #define FLD_REQUEST_PORTAL 29
142 #define SEQ_METADATA_PORTAL 30
143 #define SEQ_DATA_PORTAL 31
144 #define SEQ_CONTROLLER_PORTAL 32
146 /* Portal 63 is reserved for the Cray Inc DVS - nic@cray.com, roe@cray.com, n8851@cray.com */
149 #define PTL_RPC_MSG_REQUEST 4711
150 #define PTL_RPC_MSG_ERR 4712
151 #define PTL_RPC_MSG_REPLY 4713
153 /* DON'T use swabbed values of MAGIC as magic! */
154 #define LUSTRE_MSG_MAGIC_V1 0x0BD00BD0
155 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
157 #define LUSTRE_MSG_MAGIC_V1_SWABBED 0xD00BD00B
158 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
160 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
162 #define PTLRPC_MSG_VERSION 0x00000003
163 #define LUSTRE_VERSION_MASK 0xffff0000
164 #define LUSTRE_OBD_VERSION 0x00010000
165 #define LUSTRE_MDS_VERSION 0x00020000
166 #define LUSTRE_OST_VERSION 0x00030000
167 #define LUSTRE_DLM_VERSION 0x00040000
168 #define LUSTRE_LOG_VERSION 0x00050000
169 #define LUSTRE_MGS_VERSION 0x00060000
171 typedef __u32 mdsno_t;
172 typedef __u64 seqno_t;
173 typedef __u64 obd_id;
174 typedef __u64 obd_seq;
175 typedef __s64 obd_time;
176 typedef __u64 obd_size;
177 typedef __u64 obd_off;
178 typedef __u64 obd_blocks;
179 typedef __u64 obd_valid;
180 typedef __u32 obd_blksize;
181 typedef __u32 obd_mode;
182 typedef __u32 obd_uid;
183 typedef __u32 obd_gid;
184 typedef __u32 obd_flag;
185 typedef __u32 obd_count;
188 * Describes a range of sequence, lsr_start is included but lsr_end is
190 * Same structure is used in fld module where lsr_index field holds mdt id
194 #define LU_SEQ_RANGE_MDT 0x0
195 #define LU_SEQ_RANGE_OST 0x1
197 struct lu_seq_range {
205 * returns width of given range \a r
208 static inline __u64 range_space(const struct lu_seq_range *range)
210 return range->lsr_end - range->lsr_start;
214 * initialize range to zero
217 static inline void range_init(struct lu_seq_range *range)
219 range->lsr_start = range->lsr_end = range->lsr_index = 0;
223 * check if given seq id \a s is within given range \a r
226 static inline int range_within(const struct lu_seq_range *range,
229 return s >= range->lsr_start && s < range->lsr_end;
232 static inline int range_is_sane(const struct lu_seq_range *range)
234 return (range->lsr_end >= range->lsr_start);
237 static inline int range_is_zero(const struct lu_seq_range *range)
239 return (range->lsr_start == 0 && range->lsr_end == 0);
242 static inline int range_is_exhausted(const struct lu_seq_range *range)
245 return range_space(range) == 0;
248 /* return 0 if two range have the same location */
249 static inline int range_compare_loc(const struct lu_seq_range *r1,
250 const struct lu_seq_range *r2)
252 return r1->lsr_index != r2->lsr_index ||
253 r1->lsr_flags != r2->lsr_flags;
256 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x):%x:%x"
258 #define PRANGE(range) \
259 (range)->lsr_start, \
261 (range)->lsr_index, \
264 /** \defgroup lu_fid lu_fid
268 * Flags for lustre_mdt_attrs::lma_compat and lustre_mdt_attrs::lma_incompat.
271 LMAC_HSM = 0x00000001,
272 LMAC_SOM = 0x00000002,
276 * Masks for all features that should be supported by a Lustre version to
277 * access a specific file.
278 * This information is stored in lustre_mdt_attrs::lma_incompat.
280 * NOTE: No incompat feature should be added before bug #17670 is landed.
282 #define LMA_INCOMPAT_SUPP 0x0
285 * Following struct for MDT attributes, that will be kept inode's EA.
286 * Introduced in 2.0 release (please see b15993, for details)
288 struct lustre_mdt_attrs {
290 * Bitfield for supported data in this structure. From enum lma_compat.
291 * lma_self_fid and lma_flags are always available.
295 * Per-file incompat feature list. Lustre version should support all
296 * flags set in this field. The supported feature mask is available in
300 /** FID of this inode */
301 struct lu_fid lma_self_fid;
302 /** mdt/ost type, others */
304 /* IO Epoch SOM attributes belongs to */
306 /** total file size in objects */
308 /** total fs blocks in objects */
309 __u64 lma_som_blocks;
310 /** mds mount id the size is valid for */
311 __u64 lma_som_mountid;
315 * Fill \a lma with its first content.
316 * Only fid is stored.
318 static inline void lustre_lma_init(struct lustre_mdt_attrs *lma,
319 const struct lu_fid *fid)
322 lma->lma_incompat = 0;
323 memcpy(&lma->lma_self_fid, fid, sizeof(*fid));
325 lma->lma_ioepoch = 0;
326 lma->lma_som_size = 0;
327 lma->lma_som_blocks = 0;
328 lma->lma_som_mountid = 0;
330 /* If a field is added in struct lustre_mdt_attrs, zero it explicitly
331 * and change the test below. */
332 LASSERT(sizeof(*lma) ==
333 (offsetof(struct lustre_mdt_attrs, lma_som_mountid) +
334 sizeof(lma->lma_som_mountid)));
337 extern void lustre_swab_lu_fid(struct lu_fid *fid);
340 * Swab, if needed, lustre_mdt_attr struct to on-disk format.
341 * Otherwise, do not touch it.
343 static inline void lustre_lma_swab(struct lustre_mdt_attrs *lma)
345 /* Use LUSTRE_MSG_MAGIC to detect local endianess. */
346 if (LUSTRE_MSG_MAGIC != cpu_to_le32(LUSTRE_MSG_MAGIC)) {
347 __swab32s(&lma->lma_compat);
348 __swab32s(&lma->lma_incompat);
349 lustre_swab_lu_fid(&lma->lma_self_fid);
350 __swab64s(&lma->lma_flags);
351 __swab64s(&lma->lma_ioepoch);
352 __swab64s(&lma->lma_som_size);
353 __swab64s(&lma->lma_som_blocks);
354 __swab64s(&lma->lma_som_mountid);
358 /* This is the maximum number of MDTs allowed in CMD testing until such
359 * a time that FID-on-OST is implemented. This is due to the limitations
360 * of packing non-0-MDT numbers into the FID SEQ namespace. Once FID-on-OST
361 * is implemented this limit will be virtually unlimited. */
362 #define MAX_MDT_COUNT 8
369 /** initial fid id value */
370 LUSTRE_FID_INIT_OID = 1UL
373 /** returns fid object sequence */
374 static inline __u64 fid_seq(const struct lu_fid *fid)
379 /** returns fid object id */
380 static inline __u32 fid_oid(const struct lu_fid *fid)
385 /** returns fid object version */
386 static inline __u32 fid_ver(const struct lu_fid *fid)
391 static inline void fid_zero(struct lu_fid *fid)
393 memset(fid, 0, sizeof(*fid));
396 static inline obd_id fid_ver_oid(const struct lu_fid *fid)
398 return ((__u64)fid_ver(fid) << 32 | fid_oid(fid));
402 * Note that reserved SEQ numbers below 12 will conflict with ldiskfs
403 * inodes in the IGIF namespace, so these reserved SEQ numbers can be
404 * used for other purposes and not risk collisions with existing inodes.
406 * Different FID Format
407 * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs#NEW.0
410 FID_SEQ_OST_MDT0 = 0,
413 FID_SEQ_OST_MDT1 = 3,
414 FID_SEQ_OST_MAX = 9, /* Max MDT count before OST_on_FID */
417 FID_SEQ_IGIF_MAX = 0x0ffffffffULL,
418 FID_SEQ_IDIF = 0x100000000ULL,
419 FID_SEQ_IDIF_MAX = 0x1ffffffffULL,
420 /* Normal FID sequence starts from this value, i.e. 1<<33 */
421 FID_SEQ_START = 0x200000000ULL,
422 FID_SEQ_LOCAL_FILE = 0x200000001ULL,
423 FID_SEQ_DOT_LUSTRE = 0x200000002ULL,
424 FID_SEQ_NORMAL = 0x200000400ULL,
425 FID_SEQ_LOV_DEFAULT= 0xffffffffffffffffULL
428 #define OBIF_OID_MAX_BITS 32
429 #define OBIF_MAX_OID (1ULL << OBIF_OID_MAX_BITS)
430 #define OBIF_OID_MASK ((1ULL << OBIF_OID_MAX_BITS) - 1)
431 #define IDIF_OID_MAX_BITS 48
432 #define IDIF_MAX_OID (1ULL << IDIF_OID_MAX_BITS)
433 #define IDIF_OID_MASK ((1ULL << IDIF_OID_MAX_BITS) - 1)
436 static inline int fid_seq_is_mdt0(obd_seq seq)
438 return (seq == FID_SEQ_OST_MDT0);
441 static inline int fid_seq_is_cmd(const __u64 seq)
443 return (seq >= FID_SEQ_OST_MDT1 && seq <= FID_SEQ_OST_MAX);
446 static inline int fid_seq_is_mdt(const __u64 seq)
448 return seq == FID_SEQ_OST_MDT0 ||
449 (seq >= FID_SEQ_OST_MDT1 && seq <= FID_SEQ_OST_MAX);
452 static inline int fid_seq_is_rsvd(const __u64 seq)
454 return seq <= FID_SEQ_RSVD;
457 static inline int fid_is_mdt0(const struct lu_fid *fid)
459 return fid_seq_is_mdt0(fid_seq(fid));
463 * Check if a fid is igif or not.
464 * \param fid the fid to be tested.
465 * \return true if the fid is a igif; otherwise false.
467 static inline int fid_seq_is_igif(const __u64 seq)
469 return seq >= FID_SEQ_IGIF && seq <= FID_SEQ_IGIF_MAX;
472 static inline int fid_is_igif(const struct lu_fid *fid)
474 return fid_seq_is_igif(fid_seq(fid));
478 * Check if a fid is idif or not.
479 * \param fid the fid to be tested.
480 * \return true if the fid is a idif; otherwise false.
482 static inline int fid_seq_is_idif(const __u64 seq)
484 return seq >= FID_SEQ_IDIF && seq <= FID_SEQ_IDIF_MAX;
487 static inline int fid_is_idif(const struct lu_fid *fid)
489 return fid_seq_is_idif(fid_seq(fid));
497 static inline int fid_seq_is_norm(const __u64 seq)
499 return (seq >= FID_SEQ_NORMAL);
502 static inline int fid_is_norm(const struct lu_fid *fid)
504 return fid_seq_is_norm(fid_seq(fid));
507 /* convert an OST objid into an IDIF FID SEQ number */
508 static inline obd_seq fid_idif_seq(obd_id id, __u32 ost_idx)
510 return FID_SEQ_IDIF | (ost_idx << 16) | ((id >> 32) & 0xffff);
513 /* convert a packed IDIF FID into an OST objid */
514 static inline obd_id fid_idif_id(obd_seq seq, __u32 oid, __u32 ver)
516 return ((__u64)ver << 48) | ((seq & 0xffff) << 32) | oid;
519 /* unpack an ostid (id/seq) from a wire/disk structure into an IDIF FID */
520 static inline void ostid_idif_unpack(struct ost_id *ostid,
521 struct lu_fid *fid, __u32 ost_idx)
523 fid->f_seq = fid_idif_seq(ostid->oi_id, ost_idx);
524 fid->f_oid = ostid->oi_id; /* truncate to 32 bits by assignment */
525 fid->f_ver = ostid->oi_id >> 48; /* in theory, not currently used */
528 /* unpack an ostid (id/seq) from a wire/disk structure into a non-IDIF FID */
529 static inline void ostid_fid_unpack(struct ost_id *ostid, struct lu_fid *fid)
531 fid->f_seq = ostid->oi_seq;
532 fid->f_oid = ostid->oi_id; /* truncate to 32 bits by assignment */
533 fid->f_ver = ostid->oi_id >> 32; /* in theory, not currently used */
536 /* Unpack an OST object id/seq (group) into a FID. This is needed for
537 * converting all obdo, lmm, lsm, etc. 64-bit id/seq pairs into proper
538 * FIDs. Note that if an id/seq is already in FID/IDIF format it will
539 * be passed through unchanged. Only legacy OST objects in "group 0"
540 * will be mapped into the IDIF namespace so that they can fit into the
541 * struct lu_fid fields without loss. For reference see:
542 * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs
544 static inline int fid_ostid_unpack(struct lu_fid *fid, struct ost_id *ostid,
547 if (ost_idx > 0xffff) {
548 CERROR("bad ost_idx, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
549 ostid->oi_seq, ostid->oi_id, ost_idx);
553 if (fid_seq_is_mdt0(ostid->oi_seq)) {
554 /* This is a "legacy" (old 1.x/2.early) OST object in "group 0"
555 * that we map into the IDIF namespace. It allows up to 2^48
556 * objects per OST, as this is the object namespace that has
557 * been in production for years. This can handle create rates
558 * of 1M objects/s/OST for 9 years, or combinations thereof. */
559 if (ostid->oi_id >= IDIF_MAX_OID) {
560 CERROR("bad MDT0 id, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
561 ostid->oi_seq, ostid->oi_id, ost_idx);
564 ostid_idif_unpack(ostid, fid, ost_idx);
566 } else if (fid_seq_is_rsvd(ostid->oi_seq)) {
567 /* These are legacy OST objects for LLOG/ECHO and CMD testing.
568 * We only support 2^32 objects in these groups, and cannot
569 * uniquely identify them in the system (i.e. they are the
570 * duplicated on all OSTs), but this is not strictly required
571 * for the old object protocol, which has a separate ost_idx. */
572 if (ostid->oi_id >= 0xffffffffULL) {
573 CERROR("bad RSVD id, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
574 ostid->oi_seq, ostid->oi_id, ost_idx);
577 ostid_fid_unpack(ostid, fid);
579 } else if (unlikely(fid_seq_is_igif(ostid->oi_seq))) {
580 /* This is an MDT inode number, which should never collide with
581 * proper OST object IDs, and is probably a broken filesystem */
582 CERROR("bad IGIF, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
583 ostid->oi_seq, ostid->oi_id, ost_idx);
586 } else /* if (fid_seq_is_idif(seq) || fid_seq_is_norm(seq)) */ {
587 /* This is either an IDIF object, which identifies objects across
588 * all OSTs, or a regular FID. The IDIF namespace maps legacy
589 * OST objects into the FID namespace. In both cases, we just
590 * pass the FID through, no conversion needed. */
591 ostid_fid_unpack(ostid, fid);
597 /* pack an IDIF FID into an ostid (id/seq) for the wire/disk */
598 static inline void ostid_idif_pack(struct lu_fid *fid, struct ost_id *ostid)
600 ostid->oi_seq = FID_SEQ_OST_MDT0;
601 ostid->oi_id = fid_idif_id(fid->f_seq, fid->f_oid, fid->f_ver);
604 /* pack a non-IDIF FID into an ostid (id/seq) for the wire/disk */
605 static inline void ostid_fid_pack(struct lu_fid *fid, struct ost_id *ostid)
607 ostid->oi_seq = fid_seq(fid);
608 ostid->oi_id = fid_ver_oid(fid);
611 /* pack any OST FID into an ostid (id/seq) for the wire/disk */
612 static inline int fid_ostid_pack(struct lu_fid *fid, struct ost_id *ostid)
614 if (unlikely(fid_seq_is_igif(fid->f_seq))) {
615 CERROR("bad IGIF, "DFID"\n", PFID(fid));
619 if (fid_is_idif(fid))
620 ostid_idif_pack(fid, ostid);
622 ostid_fid_pack(fid, ostid);
627 /* extract OST sequence (group) from a wire ost_id (id/seq) pair */
628 static inline obd_seq ostid_seq(struct ost_id *ostid)
630 if (unlikely(fid_seq_is_igif(ostid->oi_seq)))
631 CWARN("bad IGIF, oi_seq: "LPU64" oi_id: "LPX64"\n",
632 ostid->oi_seq, ostid->oi_id);
634 if (unlikely(fid_seq_is_idif(ostid->oi_seq)))
635 return FID_SEQ_OST_MDT0;
637 return ostid->oi_seq;
640 /* extract OST objid from a wire ost_id (id/seq) pair */
641 static inline obd_id ostid_id(struct ost_id *ostid)
643 if (ostid->oi_seq == FID_SEQ_OST_MDT0)
644 return ostid->oi_id & IDIF_OID_MASK;
646 if (fid_seq_is_rsvd(ostid->oi_seq))
647 return ostid->oi_id & OBIF_OID_MASK;
649 if (fid_seq_is_idif(ostid->oi_seq))
650 return fid_idif_id(ostid->oi_seq, ostid->oi_id, 0);
656 * Get inode number from a igif.
657 * \param fid a igif to get inode number from.
658 * \return inode number for the igif.
660 static inline ino_t lu_igif_ino(const struct lu_fid *fid)
666 * Build igif from the inode number/generation.
668 #define LU_IGIF_BUILD(fid, ino, gen) \
674 static inline void lu_igif_build(struct lu_fid *fid, __u32 ino, __u32 gen)
676 LU_IGIF_BUILD(fid, ino, gen);
677 LASSERT(fid_is_igif(fid));
681 * Get inode generation from a igif.
682 * \param fid a igif to get inode generation from.
683 * \return inode generation for the igif.
685 static inline __u32 lu_igif_gen(const struct lu_fid *fid)
691 * Fids are transmitted across network (in the sender byte-ordering),
692 * and stored on disk in big-endian order.
694 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
696 /* check that all fields are converted */
697 CLASSERT(sizeof *src ==
698 sizeof fid_seq(src) +
699 sizeof fid_oid(src) + sizeof fid_ver(src));
700 LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
701 dst->f_seq = cpu_to_le64(fid_seq(src));
702 dst->f_oid = cpu_to_le32(fid_oid(src));
703 dst->f_ver = cpu_to_le32(fid_ver(src));
706 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
708 /* check that all fields are converted */
709 CLASSERT(sizeof *src ==
710 sizeof fid_seq(src) +
711 sizeof fid_oid(src) + sizeof fid_ver(src));
712 dst->f_seq = le64_to_cpu(fid_seq(src));
713 dst->f_oid = le32_to_cpu(fid_oid(src));
714 dst->f_ver = le32_to_cpu(fid_ver(src));
715 LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
718 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
720 /* check that all fields are converted */
721 CLASSERT(sizeof *src ==
722 sizeof fid_seq(src) +
723 sizeof fid_oid(src) + sizeof fid_ver(src));
724 LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
725 dst->f_seq = cpu_to_be64(fid_seq(src));
726 dst->f_oid = cpu_to_be32(fid_oid(src));
727 dst->f_ver = cpu_to_be32(fid_ver(src));
730 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
732 /* check that all fields are converted */
733 CLASSERT(sizeof *src ==
734 sizeof fid_seq(src) +
735 sizeof fid_oid(src) + sizeof fid_ver(src));
736 dst->f_seq = be64_to_cpu(fid_seq(src));
737 dst->f_oid = be32_to_cpu(fid_oid(src));
738 dst->f_ver = be32_to_cpu(fid_ver(src));
739 LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
742 static inline int fid_is_sane(const struct lu_fid *fid)
746 ((fid_seq(fid) >= FID_SEQ_START && fid_oid(fid) != 0
747 && fid_ver(fid) == 0) ||
751 static inline int fid_is_zero(const struct lu_fid *fid)
753 return fid_seq(fid) == 0 && fid_oid(fid) == 0;
756 extern void lustre_swab_lu_fid(struct lu_fid *fid);
757 extern void lustre_swab_lu_seq_range(struct lu_seq_range *range);
759 static inline int lu_fid_eq(const struct lu_fid *f0,
760 const struct lu_fid *f1)
762 /* Check that there is no alignment padding. */
763 CLASSERT(sizeof *f0 ==
764 sizeof f0->f_seq + sizeof f0->f_oid + sizeof f0->f_ver);
765 LASSERTF(fid_is_igif(f0) || fid_ver(f0) == 0, DFID, PFID(f0));
766 LASSERTF(fid_is_igif(f1) || fid_ver(f1) == 0, DFID, PFID(f1));
767 return memcmp(f0, f1, sizeof *f0) == 0;
770 #define __diff_normalize(val0, val1) \
772 typeof(val0) __val0 = (val0); \
773 typeof(val1) __val1 = (val1); \
775 (__val0 == __val1 ? 0 : __val0 > __val1 ? +1 : -1); \
778 static inline int lu_fid_cmp(const struct lu_fid *f0,
779 const struct lu_fid *f1)
782 __diff_normalize(fid_seq(f0), fid_seq(f1)) ?:
783 __diff_normalize(fid_oid(f0), fid_oid(f1)) ?:
784 __diff_normalize(fid_ver(f0), fid_ver(f1));
789 /** \defgroup lu_dir lu_dir
793 * Enumeration of possible directory entry attributes.
795 * Attributes follow directory entry header in the order they appear in this
798 enum lu_dirent_attrs {
801 LUDA_64BITHASH = 0x0004,
805 * Layout of readdir pages, as transmitted on wire.
808 /** valid if LUDA_FID is set. */
809 struct lu_fid lde_fid;
810 /** a unique entry identifier: a hash or an offset. */
812 /** total record length, including all attributes. */
816 /** optional variable size attributes following this entry.
817 * taken from enum lu_dirent_attrs.
820 /** name is followed by the attributes indicated in ->ldp_attrs, in
821 * their natural order. After the last attribute, padding bytes are
822 * added to make ->lde_reclen a multiple of 8.
828 * Definitions of optional directory entry attributes formats.
830 * Individual attributes do not have their length encoded in a generic way. It
831 * is assumed that consumer of an attribute knows its format. This means that
832 * it is impossible to skip over an unknown attribute, except by skipping over all
833 * remaining attributes (by using ->lde_reclen), which is not too
834 * constraining, because new server versions will append new attributes at
835 * the end of an entry.
839 * Fid directory attribute: a fid of an object referenced by the entry. This
840 * will be almost always requested by the client and supplied by the server.
842 * Aligned to 8 bytes.
844 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
849 * Aligned to 2 bytes.
856 __u64 ldp_hash_start;
860 struct lu_dirent ldp_entries[0];
863 enum lu_dirpage_flags {
865 * dirpage contains no entry.
869 * last entry's lde_hash equals ldp_hash_end.
874 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
876 if (le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
879 return dp->ldp_entries;
882 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
884 struct lu_dirent *next;
886 if (le16_to_cpu(ent->lde_reclen) != 0)
887 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
894 static inline int lu_dirent_calc_size(int namelen, __u16 attr)
898 if (attr & LUDA_TYPE) {
899 const unsigned align = sizeof(struct luda_type) - 1;
900 size = (sizeof(struct lu_dirent) + namelen + align) & ~align;
901 size += sizeof(struct luda_type);
903 size = sizeof(struct lu_dirent) + namelen;
905 return (size + 7) & ~7;
908 static inline int lu_dirent_size(struct lu_dirent *ent)
910 if (le16_to_cpu(ent->lde_reclen) == 0) {
911 return lu_dirent_calc_size(le16_to_cpu(ent->lde_namelen),
912 le32_to_cpu(ent->lde_attrs));
914 return le16_to_cpu(ent->lde_reclen);
917 #define MDS_DIR_END_OFF 0xfffffffffffffffeULL
920 * MDS_READPAGE page size
922 * This is the directory page size packed in MDS_READPAGE RPC.
923 * It's different than CFS_PAGE_SIZE because the client needs to
924 * access the struct lu_dirpage header packed at the beginning of
925 * the "page" and without this there isn't any way to know find the
926 * lu_dirpage header is if client and server CFS_PAGE_SIZE differ.
928 #define LU_PAGE_SHIFT 12
929 #define LU_PAGE_SIZE (1UL << LU_PAGE_SHIFT)
930 #define LU_PAGE_MASK (~(LU_PAGE_SIZE - 1))
932 #define LU_PAGE_COUNT 1 << (CFS_PAGE_SHIFT - LU_PAGE_SHIFT)
936 struct lustre_handle {
939 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
941 static inline int lustre_handle_is_used(struct lustre_handle *lh)
943 return lh->cookie != 0ull;
946 static inline int lustre_handle_equal(const struct lustre_handle *lh1,
947 const struct lustre_handle *lh2)
949 return lh1->cookie == lh2->cookie;
952 static inline void lustre_handle_copy(struct lustre_handle *tgt,
953 struct lustre_handle *src)
955 tgt->cookie = src->cookie;
958 /* flags for lm_flags */
959 #define MSGHDR_AT_SUPPORT 0x1
960 #define MSGHDR_CKSUM_INCOMPAT18 0x2
962 #define lustre_msg lustre_msg_v2
963 /* we depend on this structure to be 8-byte aligned */
964 /* this type is only endian-adjusted in lustre_unpack_msg() */
965 struct lustre_msg_v2 {
977 /* without gss, ptlrpc_body is put at the first buffer. */
978 #define PTLRPC_NUM_VERSIONS 4
980 struct lustre_handle pb_handle;
987 __u64 pb_last_committed;
992 __u32 pb_timeout; /* for req, the deadline, for rep, the service est */
993 __u32 pb_service_time; /* for rep, actual service time */
996 /* VBR: pre-versions */
997 __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
998 /* padding for future needs */
1002 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
1004 /* message body offset for lustre_msg_v2 */
1005 /* ptlrpc body offset in all request/reply messages */
1006 #define MSG_PTLRPC_BODY_OFF 0
1008 /* normal request/reply message record offset */
1009 #define REQ_REC_OFF 1
1010 #define REPLY_REC_OFF 1
1012 /* ldlm request message body offset */
1013 #define DLM_LOCKREQ_OFF 1 /* lockreq offset */
1014 #define DLM_REQ_REC_OFF 2 /* normal dlm request record offset */
1016 /* ldlm intent lock message body offset */
1017 #define DLM_INTENT_IT_OFF 2 /* intent lock it offset */
1018 #define DLM_INTENT_REC_OFF 3 /* intent lock record offset */
1020 /* ldlm reply message body offset */
1021 #define DLM_LOCKREPLY_OFF 1 /* lockrep offset */
1022 #define DLM_REPLY_REC_OFF 2 /* reply record offset */
1024 /** only use in req->rq_{req,rep}_swab_mask */
1025 #define MSG_PTLRPC_HEADER_OFF 31
1027 /* Flags that are operation-specific go in the top 16 bits. */
1028 #define MSG_OP_FLAG_MASK 0xffff0000
1029 #define MSG_OP_FLAG_SHIFT 16
1031 /* Flags that apply to all requests are in the bottom 16 bits */
1032 #define MSG_GEN_FLAG_MASK 0x0000ffff
1033 #define MSG_LAST_REPLAY 0x0001
1034 #define MSG_RESENT 0x0002
1035 #define MSG_REPLAY 0x0004
1036 /* #define MSG_AT_SUPPORT 0x0008
1037 * This was used in early prototypes of adaptive timeouts, and while there
1038 * shouldn't be any users of that code there also isn't a need for using this
1039 * bits. Defer usage until at least 1.10 to avoid potential conflict. */
1040 #define MSG_DELAY_REPLAY 0x0010
1041 #define MSG_VERSION_REPLAY 0x0020
1042 #define MSG_REQ_REPLAY_DONE 0x0040
1043 #define MSG_LOCK_REPLAY_DONE 0x0080
1046 * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
1049 #define MSG_CONNECT_RECOVERING 0x00000001
1050 #define MSG_CONNECT_RECONNECT 0x00000002
1051 #define MSG_CONNECT_REPLAYABLE 0x00000004
1052 //#define MSG_CONNECT_PEER 0x8
1053 #define MSG_CONNECT_LIBCLIENT 0x00000010
1054 #define MSG_CONNECT_INITIAL 0x00000020
1055 #define MSG_CONNECT_ASYNC 0x00000040
1056 #define MSG_CONNECT_NEXT_VER 0x00000080 /* use next version of lustre_msg */
1057 #define MSG_CONNECT_TRANSNO 0x00000100 /* report transno */
1060 #define OBD_CONNECT_RDONLY 0x1ULL /*client has read-only access*/
1061 #define OBD_CONNECT_INDEX 0x2ULL /*connect specific LOV idx */
1062 #define OBD_CONNECT_MDS 0x4ULL /*connect from MDT to OST */
1063 #define OBD_CONNECT_GRANT 0x8ULL /*OSC gets grant at connect */
1064 #define OBD_CONNECT_SRVLOCK 0x10ULL /*server takes locks for cli */
1065 #define OBD_CONNECT_VERSION 0x20ULL /*Lustre versions in ocd */
1066 #define OBD_CONNECT_REQPORTAL 0x40ULL /*Separate non-IO req portal */
1067 #define OBD_CONNECT_ACL 0x80ULL /*access control lists */
1068 #define OBD_CONNECT_XATTR 0x100ULL /*client use extended attr */
1069 #define OBD_CONNECT_CROW 0x200ULL /*MDS+OST create obj on write*/
1070 #define OBD_CONNECT_TRUNCLOCK 0x400ULL /*locks on server for punch */
1071 #define OBD_CONNECT_TRANSNO 0x800ULL /*replay sends init transno */
1072 #define OBD_CONNECT_IBITS 0x1000ULL /*support for inodebits locks*/
1073 #define OBD_CONNECT_JOIN 0x2000ULL /*files can be concatenated.
1074 *We do not support JOIN FILE
1075 *anymore, reserve this flags
1076 *just for preventing such bit
1078 #define OBD_CONNECT_ATTRFID 0x4000ULL /*Server can GetAttr By Fid*/
1079 #define OBD_CONNECT_NODEVOH 0x8000ULL /*No open hndl on specl nodes*/
1080 #define OBD_CONNECT_RMT_CLIENT 0x10000ULL /*Remote client */
1081 #define OBD_CONNECT_RMT_CLIENT_FORCE 0x20000ULL /*Remote client by force */
1082 #define OBD_CONNECT_BRW_SIZE 0x40000ULL /*Max bytes per rpc */
1083 #define OBD_CONNECT_QUOTA64 0x80000ULL /*64bit qunit_data.qd_count */
1084 #define OBD_CONNECT_MDS_CAPA 0x100000ULL /*MDS capability */
1085 #define OBD_CONNECT_OSS_CAPA 0x200000ULL /*OSS capability */
1086 #define OBD_CONNECT_CANCELSET 0x400000ULL /*Early batched cancels. */
1087 #define OBD_CONNECT_SOM 0x800000ULL /*Size on MDS */
1088 #define OBD_CONNECT_AT 0x1000000ULL /*client uses AT */
1089 #define OBD_CONNECT_LRU_RESIZE 0x2000000ULL /*LRU resize feature. */
1090 #define OBD_CONNECT_MDS_MDS 0x4000000ULL /*MDS-MDS connection */
1091 #define OBD_CONNECT_REAL 0x8000000ULL /*real connection */
1092 #define OBD_CONNECT_CHANGE_QS 0x10000000ULL /*shrink/enlarge qunit */
1093 #define OBD_CONNECT_CKSUM 0x20000000ULL /*support several cksum algos*/
1094 #define OBD_CONNECT_FID 0x40000000ULL /*FID is supported by server */
1095 #define OBD_CONNECT_VBR 0x80000000ULL /*version based recovery */
1096 #define OBD_CONNECT_LOV_V3 0x100000000ULL /*client supports LOV v3 EA */
1097 #define OBD_CONNECT_GRANT_SHRINK 0x200000000ULL /* support grant shrink */
1098 #define OBD_CONNECT_SKIP_ORPHAN 0x400000000ULL /* don't reuse orphan objids */
1099 #define OBD_CONNECT_MAX_EASIZE 0x800000000ULL /* preserved for large EA */
1100 #define OBD_CONNECT_FULL20 0x1000000000ULL /* it is 2.0 client */
1101 #define OBD_CONNECT_LAYOUTLOCK 0x2000000000ULL /* client supports layout lock */
1102 #define OBD_CONNECT_64BITHASH 0x4000000000ULL /* client supports 64-bits
1104 #define OBD_CONNECT_MAXBYTES 0x8000000000ULL /* max stripe size */
1105 /* also update obd_connect_names[] for lprocfs_rd_connect_flags()
1106 * and lustre/utils/wirecheck.c */
1108 #ifdef HAVE_LRU_RESIZE_SUPPORT
1109 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
1111 #define LRU_RESIZE_CONNECT_FLAG 0
1114 #define MDT_CONNECT_SUPPORTED (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
1115 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
1116 OBD_CONNECT_IBITS | OBD_CONNECT_JOIN | \
1117 OBD_CONNECT_NODEVOH | OBD_CONNECT_ATTRFID | \
1118 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1119 OBD_CONNECT_RMT_CLIENT | \
1120 OBD_CONNECT_RMT_CLIENT_FORCE | \
1121 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_MDS_CAPA | \
1122 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_MDS_MDS | \
1123 OBD_CONNECT_FID | LRU_RESIZE_CONNECT_FLAG | \
1124 OBD_CONNECT_VBR | OBD_CONNECT_LOV_V3 | \
1125 OBD_CONNECT_SOM | OBD_CONNECT_FULL20 | \
1126 OBD_CONNECT_64BITHASH)
1127 #define OST_CONNECT_SUPPORTED (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
1128 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
1129 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
1130 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_QUOTA64 | \
1131 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1132 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_CKSUM | \
1133 OBD_CONNECT_CHANGE_QS | \
1134 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_RMT_CLIENT | \
1135 OBD_CONNECT_RMT_CLIENT_FORCE | OBD_CONNECT_VBR | \
1136 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
1137 OBD_CONNECT_GRANT_SHRINK | OBD_CONNECT_FULL20 | \
1138 OBD_CONNECT_64BITHASH | OBD_CONNECT_MAXBYTES)
1139 #define ECHO_CONNECT_SUPPORTED (0)
1140 #define MGS_CONNECT_SUPPORTED (OBD_CONNECT_VERSION | OBD_CONNECT_AT | \
1143 #define OBD_OCD_VERSION(major,minor,patch,fix) (((major)<<24) + ((minor)<<16) +\
1144 ((patch)<<8) + (fix))
1145 #define OBD_OCD_VERSION_MAJOR(version) ((int)((version)>>24)&255)
1146 #define OBD_OCD_VERSION_MINOR(version) ((int)((version)>>16)&255)
1147 #define OBD_OCD_VERSION_PATCH(version) ((int)((version)>>8)&255)
1148 #define OBD_OCD_VERSION_FIX(version) ((int)(version)&255)
1150 /* This structure is used for both request and reply.
1152 * If we eventually have separate connect data for different types, which we
1153 * almost certainly will, then perhaps we stick a union in here. */
1154 struct obd_connect_data_v1 {
1155 __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1156 __u32 ocd_version; /* lustre release version number */
1157 __u32 ocd_grant; /* initial cache grant amount (bytes) */
1158 __u32 ocd_index; /* LOV index to connect to */
1159 __u32 ocd_brw_size; /* Maximum BRW size in bytes */
1160 __u64 ocd_ibits_known; /* inode bits this client understands */
1161 __u32 ocd_nllu; /* non-local-lustre-user */
1162 __u32 ocd_nllg; /* non-local-lustre-group */
1163 __u64 ocd_transno; /* first transno from client to be replayed */
1164 __u32 ocd_group; /* MDS group on OST */
1165 __u32 ocd_cksum_types; /* supported checksum algorithms */
1166 __u32 ocd_max_easize; /* How big LOV EA can be on MDS */
1167 __u32 padding; /* also fix lustre_swab_connect */
1168 __u64 ocd_maxbytes; /* Maximum stripe size in bytes */
1171 struct obd_connect_data {
1172 __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1173 __u32 ocd_version; /* lustre release version number */
1174 __u32 ocd_grant; /* initial cache grant amount (bytes) */
1175 __u32 ocd_index; /* LOV index to connect to */
1176 __u32 ocd_brw_size; /* Maximum BRW size in bytes */
1177 __u64 ocd_ibits_known; /* inode bits this client understands */
1178 __u32 ocd_nllu; /* non-local-lustre-user */
1179 __u32 ocd_nllg; /* non-local-lustre-group */
1180 __u64 ocd_transno; /* first transno from client to be replayed */
1181 __u32 ocd_group; /* MDS group on OST */
1182 __u32 ocd_cksum_types; /* supported checksum algorithms */
1183 __u32 ocd_max_easize; /* How big LOV EA can be on MDS */
1184 __u32 padding; /* also fix lustre_swab_connect */
1185 __u64 ocd_maxbytes; /* Maximum stripe size in bytes */
1186 /* Fields after ocd_maxbytes are only accessible by the receiver
1187 * if the corresponding flag in ocd_connect_flags is set. Accessing
1188 * any field after ocd_maxbytes on the receiver without a valid flag
1189 * may result in out-of-bound memory access and kernel oops. */
1190 __u64 padding1; /* added 2.2.0. also fix lustre_swab_connect */
1191 __u64 padding2; /* added 2.2.0. also fix lustre_swab_connect */
1192 __u64 padding3; /* added 2.2.0. also fix lustre_swab_connect */
1193 __u64 padding4; /* added 2.2.0. also fix lustre_swab_connect */
1194 __u64 padding5; /* added 2.2.0. also fix lustre_swab_connect */
1195 __u64 padding6; /* added 2.2.0. also fix lustre_swab_connect */
1196 __u64 padding7; /* added 2.2.0. also fix lustre_swab_connect */
1197 __u64 padding8; /* added 2.2.0. also fix lustre_swab_connect */
1198 __u64 padding9; /* added 2.2.0. also fix lustre_swab_connect */
1199 __u64 paddingA; /* added 2.2.0. also fix lustre_swab_connect */
1200 __u64 paddingB; /* added 2.2.0. also fix lustre_swab_connect */
1201 __u64 paddingC; /* added 2.2.0. also fix lustre_swab_connect */
1202 __u64 paddingD; /* added 2.2.0. also fix lustre_swab_connect */
1203 __u64 paddingE; /* added 2.2.0. also fix lustre_swab_connect */
1204 __u64 paddingF; /* added 2.2.0. also fix lustre_swab_connect */
1208 extern void lustre_swab_connect(struct obd_connect_data *ocd);
1211 * Supported checksum algorithms. Up to 32 checksum types are supported.
1212 * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
1213 * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
1214 * algorithm and also the OBD_FL_CKSUM* flags.
1217 OBD_CKSUM_CRC32 = 0x00000001,
1218 OBD_CKSUM_ADLER = 0x00000002,
1222 * OST requests: OBDO & OBD request records
1227 OST_REPLY = 0, /* reply ? */
1243 OST_QUOTACHECK = 18,
1245 OST_QUOTA_ADJUST_QUNIT = 20,
1248 #define OST_FIRST_OPC OST_REPLY
1251 OBD_FL_INLINEDATA = 0x00000001,
1252 OBD_FL_OBDMDEXISTS = 0x00000002,
1253 OBD_FL_DELORPHAN = 0x00000004, /* if set in o_flags delete orphans */
1254 OBD_FL_NORPC = 0x00000008, /* set in o_flags do in OSC not OST */
1255 OBD_FL_IDONLY = 0x00000010, /* set in o_flags only adjust obj id*/
1256 OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
1257 OBD_FL_DEBUG_CHECK = 0x00000040, /* echo client/server debug check */
1258 OBD_FL_NO_USRQUOTA = 0x00000100, /* the object's owner is over quota */
1259 OBD_FL_NO_GRPQUOTA = 0x00000200, /* the object's group is over quota */
1260 OBD_FL_CREATE_CROW = 0x00000400, /* object should be create on write */
1261 OBD_FL_SRVLOCK = 0x00000800, /* delegate DLM locking to server */
1262 OBD_FL_CKSUM_CRC32 = 0x00001000, /* CRC32 checksum type */
1263 OBD_FL_CKSUM_ADLER = 0x00002000, /* ADLER checksum type */
1264 OBD_FL_CKSUM_RSVD1 = 0x00004000, /* for future cksum types */
1265 OBD_FL_CKSUM_RSVD2 = 0x00008000, /* for future cksum types */
1266 OBD_FL_CKSUM_RSVD3 = 0x00010000, /* for future cksum types */
1267 OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
1268 OBD_FL_MMAP = 0x00040000, /* object is mmapped on the client */
1269 OBD_FL_RECOV_RESEND = 0x00080000, /* recoverable resent */
1271 OBD_FL_CKSUM_ALL = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER,
1273 /* mask for local-only flag, which won't be sent over network */
1274 OBD_FL_LOCAL_MASK = 0xF0000000,
1277 #define LOV_MAGIC_V1 0x0BD10BD0
1278 #define LOV_MAGIC LOV_MAGIC_V1
1279 #define LOV_MAGIC_JOIN_V1 0x0BD20BD0
1280 #define LOV_MAGIC_V3 0x0BD30BD0
1282 #define LOV_PATTERN_RAID0 0x001 /* stripes are used round-robin */
1283 #define LOV_PATTERN_RAID1 0x002 /* stripes are mirrors of each other */
1284 #define LOV_PATTERN_FIRST 0x100 /* first stripe is not in round-robin */
1285 #define LOV_PATTERN_CMOBD 0x200
1287 #define lov_ost_data lov_ost_data_v1
1288 struct lov_ost_data_v1 { /* per-stripe data structure (little-endian)*/
1289 __u64 l_object_id; /* OST object ID */
1290 __u64 l_object_seq; /* OST object seq number */
1291 __u32 l_ost_gen; /* generation of this l_ost_idx */
1292 __u32 l_ost_idx; /* OST index in LOV (lov_tgt_desc->tgts) */
1295 #define lov_mds_md lov_mds_md_v1
1296 struct lov_mds_md_v1 { /* LOV EA mds/wire data (little-endian) */
1297 __u32 lmm_magic; /* magic number = LOV_MAGIC_V1 */
1298 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1299 __u64 lmm_object_id; /* LOV object ID */
1300 __u64 lmm_object_seq; /* LOV object seq number */
1301 __u32 lmm_stripe_size; /* size of stripe in bytes */
1302 __u32 lmm_stripe_count; /* num stripes in use for this object */
1303 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1306 /* extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm); */
1308 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
1309 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
1311 #define XATTR_NAME_ACL_ACCESS "system.posix_acl_access"
1312 #define XATTR_NAME_ACL_DEFAULT "system.posix_acl_default"
1313 #define XATTR_USER_PREFIX "user."
1314 #define XATTR_TRUSTED_PREFIX "trusted."
1315 #define XATTR_SECURITY_PREFIX "security."
1316 #define XATTR_LUSTRE_PREFIX "lustre."
1318 #define XATTR_NAME_LOV "trusted.lov"
1319 #define XATTR_NAME_LMA "trusted.lma"
1320 #define XATTR_NAME_LMV "trusted.lmv"
1321 #define XATTR_NAME_LINK "trusted.link"
1324 struct lov_mds_md_v3 { /* LOV EA mds/wire data (little-endian) */
1325 __u32 lmm_magic; /* magic number = LOV_MAGIC_V3 */
1326 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1327 __u64 lmm_object_id; /* LOV object ID */
1328 __u64 lmm_object_seq; /* LOV object seq number */
1329 __u32 lmm_stripe_size; /* size of stripe in bytes */
1330 __u32 lmm_stripe_count; /* num stripes in use for this object */
1331 char lmm_pool_name[LOV_MAXPOOLNAME]; /* must be 32bit aligned */
1332 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1336 #define OBD_MD_FLID (0x00000001ULL) /* object ID */
1337 #define OBD_MD_FLATIME (0x00000002ULL) /* access time */
1338 #define OBD_MD_FLMTIME (0x00000004ULL) /* data modification time */
1339 #define OBD_MD_FLCTIME (0x00000008ULL) /* change time */
1340 #define OBD_MD_FLSIZE (0x00000010ULL) /* size */
1341 #define OBD_MD_FLBLOCKS (0x00000020ULL) /* allocated blocks count */
1342 #define OBD_MD_FLBLKSZ (0x00000040ULL) /* block size */
1343 #define OBD_MD_FLMODE (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1344 #define OBD_MD_FLTYPE (0x00000100ULL) /* object type (mode & S_IFMT) */
1345 #define OBD_MD_FLUID (0x00000200ULL) /* user ID */
1346 #define OBD_MD_FLGID (0x00000400ULL) /* group ID */
1347 #define OBD_MD_FLFLAGS (0x00000800ULL) /* flags word */
1348 #define OBD_MD_FLNLINK (0x00002000ULL) /* link count */
1349 #define OBD_MD_FLGENER (0x00004000ULL) /* generation number */
1350 /*#define OBD_MD_FLINLINE (0x00008000ULL) inline data. used until 1.6.5 */
1351 #define OBD_MD_FLRDEV (0x00010000ULL) /* device number */
1352 #define OBD_MD_FLEASIZE (0x00020000ULL) /* extended attribute data */
1353 #define OBD_MD_LINKNAME (0x00040000ULL) /* symbolic link target */
1354 #define OBD_MD_FLHANDLE (0x00080000ULL) /* file/lock handle */
1355 #define OBD_MD_FLCKSUM (0x00100000ULL) /* bulk data checksum */
1356 #define OBD_MD_FLQOS (0x00200000ULL) /* quality of service stats */
1357 /*#define OBD_MD_FLOSCOPQ (0x00400000ULL) osc opaque data, never used */
1358 #define OBD_MD_FLCOOKIE (0x00800000ULL) /* log cancellation cookie */
1359 #define OBD_MD_FLGROUP (0x01000000ULL) /* group */
1360 #define OBD_MD_FLFID (0x02000000ULL) /* ->ost write inline fid */
1361 #define OBD_MD_FLEPOCH (0x04000000ULL) /* ->ost write with ioepoch */
1362 /* ->mds if epoch opens or closes */
1363 #define OBD_MD_FLGRANT (0x08000000ULL) /* ost preallocation space grant */
1364 #define OBD_MD_FLDIREA (0x10000000ULL) /* dir's extended attribute data */
1365 #define OBD_MD_FLUSRQUOTA (0x20000000ULL) /* over quota flags sent from ost */
1366 #define OBD_MD_FLGRPQUOTA (0x40000000ULL) /* over quota flags sent from ost */
1367 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1369 #define OBD_MD_MDS (0x0000000100000000ULL) /* where an inode lives on */
1370 #define OBD_MD_REINT (0x0000000200000000ULL) /* reintegrate oa */
1371 #define OBD_MD_MEA (0x0000000400000000ULL) /* CMD split EA */
1372 #define OBD_MD_MDTIDX (0x0000000800000000ULL) /* Get MDT index */
1374 #define OBD_MD_FLXATTR (0x0000001000000000ULL) /* xattr */
1375 #define OBD_MD_FLXATTRLS (0x0000002000000000ULL) /* xattr list */
1376 #define OBD_MD_FLXATTRRM (0x0000004000000000ULL) /* xattr remove */
1377 #define OBD_MD_FLACL (0x0000008000000000ULL) /* ACL */
1378 #define OBD_MD_FLRMTPERM (0x0000010000000000ULL) /* remote permission */
1379 #define OBD_MD_FLMDSCAPA (0x0000020000000000ULL) /* MDS capability */
1380 #define OBD_MD_FLOSSCAPA (0x0000040000000000ULL) /* OSS capability */
1381 #define OBD_MD_FLCKSPLIT (0x0000080000000000ULL) /* Check split on server */
1382 #define OBD_MD_FLCROSSREF (0x0000100000000000ULL) /* Cross-ref case */
1383 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1385 #define OBD_FL_TRUNC (0x0000200000000000ULL) /* for filter_truncate */
1387 #define OBD_MD_FLRMTLSETFACL (0x0001000000000000ULL) /* lfs lsetfacl case */
1388 #define OBD_MD_FLRMTLGETFACL (0x0002000000000000ULL) /* lfs lgetfacl case */
1389 #define OBD_MD_FLRMTRSETFACL (0x0004000000000000ULL) /* lfs rsetfacl case */
1390 #define OBD_MD_FLRMTRGETFACL (0x0008000000000000ULL) /* lfs rgetfacl case */
1392 #define OBD_MD_FLGETATTR (OBD_MD_FLID | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1393 OBD_MD_FLCTIME | OBD_MD_FLSIZE | OBD_MD_FLBLKSZ | \
1394 OBD_MD_FLMODE | OBD_MD_FLTYPE | OBD_MD_FLUID | \
1395 OBD_MD_FLGID | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1396 OBD_MD_FLGENER | OBD_MD_FLRDEV | OBD_MD_FLGROUP)
1398 /* don't forget obdo_fid which is way down at the bottom so it can
1399 * come after the definition of llog_cookie */
1402 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
1403 #define OBD_STATFS_NODELAY 0x0001 /* requests should be send without delay
1404 * and resends for avoid deadlocks */
1405 #define OBD_STATFS_FROM_CACHE 0x0002 /* the statfs callback should not update
1407 #define OBD_STATFS_PTLRPCD 0x0004 /* requests will be sent via ptlrpcd
1408 * instead of a specific set. This
1409 * means that we cannot rely on the set
1410 * interpret routine to be called.
1411 * lov_statfs_fini() must thus be called
1412 * by the request interpret routine */
1414 /* ost_body.data values for OST_BRW */
1416 #define OBD_BRW_READ 0x01
1417 #define OBD_BRW_WRITE 0x02
1418 #define OBD_BRW_RWMASK (OBD_BRW_READ | OBD_BRW_WRITE)
1419 #define OBD_BRW_SYNC 0x08 /* this page is a part of synchronous
1420 * transfer and is not accounted in
1422 #define OBD_BRW_CHECK 0x10
1423 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
1424 #define OBD_BRW_GRANTED 0x40 /* the ost manages this */
1425 #define OBD_BRW_NOCACHE 0x80 /* this page is a part of non-cached IO */
1426 #define OBD_BRW_NOQUOTA 0x100
1427 #define OBD_BRW_SRVLOCK 0x200 /* Client holds no lock over this page */
1428 #define OBD_BRW_ASYNC 0x400 /* Server may delay commit to disk */
1429 #define OBD_BRW_MEMALLOC 0x800 /* Client runs in the "kswapd" context */
1431 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
1433 #define OST_MIN_PRECREATE 32
1434 #define OST_MAX_PRECREATE 20000
1443 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
1445 /* multiple of 8 bytes => can array */
1446 struct niobuf_remote {
1452 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
1454 /* lock value block communicated between the filter and llite */
1456 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1457 * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1458 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1459 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1460 #define OST_LVB_IS_ERR(blocks) \
1461 ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1462 #define OST_LVB_SET_ERR(blocks, rc) \
1463 do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1464 #define OST_LVB_GET_ERR(blocks) (int)(blocks - OST_LVB_ERR_INIT)
1474 extern void lustre_swab_ost_lvb(struct ost_lvb *);
1483 MDS_GETATTR_NAME = 34,
1488 MDS_DISCONNECT = 39,
1494 MDS_DONE_WRITING = 45,
1496 MDS_QUOTACHECK = 47,
1499 MDS_SETXATTR = 50, /* obsolete, now it's MDS_REINT op */
1506 #define MDS_FIRST_OPC MDS_GETATTR
1523 } mds_reint_t, mdt_reint_t;
1525 extern void lustre_swab_generic_32s (__u32 *val);
1527 /* the disposition of the intent outlines what was executed */
1528 #define DISP_IT_EXECD 0x00000001
1529 #define DISP_LOOKUP_EXECD 0x00000002
1530 #define DISP_LOOKUP_NEG 0x00000004
1531 #define DISP_LOOKUP_POS 0x00000008
1532 #define DISP_OPEN_CREATE 0x00000010
1533 #define DISP_OPEN_OPEN 0x00000020
1534 #define DISP_ENQ_COMPLETE 0x00400000
1535 #define DISP_ENQ_OPEN_REF 0x00800000
1536 #define DISP_ENQ_CREATE_REF 0x01000000
1537 #define DISP_OPEN_LOCK 0x02000000
1539 /* INODE LOCK PARTS */
1540 #define MDS_INODELOCK_LOOKUP 0x000001 /* dentry, mode, owner, group */
1541 #define MDS_INODELOCK_UPDATE 0x000002 /* size, links, timestamps */
1542 #define MDS_INODELOCK_OPEN 0x000004 /* For opened files */
1544 /* Do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits */
1545 #define MDS_INODELOCK_MAXSHIFT 2
1546 /* This FULL lock is useful to take on unlink sort of operations */
1547 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
1549 extern void lustre_swab_ll_fid (struct ll_fid *fid);
1551 #define MDS_STATUS_CONN 1
1552 #define MDS_STATUS_LOV 2
1554 struct mds_status_req {
1559 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
1561 /* mdt_thread_info.mti_flags. */
1563 /* The flag indicates Size-on-MDS attributes are changed. */
1564 MF_SOM_CHANGE = (1 << 0),
1565 /* Flags indicates an epoch opens or closes. */
1566 MF_EPOCH_OPEN = (1 << 1),
1567 MF_EPOCH_CLOSE = (1 << 2),
1568 MF_MDC_CANCEL_FID1 = (1 << 3),
1569 MF_MDC_CANCEL_FID2 = (1 << 4),
1570 MF_MDC_CANCEL_FID3 = (1 << 5),
1571 MF_MDC_CANCEL_FID4 = (1 << 6),
1572 /* There is a pending attribute update. */
1573 MF_SOM_AU = (1 << 7),
1574 /* Cancel OST locks while getattr OST attributes. */
1575 MF_GETATTR_LOCK = (1 << 8),
1578 #define MF_SOM_LOCAL_FLAGS (MF_SOM_CHANGE | MF_EPOCH_OPEN | MF_EPOCH_CLOSE)
1580 #define MDS_BFLAG_UNCOMMITTED_WRITES 0x1
1582 /* these should be identical to their EXT3_*_FL counterparts, and are
1583 * redefined here only to avoid dragging in ext3_fs.h */
1584 #define MDS_SYNC_FL 0x00000008 /* Synchronous updates */
1585 #define MDS_IMMUTABLE_FL 0x00000010 /* Immutable file */
1586 #define MDS_APPEND_FL 0x00000020 /* writes to file may only append */
1587 #define MDS_NOATIME_FL 0x00000080 /* do not update atime */
1588 #define MDS_DIRSYNC_FL 0x00010000 /* dirsync behaviour (dir only) */
1591 /* Convert wire MDS_*_FL to corresponding client local VFS S_* values
1592 * for the client inode i_flags. The MDS_*_FL are the Lustre wire
1593 * protocol equivalents of LDISKFS_*_FL values stored on disk, while
1594 * the S_* flags are kernel-internal values that change between kernel
1595 * versions. These flags are set/cleared via FSFILT_IOC_{GET,SET}_FLAGS.
1596 * See b=16526 for a full history. */
1597 static inline int ll_ext_to_inode_flags(int flags)
1599 return (((flags & MDS_SYNC_FL) ? S_SYNC : 0) |
1600 ((flags & MDS_NOATIME_FL) ? S_NOATIME : 0) |
1601 ((flags & MDS_APPEND_FL) ? S_APPEND : 0) |
1602 #if defined(S_DIRSYNC)
1603 ((flags & MDS_DIRSYNC_FL) ? S_DIRSYNC : 0) |
1605 ((flags & MDS_IMMUTABLE_FL) ? S_IMMUTABLE : 0));
1608 static inline int ll_inode_to_ext_flags(int iflags)
1610 return (((iflags & S_SYNC) ? MDS_SYNC_FL : 0) |
1611 ((iflags & S_NOATIME) ? MDS_NOATIME_FL : 0) |
1612 ((iflags & S_APPEND) ? MDS_APPEND_FL : 0) |
1613 #if defined(S_DIRSYNC)
1614 ((iflags & S_DIRSYNC) ? MDS_DIRSYNC_FL : 0) |
1616 ((iflags & S_IMMUTABLE) ? MDS_IMMUTABLE_FL : 0));
1621 * while mds_body is to interact with 1.6, mdt_body is to interact with 2.0.
1622 * both of them should have the same fields layout, because at client side
1623 * one could be dynamically cast to the other.
1625 * mdt_body has large size than mds_body, with unused padding (48 bytes)
1626 * at the end. client always use size of mdt_body to prepare request/reply
1627 * buffers, and actual data could be interepeted as mdt_body or mds_body
1633 struct lustre_handle handle;
1635 __u64 size; /* Offset, in the case of MDS_READPAGE */
1639 __u64 blocks; /* XID, in the case of MDS_READPAGE */
1648 __u32 flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1650 __u32 nlink; /* #bytes to read in the case of MDS_READPAGE */
1656 __u32 max_cookiesize;
1657 __u32 padding_4; /* also fix lustre_swab_mds_body */
1660 extern void lustre_swab_mds_body (struct mds_body *b);
1665 struct lustre_handle handle;
1667 __u64 size; /* Offset, in the case of MDS_READPAGE */
1671 __u64 blocks; /* XID, in the case of MDS_READPAGE */
1673 __u64 ino; /* for 1.6 compatibility */
1680 __u32 flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1682 __u32 nlink; /* #bytes to read in the case of MDS_READPAGE */
1683 __u32 generation; /* for 1.6 compatibility */
1688 __u32 max_cookiesize;
1689 __u32 uid_h; /* high 32-bits of uid, for FUID */
1690 __u32 gid_h; /* high 32-bits of gid, for FUID */
1691 __u32 padding_5; /* also fix lustre_swab_mdt_body */
1699 extern void lustre_swab_mdt_body (struct mdt_body *b);
1701 struct mdt_ioepoch {
1702 struct lustre_handle handle;
1708 extern void lustre_swab_mdt_ioepoch (struct mdt_ioepoch *b);
1710 #define Q_QUOTACHECK 0x800100
1711 #define Q_INITQUOTA 0x800101 /* init slave limits */
1712 #define Q_GETOINFO 0x800102 /* get obd quota info */
1713 #define Q_GETOQUOTA 0x800103 /* get obd quotas */
1714 #define Q_FINVALIDATE 0x800104 /* invalidate operational quotas */
1716 #define Q_TYPEMATCH(id, type) \
1717 ((id) == (type) || (id) == UGQUOTA)
1719 #define Q_TYPESET(oqc, type) Q_TYPEMATCH((oqc)->qc_type, type)
1721 #define Q_GETOCMD(oqc) \
1722 ((oqc)->qc_cmd == Q_GETOINFO || (oqc)->qc_cmd == Q_GETOQUOTA)
1724 #define QCTL_COPY(out, in) \
1726 Q_COPY(out, in, qc_cmd); \
1727 Q_COPY(out, in, qc_type); \
1728 Q_COPY(out, in, qc_id); \
1729 Q_COPY(out, in, qc_stat); \
1730 Q_COPY(out, in, qc_dqinfo); \
1731 Q_COPY(out, in, qc_dqblk); \
1734 struct obd_quotactl {
1739 struct obd_dqinfo qc_dqinfo;
1740 struct obd_dqblk qc_dqblk;
1743 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1745 struct quota_adjust_qunit {
1752 extern void lustre_swab_quota_adjust_qunit(struct quota_adjust_qunit *q);
1754 /* flags is shared among quota structures */
1755 #define LQUOTA_FLAGS_GRP 1UL /* 0 is user, 1 is group */
1756 #define LQUOTA_FLAGS_BLK 2UL /* 0 is inode, 1 is block */
1757 #define LQUOTA_FLAGS_ADJBLK 4UL /* adjust the block qunit size */
1758 #define LQUOTA_FLAGS_ADJINO 8UL /* adjust the inode qunit size */
1759 #define LQUOTA_FLAGS_CHG_QS 16UL /* indicate whether it has capability of
1760 * OBD_CONNECT_CHANGE_QS */
1761 #define LQUOTA_FLAGS_RECOVERY 32UL /* recovery is going on a uid/gid */
1762 #define LQUOTA_FLAGS_SETQUOTA 64UL /* being setquota on a uid/gid */
1764 /* flags is specific for quota_adjust_qunit */
1765 #define LQUOTA_QAQ_CREATE_LQS (1 << 31) /* when it is set, need create lqs */
1767 /* the status of lqs_flags in struct lustre_qunit_size */
1768 #define LQUOTA_QUNIT_FLAGS (LQUOTA_FLAGS_GRP | LQUOTA_FLAGS_BLK)
1770 #define QAQ_IS_GRP(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_GRP)
1771 #define QAQ_IS_ADJBLK(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_ADJBLK)
1772 #define QAQ_IS_ADJINO(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_ADJINO)
1773 #define QAQ_IS_CREATE_LQS(qaq) ((qaq)->qaq_flags & LQUOTA_QAQ_CREATE_LQS)
1775 #define QAQ_SET_GRP(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_GRP)
1776 #define QAQ_SET_ADJBLK(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_ADJBLK)
1777 #define QAQ_SET_ADJINO(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_ADJINO)
1778 #define QAQ_SET_CREATE_LQS(qaq) ((qaq)->qaq_flags |= LQUOTA_QAQ_CREATE_LQS)
1780 /* inode access permission for remote user, the inode info are omitted,
1781 * for client knows them. */
1782 struct mds_remote_perm {
1787 __u32 rp_access_perm; /* MAY_READ/WRITE/EXEC */
1790 /* permissions for md_perm.mp_perm */
1792 CFS_SETUID_PERM = 0x01,
1793 CFS_SETGID_PERM = 0x02,
1794 CFS_SETGRP_PERM = 0x04,
1795 CFS_RMTACL_PERM = 0x08,
1796 CFS_RMTOWN_PERM = 0x10
1799 extern void lustre_swab_mds_remote_perm(struct mds_remote_perm *p);
1801 struct mdt_remote_perm {
1808 __u32 rp_access_perm; /* MAY_READ/WRITE/EXEC */
1811 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
1813 struct mdt_rec_setattr {
1823 __u32 sa_padding_1_h;
1824 struct lu_fid sa_fid;
1833 __u32 sa_attr_flags;
1841 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
1844 * Attribute flags used in mdt_rec_setattr::sa_valid.
1845 * The kernel's #defines for ATTR_* should not be used over the network
1846 * since the client and MDS may run different kernels (see bug 13828)
1847 * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1849 #define MDS_ATTR_MODE 0x1ULL /* = 1 */
1850 #define MDS_ATTR_UID 0x2ULL /* = 2 */
1851 #define MDS_ATTR_GID 0x4ULL /* = 4 */
1852 #define MDS_ATTR_SIZE 0x8ULL /* = 8 */
1853 #define MDS_ATTR_ATIME 0x10ULL /* = 16 */
1854 #define MDS_ATTR_MTIME 0x20ULL /* = 32 */
1855 #define MDS_ATTR_CTIME 0x40ULL /* = 64 */
1856 #define MDS_ATTR_ATIME_SET 0x80ULL /* = 128 */
1857 #define MDS_ATTR_MTIME_SET 0x100ULL /* = 256 */
1858 #define MDS_ATTR_FORCE 0x200ULL /* = 512, Not a change, but a change it */
1859 #define MDS_ATTR_ATTR_FLAG 0x400ULL /* = 1024 */
1860 #define MDS_ATTR_KILL_SUID 0x800ULL /* = 2048 */
1861 #define MDS_ATTR_KILL_SGID 0x1000ULL /* = 4096 */
1862 #define MDS_ATTR_CTIME_SET 0x2000ULL /* = 8192 */
1863 #define MDS_ATTR_FROM_OPEN 0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
1864 #define MDS_ATTR_BLOCKS 0x8000ULL /* = 32768 */
1867 #define FMODE_READ 00000001
1868 #define FMODE_WRITE 00000002
1871 /* IO Epoch is opened on a closed file. */
1872 #define FMODE_EPOCH 01000000
1873 /* IO Epoch is opened on a file truncate. */
1874 #define FMODE_TRUNC 02000000
1875 /* Size-on-MDS Attribute Update is pending. */
1876 #define FMODE_SOM 04000000
1877 #define FMODE_CLOSED 0
1879 #define MDS_OPEN_CREATED 00000010
1880 #define MDS_OPEN_CROSS 00000020
1882 #define MDS_FMODE_EXEC 00000004
1883 #define MDS_OPEN_CREAT 00000100
1884 #define MDS_OPEN_EXCL 00000200
1885 #define MDS_OPEN_TRUNC 00001000
1886 #define MDS_OPEN_APPEND 00002000
1887 #define MDS_OPEN_SYNC 00010000
1888 #define MDS_OPEN_DIRECTORY 00200000
1890 #define MDS_OPEN_DELAY_CREATE 0100000000 /* delay initial object create */
1891 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1892 #define MDS_OPEN_JOIN_FILE 0400000000 /* open for join file.
1893 * We do not support JOIN FILE
1894 * anymore, reserve this flags
1895 * just for preventing such bit
1897 #define MDS_CREATE_RMT_ACL 01000000000 /* indicate create on remote server
1898 * with default ACL */
1899 #define MDS_CREATE_SLAVE_OBJ 02000000000 /* indicate create slave object
1900 * actually, this is for create, not
1901 * conflict with other open flags */
1902 #define MDS_OPEN_LOCK 04000000000 /* This open requires open lock */
1903 #define MDS_OPEN_HAS_EA 010000000000 /* specify object create pattern */
1904 #define MDS_OPEN_HAS_OBJS 020000000000 /* Just set the EA the obj exist */
1905 #define MDS_OPEN_NORESTORE 0100000000000ULL /* Do not restore file at open */
1906 #define MDS_OPEN_NEWSTRIPE 0200000000000ULL /* New stripe needed (restripe or
1909 /* permission for create non-directory file */
1910 #define MAY_CREATE (1 << 7)
1911 /* permission for create directory file */
1912 #define MAY_LINK (1 << 8)
1913 /* permission for delete from the directory */
1914 #define MAY_UNLINK (1 << 9)
1915 /* source's permission for rename */
1916 #define MAY_RENAME_SRC (1 << 10)
1917 /* target's permission for rename */
1918 #define MAY_RENAME_TAR (1 << 11)
1919 /* part (parent's) VTX permission check */
1920 #define MAY_VTX_PART (1 << 12)
1921 /* full VTX permission check */
1922 #define MAY_VTX_FULL (1 << 13)
1923 /* lfs rgetfacl permission check */
1924 #define MAY_RGETFACL (1 << 14)
1927 MDS_CHECK_SPLIT = 1 << 0,
1928 MDS_CROSS_REF = 1 << 1,
1929 MDS_VTX_BYPASS = 1 << 2,
1930 MDS_PERM_BYPASS = 1 << 3,
1932 MDS_QUOTA_IGNORE = 1 << 5,
1933 MDS_CLOSE_CLEANUP = 1 << 6,
1934 MDS_KEEP_ORPHAN = 1 << 7
1937 /* instance of mdt_reint_rec */
1938 struct mdt_rec_create {
1946 __u32 cr_suppgid1_h;
1948 __u32 cr_suppgid2_h;
1949 struct lu_fid cr_fid1;
1950 struct lu_fid cr_fid2;
1951 struct lustre_handle cr_old_handle; /* handle in case of open replay */
1955 __u64 cr_padding_1; /* rr_blocks */
1958 /* use of helpers set/get_mrc_cr_flags() is needed to access
1959 * 64 bits cr_flags [cr_flags_l, cr_flags_h], this is done to
1960 * extend cr_flags size without breaking 1.8 compat */
1961 __u32 cr_flags_l; /* for use with open, low 32 bits */
1962 __u32 cr_flags_h; /* for use with open, high 32 bits */
1963 __u32 cr_padding_3; /* rr_padding_3 */
1964 __u32 cr_padding_4; /* rr_padding_4 */
1967 static inline void set_mrc_cr_flags(struct mdt_rec_create *mrc, __u64 flags)
1969 mrc->cr_flags_l = (__u32)(flags & 0xFFFFFFFFUll);
1970 mrc->cr_flags_h = (__u32)(flags >> 32);
1973 static inline __u64 get_mrc_cr_flags(struct mdt_rec_create *mrc)
1975 return ((__u64)(mrc->cr_flags_l) | ((__u64)mrc->cr_flags_h << 32));
1978 /* instance of mdt_reint_rec */
1979 struct mdt_rec_link {
1987 __u32 lk_suppgid1_h;
1989 __u32 lk_suppgid2_h;
1990 struct lu_fid lk_fid1;
1991 struct lu_fid lk_fid2;
1993 __u64 lk_padding_1; /* rr_atime */
1994 __u64 lk_padding_2; /* rr_ctime */
1995 __u64 lk_padding_3; /* rr_size */
1996 __u64 lk_padding_4; /* rr_blocks */
1998 __u32 lk_padding_5; /* rr_mode */
1999 __u32 lk_padding_6; /* rr_flags */
2000 __u32 lk_padding_7; /* rr_padding_2 */
2001 __u32 lk_padding_8; /* rr_padding_3 */
2002 __u32 lk_padding_9; /* rr_padding_4 */
2005 /* instance of mdt_reint_rec */
2006 struct mdt_rec_unlink {
2014 __u32 ul_suppgid1_h;
2016 __u32 ul_suppgid2_h;
2017 struct lu_fid ul_fid1;
2018 struct lu_fid ul_fid2;
2020 __u64 ul_padding_2; /* rr_atime */
2021 __u64 ul_padding_3; /* rr_ctime */
2022 __u64 ul_padding_4; /* rr_size */
2023 __u64 ul_padding_5; /* rr_blocks */
2026 __u32 ul_padding_6; /* rr_flags */
2027 __u32 ul_padding_7; /* rr_padding_2 */
2028 __u32 ul_padding_8; /* rr_padding_3 */
2029 __u32 ul_padding_9; /* rr_padding_4 */
2032 /* instance of mdt_reint_rec */
2033 struct mdt_rec_rename {
2041 __u32 rn_suppgid1_h;
2043 __u32 rn_suppgid2_h;
2044 struct lu_fid rn_fid1;
2045 struct lu_fid rn_fid2;
2047 __u64 rn_padding_1; /* rr_atime */
2048 __u64 rn_padding_2; /* rr_ctime */
2049 __u64 rn_padding_3; /* rr_size */
2050 __u64 rn_padding_4; /* rr_blocks */
2051 __u32 rn_bias; /* some operation flags */
2052 __u32 rn_mode; /* cross-ref rename has mode */
2053 __u32 rn_padding_5; /* rr_flags */
2054 __u32 rn_padding_6; /* rr_padding_2 */
2055 __u32 rn_padding_7; /* rr_padding_3 */
2056 __u32 rn_padding_8; /* rr_padding_4 */
2059 /* instance of mdt_reint_rec */
2060 struct mdt_rec_setxattr {
2068 __u32 sx_suppgid1_h;
2070 __u32 sx_suppgid2_h;
2071 struct lu_fid sx_fid;
2072 __u64 sx_padding_1; /* These three are rr_fid2 */
2077 __u64 sx_padding_5; /* rr_ctime */
2078 __u64 sx_padding_6; /* rr_size */
2079 __u64 sx_padding_7; /* rr_blocks */
2082 __u32 sx_padding_8; /* rr_flags */
2083 __u32 sx_padding_9; /* rr_padding_2 */
2084 __u32 sx_padding_10; /* rr_padding_3 */
2085 __u32 sx_padding_11; /* rr_padding_4 */
2089 * mdt_rec_reint is the template for all mdt_reint_xxx structures.
2090 * Do NOT change the size of various members, otherwise the value
2091 * will be broken in lustre_swab_mdt_rec_reint().
2093 * If you add new members in other mdt_reint_xxx structres and need to use the
2094 * rr_padding_x fields, then update lustre_swab_mdt_rec_reint() also.
2096 struct mdt_rec_reint {
2104 __u32 rr_suppgid1_h;
2106 __u32 rr_suppgid2_h;
2107 struct lu_fid rr_fid1;
2108 struct lu_fid rr_fid2;
2117 __u32 rr_padding_2; /* also fix lustre_swab_mdt_rec_reint */
2118 __u32 rr_padding_3; /* also fix lustre_swab_mdt_rec_reint */
2119 __u32 rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
2122 extern void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
2125 __u32 ld_tgt_count; /* how many MDS's */
2126 __u32 ld_active_tgt_count; /* how many active */
2127 __u32 ld_default_stripe_count; /* how many objects are used */
2128 __u32 ld_pattern; /* default MEA_MAGIC_* */
2129 __u64 ld_default_hash_size;
2130 __u64 ld_padding_1; /* also fix lustre_swab_lmv_desc */
2131 __u32 ld_padding_2; /* also fix lustre_swab_lmv_desc */
2132 __u32 ld_qos_maxage; /* in second */
2133 __u32 ld_padding_3; /* also fix lustre_swab_lmv_desc */
2134 __u32 ld_padding_4; /* also fix lustre_swab_lmv_desc */
2135 struct obd_uuid ld_uuid;
2138 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
2140 /* TODO: lmv_stripe_md should contain mds capabilities for all slave fids */
2141 struct lmv_stripe_md {
2146 char mea_pool_name[LOV_MAXPOOLNAME];
2147 struct lu_fid mea_ids[0];
2150 extern void lustre_swab_lmv_stripe_md(struct lmv_stripe_md *mea);
2152 /* lmv structures */
2153 #define MEA_MAGIC_LAST_CHAR 0xb2221ca1
2154 #define MEA_MAGIC_ALL_CHARS 0xb222a11c
2155 #define MEA_MAGIC_HASH_SEGMENT 0xb222a11b
2157 #define MAX_HASH_SIZE_32 0x7fffffffUL
2158 #define MAX_HASH_SIZE 0x7fffffffffffffffULL
2159 #define MAX_HASH_HIGHEST_BIT 0x1000000000000000ULL
2166 extern void lustre_swab_md_fld (struct md_fld *mf);
2171 FLD_FIRST_OPC = FLD_QUERY
2177 SEQ_FIRST_OPC = SEQ_QUERY
2181 SEQ_ALLOC_SUPER = 0,
2186 * LOV data structures
2189 #define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */
2190 #define LOV_MIN_STRIPE_SIZE (1<<LOV_MIN_STRIPE_BITS)
2191 #define LOV_MAX_STRIPE_COUNT 160 /* until bug 4424 is fixed */
2192 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
2194 #define LOV_MAX_UUID_BUFFER_SIZE 8192
2195 /* The size of the buffer the lov/mdc reserves for the
2196 * array of UUIDs returned by the MDS. With the current
2197 * protocol, this will limit the max number of OSTs per LOV */
2199 #define LOV_DESC_MAGIC 0xB0CCDE5C
2201 /* LOV settings descriptor (should only contain static info) */
2203 __u32 ld_tgt_count; /* how many OBD's */
2204 __u32 ld_active_tgt_count; /* how many active */
2205 __u32 ld_default_stripe_count; /* how many objects are used */
2206 __u32 ld_pattern; /* default PATTERN_RAID0 */
2207 __u64 ld_default_stripe_size; /* in bytes */
2208 __u64 ld_default_stripe_offset; /* in bytes */
2209 __u32 ld_padding_0; /* unused */
2210 __u32 ld_qos_maxage; /* in second */
2211 __u32 ld_padding_1; /* also fix lustre_swab_lov_desc */
2212 __u32 ld_padding_2; /* also fix lustre_swab_lov_desc */
2213 struct obd_uuid ld_uuid;
2216 #define ld_magic ld_active_tgt_count /* for swabbing from llogs */
2218 extern void lustre_swab_lov_desc (struct lov_desc *ld);
2223 /* opcodes -- MUST be distinct from OST/MDS opcodes */
2228 LDLM_BL_CALLBACK = 104,
2229 LDLM_CP_CALLBACK = 105,
2230 LDLM_GL_CALLBACK = 106,
2231 LDLM_SET_INFO = 107,
2234 #define LDLM_FIRST_OPC LDLM_ENQUEUE
2236 #define RES_NAME_SIZE 4
2237 struct ldlm_res_id {
2238 __u64 name[RES_NAME_SIZE];
2241 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
2257 #define LCK_MODE_NUM 8
2267 #define LDLM_MIN_TYPE LDLM_PLAIN
2269 struct ldlm_extent {
2275 static inline int ldlm_extent_overlap(struct ldlm_extent *ex1,
2276 struct ldlm_extent *ex2)
2278 return (ex1->start <= ex2->end) && (ex2->start <= ex1->end);
2281 struct ldlm_inodebits {
2285 struct ldlm_flock_wire {
2293 /* it's important that the fields of the ldlm_extent structure match
2294 * the first fields of the ldlm_flock structure because there is only
2295 * one ldlm_swab routine to process the ldlm_policy_data_t union. if
2296 * this ever changes we will need to swab the union differently based
2297 * on the resource type. */
2300 struct ldlm_extent l_extent;
2301 struct ldlm_flock_wire l_flock;
2302 struct ldlm_inodebits l_inodebits;
2303 } ldlm_wire_policy_data_t;
2305 extern void lustre_swab_ldlm_policy_data (ldlm_wire_policy_data_t *d);
2307 struct ldlm_intent {
2311 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
2313 struct ldlm_resource_desc {
2314 ldlm_type_t lr_type;
2315 __u32 lr_padding; /* also fix lustre_swab_ldlm_resource_desc */
2316 struct ldlm_res_id lr_name;
2319 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
2321 struct ldlm_lock_desc {
2322 struct ldlm_resource_desc l_resource;
2323 ldlm_mode_t l_req_mode;
2324 ldlm_mode_t l_granted_mode;
2325 ldlm_wire_policy_data_t l_policy_data;
2328 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
2330 #define LDLM_LOCKREQ_HANDLES 2
2331 #define LDLM_ENQUEUE_CANCEL_OFF 1
2333 struct ldlm_request {
2336 struct ldlm_lock_desc lock_desc;
2337 struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
2340 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
2342 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
2343 * Otherwise, 2 are available. */
2344 #define ldlm_request_bufsize(count,type) \
2346 int _avail = LDLM_LOCKREQ_HANDLES; \
2347 _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
2348 sizeof(struct ldlm_request) + \
2349 (count > _avail ? count - _avail : 0) * \
2350 sizeof(struct lustre_handle); \
2355 __u32 lock_padding; /* also fix lustre_swab_ldlm_reply */
2356 struct ldlm_lock_desc lock_desc;
2357 struct lustre_handle lock_handle;
2358 __u64 lock_policy_res1;
2359 __u64 lock_policy_res2;
2362 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
2365 * Opcodes for mountconf (mgs and mgc)
2370 MGS_EXCEPTION, /* node died, etc. */
2371 MGS_TARGET_REG, /* whenever target starts up */
2376 #define MGS_FIRST_OPC MGS_CONNECT
2378 #define MGS_PARAM_MAXLEN 1024
2379 #define KEY_SET_INFO "set_info"
2381 struct mgs_send_param {
2382 char mgs_param[MGS_PARAM_MAXLEN];
2385 /* We pass this info to the MGS so it can write config logs */
2386 #define MTI_NAME_MAXLEN 64
2387 #define MTI_PARAM_MAXLEN 4096
2388 #define MTI_NIDS_MAX 32
2389 struct mgs_target_info {
2390 __u32 mti_lustre_ver;
2391 __u32 mti_stripe_index;
2392 __u32 mti_config_ver;
2394 __u32 mti_nid_count;
2395 __u32 padding; /* 64 bit align */
2396 char mti_fsname[MTI_NAME_MAXLEN];
2397 char mti_svname[MTI_NAME_MAXLEN];
2398 char mti_uuid[sizeof(struct obd_uuid)];
2399 __u64 mti_nids[MTI_NIDS_MAX]; /* host nids (lnet_nid_t)*/
2400 char mti_params[MTI_PARAM_MAXLEN];
2403 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
2405 /* Config marker flags (in config log) */
2406 #define CM_START 0x01
2408 #define CM_SKIP 0x04
2409 #define CM_UPGRADE146 0x08
2410 #define CM_EXCLUDE 0x10
2411 #define CM_START_SKIP (CM_START | CM_SKIP)
2414 __u32 cm_step; /* aka config version */
2416 __u32 cm_vers; /* lustre release version number */
2417 __u32 padding; /* 64 bit align */
2418 obd_time cm_createtime; /*when this record was first created */
2419 obd_time cm_canceltime; /*when this record is no longer valid*/
2420 char cm_tgtname[MTI_NAME_MAXLEN];
2421 char cm_comment[MTI_NAME_MAXLEN];
2424 extern void lustre_swab_cfg_marker(struct cfg_marker *marker,
2425 int swab, int size);
2428 * Opcodes for multiple servers.
2437 #define OBD_FIRST_OPC OBD_PING
2439 /* catalog of log objects */
2441 /** Identifier for a single log object */
2446 } __attribute__((packed));
2448 /** Records written to the CATALOGS list */
2449 #define CATLIST "CATALOGS"
2451 struct llog_logid lci_logid;
2455 } __attribute__((packed));
2457 /* Log data record types - there is no specific reason that these need to
2458 * be related to the RPC opcodes, but no reason not to (may be handy later?)
2460 #define LLOG_OP_MAGIC 0x10600000
2461 #define LLOG_OP_MASK 0xfff00000
2464 LLOG_PAD_MAGIC = LLOG_OP_MAGIC | 0x00000,
2465 OST_SZ_REC = LLOG_OP_MAGIC | 0x00f00,
2466 OST_RAID1_REC = LLOG_OP_MAGIC | 0x01000,
2467 MDS_UNLINK_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_UNLINK,
2468 MDS_SETATTR_REC = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_SETATTR,
2469 MDS_SETATTR64_REC = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) | REINT_SETATTR,
2470 OBD_CFG_REC = LLOG_OP_MAGIC | 0x20000,
2471 PTL_CFG_REC = LLOG_OP_MAGIC | 0x30000, /* obsolete */
2472 LLOG_GEN_REC = LLOG_OP_MAGIC | 0x40000,
2473 LLOG_JOIN_REC = LLOG_OP_MAGIC | 0x50000, /* obsolete */
2474 CHANGELOG_REC = LLOG_OP_MAGIC | 0x60000,
2475 CHANGELOG_USER_REC = LLOG_OP_MAGIC | 0x70000,
2476 LLOG_HDR_MAGIC = LLOG_OP_MAGIC | 0x45539,
2477 LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
2481 * for now, continue to support old pad records which have 0 for their
2482 * type but still need to be swabbed for their length
2484 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
2485 (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == \
2486 __swab32(LLOG_OP_MAGIC) || \
2487 (((r)->lrh_type == 0) && ((r)->lrh_len > LLOG_CHUNK_SIZE)))
2489 /** Log record header - stored in little endian order.
2490 * Each record must start with this struct, end with a llog_rec_tail,
2491 * and be a multiple of 256 bits in size.
2493 struct llog_rec_hdr {
2500 struct llog_rec_tail {
2505 struct llog_logid_rec {
2506 struct llog_rec_hdr lid_hdr;
2507 struct llog_logid lid_id;
2513 struct llog_rec_tail lid_tail;
2514 } __attribute__((packed));
2516 struct llog_create_rec {
2517 struct llog_rec_hdr lcr_hdr;
2518 struct ll_fid lcr_fid;
2522 struct llog_rec_tail lcr_tail;
2523 } __attribute__((packed));
2525 struct llog_orphan_rec {
2526 struct llog_rec_hdr lor_hdr;
2530 struct llog_rec_tail lor_tail;
2531 } __attribute__((packed));
2533 struct llog_unlink_rec {
2534 struct llog_rec_hdr lur_hdr;
2537 obd_count lur_count;
2538 struct llog_rec_tail lur_tail;
2539 } __attribute__((packed));
2541 struct llog_setattr_rec {
2542 struct llog_rec_hdr lsr_hdr;
2548 struct llog_rec_tail lsr_tail;
2549 } __attribute__((packed));
2551 struct llog_setattr64_rec {
2552 struct llog_rec_hdr lsr_hdr;
2560 struct llog_rec_tail lsr_tail;
2561 } __attribute__((packed));
2563 struct llog_size_change_rec {
2564 struct llog_rec_hdr lsc_hdr;
2565 struct ll_fid lsc_fid;
2568 struct llog_rec_tail lsc_tail;
2569 } __attribute__((packed));
2571 #define CHANGELOG_MAGIC 0xca103000
2573 /** \a changelog_rec_type's that can't be masked */
2574 #define CHANGELOG_MINMASK (1 << CL_MARK)
2575 /** bits covering all \a changelog_rec_type's */
2576 #define CHANGELOG_ALLMASK 0XFFFFFFFF
2577 /** default \a changelog_rec_type mask */
2578 #define CHANGELOG_DEFMASK CHANGELOG_ALLMASK & ~(1 << CL_ATIME)
2580 /* changelog llog name, needed by client replicators */
2581 #define CHANGELOG_CATALOG "changelog_catalog"
2583 struct changelog_setinfo {
2586 } __attribute__((packed));
2588 /** changelog record */
2589 struct llog_changelog_rec {
2590 struct llog_rec_hdr cr_hdr;
2591 struct changelog_rec cr;
2592 struct llog_rec_tail cr_tail; /**< for_sizezof_only */
2593 } __attribute__((packed));
2595 #define CHANGELOG_USER_PREFIX "cl"
2597 struct llog_changelog_user_rec {
2598 struct llog_rec_hdr cur_hdr;
2602 struct llog_rec_tail cur_tail;
2603 } __attribute__((packed));
2608 } __attribute__((packed));
2610 struct llog_gen_rec {
2611 struct llog_rec_hdr lgr_hdr;
2612 struct llog_gen lgr_gen;
2613 struct llog_rec_tail lgr_tail;
2615 /* On-disk header structure of each log object, stored in little endian order */
2616 #define LLOG_CHUNK_SIZE 8192
2617 #define LLOG_HEADER_SIZE (96)
2618 #define LLOG_BITMAP_BYTES (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
2620 #define LLOG_MIN_REC_SIZE (24) /* round(llog_rec_hdr + llog_rec_tail) */
2622 /* flags for the logs */
2623 #define LLOG_F_ZAP_WHEN_EMPTY 0x1
2624 #define LLOG_F_IS_CAT 0x2
2625 #define LLOG_F_IS_PLAIN 0x4
2627 struct llog_log_hdr {
2628 struct llog_rec_hdr llh_hdr;
2629 obd_time llh_timestamp;
2631 __u32 llh_bitmap_offset;
2635 /* for a catalog the first plain slot is next to it */
2636 struct obd_uuid llh_tgtuuid;
2637 __u32 llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
2638 __u32 llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
2639 struct llog_rec_tail llh_tail;
2640 } __attribute__((packed));
2642 #define LLOG_BITMAP_SIZE(llh) ((llh->llh_hdr.lrh_len - \
2643 llh->llh_bitmap_offset - \
2644 sizeof(llh->llh_tail)) * 8)
2646 /** log cookies are used to reference a specific log file and a record therein */
2647 struct llog_cookie {
2648 struct llog_logid lgc_lgl;
2652 } __attribute__((packed));
2654 /** llog protocol */
2655 enum llogd_rpc_ops {
2656 LLOG_ORIGIN_HANDLE_CREATE = 501,
2657 LLOG_ORIGIN_HANDLE_NEXT_BLOCK = 502,
2658 LLOG_ORIGIN_HANDLE_READ_HEADER = 503,
2659 LLOG_ORIGIN_HANDLE_WRITE_REC = 504,
2660 LLOG_ORIGIN_HANDLE_CLOSE = 505,
2661 LLOG_ORIGIN_CONNECT = 506,
2662 LLOG_CATINFO = 507, /* for lfs catinfo */
2663 LLOG_ORIGIN_HANDLE_PREV_BLOCK = 508,
2664 LLOG_ORIGIN_HANDLE_DESTROY = 509, /* for destroy llog object*/
2666 LLOG_FIRST_OPC = LLOG_ORIGIN_HANDLE_CREATE
2670 struct llog_logid lgd_logid;
2672 __u32 lgd_llh_flags;
2674 __u32 lgd_saved_index;
2676 __u64 lgd_cur_offset;
2677 } __attribute__((packed));
2679 struct llogd_conn_body {
2680 struct llog_gen lgdc_gen;
2681 struct llog_logid lgdc_logid;
2682 __u32 lgdc_ctxt_idx;
2683 } __attribute__((packed));
2685 /* Note: 64-bit types are 64-bit aligned in structure */
2687 obd_valid o_valid; /* hot fields in this obdo */
2689 obd_id o_parent_seq;
2690 obd_size o_size; /* o_size-o_blocks == ost_lvb */
2694 obd_blocks o_blocks; /* brw: cli sent cached bytes */
2697 /* 32-bit fields start here: keep an even number of them via padding */
2698 obd_blksize o_blksize; /* optimal IO blocksize */
2699 obd_mode o_mode; /* brw: cli sent cache remain */
2703 obd_count o_nlink; /* brw: checksum */
2704 obd_count o_parent_oid;
2705 obd_count o_misc; /* brw: o_dropped */
2706 __u64 o_ioepoch; /* epoch in ost writes */
2707 __u32 o_stripe_idx; /* holds stripe idx */
2709 struct lustre_handle o_handle; /* brw: lock handle to prolong locks */
2710 struct llog_cookie o_lcookie; /* destroy: unlink cookie from MDS */
2720 #define o_id o_oi.oi_id
2721 #define o_seq o_oi.oi_seq
2722 #define o_dirty o_blocks
2723 #define o_undirty o_mode
2724 #define o_dropped o_misc
2725 #define o_cksum o_nlink
2727 static inline void lustre_set_wire_obdo(struct obdo *wobdo, struct obdo *lobdo)
2729 memcpy(wobdo, lobdo, sizeof(*lobdo));
2730 wobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
2733 static inline void lustre_get_wire_obdo(struct obdo *lobdo, struct obdo *wobdo)
2735 obd_flag local_flags = 0;
2737 if (lobdo->o_valid & OBD_MD_FLFLAGS)
2738 local_flags = lobdo->o_flags & OBD_FL_LOCAL_MASK;
2740 LASSERT(!(wobdo->o_flags & OBD_FL_LOCAL_MASK));
2742 memcpy(lobdo, wobdo, sizeof(*lobdo));
2743 if (local_flags != 0) {
2744 lobdo->o_valid |= OBD_MD_FLFLAGS;
2745 lobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
2746 lobdo->o_flags |= local_flags;
2750 extern void lustre_swab_obdo (struct obdo *o);
2752 /* request structure for OST's */
2757 /* Key for FIEMAP to be used in get_info calls */
2758 struct ll_fiemap_info_key {
2761 struct ll_user_fiemap fiemap;
2764 extern void lustre_swab_ost_body (struct ost_body *b);
2765 extern void lustre_swab_ost_last_id(obd_id *id);
2766 extern void lustre_swab_fiemap(struct ll_user_fiemap *fiemap);
2768 extern void lustre_swab_lov_user_md_v1(struct lov_user_md_v1 *lum);
2769 extern void lustre_swab_lov_user_md_v3(struct lov_user_md_v3 *lum);
2770 extern void lustre_swab_lov_user_md_objects(struct lov_user_ost_data *lod,
2772 extern void lustre_swab_lov_mds_md(struct lov_mds_md *lmm);
2775 extern void lustre_swab_llogd_body (struct llogd_body *d);
2776 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
2777 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
2778 extern void lustre_swab_llog_rec(struct llog_rec_hdr *rec,
2779 struct llog_rec_tail *tail);
2782 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
2784 /* Functions for dumping PTLRPC fields */
2785 void dump_rniobuf(struct niobuf_remote *rnb);
2786 void dump_ioo(struct obd_ioobj *nb);
2787 void dump_obdo(struct obdo *oa);
2788 void dump_ost_body(struct ost_body *ob);
2789 void dump_rcs(__u32 *rc);
2791 /* this will be used when OBD_CONNECT_CHANGE_QS is set */
2794 * ID appiles to (uid, gid)
2798 * LQUOTA_FLAGS_* affect the responding bits
2802 * acquire/release count (bytes for block quota)
2806 * when a master returns the reply to a slave, it will
2807 * contain the current corresponding qunit size
2813 #define QDATA_IS_GRP(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_GRP)
2814 #define QDATA_IS_BLK(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_BLK)
2815 #define QDATA_IS_ADJBLK(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_ADJBLK)
2816 #define QDATA_IS_ADJINO(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_ADJINO)
2817 #define QDATA_IS_CHANGE_QS(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_CHG_QS)
2819 #define QDATA_SET_GRP(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_GRP)
2820 #define QDATA_SET_BLK(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_BLK)
2821 #define QDATA_SET_ADJBLK(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_ADJBLK)
2822 #define QDATA_SET_ADJINO(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_ADJINO)
2823 #define QDATA_SET_CHANGE_QS(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_CHG_QS)
2825 #define QDATA_CLR_GRP(qdata) ((qdata)->qd_flags &= ~LQUOTA_FLAGS_GRP)
2826 #define QDATA_CLR_CHANGE_QS(qdata) ((qdata)->qd_flags &= ~LQUOTA_FLAGS_CHG_QS)
2828 extern void lustre_swab_qdata(struct qunit_data *d);
2829 extern struct qunit_data *quota_get_qdata(void *req, int is_req, int is_exp);
2830 extern int quota_copy_qdata(void *request, struct qunit_data *qdata,
2831 int is_req, int is_exp);
2838 #define QUOTA_FIRST_OPC QUOTA_DQACQ
2840 #define QUOTA_REQUEST 1
2841 #define QUOTA_REPLY 0
2842 #define QUOTA_EXPORT 1
2843 #define QUOTA_IMPORT 0
2845 /* quota check function */
2846 #define QUOTA_RET_OK 0 /**< return successfully */
2847 #define QUOTA_RET_NOQUOTA 1 /**< not support quota */
2848 #define QUOTA_RET_NOLIMIT 2 /**< quota limit isn't set */
2849 #define QUOTA_RET_ACQUOTA 4 /**< need to acquire extra quota */
2852 /* security opcodes */
2855 SEC_CTX_INIT_CONT = 802,
2858 SEC_FIRST_OPC = SEC_CTX_INIT
2862 * capa related definitions
2864 #define CAPA_HMAC_MAX_LEN 64
2865 #define CAPA_HMAC_KEY_MAX_LEN 56
2867 /* NB take care when changing the sequence of elements this struct,
2868 * because the offset info is used in find_capa() */
2869 struct lustre_capa {
2870 struct lu_fid lc_fid; /** fid */
2871 __u64 lc_opc; /** operations allowed */
2872 __u64 lc_uid; /** file owner */
2873 __u64 lc_gid; /** file group */
2874 __u32 lc_flags; /** HMAC algorithm & flags */
2875 __u32 lc_keyid; /** key# used for the capability */
2876 __u32 lc_timeout; /** capa timeout value (sec) */
2877 __u32 lc_expiry; /** expiry time (sec) */
2878 __u8 lc_hmac[CAPA_HMAC_MAX_LEN]; /** HMAC */
2879 } __attribute__((packed));
2881 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
2883 /** lustre_capa::lc_opc */
2885 CAPA_OPC_BODY_WRITE = 1<<0, /**< write object data */
2886 CAPA_OPC_BODY_READ = 1<<1, /**< read object data */
2887 CAPA_OPC_INDEX_LOOKUP = 1<<2, /**< lookup object fid */
2888 CAPA_OPC_INDEX_INSERT = 1<<3, /**< insert object fid */
2889 CAPA_OPC_INDEX_DELETE = 1<<4, /**< delete object fid */
2890 CAPA_OPC_OSS_WRITE = 1<<5, /**< write oss object data */
2891 CAPA_OPC_OSS_READ = 1<<6, /**< read oss object data */
2892 CAPA_OPC_OSS_TRUNC = 1<<7, /**< truncate oss object */
2893 CAPA_OPC_OSS_DESTROY = 1<<8, /**< destroy oss object */
2894 CAPA_OPC_META_WRITE = 1<<9, /**< write object meta data */
2895 CAPA_OPC_META_READ = 1<<10, /**< read object meta data */
2898 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
2899 #define CAPA_OPC_MDS_ONLY \
2900 (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
2901 CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
2902 #define CAPA_OPC_OSS_ONLY \
2903 (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC | \
2904 CAPA_OPC_OSS_DESTROY)
2905 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
2906 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
2908 /* MDS capability covers object capability for operations of body r/w
2909 * (dir readpage/sendpage), index lookup/insert/delete and meta data r/w,
2910 * while OSS capability only covers object capability for operations of
2911 * oss data(file content) r/w/truncate.
2913 static inline int capa_for_mds(struct lustre_capa *c)
2915 return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) != 0;
2918 static inline int capa_for_oss(struct lustre_capa *c)
2920 return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) == 0;
2923 /* lustre_capa::lc_hmac_alg */
2925 CAPA_HMAC_ALG_SHA1 = 1, /**< sha1 algorithm */
2929 #define CAPA_FL_MASK 0x00ffffff
2930 #define CAPA_HMAC_ALG_MASK 0xff000000
2932 struct lustre_capa_key {
2933 __u64 lk_seq; /**< mds# */
2934 __u32 lk_keyid; /**< key# */
2936 __u8 lk_key[CAPA_HMAC_KEY_MAX_LEN]; /**< key */
2937 } __attribute__((packed));
2939 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
2941 /** The link ea holds 1 \a link_ea_entry for each hardlink */
2942 #define LINK_EA_MAGIC 0x11EAF1DFUL
2943 struct link_ea_header {
2946 __u64 leh_len; /* total size */
2952 /** Hardlink data is name and parent fid.
2953 * Stored in this crazy struct for maximum packing and endian-neutrality
2955 struct link_ea_entry {
2956 /** __u16 stored big-endian, unaligned */
2957 unsigned char lee_reclen[2];
2958 unsigned char lee_parent_fid[sizeof(struct lu_fid)];
2960 }__attribute__((packed));
2962 /** fid2path request/reply structure */
2963 struct getinfo_fid2path {
2964 struct lu_fid gf_fid;
2969 } __attribute__((packed));
2971 void lustre_swab_fid2path (struct getinfo_fid2path *gf);