1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2001 Cluster File Systems, Inc. <braam@clusterfs.com>
6 * This file is part of Lustre, http://www.lustre.org.
8 * Lustre is free software; you can redistribute it and/or
9 * modify it under the terms of version 2 of the GNU General Public
10 * License as published by the Free Software Foundation.
12 * Lustre is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Lustre; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * Lustre wire protocol definitions.
23 * All structs passing over the wire should be declared here (lov_mds_md
24 * being the lone exception). Structs must be properly aligned to put
25 * 64-bit values on an 8-byte boundary. Any structs being added here
26 * must also be added to utils/wirecheck.c and "make newwiretest" run
27 * to regenerate the utils/wiretest.c sources. This allows us to verify
28 * that wire structs have the proper alignment/size on all architectures.
30 * We assume all nodes are either little-endian or big-endian, and we
31 * always send messages in the sender's native format. The receiver
32 * detects the message format by checking the 'magic' field of the message
33 * (see lustre_msg_swabbed() below).
35 * Each wire type has corresponding 'lustre_swab_xxxtypexxx()' routines,
36 * implemented either here, inline (trivial implementations) or in
37 * ptlrpc/pack_generic.c. These 'swabbers' convert the type from "other"
38 * endian, in-place in the message buffer.
40 * A swabber takes a single pointer argument. The caller must already have
41 * verified that the length of the message buffer >= sizeof (type).
43 * For variable length types, a second 'lustre_swab_v_xxxtypexxx()' routine
44 * may be defined that swabs just the variable part, after the caller has
45 * verified that the message buffer is large enough.
48 #ifndef _LUSTRE_IDL_H_
49 #define _LUSTRE_IDL_H_
51 #ifdef HAVE_ASM_TYPES_H
52 #include <asm/types.h>
59 # include <linux/ioctl.h>
60 # include <linux/types.h>
61 # include <linux/list.h>
62 # include <linux/string.h> /* for strncpy, below */
63 # include <linux/fs.h> /* to check for FMODE_EXEC, dev_t, lest we redefine */
64 # include <linux/posix_acl.h>
67 # include <sys/types.h>
71 # include <libcfs/list.h>
75 /* Defn's shared with user-space. */
76 #include <lustre/lustre_user.h>
79 * this file contains all data structures used in Lustre interfaces:
80 * - obdo and obd_request records
81 * - mds_request records
89 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
90 * FOO_REPLY_PORTAL is for incoming replies on the FOO
91 * FOO_BULK_PORTAL is for incoming bulk on the FOO
94 #define CONNMGR_REQUEST_PORTAL 1
95 #define CONNMGR_REPLY_PORTAL 2
96 //#define OSC_REQUEST_PORTAL 3
97 #define OSC_REPLY_PORTAL 4
98 //#define OSC_BULK_PORTAL 5
99 #define OST_REQUEST_PORTAL 6
100 #define OST_CREATE_PORTAL 7
101 #define OST_BULK_PORTAL 8
102 //#define MDC_REQUEST_PORTAL 9
103 #define MDC_REPLY_PORTAL 10
104 //#define MDC_BULK_PORTAL 11
105 #define MDS_REQUEST_PORTAL 12
106 //#define MDS_REPLY_PORTAL 13
107 #define MDS_BULK_PORTAL 14
108 #define LDLM_CB_REQUEST_PORTAL 15
109 #define LDLM_CB_REPLY_PORTAL 16
110 #define LDLM_CANCEL_REQUEST_PORTAL 17
111 #define LDLM_CANCEL_REPLY_PORTAL 18
112 #define PTLBD_REQUEST_PORTAL 19
113 #define PTLBD_REPLY_PORTAL 20
114 #define PTLBD_BULK_PORTAL 21
115 #define MDS_SETATTR_PORTAL 22
116 #define MDS_READPAGE_PORTAL 23
117 #define MGMT_REQUEST_PORTAL 24
118 #define MGMT_REPLY_PORTAL 25
119 #define MGMT_CLI_REQUEST_PORTAL 26
120 #define MGMT_CLI_REPLY_PORTAL 27
121 #define GKS_REQUEST_PORTAL 28
122 #define GKC_REPLY_PORTAL 29
123 #define MDS_CLOSE_PORTAL 30
124 #define OST_DESTROY_PORTAL 31
129 #define SVC_RUNNING 8
130 #define SVC_STOPPING 16
131 #define SVC_STOPPED 32
134 #define PTL_RPC_MSG_REQUEST 4711
135 #define PTL_RPC_MSG_ERR 4712
136 #define PTL_RPC_MSG_REPLY 4713
138 #define PTLRPC_MSG_MAGIC 0x0BD00BD0
141 #define PTLRPC_MSG_VERSION 0x00000003
142 #define LUSTRE_VERSION_MASK 0xffff0000
143 #define LUSTRE_OBD_VERSION 0x00010000
144 #define LUSTRE_MDS_VERSION 0x00020000
145 #define LUSTRE_OST_VERSION 0x00030000
146 #define LUSTRE_DLM_VERSION 0x00040000
147 #define LUSTRE_LOG_VERSION 0x00050000
148 #define LUSTRE_PBD_VERSION 0x00060000
149 #define LUSTRE_GKS_VERSION 0x00070000
151 struct lustre_handle {
154 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
156 /* we depend on this structure to be 8-byte aligned */
157 /* this type is only endian-adjusted in lustre_unpack_msg() */
159 struct lustre_handle handle;
165 __u64 last_committed;
174 /* Flags that are operation-specific go in the top 16 bits. */
175 #define MSG_OP_FLAG_MASK 0xffff0000
176 #define MSG_OP_FLAG_SHIFT 16
178 /* Flags that apply to all requests are in the bottom 16 bits */
179 #define MSG_GEN_FLAG_MASK 0x0000ffff
180 #define MSG_LAST_REPLAY 1
183 #define MSG_REQ_REPLAY_DONE 8
184 #define MSG_LOCK_REPLAY_DONE 16
186 static inline int lustre_msg_get_flags(struct lustre_msg *msg)
188 return (msg->flags & MSG_GEN_FLAG_MASK);
191 static inline void lustre_msg_add_flags(struct lustre_msg *msg, int flags)
193 msg->flags |= MSG_GEN_FLAG_MASK & flags;
196 static inline void lustre_msg_set_flags(struct lustre_msg *msg, int flags)
198 msg->flags &= ~MSG_GEN_FLAG_MASK;
199 lustre_msg_add_flags(msg, flags);
202 static inline void lustre_msg_clear_flags(struct lustre_msg *msg, int flags)
204 msg->flags &= ~(MSG_GEN_FLAG_MASK & flags);
207 static inline int lustre_msg_get_op_flags(struct lustre_msg *msg)
209 return (msg->flags >> MSG_OP_FLAG_SHIFT);
212 static inline void lustre_msg_add_op_flags(struct lustre_msg *msg, int flags)
214 msg->flags |= ((flags & MSG_GEN_FLAG_MASK) << MSG_OP_FLAG_SHIFT);
217 static inline void lustre_msg_set_op_flags(struct lustre_msg *msg, int flags)
219 msg->flags &= ~MSG_OP_FLAG_MASK;
220 lustre_msg_add_op_flags(msg, flags);
224 * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
227 #define MSG_CONNECT_RECOVERING 0x1
228 #define MSG_CONNECT_RECONNECT 0x2
229 #define MSG_CONNECT_REPLAYABLE 0x4
230 #define MSG_CONNECT_PEER 0x8
231 #define MSG_CONNECT_LIBCLIENT 0x10
232 #define MSG_CONNECT_INITIAL 0x20
233 #define MSG_CONNECT_ASYNC 0x40
234 #define MSG_CONNECT_TRANSNO 0X80 /* report transno */
238 #define OBD_CONNECT_RDONLY (0x00000001LL)
239 #define OBD_CONNECT_REMOTE (0x40000000LL)
240 #define OBD_CONNECT_LOCAL (0x80000000LL)
242 #define OBD_CONNECT_SUPPORTED (OBD_CONNECT_RDONLY | \
243 OBD_CONNECT_REMOTE | \
246 /* This structure is used for both request and reply.
248 * If we eventually have separate connect data for different types, which we
249 * almost certainly will, then perhaps we stick a union in here. */
250 struct obd_connect_data {
251 __u64 ocd_connect_flags;
253 __u64 transno; /* first transno from client to be replayed */
257 extern void lustre_swab_connect(struct obd_connect_data *ocd);
260 * OST requests: OBDO & OBD request records
265 OST_REPLY = 0, /* reply ? */
285 #define OST_FIRST_OPC OST_REPLY
287 typedef uint64_t obd_id;
288 typedef uint64_t obd_gr;
289 typedef uint64_t obd_time;
290 typedef uint64_t obd_size;
291 typedef uint64_t obd_off;
292 typedef uint64_t obd_blocks;
293 typedef uint32_t obd_blksize;
294 typedef uint32_t obd_mode;
295 typedef uint32_t obd_uid;
296 typedef uint32_t obd_gid;
297 typedef uint32_t obd_flags;
298 typedef uint64_t obd_valid;
299 typedef uint32_t obd_count;
301 #define OBD_FL_INLINEDATA (0x00000001)
302 #define OBD_FL_OBDMDEXISTS (0x00000002)
303 #define OBD_FL_DELORPHAN (0x00000004) /* if set in o_flags delete orphans */
304 #define OBD_FL_NORPC (0x00000008) // if set in o_flags set in OSC not OST
305 #define OBD_FL_IDONLY (0x00000010) // if set in o_flags only adjust obj id
306 #define OBD_FL_RECREATE_OBJS (0x00000020) // recreate missing obj
307 #define OBD_FL_DEBUG_CHECK (0x00000040) /* echo client/server debug check */
308 #define OBD_FL_REINT (0x00000080) /* reint during cache flush */
310 /* this should be sizeof(struct lustre_handle) + sizeof(struct llog_cookie) +
311 * sizeof(struct lustre_id). */
312 #define OBD_INLINESZ (80)
314 /* Note: 64-bit types are 64-bit aligned in structure */
322 obd_blocks o_blocks; /* brw: cli sent cached bytes */
324 obd_blksize o_blksize; /* optimal IO blocksize */
325 obd_mode o_mode; /* brw: cli sent cache remain */
329 obd_count o_nlink; /* brw: checksum */
330 obd_count o_generation;
331 obd_valid o_valid; /* hot fields in this obdo */
332 obd_count o_misc; /* brw: o_dropped */
333 __u32 o_easize; /* epoch in ost writes */
336 obd_uid o_fsuid; /* fsuid, used by capability */
337 char o_inline[OBD_INLINESZ]; /* fid in ost writes */
340 #define o_dirty o_blocks
341 #define o_undirty o_mode
342 #define o_dropped o_misc
343 #define o_cksum o_nlink
345 extern void lustre_swab_obdo (struct obdo *o);
347 #define LOV_MAGIC_V1 0x0BD10BD0
348 #define LOV_MAGIC LOV_MAGIC_V1
350 #define LOV_PATTERN_RAID0 0x001 /* stripes are used round-robin */
351 #define LOV_PATTERN_RAID1 0x002 /* stripes are mirrors of each other */
352 #define LOV_PATTERN_FIRST 0x100 /* first stripe is not in round-robin */
353 #define LOV_PATTERN_CMOBD 0x200
355 #define lov_ost_data lov_ost_data_v1
356 struct lov_ost_data { /* per-stripe data structure (little-endian)*/
357 __u64 l_object_id; /* OST object ID */
358 __u64 l_object_gr; /* OST object group (creating MDS number) */
359 __u32 l_ost_gen; /* generation of this l_ost_idx */
360 __u32 l_ost_idx; /* OST index in LOV (lov_tgt_desc->tgts) */
363 #define lov_mds_md lov_mds_md_v1
364 struct lov_mds_md_v1 { /* LOV EA mds/wire data (little-endian) */
365 __u32 lmm_magic; /* magic number = LOV_MAGIC_V1 */
366 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
367 __u64 lmm_object_id; /* LOV object ID */
368 __u64 lmm_object_gr; /* LOV object group */
369 __u32 lmm_stripe_size; /* size of stripe in bytes */
370 __u32 lmm_stripe_count; /* num stripes in use for this object */
371 struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
374 #define LOV_MAGIC_V0 0x0BD00BD0
376 struct lov_ost_data_v0 { /* per-stripe data structure (little-endian)*/
377 __u64 l_object_id; /* OST object ID */
380 struct lov_mds_md_v0 { /* LOV EA mds/wire data (little-endian) */
381 __u32 lmm_magic; /* magic number = LOV_MAGIC_V0 */
382 __u64 lmm_object_id; /* LOV object ID */
383 __u32 lmm_stripe_size; /* size of the stripe in bytes (not RAID1) */
384 __u32 lmm_stripe_offset; /* starting stripe offset in lmm_objects */
385 __u16 lmm_stripe_count; /* number of stipes in use for this object */
386 __u16 lmm_ost_count; /* how many OST idx are in this LOV md */
387 struct lov_ost_data_v0 lmm_objects[0];
388 } __attribute__((packed));
390 #define OBD_MD_FLALL (0xffffffffffffffffLL)
391 #define OBD_MD_FLID (0x0000000000000001LL) /* object ID */
392 #define OBD_MD_FLATIME (0x0000000000000002LL) /* access time */
393 #define OBD_MD_FLMTIME (0x0000000000000004LL) /* data modification time */
394 #define OBD_MD_FLCTIME (0x0000000000000008LL) /* change time */
395 #define OBD_MD_FLSIZE (0x0000000000000010LL) /* size */
396 #define OBD_MD_FLBLOCKS (0x0000000000000020LL) /* allocated blocks count */
397 #define OBD_MD_FLBLKSZ (0x0000000000000040LL) /* block size */
398 #define OBD_MD_FLMODE (0x0000000000000080LL) /* access bits (mode & ~S_IFMT) */
399 #define OBD_MD_FLTYPE (0x0000000000000100LL) /* object type (mode & S_IFMT) */
400 #define OBD_MD_FLUID (0x0000000000000200LL) /* user ID */
401 #define OBD_MD_FLGID (0x0000000000000400LL) /* group ID */
402 #define OBD_MD_FLFLAGS (0x0000000000000800LL) /* flags word */
403 #define OBD_MD_FLXATTR (0x0000000000001000LL) /* user xattr */
404 #define OBD_MD_FLNLINK (0x0000000000002000LL) /* link count */
405 #define OBD_MD_FLGENER (0x0000000000004000LL) /* generation number */
406 #define OBD_MD_FLINLINE (0x0000000000008000LL) /* inline data */
407 #define OBD_MD_FLRDEV (0x0000000000010000LL) /* device number */
408 #define OBD_MD_FLEASIZE (0x0000000000020000LL) /* extended attribute data */
409 #define OBD_MD_LINKNAME (0x0000000000040000LL) /* symbolic link target */
410 #define OBD_MD_FLHANDLE (0x0000000000080000LL) /* file handle */
411 #define OBD_MD_FLCKSUM (0x0000000000100000LL) /* bulk data checksum */
412 #define OBD_MD_FLQOS (0x0000000000200000LL) /* quality of service stats */
413 #define OBD_MD_FLOSCOPQ (0x0000000000400000LL) /* osc opaque data */
414 #define OBD_MD_FLCOOKIE (0x0000000000800000LL) /* log cancellation cookie */
415 #define OBD_MD_FLGROUP (0x0000000001000000LL) /* group */
416 #define OBD_MD_FLIFID (0x0000000002000000LL) /* ->ost write inline fid */
417 #define OBD_MD_FLEPOCH (0x0000000004000000LL) /* ->ost write easize is epoch */
418 #define OBD_MD_FLGRANT (0x0000000008000000LL) /* ost preallocation space grant */
419 #define OBD_MD_MDS (0x0000000010000000LL) /* where an inode lives on */
420 #define OBD_MD_FLDIREA (0x0000000020000000LL) /* dir's extended attribute data */
421 #define OBD_MD_REINT (0x0000000040000000LL) /* reintegrate oa */
422 #define OBD_MD_FID (0x0000000080000000LL) /* lustre_id data */
423 #define OBD_MD_MEA (0x0000000100000000LL) /* shows we are interested in MEA */
424 #define OBD_MD_FLXATTRLIST (0x0000000200000000LL) /* user xattr list */
425 #define OBD_MD_FLACL (0x0000000400000000LL) /* acl */
426 #define OBD_MD_FLRMTACL (0x0000000800000000LL) /* remote acl */
427 #define OBD_MD_FLKEY (0x0000001000000000LL) /* mds key extended attributes */
428 #define OBD_MD_FLAUDIT (0x0000002000000000LL) /* audit setting */
429 #define OBD_MD_CAPA (0x0000004000000000LL) /* capability */
430 #define OBD_MD_FLFSUID (0x0000008000000000LL) /* fsuid */
432 #define OBD_MD_FLNOTOBD (~(OBD_MD_FLBLOCKS | OBD_MD_LINKNAME | \
433 OBD_MD_FLEASIZE | OBD_MD_FLHANDLE | \
434 OBD_MD_FLCKSUM | OBD_MD_FLQOS | \
435 OBD_MD_FLOSCOPQ | OBD_MD_FLCOOKIE | \
436 OBD_MD_FLXATTR | OBD_MD_FLXATTRLIST | \
437 OBD_MD_FLACL | OBD_MD_MDS | \
438 OBD_MD_FLKEY | OBD_MD_FLAUDIT | \
439 OBD_MD_CAPA | OBD_MD_FLFSUID))
441 static inline struct lustre_handle *obdo_handle(struct obdo *oa)
443 return (struct lustre_handle *)oa->o_inline;
446 static inline struct llog_cookie *obdo_logcookie(struct obdo *oa)
448 return (struct llog_cookie *)(oa->o_inline +
449 sizeof(struct lustre_handle));
452 /* don't forget obdo_fid which is way down at the bottom so it can come after
453 * the definition of llog_cookie */
468 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
470 /* ost_body.data values for OST_BRW */
472 #define OBD_BRW_READ 0x01
473 #define OBD_BRW_WRITE 0x02
474 #define OBD_BRW_RWMASK (OBD_BRW_READ | OBD_BRW_WRITE)
475 #define OBD_BRW_SYNC 0x08
476 #define OBD_BRW_CHECK 0x10
477 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
478 #define OBD_BRW_GRANTED 0x40 /* the ost manages this */
480 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
489 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
491 /* multiple of 8 bytes => can array */
492 struct niobuf_remote {
498 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
500 /* request structure for OST's */
502 #define OST_REQ_HAS_OA1 0x1
508 extern void lustre_swab_ost_body (struct ost_body *b);
509 extern void lustre_swab_ost_last_id(obd_id *id);
510 extern void lustre_swab_generic_32s(__u32 *val);
512 /* lock value block communicated between the filter and llite */
522 extern void lustre_swab_ost_lvb(struct ost_lvb *);
528 /* offsets in the request */
529 #define MDS_REQ_SECDESC_OFF 0
530 #define MDS_REQ_REC_OFF 1
532 #define MDS_REQ_INTENT_LOCKREQ_OFF 1
533 #define MDS_REQ_INTENT_IT_OFF 2
534 #define MDS_REQ_INTENT_REC_OFF 3
536 /* maximum supplementary groups */
537 #define LUSTRE_MAX_GROUPS 128
540 * security descriptor in mds request
542 struct mds_req_sec_desc {
552 struct ptlrpc_request;
553 struct mds_req_sec_desc *lustre_swab_mds_secdesc(struct ptlrpc_request *req,
559 MDS_GETATTR_LOCK = 34,
570 MDS_DONE_WRITING = 45,
571 MDS_ACCESS_CHECK = 46,
576 #define MDS_FIRST_OPC MDS_GETATTR
582 #define REINT_SETATTR 1
583 #define REINT_CREATE 2
585 #define REINT_UNLINK 4
586 #define REINT_RENAME 5
587 #define REINT_SETXATTR 6
589 #define REINT_CLOSE 8
590 #define REINT_WRITE 9
593 /* the disposition of the intent outlines what was executed */
594 #define DISP_IT_EXECD (1 << 0)
595 #define DISP_LOOKUP_EXECD (1 << 1)
596 #define DISP_LOOKUP_NEG (1 << 2)
597 #define DISP_LOOKUP_POS (1 << 3)
598 #define DISP_OPEN_CREATE (1 << 4)
599 #define DISP_OPEN_OPEN (1 << 5)
600 #define DISP_ENQ_COMPLETE (1 << 6)
602 /* INODE LOCK PARTS */
603 #define MDS_INODELOCK_LOOKUP 0x000001 /* dentry, mode, owner, group */
604 #define MDS_INODELOCK_UPDATE 0x000002 /* size, links, timestamps */
605 #define MDS_INODELOCK_OPEN 0x000004 /* for opened files */
607 /* do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits */
608 #define MDS_INODELOCK_MAXSHIFT 2
610 /* this FULL lock is useful to take on unlink sort of operations */
611 #define MDS_INODELOCK_FULL ((1 << (MDS_INODELOCK_MAXSHIFT + 1)) - 1)
613 /* lustre store cookie */
617 __u64 l3s_ino; /* inode number on local MDS */
618 __u32 l3s_gen; /* inode generation */
619 __u32 l3s_type; /* inode type */
631 __u64 lf_id; /* fid counter maintained on per
633 __u64 lf_group; /* sequence group num */
635 __u32 lf_version; /* what snapfs version of inode */
641 struct lustre_stc li_stc; /* store cookie */
642 struct lustre_fid li_fid; /* fid cookie */
648 struct lustre_id mea_ids[0];
651 #define MEA_MAGIC_LAST_CHAR 0xb2221ca1
652 #define MEA_MAGIC_ALL_CHARS 0xb222a11c
658 struct lustre_id mea_ids[0];
661 #define MDS_STATUS_CONN 1
662 #define MDS_STATUS_LOV 2
664 struct mds_status_req {
672 struct lustre_id pp_id1;
673 struct lustre_id pp_id2;
674 __u8 pp_name[NAME_MAX + 1];
686 struct audit_attr_msg {
691 extern void lustre_swab_lustre_id(struct lustre_id *id);
692 extern void lustre_swab_lustre_stc(struct lustre_stc *stc);
693 extern void lustre_swab_lustre_fid(struct lustre_fid *fid);
694 extern void lustre_swab_parseid_pkg(struct parseid_pkg *pkg);
695 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
697 extern void lustre_swab_audit_msg (struct audit_msg *r);
698 extern void lustre_swab_audit_attr (struct audit_attr_msg *r);
699 extern void lustre_swab_parseid_pkg(struct parseid_pkg *pkg);
701 #define MDS_BFLAG_UNCOMMITTED_WRITES 0x1
702 #define MDS_BFLAG_CLOSE_EPOCH 0x2
703 #define MDS_BFLAG_DIRTY_EPOCH 0x4
706 struct lustre_id id1;
707 struct lustre_id id2;
708 struct lustre_handle handle;
709 __u64 size; /* Offset, in the case of MDS_READPAGE */
710 __u64 blocks; /* XID, in the case of MDS_READPAGE */
720 __u32 flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
722 __u32 nlink; /* #bytes to read in the case of MDS_READPAGE */
726 extern void lustre_swab_mds_body (struct mds_body *b);
728 struct mds_remote_perm {
732 __u8 mrp_allow_setuid;
733 __u8 mrp_allow_setgid;
737 struct mds_body *body;
738 struct lov_stripe_md *lsm;
740 struct posix_acl *posix_acl;
741 struct mds_remote_perm *remote_perm;
742 struct lustre_key *key;
745 void lustre_swab_remote_perm(struct mds_remote_perm *p);
748 struct lustre_id id1;
749 struct lustre_id id2;
754 struct mea *mea1; /* mea of inode1 */
755 struct mea *mea2; /* mea of inode2 */
759 /* fields needed for md_close() */
769 #define MDS_MODE_DONT_LOCK (1 << 30)
770 #define MDS_MODE_REPLAY (1 << 31)
772 /* XXX Following ATTR_XXX should go to vfs patch... */
773 #ifdef ATTR_CTIME_SET
774 #error "ATTR_CTIME_SET has been defined somewhere else"
777 #error "ATTR_EA has been defined somewhere else"
780 #error "ATTR_EA_RM has been defined somewhere else"
783 #define ATTR_CTIME_SET 0x00002000
784 #define ATTR_EA 0x00040000
785 #define ATTR_EA_RM 0x00080000
786 #define ATTR_EA_CMOBD 0x00100000
787 #define ATTR_KEY 0x00200000
788 #define ATTR_MAC 0x00400000
791 #define FMODE_READ 00000001
792 #define FMODE_WRITE 00000002
795 #define FMODE_EXEC 00000004
797 #define MDS_OPEN_CREAT 00000100
798 #define MDS_OPEN_EXCL 00000200
799 #define MDS_OPEN_TRUNC 00001000
800 #define MDS_OPEN_APPEND 00002000
801 #define MDS_OPEN_SYNC 00010000
802 #define MDS_OPEN_DIRECTORY 00200000
803 #define MDS_REINT_REQ 01000000
805 #define MDS_OPEN_DELAY_CREATE 0100000000 /* delay initial object create */
806 #define MDS_OPEN_HAS_KEY 01000000000 /* just set the EA the obj exist */
807 #define MDS_OPEN_HAS_EA 010000000000 /* specify object create pattern */
808 #define MDS_OPEN_HAS_OBJS 020000000000 /* just set the EA the obj exist */
810 struct mds_rec_create {
812 __u32 cr_flags; /* for use with open */
815 struct lustre_id cr_id;
816 struct lustre_id cr_replayid;
823 extern void lustre_swab_mds_rec_create (struct mds_rec_create *cr);
825 struct mds_rec_link {
829 struct lustre_id lk_id1;
830 struct lustre_id lk_id2;
834 extern void lustre_swab_mds_rec_link (struct mds_rec_link *lk);
836 struct mds_rec_unlink {
840 struct lustre_id ul_id1;
841 struct lustre_id ul_id2;
845 extern void lustre_swab_mds_rec_unlink (struct mds_rec_unlink *ul);
847 struct mds_rec_rename {
851 struct lustre_id rn_id1;
852 struct lustre_id rn_id2;
856 struct mds_rec_setattr {
860 struct lustre_id sa_id;
871 extern void lustre_swab_mds_rec_rename (struct mds_rec_rename *rn);
874 * LOV data structures
877 #define LOV_MAX_UUID_BUFFER_SIZE 8192
878 /* The size of the buffer the lov/mdc reserves for the
879 * array of UUIDs returned by the MDS. With the current
880 * protocol, this will limit the max number of OSTs per LOV */
883 __u32 ld_tgt_count; /* how many OBD's */
884 __u32 ld_active_tgt_count; /* how many active */
885 __u32 ld_default_stripe_count; /* how many objects are used */
886 __u32 ld_pattern; /* PATTERN_RAID0, PATTERN_RAID1 */
887 __u64 ld_default_stripe_size; /* in bytes */
888 __u64 ld_default_stripe_offset; /* in bytes */
889 struct obd_uuid ld_uuid;
893 __u32 ld_tgt_count; /* how many MDS's */
894 __u32 ld_active_tgt_count; /* how many active */
895 struct obd_uuid ld_uuid;
901 /* opcodes -- MUST be distinct from OST/MDS opcodes */
906 LDLM_BL_CALLBACK = 104,
907 LDLM_CP_CALLBACK = 105,
908 LDLM_GL_CALLBACK = 106,
911 #define LDLM_FIRST_OPC LDLM_ENQUEUE
913 #define RES_NAME_SIZE 4
915 __u64 name[RES_NAME_SIZE];
918 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
936 struct ldlm_inodebits {
945 __u64 blocking_export;
948 /* it's important that the fields of the ldlm_extent structure match
949 * the first fields of the ldlm_flock structure because there is only
950 * one ldlm_swab routine to process the ldlm_policy_data_t union. if
951 * this ever changes we will need to swab the union differently based
952 * on the resource type. */
955 struct ldlm_extent l_extent;
956 struct ldlm_flock l_flock;
957 struct ldlm_inodebits l_inodebits;
958 } ldlm_policy_data_t;
960 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
966 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
968 struct ldlm_resource_desc {
971 struct ldlm_res_id lr_name;
974 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
976 struct ldlm_lock_desc {
977 struct ldlm_resource_desc l_resource;
978 ldlm_mode_t l_req_mode;
979 ldlm_mode_t l_granted_mode;
980 ldlm_policy_data_t l_policy_data;
983 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
985 struct ldlm_request {
988 struct ldlm_lock_desc lock_desc;
989 struct lustre_handle lock_handle1;
990 struct lustre_handle lock_handle2;
993 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
998 struct ldlm_lock_desc lock_desc;
999 struct lustre_handle lock_handle;
1000 __u64 lock_policy_res1;
1001 __u64 lock_policy_res2;
1004 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
1007 * ptlbd, portal block device requests
1014 PTLBD_CONNECT = 204,
1015 PTLBD_DISCONNECT = 205,
1018 #define PTLBD_FIRST_OPC PTLBD_QUERY
1028 extern void lustre_swab_ptlbd_op (struct ptlbd_op *op);
1037 extern void lustre_swab_ptlbd_niob (struct ptlbd_niob *n);
1044 extern void lustre_swab_ptlbd_rsp (struct ptlbd_rsp *r);
1046 #define CAPA_KEY_LEN 16
1047 #define CAPA_DIGEST_SIZE 16
1049 struct lustre_capa {
1050 __u32 lc_uid; /* uid */
1051 __u32 lc_op; /* operations allowed */
1052 __u64 lc_ino; /* inode# */
1053 __u32 lc_mdsid; /* mds# */
1054 __u32 lc_keyid; /* key used for the capability */
1055 __u64 lc_expiry; /* expiry time (sec): servers have clocks */
1056 __u32 lc_flags; /* security features for capability */
1057 __u8 lc_hmac[CAPA_DIGEST_SIZE]; /* HMAC */
1058 } __attribute__((packed));
1060 extern void lustre_swab_lustre_capa (struct lustre_capa *c);
1062 struct lustre_capa_key {
1063 __u32 lk_mdsid; /* mds# */
1064 __u32 lk_keyid; /* key# */
1065 __u64 lk_expiry; /* expiry (sec) */
1066 __u8 lk_key[CAPA_KEY_LEN]; /* key */
1069 extern void lustre_swab_lustre_capa_key (struct lustre_capa_key *k);
1072 * Opcodes for management/monitoring node.
1077 MGMT_EXCEPTION, /* node died, etc. */
1080 #define MGMT_FIRST_OPC MGMT_CONNECT
1083 * Opcodes for multiple servers.
1091 #define OBD_FIRST_OPC OBD_PING
1093 /* catalog of log objects */
1095 /* Identifier for a single log object */
1100 } __attribute__((packed));
1102 /* Records written to the CATALOGS list */
1103 #define CATLIST "CATALOGS"
1105 struct llog_logid lci_logid;
1106 __u32 lci_padding[3];
1107 } __attribute__((packed));
1109 /* Log data record types - there is no specific reason that these need to
1110 * be related to the RPC opcodes, but no reason not to (may be handy later?)
1113 OST_SZ_REC = 0x10600000 | (OST_SAN_WRITE << 8),
1114 OST_RAID1_REC = 0x10600000 | ((OST_SAN_WRITE + 1) << 8),
1115 MDS_UNLINK_REC = 0x10610000 | (MDS_REINT << 8) | REINT_UNLINK,
1116 OBD_CFG_REC = 0x10620000,
1117 PTL_CFG_REC = 0x10630000,
1118 LLOG_GEN_REC = 0x10640000,
1119 LLOG_HDR_MAGIC = 0x10645539,
1120 LLOG_LOGID_MAGIC = 0x1064553b,
1121 SMFS_UPDATE_REC = 0x10650000,
1122 CACHE_LRU_REC = 0x10660000,
1123 SMFS_AUDIT_GEN_REC = 0x10670000,
1124 SMFS_AUDIT_NAME_REC = 0x10680000,
1127 /* Log record header - stored in little endian order.
1128 * Each record must start with this struct, end with a llog_rec_tail,
1129 * and be a multiple of 256 bits in size.
1131 struct llog_rec_hdr {
1138 struct llog_rec_tail {
1143 struct llog_logid_rec {
1144 struct llog_rec_hdr lid_hdr;
1145 struct llog_logid lid_id;
1147 struct llog_rec_tail lid_tail;
1148 } __attribute__((packed));
1150 struct llog_create_rec {
1151 struct llog_rec_hdr lcr_hdr;
1152 struct lustre_id lcr_id;
1156 struct llog_rec_tail lcr_tail;
1157 } __attribute__((packed));
1159 struct llog_orphan_rec {
1160 struct llog_rec_hdr lor_hdr;
1164 struct llog_rec_tail lor_tail;
1165 } __attribute__((packed));
1167 struct llog_unlink_rec {
1168 struct llog_rec_hdr lur_hdr;
1172 struct llog_rec_tail lur_tail;
1173 } __attribute__((packed));
1175 struct llog_size_change_rec {
1176 struct llog_rec_hdr lsc_hdr;
1177 struct lustre_id lsc_id;
1180 struct llog_rec_tail lsc_tail;
1181 } __attribute__((packed));
1188 struct llog_gen_rec {
1189 struct llog_rec_hdr lgr_hdr;
1190 struct llog_gen lgr_gen;
1191 struct llog_rec_tail lgr_tail;
1192 } __attribute__((packed));
1194 struct llog_lru_rec {
1195 struct llog_rec_hdr llr_hdr;
1196 struct lustre_id llr_cid;
1197 struct lustre_id llr_pid;
1198 struct llog_rec_tail llr_tail;
1199 } __attribute__((packed));
1201 /* On-disk header structure of each log object, stored in little endian order */
1202 #define LLOG_CHUNK_SIZE 8192
1203 #define LLOG_HEADER_SIZE (96)
1204 #define LLOG_BITMAP_BYTES (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
1206 #define LLOG_MIN_REC_SIZE (24) /* round(llog_rec_hdr + llog_rec_tail) */
1208 /* flags for the logs */
1209 #define LLOG_F_ZAP_WHEN_EMPTY 0x1
1210 #define LLOG_F_IS_CAT 0x2
1211 #define LLOG_F_IS_PLAIN 0x4
1213 struct llog_log_hdr {
1214 struct llog_rec_hdr llh_hdr;
1215 __u64 llh_timestamp;
1217 __u32 llh_bitmap_offset;
1221 /* for a catalog the first plain slot is next to it */
1222 struct obd_uuid llh_tgtuuid;
1223 __u32 llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
1224 __u32 llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
1225 struct llog_rec_tail llh_tail;
1226 } __attribute__((packed));
1228 #define LLOG_BITMAP_SIZE(llh) ((llh->llh_hdr.lrh_len - \
1229 llh->llh_bitmap_offset - \
1230 sizeof(llh->llh_tail)) * 8)
1232 /* log cookies are used to reference a specific log file and a record therein */
1233 struct llog_cookie {
1234 struct llog_logid lgc_lgl;
1238 } __attribute__((packed));
1241 enum llogd_rpc_ops {
1242 LLOG_ORIGIN_HANDLE_OPEN = 501,
1243 LLOG_ORIGIN_HANDLE_NEXT_BLOCK = 502,
1244 LLOG_ORIGIN_HANDLE_READ_HEADER = 503,
1245 LLOG_ORIGIN_HANDLE_WRITE_REC = 504,
1246 LLOG_ORIGIN_HANDLE_CLOSE = 505,
1247 LLOG_ORIGIN_CONNECT = 506,
1248 LLOG_CATINFO = 507, /* for lfs catinfo */
1249 LLOG_ORIGIN_HANDLE_PREV_BLOCK = 508,
1253 struct llog_logid lgd_logid;
1255 __u32 lgd_llh_flags;
1257 __u32 lgd_saved_index;
1259 __u64 lgd_cur_offset;
1260 } __attribute__((packed));
1262 struct llogd_conn_body {
1263 struct llog_gen lgdc_gen;
1264 struct llog_logid lgdc_logid;
1265 __u32 lgdc_ctxt_idx;
1266 } __attribute__((packed));
1268 extern void lustre_swab_llogd_body (struct llogd_body *d);
1269 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
1270 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
1273 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
1275 static inline struct lustre_id *obdo_id(struct obdo *oa)
1277 void *raw_id = oa->o_inline + sizeof(struct lustre_handle) +
1278 sizeof(struct llog_cookie);
1280 return (struct lustre_id *)raw_id;
1283 /* security negotiate */
1286 SEC_INIT_CONTINUE = 601,
1290 #define SEC_FIRST_OPC SEC_INIT
1294 GKS_DISCONNECT = 701,
1296 GKS_DECRYPT_KEY = 703,
1304 __u8 ck_mac[MAC_SIZE];
1305 __u8 ck_key[KEY_SIZE];
1310 struct posix_acl_entry {
1312 unsigned short e_perm;
1322 struct posix_acl_entry kp_acls[0];
1325 struct key_context {
1326 struct crypto_key kc_ck;
1329 struct key_perm kc_perm;
1331 typedef int (*crypt_cb_t)(struct page *page, __u64 offset,
1332 __u64 count, int flags);
1334 extern void lustre_swab_key_context (struct key_context *kctxt);
1335 extern void lustre_swab_key_perms (struct key_perm *kperm);
1337 extern void lustre_swab_lustre_id(struct lustre_id *id);
1338 extern void lustre_swab_lov_desc(struct lov_desc *desc);
1339 extern void lustre_swab_fid_extent(struct fid_extent *ext);
1340 extern void lustre_swab_lustre_stc(struct lustre_stc *stc);
1341 extern void lustre_swab_lustre_fid(struct lustre_fid *fid);
1342 extern void lustre_swab_mds_status_req(struct mds_status_req *r);
1343 extern void lustre_swab_mds_rec_setattr(struct mds_rec_setattr *sa);