Whamcloud - gitweb
8a0926c75c1a459df53f2a1ad1d1788ec0dc1d3b
[fs/lustre-release.git] / lustre / include / linux / lustre_idl.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  *  Copyright (C) 2001 Cluster File Systems, Inc. <braam@clusterfs.com>
5  *
6  *   This file is part of Lustre, http://www.lustre.org.
7  *
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.
11  *
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.
16  *
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.
20  *
21  * Lustre wire protocol definitions.
22  *
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.
29  *
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).
34  *
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.
39  *
40  * A swabber takes a single pointer argument.  The caller must already have
41  * verified that the length of the message buffer >= sizeof (type).
42  *
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.
46  */
47
48 #ifndef _LUSTRE_IDL_H_
49 #define _LUSTRE_IDL_H_
50
51 #ifdef HAVE_ASM_TYPES_H
52 #include <asm/types.h>
53 #else
54 #include "types.h"
55 #endif
56
57
58 #ifdef __KERNEL__
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 #else
65 #ifdef __CYGWIN__
66 # include <sys/types.h>
67 #else
68 # include <stdint.h>
69 #endif
70 # include <libcfs/list.h>
71 # include <string.h>
72 #endif
73
74 /* Defn's shared with user-space. */
75 #include <lustre/lustre_user.h>
76
77 /*
78  * this file contains all data structures used in Lustre interfaces:
79  * - obdo and obd_request records
80  * - mds_request records
81  * - ldlm data
82  * - ioctl's
83  */
84
85 /*
86  *  GENERAL STUFF
87  */
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
91  */
92
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_CREATE_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
116 #define MGMT_REQUEST_PORTAL            24
117 #define MGMT_REPLY_PORTAL              25
118 #define MGMT_CLI_REQUEST_PORTAL        26
119 #define MGMT_CLI_REPLY_PORTAL          27
120
121 #define SVC_KILLED               1
122 #define SVC_EVENT                2
123 #define SVC_SIGNAL               4
124 #define SVC_RUNNING              8
125 #define SVC_STOPPING            16
126 #define SVC_STOPPED             32
127
128 /* packet types */
129 #define PTL_RPC_MSG_REQUEST 4711
130 #define PTL_RPC_MSG_ERR     4712
131 #define PTL_RPC_MSG_REPLY   4713
132
133 #define PTLRPC_MSG_MAGIC    0x0BD00BD0
134
135
136 #define PTLRPC_MSG_VERSION  0x00000003
137 #define LUSTRE_VERSION_MASK 0xffff0000
138 #define LUSTRE_OBD_VERSION  0x00010000
139 #define LUSTRE_MDS_VERSION  0x00020000
140 #define LUSTRE_OST_VERSION  0x00030000
141 #define LUSTRE_DLM_VERSION  0x00040000
142 #define LUSTRE_LOG_VERSION  0x00050000
143 #define LUSTRE_PBD_VERSION  0x00060000
144
145 struct lustre_handle {
146         __u64 cookie;
147 };
148 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
149
150 /* we depend on this structure to be 8-byte aligned */
151 /* this type is only endian-adjusted in lustre_unpack_msg() */
152 struct lustre_msg {
153         struct lustre_handle handle;
154         __u32 magic;
155         __u32 type;
156         __u32 version;
157         __u32 opc;
158         __u64 last_xid;
159         __u64 last_committed;
160         __u64 transno;
161         __u32 status;
162         __u32 flags;
163         __u32 conn_cnt;
164         __u32 bufcount;
165         __u32 buflens[0];
166 };
167
168 /* Flags that are operation-specific go in the top 16 bits. */
169 #define MSG_OP_FLAG_MASK   0xffff0000
170 #define MSG_OP_FLAG_SHIFT  16
171
172 /* Flags that apply to all requests are in the bottom 16 bits */
173 #define MSG_GEN_FLAG_MASK      0x0000ffff
174 #define MSG_LAST_REPLAY        1
175 #define MSG_RESENT             2
176 #define MSG_REPLAY             4
177
178 static inline int lustre_msg_get_flags(struct lustre_msg *msg)
179 {
180         return (msg->flags & MSG_GEN_FLAG_MASK);
181 }
182
183 static inline void lustre_msg_add_flags(struct lustre_msg *msg, int flags)
184 {
185         msg->flags |= MSG_GEN_FLAG_MASK & flags;
186 }
187
188 static inline void lustre_msg_set_flags(struct lustre_msg *msg, int flags)
189 {
190         msg->flags &= ~MSG_GEN_FLAG_MASK;
191         lustre_msg_add_flags(msg, flags);
192 }
193
194 static inline void lustre_msg_clear_flags(struct lustre_msg *msg, int flags)
195 {
196         msg->flags &= ~(MSG_GEN_FLAG_MASK & flags);
197 }
198
199 static inline int lustre_msg_get_op_flags(struct lustre_msg *msg)
200 {
201         return (msg->flags >> MSG_OP_FLAG_SHIFT);
202 }
203
204 static inline void lustre_msg_add_op_flags(struct lustre_msg *msg, int flags)
205 {
206         msg->flags |= ((flags & MSG_GEN_FLAG_MASK) << MSG_OP_FLAG_SHIFT);
207 }
208
209 static inline void lustre_msg_set_op_flags(struct lustre_msg *msg, int flags)
210 {
211         msg->flags &= ~MSG_OP_FLAG_MASK;
212         lustre_msg_add_op_flags(msg, flags);
213 }
214
215 /*
216  * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
217  */
218
219 #define MSG_CONNECT_RECOVERING  0x1
220 #define MSG_CONNECT_RECONNECT   0x2
221 #define MSG_CONNECT_REPLAYABLE  0x4
222 #define MSG_CONNECT_PEER        0x8
223 #define MSG_CONNECT_LIBCLIENT   0x10
224 #define MSG_CONNECT_INITIAL     0x20
225 #define MSG_CONNECT_ASYNC       0x40
226
227 /* Connect flags */
228
229 #define OBD_CONNECT_RDONLY      (0x00000001LL)
230 #define OBD_CONNECT_REMOTE      (0x40000000LL)
231 #define OBD_CONNECT_LOCAL       (0x80000000LL)
232
233 #define OBD_CONNECT_SUPPORTED (OBD_CONNECT_RDONLY |     \
234                                OBD_CONNECT_REMOTE |     \
235                                OBD_CONNECT_LOCAL)
236
237 /* This structure is used for both request and reply.
238  *
239  * If we eventually have separate connect data for different types, which we
240  * almost certainly will, then perhaps we stick a union in here. */
241 struct obd_connect_data {
242         __u64 ocd_connect_flags;
243         __u32 ocd_nllu[2];
244         __u64 padding[6];
245 };
246
247 extern void lustre_swab_connect(struct obd_connect_data *ocd);
248
249 /*
250  *   OST requests: OBDO & OBD request records
251  */
252
253 /* opcodes */
254 typedef enum {
255         OST_REPLY      =  0,       /* reply ? */
256         OST_GETATTR    =  1,
257         OST_SETATTR    =  2,
258         OST_READ       =  3,
259         OST_WRITE      =  4,
260         OST_CREATE     =  5,
261         OST_DESTROY    =  6,
262         OST_GET_INFO   =  7,
263         OST_CONNECT    =  8,
264         OST_DISCONNECT =  9,
265         OST_PUNCH      = 10,
266         OST_OPEN       = 11,
267         OST_CLOSE      = 12,
268         OST_STATFS     = 13,
269         OST_SAN_READ   = 14,
270         OST_SAN_WRITE  = 15,
271         OST_SYNC       = 16,
272         OST_SET_INFO   = 17,
273         OST_LAST_OPC
274 } ost_cmd_t;
275 #define OST_FIRST_OPC  OST_REPLY
276
277 typedef uint64_t        obd_id;
278 typedef uint64_t        obd_gr;
279 typedef uint64_t        obd_time;
280 typedef uint64_t        obd_size;
281 typedef uint64_t        obd_off;
282 typedef uint64_t        obd_blocks;
283 typedef uint32_t        obd_blksize;
284 typedef uint32_t        obd_mode;
285 typedef uint32_t        obd_uid;
286 typedef uint32_t        obd_gid;
287 typedef uint32_t        obd_flags;
288 typedef uint64_t        obd_valid;
289 typedef uint32_t        obd_count;
290
291 #define OBD_FL_INLINEDATA    (0x00000001)
292 #define OBD_FL_OBDMDEXISTS   (0x00000002)
293 #define OBD_FL_DELORPHAN     (0x00000004) /* if set in o_flags delete orphans */
294 #define OBD_FL_NORPC         (0x00000008) // if set in o_flags set in OSC not OST
295 #define OBD_FL_IDONLY        (0x00000010) // if set in o_flags only adjust obj id
296 #define OBD_FL_RECREATE_OBJS (0x00000020) // recreate missing obj
297 #define OBD_FL_DEBUG_CHECK   (0x00000040) /* echo client/server debug check */
298
299 /* this should be sizeof(struct lustre_handle) + sizeof(struct llog_cookie) +
300  * sizeof(struct lustre_id). */
301 #define OBD_INLINESZ (80)
302
303 /* Note: 64-bit types are 64-bit aligned in structure */
304 struct obdo {
305         obd_id                  o_id;
306         obd_gr                  o_gr;
307         obd_size                o_size;
308         obd_time                o_mtime;
309         obd_time                o_atime;
310         obd_time                o_ctime;
311         obd_blocks              o_blocks;       /* brw: cli sent cached bytes */
312         obd_size                o_grant;
313         obd_blksize             o_blksize;      /* optimal IO blocksize */
314         obd_mode                o_mode;         /* brw: cli sent cache remain */
315         obd_uid                 o_uid;
316         obd_gid                 o_gid;
317         obd_flags               o_flags;
318         obd_count               o_nlink;        /* brw: checksum */
319         obd_count               o_generation;
320         obd_valid               o_valid;        /* hot fields in this obdo */
321         obd_count               o_misc;         /* brw: o_dropped */
322         __u32                   o_easize;       /* epoch in ost writes */
323         __u32                   o_mds;
324         __u64                   o_fid;
325         __u32                   o_padding;
326         char                    o_inline[OBD_INLINESZ]; /* fid in ost writes */
327 };
328
329 #define o_dirty   o_blocks
330 #define o_undirty o_mode
331 #define o_dropped o_misc
332 #define o_cksum   o_nlink
333
334 extern void lustre_swab_obdo (struct obdo *o);
335
336 #define LOV_MAGIC_V1      0x0BD10BD0
337 #define LOV_MAGIC         LOV_MAGIC_V1
338
339 #define LOV_PATTERN_RAID0 0x001   /* stripes are used round-robin */
340 #define LOV_PATTERN_RAID1 0x002   /* stripes are mirrors of each other */
341 #define LOV_PATTERN_FIRST 0x100   /* first stripe is not in round-robin */
342 #define LOV_PATTERN_CMOBD 0x200  
343  
344 #define lov_ost_data lov_ost_data_v1
345 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
346         __u64 l_object_id;        /* OST object ID */
347         __u64 l_object_gr;        /* OST object group (creating MDS number) */
348         __u32 l_ost_gen;          /* generation of this l_ost_idx */
349         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
350 };
351
352 #define lov_mds_md lov_mds_md_v1
353 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
354         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
355         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
356         __u64 lmm_object_id;      /* LOV object ID */
357         __u64 lmm_object_gr;      /* LOV object group */
358         __u32 lmm_stripe_size;    /* size of stripe in bytes */
359         __u32 lmm_stripe_count;   /* num stripes in use for this object */
360         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
361 };
362
363 #define LOV_MAGIC_V0      0x0BD00BD0
364
365 struct lov_ost_data_v0 {          /* per-stripe data structure (little-endian)*/
366         __u64 l_object_id;        /* OST object ID */
367 };
368
369 struct lov_mds_md_v0 {            /* LOV EA mds/wire data (little-endian) */
370         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V0 */
371         __u64 lmm_object_id;      /* LOV object ID */
372         __u32 lmm_stripe_size;    /* size of the stripe in bytes (not RAID1) */
373         __u32 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
374         __u16 lmm_stripe_count;   /* number of stipes in use for this object */
375         __u16 lmm_ost_count;      /* how many OST idx are in this LOV md */
376         struct lov_ost_data_v0 lmm_objects[0];
377 } __attribute__((packed));
378
379 #define OBD_MD_FLALL    (0xffffffffffffffffLL)
380 #define OBD_MD_FLID     (0x0000000000000001LL)    /* object ID */
381 #define OBD_MD_FLATIME  (0x0000000000000002LL)    /* access time */
382 #define OBD_MD_FLMTIME  (0x0000000000000004LL)    /* data modification time */
383 #define OBD_MD_FLCTIME  (0x0000000000000008LL)    /* change time */
384 #define OBD_MD_FLSIZE   (0x0000000000000010LL)    /* size */
385 #define OBD_MD_FLBLOCKS (0x0000000000000020LL)    /* allocated blocks count */
386 #define OBD_MD_FLBLKSZ  (0x0000000000000040LL)    /* block size */
387 #define OBD_MD_FLMODE   (0x0000000000000080LL)    /* access bits (mode & ~S_IFMT) */
388 #define OBD_MD_FLTYPE   (0x0000000000000100LL)    /* object type (mode & S_IFMT) */
389 #define OBD_MD_FLUID    (0x0000000000000200LL)    /* user ID */
390 #define OBD_MD_FLGID    (0x0000000000000400LL)    /* group ID */
391 #define OBD_MD_FLFLAGS  (0x0000000000000800LL)    /* flags word */
392 #define OBD_MD_FLEA     (0x0000000000001000LL)    /* extended attributes */
393 #define OBD_MD_FLNLINK  (0x0000000000002000LL)    /* link count */
394 #define OBD_MD_FLGENER  (0x0000000000004000LL)    /* generation number */
395 #define OBD_MD_FLINLINE (0x0000000000008000LL)    /* inline data */
396 #define OBD_MD_FLRDEV   (0x0000000000010000LL)    /* device number */
397 #define OBD_MD_FLEASIZE (0x0000000000020000LL)    /* extended attribute data */
398 #define OBD_MD_LINKNAME (0x0000000000040000LL)    /* symbolic link target */
399 #define OBD_MD_FLHANDLE (0x0000000000080000LL)    /* file handle */
400 #define OBD_MD_FLCKSUM  (0x0000000000100000LL)    /* bulk data checksum */
401 #define OBD_MD_FLQOS    (0x0000000000200000LL)    /* quality of service stats */
402 #define OBD_MD_FLOSCOPQ (0x0000000000400000LL)    /* osc opaque data */
403 #define OBD_MD_FLCOOKIE (0x0000000000800000LL)    /* log cancellation cookie */
404 #define OBD_MD_FLGROUP  (0x0000000001000000LL)    /* group */
405 #define OBD_MD_FLIFID   (0x0000000002000000LL)    /* ->ost write inline fid */
406 #define OBD_MD_FLEPOCH  (0x0000000004000000LL)    /* ->ost write easize is epoch */
407 #define OBD_MD_FLGRANT  (0x0000000008000000LL)    /* ost preallocation space grant */
408 #define OBD_MD_MDS      (0x0000000010000000LL)    /* where an inode lives on */
409 #define OBD_MD_FLDIREA  (0x0000000020000000LL)    /* dir's extended attribute data */
410 #define OBD_MD_REINT    (0x0000000040000000LL)    /* reintegrate oa */
411 #define OBD_MD_FID      (0x0000000080000000LL)    /* lustre_id data */
412 #define OBD_MD_MEA      (0x0000000100000000LL)    /* shows we are interested in MEA */
413 #define OBD_MD_FLEALIST (0x0000000200000000LL)    /* list extended attributes */
414 #define OBD_MD_FLACL_ACCESS (0x0000000400000000LL) /*access acl*/
415
416 #define OBD_MD_FLNOTOBD (~(OBD_MD_FLBLOCKS | OBD_MD_LINKNAME |          \
417                            OBD_MD_FLEASIZE | OBD_MD_FLHANDLE |          \
418                            OBD_MD_FLCKSUM | OBD_MD_FLQOS |              \
419                            OBD_MD_FLOSCOPQ | OBD_MD_FLCOOKIE |          \
420                            OBD_MD_FLEA | OBD_MD_FLEALIST |              \
421                            OBD_MD_FLACL_ACCESS | OBD_MD_MDS))
422
423 static inline struct lustre_handle *obdo_handle(struct obdo *oa)
424 {
425         return (struct lustre_handle *)oa->o_inline;
426 }
427
428 static inline struct llog_cookie *obdo_logcookie(struct obdo *oa)
429 {
430         return (struct llog_cookie *)(oa->o_inline +
431                                       sizeof(struct lustre_handle));
432 }
433
434 /* don't forget obdo_fid which is way down at the bottom so it can come after
435  * the definition of llog_cookie */
436 struct obd_statfs {
437         __u64           os_type;
438         __u64           os_blocks;
439         __u64           os_bfree;
440         __u64           os_bavail;
441         __u64           os_files;
442         __u64           os_ffree;
443         __u8            os_fsid[40];
444         __u32           os_bsize;
445         __u32           os_namelen;
446         __u64           os_maxbytes;
447         __u32           os_spare[10];
448 };
449
450 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
451
452 /* ost_body.data values for OST_BRW */
453
454 #define OBD_BRW_READ       0x01
455 #define OBD_BRW_WRITE      0x02
456 #define OBD_BRW_RWMASK     (OBD_BRW_READ | OBD_BRW_WRITE)
457 #define OBD_BRW_SYNC       0x08
458 #define OBD_BRW_CHECK      0x10
459 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
460 #define OBD_BRW_GRANTED    0x40 /* the ost manages this */
461
462 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
463
464 #define OST_MIN_PRECREATE 32
465 #define OST_MAX_PRECREATE 20000
466
467 struct obd_ioobj {
468         obd_id               ioo_id;
469         obd_gr               ioo_gr;
470         __u32                ioo_type;
471         __u32                ioo_bufcnt;
472 };
473
474 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
475
476 /* multiple of 8 bytes => can array */
477 struct niobuf_remote {
478         __u64 offset;
479         __u32 len;
480         __u32 flags;
481 };
482
483 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
484
485 /* request structure for OST's */
486
487 #define OST_REQ_HAS_OA1  0x1
488
489 struct ost_body {
490         struct  obdo oa;
491 };
492
493 extern void lustre_swab_ost_body (struct ost_body *b);
494 extern void lustre_swab_ost_last_id(obd_id *id);
495 extern void lustre_swab_generic_32s(__u32 *val);
496
497 /* lock value block communicated between the filter and llite */
498
499 struct ost_lvb {
500         __u64 lvb_size;
501         __u64 lvb_mtime;
502         __u64 lvb_atime;
503         __u64 lvb_ctime;
504         __u64 lvb_blocks;
505 };
506
507 extern void lustre_swab_ost_lvb(struct ost_lvb *);
508
509 /*
510  *   MDS REQ RECORDS
511  */
512
513 /* offsets in the request */
514 #define MDS_REQ_SECDESC_OFF             0
515 #define MDS_REQ_REC_OFF                 1
516
517 #define MDS_REQ_INTENT_LOCKREQ_OFF      1
518 #define MDS_REQ_INTENT_IT_OFF           2
519 #define MDS_REQ_INTENT_REC_OFF          3
520
521 /* maximum supplementary groups */
522 #define LUSTRE_MAX_GROUPS               128
523
524 /* 
525  * security descriptor in mds request
526  */
527 struct mds_req_sec_desc {
528         __u32           rsd_uid;
529         __u32           rsd_gid;
530         __u32           rsd_fsuid;
531         __u32           rsd_fsgid;
532         __u32           rsd_cap;
533         __u32           rsd_ngroups;
534         __u32           rsd_groups[0];
535 };
536
537 struct ptlrpc_request;
538 struct mds_req_sec_desc *lustre_swab_mds_secdesc(struct ptlrpc_request *req,
539                                                  int offset);
540
541 /* opcodes */
542 typedef enum {
543         MDS_GETATTR      = 33,
544         MDS_GETATTR_LOCK = 34,
545         MDS_CLOSE        = 35,
546         MDS_REINT        = 36,
547         MDS_READPAGE     = 37,
548         MDS_CONNECT      = 38,
549         MDS_DISCONNECT   = 39,
550         MDS_GETSTATUS    = 40,
551         MDS_STATFS       = 41,
552         MDS_PIN          = 42,
553         MDS_UNPIN        = 43,
554         MDS_SYNC         = 44,
555         MDS_DONE_WRITING = 45,
556         MDS_LAST_OPC
557 } mds_cmd_t;
558
559 #define MDS_FIRST_OPC    MDS_GETATTR
560
561 /*
562  * Do not exceed 63
563  */
564
565 #define REINT_SETATTR      1
566 #define REINT_CREATE       2
567 #define REINT_LINK         3
568 #define REINT_UNLINK       4
569 #define REINT_RENAME       5
570 #define REINT_OPEN         6
571 #define REINT_CLOSE        7
572 #define REINT_WRITE        8
573 #define REINT_MAX          8
574
575 /* the disposition of the intent outlines what was executed */
576 #define DISP_IT_EXECD     (1 << 0)
577 #define DISP_LOOKUP_EXECD (1 << 1)
578 #define DISP_LOOKUP_NEG   (1 << 2)
579 #define DISP_LOOKUP_POS   (1 << 3)
580 #define DISP_OPEN_CREATE  (1 << 4)
581 #define DISP_OPEN_OPEN    (1 << 5)
582 #define DISP_ENQ_COMPLETE (1 << 6)
583
584 /* INODE LOCK PARTS */
585 #define MDS_INODELOCK_LOOKUP 0x000001  /* dentry, mode, owner, group */
586 #define MDS_INODELOCK_UPDATE 0x000002  /* size, links, timestamps */
587 #define MDS_INODELOCK_OPEN   0x000004  /* for opened files */
588
589 /* do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits */
590 #define MDS_INODELOCK_MAXSHIFT 2
591
592 /* this FULL lock is useful to take on unlink sort of operations */
593 #define MDS_INODELOCK_FULL ((1 << (MDS_INODELOCK_MAXSHIFT + 1)) - 1)
594
595 /* lustre store cookie */
596 struct lustre_stc {
597         union {
598                 struct {
599                     __u64 l3s_ino;     /* inode number on local MDS */
600                     __u32 l3s_gen;     /* inode generation */
601                     __u32 l3s_type;    /* inode type */
602                 } e3s;
603         } u;
604 };
605
606 /* lustre file id */
607 struct lustre_fid {
608         __u64 lf_id;                   /* fid counter maintained on per 
609                                           group basis */
610         __u64 lf_group;                /* sequence group num */
611         __u32 lf_version;              /* what snapfs version of inode */
612         __u32 lf_padding;
613 };
614
615 struct lustre_id {
616         struct lustre_stc li_stc;      /* store cookie */
617         struct lustre_fid li_fid;      /* fid cookie */
618 };
619
620 struct mea_old {
621         __u32 mea_count;
622         __u32 mea_master;
623         struct lustre_id mea_ids[0];
624 };
625
626 #define MEA_MAGIC_LAST_CHAR      0xb2221ca1
627 #define MEA_MAGIC_ALL_CHARS      0xb222a11c
628
629 struct mea {
630         __u32 mea_magic;
631         __u32 mea_count;
632         __u32 mea_master;
633         struct lustre_id mea_ids[0];
634 };
635
636 #define MDS_STATUS_CONN 1
637 #define MDS_STATUS_LOV 2
638
639 struct mds_status_req {
640         __u32  flags;
641         __u32  repbuf;
642 };
643
644 extern void lustre_swab_lustre_id(struct lustre_id *id);
645 extern void lustre_swab_lustre_stc(struct lustre_stc *stc);
646 extern void lustre_swab_lustre_fid(struct lustre_fid *fid);
647 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
648
649 #define MDS_BFLAG_UNCOMMITTED_WRITES   0x1
650
651 struct mds_body {
652         struct lustre_id id1;
653         struct lustre_id id2;
654         struct lustre_handle handle;
655         __u64          size;   /* Offset, in the case of MDS_READPAGE */
656         __u64          blocks; /* XID, in the case of MDS_READPAGE */
657         __u64          io_epoch;
658         __u64          valid;
659         __u32          mode;
660         __u32          uid;
661         __u32          gid;
662         __u32          mtime;
663         __u32          ctime;
664         __u32          atime;
665         __u32          flags;  /* from vfs for pin/unpin, MDS_BFLAG for close */
666         __u32          rdev;
667         __u32          nlink;  /* #bytes to read in the case of MDS_READPAGE */
668         __u32          eadatasize;
669 };
670
671 extern void lustre_swab_mds_body (struct mds_body *b);
672
673 struct lustre_md {
674         struct mds_body *body;
675         struct lov_stripe_md *lsm;
676         struct mea *mea;
677         struct posix_acl *acl_access;
678 };
679
680 struct mdc_op_data {
681         struct lustre_id id1;
682         struct lustre_id id2;
683         __u64            mod_time;
684         const char      *name;
685         int              namelen;
686         __u32            create_mode;
687         struct mea      *mea1;       /* mea of inode1 */
688         struct mea      *mea2;       /* mea of inode2 */
689         __u64            valid;
690 };
691
692 #define MDS_MODE_DONT_LOCK      (1 << 30)
693 #define MDS_MODE_REPLAY         (1 << 31)
694
695 struct mds_rec_setattr {
696         __u32            sa_opcode;
697         __u32            sa_valid;
698         struct lustre_id sa_id;
699         __u32            sa_mode;
700         __u32            sa_uid;
701         __u32            sa_gid;
702         __u32            sa_attr_flags;
703         __u64            sa_size;
704         __u64            sa_atime;
705         __u64            sa_mtime;
706         __u64            sa_ctime;
707 };
708
709 /* XXX Following ATTR_XXX should go to vfs patch...  */
710 #ifdef ATTR_CTIME_SET
711 #error "ATTR_CTIME_SET has been defined somewhere else"
712 #endif
713 #ifdef ATTR_EA
714 #error "ATTR_EA has been defined somewhere else"
715 #endif
716 #ifdef ATTR_EA_RM
717 #error "ATTR_EA_RM has been defined somewhere else"
718 #endif
719
720 #define ATTR_CTIME_SET  0x00002000
721 #define ATTR_EA         0x00040000
722 #define ATTR_EA_RM      0x00080000
723
724 extern void lustre_swab_mds_rec_setattr (struct mds_rec_setattr *sa);
725
726 #ifndef FMODE_READ
727 #define FMODE_READ               00000001
728 #define FMODE_WRITE              00000002
729 #endif
730 #ifndef FMODE_EXEC
731 #define FMODE_EXEC               00000004
732 #endif
733 #define MDS_OPEN_CREAT           00000100
734 #define MDS_OPEN_EXCL            00000200
735 #define MDS_OPEN_TRUNC           00001000
736 #define MDS_OPEN_APPEND          00002000
737 #define MDS_OPEN_SYNC            00010000
738 #define MDS_OPEN_DIRECTORY       00200000
739
740 #define MDS_OPEN_DELAY_CREATE    0100000000   /* delay initial object create */
741 #define MDS_OPEN_HAS_EA          010000000000 /* specify object create pattern */
742 #define MDS_OPEN_HAS_OBJS        020000000000 /* just set the EA the obj exist */
743
744 struct mds_rec_create {
745         __u32            cr_opcode;
746         __u32            cr_flags; /* for use with open */
747         __u32            cr_mode;
748         __u32            cr_padding;
749         struct lustre_id cr_id;
750         struct lustre_id cr_replayid;
751         __u64            cr_time;
752         __u64            cr_rdev;
753 };
754
755 extern void lustre_swab_mds_rec_create (struct mds_rec_create *cr);
756
757 struct mds_rec_link {
758         __u32            lk_opcode;
759         __u32            lk_padding;
760         struct lustre_id lk_id1;
761         struct lustre_id lk_id2;
762         __u64            lk_time;
763 };
764
765 extern void lustre_swab_mds_rec_link (struct mds_rec_link *lk);
766
767 struct mds_rec_unlink {
768         __u32            ul_opcode;
769         __u32            ul_mode;
770         struct lustre_id ul_id1;
771         struct lustre_id ul_id2;
772         __u64            ul_time;
773 };
774
775 extern void lustre_swab_mds_rec_unlink (struct mds_rec_unlink *ul);
776
777 struct mds_rec_rename {
778         __u32            rn_opcode;
779         __u32            rn_padding;
780         struct lustre_id rn_id1;
781         struct lustre_id rn_id2;
782         __u64            rn_time;
783 };
784
785 extern void lustre_swab_mds_rec_rename (struct mds_rec_rename *rn);
786
787 /*
788  *  LOV data structures
789  */
790
791 #define LOV_MAX_UUID_BUFFER_SIZE  8192
792 /* The size of the buffer the lov/mdc reserves for the
793  * array of UUIDs returned by the MDS.  With the current
794  * protocol, this will limit the max number of OSTs per LOV */
795
796 struct lov_desc {
797         __u32 ld_tgt_count;                /* how many OBD's */
798         __u32 ld_active_tgt_count;         /* how many active */
799         __u32 ld_default_stripe_count;     /* how many objects are used */
800         __u32 ld_pattern;                  /* PATTERN_RAID0, PATTERN_RAID1 */
801         __u64 ld_default_stripe_size;      /* in bytes */
802         __u64 ld_default_stripe_offset;    /* in bytes */
803         struct obd_uuid ld_uuid;
804 };
805
806 struct lmv_desc {
807         __u32 ld_tgt_count;                /* how many MDS's */
808         __u32 ld_active_tgt_count;         /* how many active */
809         struct obd_uuid ld_uuid;
810 };
811
812 extern void lustre_swab_lov_desc (struct lov_desc *ld);
813
814 /*
815  *   LDLM requests:
816  */
817 /* opcodes -- MUST be distinct from OST/MDS opcodes */
818 typedef enum {
819         LDLM_ENQUEUE     = 101,
820         LDLM_CONVERT     = 102,
821         LDLM_CANCEL      = 103,
822         LDLM_BL_CALLBACK = 104,
823         LDLM_CP_CALLBACK = 105,
824         LDLM_GL_CALLBACK = 106,
825         LDLM_LAST_OPC
826 } ldlm_cmd_t;
827 #define LDLM_FIRST_OPC LDLM_ENQUEUE
828
829 #define RES_NAME_SIZE 4
830 struct ldlm_res_id {
831         __u64 name[RES_NAME_SIZE];
832 };
833
834 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
835
836 /* lock types */
837 typedef enum {
838         LCK_EX = 1,
839         LCK_PW = 2,
840         LCK_PR = 4,
841         LCK_CW = 8,
842         LCK_CR = 16,
843         LCK_NL = 32,
844         LCK_GROUP = 64
845 } ldlm_mode_t;
846
847 struct ldlm_extent {
848         __u64 start;
849         __u64 end;
850         __u64 gid;
851 };
852 struct ldlm_inodebits {
853         __u64 bits;
854 };
855
856 struct ldlm_flock {
857         __u64 start;
858         __u64 end;
859         __u64 pid;
860         __u64 blocking_pid;
861         __u64 blocking_export;
862 };
863
864 /* it's important that the fields of the ldlm_extent structure match
865  * the first fields of the ldlm_flock structure because there is only
866  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
867  * this ever changes we will need to swab the union differently based
868  * on the resource type. */
869
870 typedef union {
871         struct ldlm_extent l_extent;
872         struct ldlm_flock  l_flock;
873         struct ldlm_inodebits l_inodebits;
874 } ldlm_policy_data_t;
875
876 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
877
878 struct ldlm_intent {
879         __u64 opc;
880 };
881
882 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
883
884 struct ldlm_resource_desc {
885         __u32 lr_type;
886         __u32 lr_padding;
887         struct ldlm_res_id lr_name;
888 };
889
890 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
891
892 struct ldlm_lock_desc {
893         struct ldlm_resource_desc l_resource;
894         ldlm_mode_t l_req_mode;
895         ldlm_mode_t l_granted_mode;
896         ldlm_policy_data_t l_policy_data;
897 };
898
899 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
900
901 struct ldlm_request {
902         __u32 lock_flags;
903         __u32 lock_padding;
904         struct ldlm_lock_desc lock_desc;
905         struct lustre_handle lock_handle1;
906         struct lustre_handle lock_handle2;
907 };
908
909 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
910
911 struct ldlm_reply {
912         __u32 lock_flags;
913         __u32 lock_padding;
914         struct ldlm_lock_desc lock_desc;
915         struct lustre_handle lock_handle;
916         __u64  lock_policy_res1;
917         __u64  lock_policy_res2;
918 };
919
920 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
921
922 /*
923  * ptlbd, portal block device requests
924  */
925 typedef enum {
926         PTLBD_QUERY      = 200,
927         PTLBD_READ       = 201,
928         PTLBD_WRITE      = 202,
929         PTLBD_FLUSH      = 203,
930         PTLBD_CONNECT    = 204,
931         PTLBD_DISCONNECT = 205,
932         PTLBD_LAST_OPC
933 } ptlbd_cmd_t;
934 #define PTLBD_FIRST_OPC PTLBD_QUERY
935
936 struct ptlbd_op {
937         __u16 op_cmd;
938         __u16 op_lun;
939         __u16 op_niob_cnt;
940         __u16 op__padding;
941         __u32 op_block_cnt;
942 };
943
944 extern void lustre_swab_ptlbd_op (struct ptlbd_op *op);
945
946 struct ptlbd_niob {
947         __u64 n_xid;
948         __u64 n_block_nr;
949         __u32 n_offset;
950         __u32 n_length;
951 };
952
953 extern void lustre_swab_ptlbd_niob (struct ptlbd_niob *n);
954
955 struct ptlbd_rsp {
956         __u16 r_status;
957         __u16 r_error_cnt;
958 };
959
960 extern void lustre_swab_ptlbd_rsp (struct ptlbd_rsp *r);
961
962 /*
963  * Opcodes for management/monitoring node.
964  */
965 typedef enum {
966         MGMT_CONNECT = 250,
967         MGMT_DISCONNECT,
968         MGMT_EXCEPTION,         /* node died, etc. */
969         MGMT_LAST_OPC
970 } mgmt_cmd_t;
971 #define MGMT_FIRST_OPC MGMT_CONNECT
972
973 /*
974  * Opcodes for multiple servers.
975  */
976
977 typedef enum {
978         OBD_PING = 400,
979         OBD_LOG_CANCEL,
980         OBD_LAST_OPC
981 } obd_cmd_t;
982 #define OBD_FIRST_OPC OBD_PING
983
984 /* catalog of log objects */
985
986 /* Identifier for a single log object */
987 struct llog_logid {
988         __u64                   lgl_oid;
989         __u64                   lgl_ogr;
990         __u32                   lgl_ogen;
991 } __attribute__((packed));
992
993 /* Records written to the CATALOGS list */
994 #define CATLIST "CATALOGS"
995 struct llog_catid {
996         struct llog_logid       lci_logid;
997         __u32                   lci_padding[3];
998 } __attribute__((packed));
999
1000 /* Log data record types - there is no specific reason that these need to
1001  * be related to the RPC opcodes, but no reason not to (may be handy later?)
1002  */
1003 typedef enum {
1004         OST_SZ_REC       = 0x10600000 | (OST_SAN_WRITE << 8),
1005         OST_RAID1_REC    = 0x10600000 | ((OST_SAN_WRITE + 1) << 8),
1006         MDS_UNLINK_REC   = 0x10610000 | (MDS_REINT << 8) | REINT_UNLINK,
1007         OBD_CFG_REC      = 0x10620000,
1008         PTL_CFG_REC      = 0x10630000,
1009         LLOG_GEN_REC     = 0x10640000,
1010         LLOG_HDR_MAGIC   = 0x10645539,
1011         LLOG_LOGID_MAGIC = 0x1064553b,
1012         SMFS_UPDATE_REC  = 0x10650000,
1013         CACHE_LRU_REC    = 0x10660000,
1014 } llog_op_type;
1015
1016 /* Log record header - stored in little endian order.
1017  * Each record must start with this struct, end with a llog_rec_tail,
1018  * and be a multiple of 256 bits in size.
1019  */
1020 struct llog_rec_hdr {
1021         __u32                   lrh_len;
1022         __u32                   lrh_index;
1023         __u32                   lrh_type;
1024         __u32                   padding;
1025 };
1026
1027 struct llog_rec_tail {
1028         __u32 lrt_len;
1029         __u32 lrt_index;
1030 };
1031
1032 struct llog_logid_rec {
1033         struct llog_rec_hdr     lid_hdr;
1034         struct llog_logid       lid_id;
1035         __u32                   padding[5];
1036         struct llog_rec_tail    lid_tail;
1037 } __attribute__((packed));
1038
1039 struct llog_create_rec {
1040         struct llog_rec_hdr     lcr_hdr;
1041         struct lustre_id        lcr_id;
1042         obd_id                  lcr_oid;
1043         obd_count               lcr_ogen;
1044         __u32                   padding;
1045         struct llog_rec_tail    lcr_tail;
1046 } __attribute__((packed));
1047
1048 struct llog_orphan_rec {
1049         struct llog_rec_hdr     lor_hdr;
1050         obd_id                  lor_oid;
1051         obd_count               lor_ogen;
1052         __u32                   padding;
1053         struct llog_rec_tail    lor_tail;
1054 } __attribute__((packed));
1055
1056 struct llog_unlink_rec {
1057         struct llog_rec_hdr     lur_hdr;
1058         obd_id                  lur_oid;
1059         obd_count               lur_ogen;
1060         __u32                   padding;
1061         struct llog_rec_tail    lur_tail;
1062 } __attribute__((packed));
1063
1064 struct llog_size_change_rec {
1065         struct llog_rec_hdr     lsc_hdr;
1066         struct lustre_id        lsc_id;
1067         __u32                   lsc_io_epoch;
1068         __u32                   padding;
1069         struct llog_rec_tail    lsc_tail;
1070 } __attribute__((packed));
1071
1072 struct llog_gen {
1073         __u64 mnt_cnt;
1074         __u64 conn_cnt;
1075 };
1076
1077 struct llog_gen_rec {
1078         struct llog_rec_hdr     lgr_hdr;
1079         struct llog_gen         lgr_gen;
1080         struct llog_rec_tail    lgr_tail;
1081 } __attribute__((packed));
1082
1083 struct llog_lru_rec {
1084         struct llog_rec_hdr     llr_hdr;
1085         struct lustre_id        llr_cid;
1086         struct lustre_id        llr_pid;
1087         struct llog_rec_tail    llr_tail;
1088 } __attribute__((packed));
1089
1090 /* On-disk header structure of each log object, stored in little endian order */
1091 #define LLOG_CHUNK_SIZE         8192
1092 #define LLOG_HEADER_SIZE        (96)
1093 #define LLOG_BITMAP_BYTES       (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
1094
1095 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
1096
1097 /* flags for the logs */
1098 #define LLOG_F_ZAP_WHEN_EMPTY   0x1
1099 #define LLOG_F_IS_CAT           0x2
1100 #define LLOG_F_IS_PLAIN         0x4
1101
1102 struct llog_log_hdr {
1103         struct llog_rec_hdr     llh_hdr;
1104         __u64                   llh_timestamp;
1105         __u32                   llh_count;
1106         __u32                   llh_bitmap_offset;
1107         __u32                   llh_size;
1108         __u32                   llh_flags;
1109         __u32                   llh_cat_idx;
1110         /* for a catalog the first plain slot is next to it */
1111         struct obd_uuid         llh_tgtuuid;
1112         __u32                 llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
1113         __u32                   llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
1114         struct llog_rec_tail    llh_tail;
1115 } __attribute__((packed));
1116
1117 #define LLOG_BITMAP_SIZE(llh)  ((llh->llh_hdr.lrh_len -         \
1118                                  llh->llh_bitmap_offset -       \
1119                                  sizeof(llh->llh_tail)) * 8)
1120
1121 /* log cookies are used to reference a specific log file and a record therein */
1122 struct llog_cookie {
1123         struct llog_logid       lgc_lgl;
1124         __u32                   lgc_subsys;
1125         __u32                   lgc_index;
1126         __u32                   lgc_flags;
1127 } __attribute__((packed));
1128
1129 /* llog protocol */
1130 enum llogd_rpc_ops {
1131         LLOG_ORIGIN_HANDLE_OPEN         = 501,
1132         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
1133         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
1134         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
1135         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
1136         LLOG_ORIGIN_CONNECT             = 506,
1137         LLOG_CATINFO                    = 507,  /* for lfs catinfo */
1138         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
1139 };
1140
1141 struct llogd_body {
1142         struct llog_logid  lgd_logid;
1143         __u32 lgd_ctxt_idx;
1144         __u32 lgd_llh_flags;
1145         __u32 lgd_index;
1146         __u32 lgd_saved_index;
1147         __u32 lgd_len;
1148         __u64 lgd_cur_offset;
1149 } __attribute__((packed));
1150
1151 struct llogd_conn_body {
1152         struct llog_gen         lgdc_gen;
1153         struct llog_logid       lgdc_logid;
1154         __u32                   lgdc_ctxt_idx;
1155 } __attribute__((packed));
1156
1157 extern void lustre_swab_llogd_body (struct llogd_body *d);
1158 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
1159 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
1160
1161 static inline struct lustre_id *obdo_id(struct obdo *oa)
1162 {
1163         void *raw_id = oa->o_inline + sizeof(struct lustre_handle) +
1164                 sizeof(struct llog_cookie);
1165         
1166         return (struct lustre_id *)raw_id;
1167 }
1168
1169 /* security negotiate */
1170 typedef enum {
1171         SEC_INIT                = 600,
1172         SEC_INIT_CONTINUE       = 601,
1173         SEC_FINI                = 602,
1174         SEC_LAST_OPC
1175 } sec_cmd_t;
1176 #define SEC_FIRST_OPC SEC_INIT
1177
1178 #endif