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 * (Un)packing of OST requests
23 * We assume all nodes are either little-endian or big-endian, and we
24 * always send messages in the sender's native format. The receiver
25 * detects the message format by checking the 'magic' field of the message
26 * (see lustre_msg_swabbed() below).
28 * Each wire type has corresponding 'lustre_swab_xxxtypexxx()' routines,
29 * implemented either here, inline (trivial implementations) or in
30 * ptlrpc/pack_generic.c. These 'swabbers' convert the type from "other"
31 * endian, in-place in the message buffer.
33 * A swabber takes a single pointer argument. The caller must already have
34 * verified that the length of the message buffer >= sizeof (type).
36 * For variable length types, a second 'lustre_swab_v_xxxtypexxx()' routine
37 * may be defined that swabs just the variable part, after the caller has
38 * verified that the message buffer is large enough.
41 #ifndef _LUSTRE_IDL_H_
42 #define _LUSTRE_IDL_H_
45 # include <linux/ioctl.h>
46 # include <asm/types.h>
47 # include <linux/types.h>
48 # include <linux/list.h>
49 # include <linux/string.h> /* for strncpy, below */
50 # include <asm/byteorder.h>
53 # include <sys/types.h>
55 # include <asm/types.h>
58 # include <portals/list.h>
61 * this file contains all data structures used in Lustre interfaces:
62 * - obdo and obd_request records
63 * - mds_request records
75 static inline int obd_uuid_equals(struct obd_uuid *u1, struct obd_uuid *u2)
77 return strcmp(u1->uuid, u2->uuid) == 0;
80 static inline void obd_str2uuid(struct obd_uuid *uuid, char *tmp)
82 strncpy(uuid->uuid, tmp, sizeof(*uuid));
83 uuid->uuid[sizeof(*uuid) - 1] = '\0';
86 extern struct obd_uuid lctl_fake_uuid;
88 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
89 * FOO_REPLY_PORTAL is for incoming replies on the FOO
90 * FOO_BULK_PORTAL is for incoming bulk on the FOO
93 #define CONNMGR_REQUEST_PORTAL 1
94 #define CONNMGR_REPLY_PORTAL 2
95 //#define OSC_REQUEST_PORTAL 3
96 #define OSC_REPLY_PORTAL 4
97 //#define OSC_BULK_PORTAL 5
98 #define OST_REQUEST_PORTAL 6
99 //#define OST_REPLY_PORTAL 7
100 #define OST_BULK_PORTAL 8
101 //#define MDC_REQUEST_PORTAL 9
102 #define MDC_REPLY_PORTAL 10
103 //#define MDC_BULK_PORTAL 11
104 #define MDS_REQUEST_PORTAL 12
105 //#define MDS_REPLY_PORTAL 13
106 #define MDS_BULK_PORTAL 14
107 #define LDLM_CB_REQUEST_PORTAL 15
108 #define LDLM_CB_REPLY_PORTAL 16
109 #define LDLM_CANCEL_REQUEST_PORTAL 17
110 #define LDLM_CANCEL_REPLY_PORTAL 18
111 #define PTLBD_REQUEST_PORTAL 19
112 #define PTLBD_REPLY_PORTAL 20
113 #define PTLBD_BULK_PORTAL 21
114 #define MDS_SETATTR_PORTAL 22
115 #define MDS_READPAGE_PORTAL 23
120 #define SVC_RUNNING 8
121 #define SVC_STOPPING 16
122 #define SVC_STOPPED 32
124 #define LUSTRE_CONN_NEW 1
125 #define LUSTRE_CONN_CON 2
126 #define LUSTRE_CONN_NOTCONN 3
127 #define LUSTRE_CONN_RECOVER 4
128 #define LUSTRE_CONN_FULL 5
131 #define PTL_RPC_MSG_REQUEST 4711
132 #define PTL_RPC_MSG_ERR 4712
133 #define PTL_RPC_MSG_REPLY 4713
135 #define PTLRPC_MSG_MAGIC 0x0BD00BD0
136 #define PTLRPC_MSG_VERSION 0x00040002
138 struct lustre_handle {
141 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabe
143 /* we depend on this structure to be 8-byte aligned */
144 /* this type is only endian-adjusted in lustre_unpack_msg() */
146 struct lustre_handle handle;
152 __u64 last_committed;
160 static inline int lustre_msg_swabbed (struct lustre_msg *msg)
162 return (msg->magic == __swab32 (PTLRPC_MSG_MAGIC));
165 /* Flags that are operation-specific go in the top 16 bits. */
166 #define MSG_OP_FLAG_MASK 0xffff0000
167 #define MSG_OP_FLAG_SHIFT 16
169 /* Flags that apply to all requests are in the bottom 16 bits */
170 #define MSG_GEN_FLAG_MASK 0x0000ffff
171 #define MSG_LAST_REPLAY 1
174 static inline int lustre_msg_get_flags(struct lustre_msg *msg)
176 return (msg->flags & MSG_GEN_FLAG_MASK);
179 static inline void lustre_msg_add_flags(struct lustre_msg *msg, int flags)
181 msg->flags |= MSG_GEN_FLAG_MASK & flags;
184 static inline void lustre_msg_set_flags(struct lustre_msg *msg, int flags)
186 msg->flags &= ~MSG_GEN_FLAG_MASK;
187 lustre_msg_add_flags(msg, flags);
190 static inline int lustre_msg_get_op_flags(struct lustre_msg *msg)
192 return (msg->flags >> MSG_OP_FLAG_SHIFT);
195 static inline void lustre_msg_add_op_flags(struct lustre_msg *msg, int flags)
197 msg->flags |= ((flags & MSG_GEN_FLAG_MASK) << MSG_OP_FLAG_SHIFT);
200 static inline void lustre_msg_set_op_flags(struct lustre_msg *msg, int flags)
202 msg->flags &= ~MSG_OP_FLAG_MASK;
203 lustre_msg_add_op_flags(msg, flags);
207 * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
210 #define MSG_CONNECT_RECOVERING 0x1
211 #define MSG_CONNECT_RECONNECT 0x2
212 #define MSG_CONNECT_REPLAYABLE 0x4
215 * OST requests: OBDO & OBD request records
220 OST_REPLY = 0, /* reply ? */
239 #define OST_FIRST_OPC OST_REPLY
240 /* When adding OST RPC opcodes, please update
241 * LAST/FIRST macros used in ptlrpc/ptlrpc_internals.h */
244 typedef uint64_t obd_id;
245 typedef uint64_t obd_gr;
246 typedef uint64_t obd_time;
247 typedef uint64_t obd_size;
248 typedef uint64_t obd_off;
249 typedef uint64_t obd_blocks;
250 typedef uint32_t obd_blksize;
251 typedef uint32_t obd_mode;
252 typedef uint32_t obd_uid;
253 typedef uint32_t obd_gid;
254 typedef uint64_t obd_rdev;
255 typedef uint32_t obd_flag;
256 typedef uint32_t obd_count;
258 #define OBD_FL_INLINEDATA (0x00000001)
259 #define OBD_FL_OBDMDEXISTS (0x00000002)
261 #define OBD_INLINESZ 60
262 #define FD_OSTDATA_SIZE sizeof(struct obd_client_handle)
264 /* Note: 64-bit types are 64-bit aligned in structure */
272 obd_blocks o_blocks; /* brw: clients sent cached bytes */
273 obd_rdev o_rdev; /* brw: clients/servers sent grant */
274 obd_blksize o_blksize; /* optimal IO blocksize */
279 obd_count o_nlink; /* brw: checksum */
280 obd_count o_generation;
281 obd_flag o_valid; /* hot fields in this obdo */
284 char o_inline[OBD_INLINESZ];
287 extern void lustre_swab_obdo (struct obdo *o);
289 struct lov_object_id { /* per-child structure */
293 #define LOV_MAGIC 0x0BD00BD0
297 __u64 lmm_object_id; /* lov object id */
298 __u32 lmm_stripe_size; /* size of the stripe */
299 __u32 lmm_stripe_offset; /* starting stripe offset in lmm_objects */
300 __u16 lmm_stripe_count; /* number of stipes in use for this object */
301 __u16 lmm_ost_count; /* how many OST idx are in this LOV md */
302 struct lov_object_id lmm_objects[0];
305 #define OBD_MD_FLALL (0xffffffff)
306 #define OBD_MD_FLID (0x00000001) /* object ID */
307 #define OBD_MD_FLATIME (0x00000002) /* access time */
308 #define OBD_MD_FLMTIME (0x00000004) /* data modification time */
309 #define OBD_MD_FLCTIME (0x00000008) /* change time */
310 #define OBD_MD_FLSIZE (0x00000010) /* size */
311 #define OBD_MD_FLBLOCKS (0x00000020) /* allocated blocks count */
312 #define OBD_MD_FLBLKSZ (0x00000040) /* block size */
313 #define OBD_MD_FLMODE (0x00000080) /* access bits (mode & ~S_IFMT) */
314 #define OBD_MD_FLTYPE (0x00000100) /* object type (mode & S_IFMT) */
315 #define OBD_MD_FLUID (0x00000200) /* user ID */
316 #define OBD_MD_FLGID (0x00000400) /* group ID */
317 #define OBD_MD_FLFLAGS (0x00000800) /* flags word */
318 #define OBD_MD_FLOBDFLG (0x00001000)
319 #define OBD_MD_FLNLINK (0x00002000) /* link count */
320 #define OBD_MD_FLGENER (0x00004000) /* generation number */
321 #define OBD_MD_FLINLINE (0x00008000) /* inline data */
322 #define OBD_MD_FLRDEV (0x00010000) /* device number */
323 #define OBD_MD_FLEASIZE (0x00020000) /* extended attribute data */
324 #define OBD_MD_LINKNAME (0x00040000) /* symbolic link target */
325 #define OBD_MD_FLHANDLE (0x00080000) /* file handle */
326 #define OBD_MD_FLCKSUM (0x00100000) /* bulk data checksum */
327 #define OBD_MD_FLNOTOBD (~(OBD_MD_FLOBDFLG | OBD_MD_FLBLOCKS | OBD_MD_LINKNAME|\
328 OBD_MD_FLEASIZE | OBD_MD_FLHANDLE | OBD_MD_FLCKSUM))
344 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
346 /* ost_body.data values for OST_BRW */
348 #define OBD_BRW_READ 0x01
349 #define OBD_BRW_WRITE 0x02
350 #define OBD_BRW_RWMASK (OBD_BRW_READ | OBD_BRW_WRITE)
351 #define OBD_BRW_CREATE 0x04
352 #define OBD_BRW_SYNC 0x08
353 #define OBD_BRW_CHECK 0x10
354 #define OBD_BRW_FROM_GRANT 0x20
356 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
363 } __attribute__((packed));
365 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
367 /* multiple of 8 bytes => can array */
368 struct niobuf_remote {
372 } __attribute__((packed));
374 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
376 /* request structure for OST's */
378 #define OST_REQ_HAS_OA1 0x1
384 extern void lustre_swab_ost_body (struct ost_body *b);
393 MDS_GETATTR_NAME = 34,
404 #define MDS_FIRST_OPC MDS_GETATTR
405 /* When adding MDS RPC opcodes, please update
406 * LAST/FIRST macros used in ptlrpc/ptlrpc_internals.h */
412 #define REINT_SETATTR 1
413 #define REINT_CREATE 2
415 #define REINT_UNLINK 4
416 #define REINT_RENAME 5
420 #define IT_INTENT_EXEC 1
421 #define IT_OPEN_LOOKUP (1 << 1)
422 #define IT_OPEN_NEG (1 << 2)
423 #define IT_OPEN_POS (1 << 3)
424 #define IT_OPEN_CREATE (1 << 4)
425 #define IT_OPEN_OPEN (1 << 5)
433 extern void lustre_swab_ll_fid (struct ll_fid *fid);
435 #define MDS_STATUS_CONN 1
436 #define MDS_STATUS_LOV 2
438 struct mds_status_req {
443 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
445 struct mds_fileh_body {
447 struct lustre_handle f_handle;
450 extern void lustre_swab_mds_fileh_body (struct mds_fileh_body *f);
455 struct lustre_handle handle;
456 __u64 size; /* Offset, in the case of MDS_READPAGE */
457 __u64 blocks; /* XID, in the case of MDS_READPAGE */
458 __u32 ino; /* make this a __u64 */
471 __u32 nlink; /* #bytes to read in the case of MDS_READPAGE */
477 extern void lustre_swab_mds_body (struct mds_body *b);
479 /* This is probably redundant with OBD_MD_FLEASIZE, but we need an audit */
480 #define MDS_OPEN_HAS_EA 1 /* this open has an EA, for a delayed create*/
482 /* MDS update records */
484 //struct mds_update_record_hdr {
488 struct mds_rec_setattr {
495 struct ll_fid sa_fid;
507 extern void lustre_swab_mds_rec_setattr (struct mds_rec_setattr *sa);
509 struct mds_rec_create {
514 __u32 cr_flags; /* for use with open */
516 struct ll_fid cr_fid;
517 struct ll_fid cr_replayfid;
525 extern void lustre_swab_mds_rec_create (struct mds_rec_create *cr);
527 struct mds_rec_link {
534 struct ll_fid lk_fid1;
535 struct ll_fid lk_fid2;
538 extern void lustre_swab_mds_rec_link (struct mds_rec_link *lk);
540 struct mds_rec_unlink {
548 struct ll_fid ul_fid1;
549 struct ll_fid ul_fid2;
552 extern void lustre_swab_mds_rec_unlink (struct mds_rec_unlink *ul);
554 struct mds_rec_rename {
561 struct ll_fid rn_fid1;
562 struct ll_fid rn_fid2;
565 extern void lustre_swab_mds_rec_rename (struct mds_rec_rename *rn);
568 * LOV data structures
574 #define LOV_MAX_UUID_BUFFER_SIZE 8192
575 /* The size of the buffer the lov/mdc reserves for the
576 * array of UUIDs returned by the MDS. With the current
577 * protocol, this will limit the max number of OSTs per LOV */
580 __u32 ld_tgt_count; /* how many OBD's */
581 __u32 ld_active_tgt_count; /* how many active */
582 __u32 ld_default_stripe_count; /* how many objects are used */
583 __u64 ld_default_stripe_size; /* in bytes */
584 __u64 ld_default_stripe_offset; /* in bytes */
585 __u32 ld_pattern; /* RAID 0,1 etc */
586 struct obd_uuid ld_uuid;
589 extern void lustre_swab_lov_desc (struct lov_desc *ld);
594 /* opcodes -- MUST be distinct from OST/MDS opcodes */
599 LDLM_BL_CALLBACK = 104,
600 LDLM_CP_CALLBACK = 105,
603 #define LDLM_FIRST_OPC LDLM_ENQUEUE
604 /* When adding LDLM RPC opcodes, please update
605 * LAST/FIRST macros used in ptlrpc/ptlrpc_internals.h */
607 #define RES_NAME_SIZE 3
608 #define RES_VERSION_SIZE 4
611 __u64 name[RES_NAME_SIZE];
614 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
631 extern void lustre_swab_ldlm_extent (struct ldlm_extent *e);
637 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
639 /* Note this unaligned structure; as long as it's only used in ldlm_request
640 * below, we're probably fine. */
641 struct ldlm_resource_desc {
643 struct ldlm_res_id lr_name;
644 __u32 lr_version[RES_VERSION_SIZE];
647 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
649 struct ldlm_lock_desc {
650 struct ldlm_resource_desc l_resource;
651 ldlm_mode_t l_req_mode;
652 ldlm_mode_t l_granted_mode;
653 struct ldlm_extent l_extent;
654 __u32 l_version[RES_VERSION_SIZE];
657 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
659 struct ldlm_request {
661 struct ldlm_lock_desc lock_desc;
662 struct lustre_handle lock_handle1;
663 struct lustre_handle lock_handle2;
666 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
671 struct ldlm_res_id lock_resource_name;
672 struct lustre_handle lock_handle;
673 struct ldlm_extent lock_extent; /* XXX make this policy 1 &2 */
674 __u64 lock_policy_res1;
675 __u64 lock_policy_res2;
678 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
681 * ptlbd, portal block device requests
689 PTLBD_DISCONNECT = 205,
692 #define PTLBD_FIRST_OPC PTLBD_QUERY
693 /* When adding PTLBD RPC opcodes, please update
694 * LAST/FIRST macros used in ptlrpc/ptlrpc_internals.h */
704 extern void lustre_swab_ptlbd_op (struct ptlbd_op *op);
713 extern void lustre_swab_ptlbd_niob (struct ptlbd_niob *n);
720 extern void lustre_swab_ptlbd_rsp (struct ptlbd_rsp *r);
723 * Opcodes for multiple servers.