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 __KERNEL__
  52 # include <linux/ioctl.h>
  53 # include <asm/types.h>
  54 # include <linux/types.h>
  55 # include <linux/list.h>
  56 # include <linux/string.h> /* for strncpy, below */
  57 # include <asm/byteorder.h>
  58 # include <linux/fs.h> /* to check for FMODE_EXEC, lest we redefine */
  59 #else
  60 #ifdef __CYGWIN__
  61 # include <sys/types.h>
  62 #else
  63 # include <asm/types.h>
  64 # include <stdint.h>
  65 #endif
  66 # include <portals/list.h>
  67 # include <string.h>
  68 #endif
  69
  70 /* Defn's shared with user-space. */
  71 #include <lustre/lustre_user.h>
  72
  73 /*
  74  * this file contains all data structures used in Lustre interfaces:
  75  * - obdo and obd_request records
  76  * - mds_request records
  77  * - ldlm data
  78  * - ioctl's
  79  */
  80
  81 /*
  82  *  GENERAL STUFF
  83  */
  84 struct obd_uuid {
  85         __u8 uuid[40];
  86 };
  87
  88 static inline int obd_uuid_equals(struct obd_uuid *u1, struct obd_uuid *u2)
  89 {
  90         return strcmp(u1->uuid, u2->uuid) == 0;
  91 }
  92
  93 static inline void obd_str2uuid(struct obd_uuid *uuid, char *tmp)
  94 {
  95         strncpy(uuid->uuid, tmp, sizeof(*uuid));
  96         uuid->uuid[sizeof(*uuid) - 1] = '\0';
  97 }
  98
  99 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
 100  * FOO_REPLY_PORTAL   is for incoming replies on the FOO
 101  * FOO_BULK_PORTAL    is for incoming bulk on the FOO
 102  */
 103
 104 #define CONNMGR_REQUEST_PORTAL          1
 105 #define CONNMGR_REPLY_PORTAL            2
 106 //#define OSC_REQUEST_PORTAL            3
 107 #define OSC_REPLY_PORTAL                4
 108 //#define OSC_BULK_PORTAL               5
 109 #define OST_REQUEST_PORTAL              6
 110 #define OST_CREATE_PORTAL               7
 111 #define OST_BULK_PORTAL                 8
 112 //#define MDC_REQUEST_PORTAL            9
 113 #define MDC_REPLY_PORTAL               10
 114 //#define MDC_BULK_PORTAL              11
 115 #define MDS_REQUEST_PORTAL             12
 116 //#define MDS_REPLY_PORTAL             13
 117 #define MDS_BULK_PORTAL                14
 118 #define LDLM_CB_REQUEST_PORTAL         15
 119 #define LDLM_CB_REPLY_PORTAL           16
 120 #define LDLM_CANCEL_REQUEST_PORTAL     17
 121 #define LDLM_CANCEL_REPLY_PORTAL       18
 122 #define PTLBD_REQUEST_PORTAL           19
 123 #define PTLBD_REPLY_PORTAL             20
 124 #define PTLBD_BULK_PORTAL              21
 125 #define MDS_SETATTR_PORTAL             22
 126 #define MDS_READPAGE_PORTAL            23
 127 #define MGMT_REQUEST_PORTAL            24
 128 #define MGMT_REPLY_PORTAL              25
 129 #define MGMT_CLI_REQUEST_PORTAL        26
 130 #define MGMT_CLI_REPLY_PORTAL          27
 131
 132 #define SVC_KILLED               1
 133 #define SVC_EVENT                2
 134 #define SVC_SIGNAL               4
 135 #define SVC_RUNNING              8
 136 #define SVC_STOPPING            16
 137 #define SVC_STOPPED             32
 138
 139 /* packet types */
 140 #define PTL_RPC_MSG_REQUEST 4711
 141 #define PTL_RPC_MSG_ERR     4712
 142 #define PTL_RPC_MSG_REPLY   4713
 143
 144 #define PTLRPC_MSG_MAGIC    0x0BD00BD0
 145
 146
 147 #define PTLRPC_MSG_VERSION  0x00000003
 148 #define LUSTRE_MDS_VERSION  (0x00040000|PTLRPC_MSG_VERSION)
 149 #define LUSTRE_OST_VERSION  (0x00040000|PTLRPC_MSG_VERSION)
 150 #define LUSTRE_DLM_VERSION  (0x00040000|PTLRPC_MSG_VERSION)
 151
 152 struct lustre_handle {
 153         __u64 cookie;
 154 };
 155 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
 156
 157 /* we depend on this structure to be 8-byte aligned */
 158 /* this type is only endian-adjusted in lustre_unpack_msg() */
 159 struct lustre_msg {
 160         struct lustre_handle handle;
 161         __u32 magic;
 162         __u32 type;
 163         __u32 version;
 164         __u32 opc;
 165         __u64 last_xid;
 166         __u64 last_committed;
 167         __u64 transno;
 168         __u32 status;
 169         __u32 flags;
 170         __u32 conn_cnt;
 171         __u32 bufcount;
 172         __u32 buflens[0];
 173 };
 174
 175 /* Flags that are operation-specific go in the top 16 bits. */
 176 #define MSG_OP_FLAG_MASK   0xffff0000
 177 #define MSG_OP_FLAG_SHIFT  16
 178
 179 /* Flags that apply to all requests are in the bottom 16 bits */
 180 #define MSG_GEN_FLAG_MASK      0x0000ffff
 181 #define MSG_LAST_REPLAY        1
 182 #define MSG_RESENT             2
 183 #define MSG_REPLAY             4
 184
 185 static inline int lustre_msg_get_flags(struct lustre_msg *msg)
 186 {
 187         return (msg->flags & MSG_GEN_FLAG_MASK);
 188 }
 189
 190 static inline void lustre_msg_add_flags(struct lustre_msg *msg, int flags)
 191 {
 192         msg->flags |= MSG_GEN_FLAG_MASK & flags;
 193 }
 194
 195 static inline void lustre_msg_set_flags(struct lustre_msg *msg, int flags)
 196 {
 197         msg->flags &= ~MSG_GEN_FLAG_MASK;
 198         lustre_msg_add_flags(msg, flags);
 199 }
 200
 201 static inline void lustre_msg_clear_flags(struct lustre_msg *msg, int flags)
 202 {
 203         msg->flags &= ~(MSG_GEN_FLAG_MASK & flags);
 204 }
 205
 206 static inline int lustre_msg_get_op_flags(struct lustre_msg *msg)
 207 {
 208         return (msg->flags >> MSG_OP_FLAG_SHIFT);
 209 }
 210
 211 static inline void lustre_msg_add_op_flags(struct lustre_msg *msg, int flags)
 212 {
 213         msg->flags |= ((flags & MSG_GEN_FLAG_MASK) << MSG_OP_FLAG_SHIFT);
 214 }
 215
 216 static inline void lustre_msg_set_op_flags(struct lustre_msg *msg, int flags)
 217 {
 218         msg->flags &= ~MSG_OP_FLAG_MASK;
 219         lustre_msg_add_op_flags(msg, flags);
 220 }
 221
 222 /*
 223  * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
 224  */
 225
 226 #define MSG_CONNECT_RECOVERING  0x1
 227 #define MSG_CONNECT_RECONNECT   0x2
 228 #define MSG_CONNECT_REPLAYABLE  0x4
 229 //#define MSG_CONNECT_PEER        0x8
 230 #define MSG_CONNECT_LIBCLIENT   0x10
 231
 232 /*
 233  *   OST requests: OBDO & OBD request records
 234  */
 235
 236 /* opcodes */
 237 typedef enum {
 238         OST_REPLY      =  0,       /* reply ? */
 239         OST_GETATTR    =  1,
 240         OST_SETATTR    =  2,
 241         OST_READ       =  3,
 242         OST_WRITE      =  4,
 243         OST_CREATE     =  5,
 244         OST_DESTROY    =  6,
 245         OST_GET_INFO   =  7,
 246         OST_CONNECT    =  8,
 247         OST_DISCONNECT =  9,
 248         OST_PUNCH      = 10,
 249         OST_OPEN       = 11,
 250         OST_CLOSE      = 12,
 251         OST_STATFS     = 13,
 252         OST_SAN_READ   = 14,
 253         OST_SAN_WRITE  = 15,
 254         OST_SYNC       = 16,
 255         OST_SET_INFO   = 17,
 256         OST_LAST_OPC
 257 } ost_cmd_t;
 258 #define OST_FIRST_OPC  OST_REPLY
 259
 260 typedef uint64_t        obd_id;
 261 typedef uint64_t        obd_gr;
 262 typedef uint64_t        obd_time;
 263 typedef uint64_t        obd_size;
 264 typedef uint64_t        obd_off;
 265 typedef uint64_t        obd_blocks;
 266 typedef uint32_t        obd_blksize;
 267 typedef uint32_t        obd_mode;
 268 typedef uint32_t        obd_uid;
 269 typedef uint32_t        obd_gid;
 270 typedef uint32_t        obd_flag;
 271 typedef uint32_t        obd_count;
 272
 273 #define OBD_FL_INLINEDATA   (0x00000001)
 274 #define OBD_FL_OBDMDEXISTS  (0x00000002)
 275 #define OBD_FL_DELORPHAN    (0x00000004) /* if set in o_flags delete orphans */
 276 #define OBD_FL_NORPC        (0x00000008) // if set in o_flags set in OSC not OST
 277 #define OBD_FL_IDONLY       (0x00000010) // if set in o_flags only adjust obj id
 278 #define OBD_FL_RECREATE_OBJS (0x00000020) // recreate missing obj
 279
 280 #define OBD_INLINESZ    64
 281
 282 /* Note: 64-bit types are 64-bit aligned in structure */
 283 struct obdo {
 284         obd_id                  o_id;
 285         obd_gr                  o_gr;
 286         obd_time                o_atime;
 287         obd_time                o_mtime;
 288         obd_time                o_ctime;
 289         obd_size                o_size;
 290         obd_blocks              o_blocks;       /* brw: cli sent cached bytes */
 291         obd_size                o_grant;
 292         obd_blksize             o_blksize;      /* optimal IO blocksize */
 293         obd_mode                o_mode;         /* brw: cli sent cache remain */
 294         obd_uid                 o_uid;
 295         obd_gid                 o_gid;
 296         obd_flag                o_flags;
 297         obd_count               o_nlink;        /* brw: checksum */
 298         obd_count               o_generation;
 299         obd_flag                o_valid;        /* hot fields in this obdo */
 300         obd_count               o_misc;
 301         __u32                   o_easize;       /* epoch in ost writes */
 302         char                    o_inline[OBD_INLINESZ]; /* fid in ost writes */
 303 };
 304
 305 #define o_dirty   o_blocks
 306 #define o_undirty o_mode
 307 #define o_dropped o_misc
 308 #define o_cksum   o_nlink
 309
 310 extern void lustre_swab_obdo (struct obdo *o);
 311
 312 #define LOV_MAGIC_V1      0x0BD10BD0
 313 #define LOV_MAGIC         LOV_MAGIC_V1
 314
 315 #define LOV_PATTERN_RAID0 0x001   /* stripes are used round-robin */
 316 #define LOV_PATTERN_RAID1 0x002   /* stripes are mirrors of each other */
 317 #define LOV_PATTERN_FIRST 0x100   /* first stripe is not in round-robin */
 318
 319 #define lov_ost_data lov_ost_data_v1
 320 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
 321         __u64 l_object_id;        /* OST object ID */
 322         __u64 l_object_gr;        /* OST object group (creating MDS number) */
 323         __u32 l_ost_gen;          /* generation of this l_ost_idx */
 324         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
 325 };
 326
 327 #define lov_mds_md lov_mds_md_v1
 328 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
 329         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
 330         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 331         __u64 lmm_object_id;      /* LOV object ID */
 332         __u64 lmm_object_gr;      /* LOV object group */
 333         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 334         __u32 lmm_stripe_count;   /* num stripes in use for this object */
 335         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 336 };
 337
 338 #define LOV_MAGIC_V0      0x0BD00BD0
 339
 340 struct lov_ost_data_v0 {          /* per-stripe data structure (little-endian)*/
 341         __u64 l_object_id;        /* OST object ID */
 342 };
 343
 344 struct lov_mds_md_v0 {            /* LOV EA mds/wire data (little-endian) */
 345         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V0 */
 346         __u64 lmm_object_id;      /* LOV object ID */
 347         __u32 lmm_stripe_size;    /* size of the stripe in bytes (not RAID1) */
 348         __u32 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 349         __u16 lmm_stripe_count;   /* number of stipes in use for this object */
 350         __u16 lmm_ost_count;      /* how many OST idx are in this LOV md */
 351         struct lov_ost_data_v0 lmm_objects[0];
 352 } __attribute__((packed));
 353
 354 #define OBD_MD_FLALL    (0xffffffff)
 355 #define OBD_MD_FLID     (0x00000001)    /* object ID */
 356 #define OBD_MD_FLATIME  (0x00000002)    /* access time */
 357 #define OBD_MD_FLMTIME  (0x00000004)    /* data modification time */
 358 #define OBD_MD_FLCTIME  (0x00000008)    /* change time */
 359 #define OBD_MD_FLSIZE   (0x00000010)    /* size */
 360 #define OBD_MD_FLBLOCKS (0x00000020)    /* allocated blocks count */
 361 #define OBD_MD_FLBLKSZ  (0x00000040)    /* block size */
 362 #define OBD_MD_FLMODE   (0x00000080)    /* access bits (mode & ~S_IFMT) */
 363 #define OBD_MD_FLTYPE   (0x00000100)    /* object type (mode & S_IFMT) */
 364 #define OBD_MD_FLUID    (0x00000200)    /* user ID */
 365 #define OBD_MD_FLGID    (0x00000400)    /* group ID */
 366 #define OBD_MD_FLFLAGS  (0x00000800)    /* flags word */
 367 #define OBD_MD_FLNLINK  (0x00002000)    /* link count */
 368 #define OBD_MD_FLGENER  (0x00004000)    /* generation number */
 369 #define OBD_MD_FLINLINE (0x00008000)    /* inline data */
 370 #define OBD_MD_FLRDEV   (0x00010000)    /* device number */
 371 #define OBD_MD_FLEASIZE (0x00020000)    /* extended attribute data */
 372 #define OBD_MD_LINKNAME (0x00040000)    /* symbolic link target */
 373 #define OBD_MD_FLHANDLE (0x00080000)    /* file handle */
 374 #define OBD_MD_FLCKSUM  (0x00100000)    /* bulk data checksum */
 375 #define OBD_MD_FLQOS    (0x00200000)    /* quality of service stats */
 376 #define OBD_MD_FLOSCOPQ (0x00400000)    /* osc opaque data */
 377 #define OBD_MD_FLCOOKIE (0x00800000)    /* log cancellation cookie */
 378 #define OBD_MD_FLGROUP  (0x01000000)    /* group */
 379 #define OBD_MD_FLIFID   (0x02000000)    /* ->ost write inline fid */
 380 #define OBD_MD_FLEPOCH  (0x04000000)    /* ->ost write easize is epoch */
 381 #define OBD_MD_FLGRANT  (0x08000000)    /* ost preallocation space grant */
 382 #define OBD_MD_FLDIREA  (0x10000000)    /* dir's extended attribute data */
 383 #define OBD_MD_FLNOTOBD (~(OBD_MD_FLBLOCKS | OBD_MD_LINKNAME|\
 384                            OBD_MD_FLEASIZE | OBD_MD_FLHANDLE | OBD_MD_FLCKSUM|\
 385                            OBD_MD_FLQOS | OBD_MD_FLOSCOPQ | OBD_MD_FLCOOKIE))
 386
 387
 388 static inline struct lustre_handle *obdo_handle(struct obdo *oa)
 389 {
 390         return (struct lustre_handle *)oa->o_inline;
 391 }
 392
 393 static inline struct llog_cookie *obdo_logcookie(struct obdo *oa)
 394 {
 395         return (struct llog_cookie *)(oa->o_inline +
 396                                       sizeof(struct lustre_handle));
 397 }
 398 /* don't forget obdo_fid which is way down at the bottom so it can
 399  * come after the definition of llog_cookie */
 400
 401 struct obd_statfs {
 402         __u64           os_type;
 403         __u64           os_blocks;
 404         __u64           os_bfree;
 405         __u64           os_bavail;
 406         __u64           os_files;
 407         __u64           os_ffree;
 408         __u8            os_fsid[40];
 409         __u32           os_bsize;
 410         __u32           os_namelen;
 411         __u64           os_maxbytes;
 412         __u32           os_spare[10];
 413 };
 414
 415 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
 416
 417 /* ost_body.data values for OST_BRW */
 418
 419 #define OBD_BRW_READ       0x01
 420 #define OBD_BRW_WRITE      0x02
 421 #define OBD_BRW_RWMASK     (OBD_BRW_READ | OBD_BRW_WRITE)
 422 #define OBD_BRW_SYNC       0x08
 423 #define OBD_BRW_CHECK      0x10
 424 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
 425 #define OBD_BRW_GRANTED    0x40 /* the ost manages this */
 426
 427 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
 428
 429 struct obd_ioobj {
 430         obd_id               ioo_id;
 431         obd_gr               ioo_gr;
 432         __u32                ioo_type;
 433         __u32                ioo_bufcnt;
 434 };
 435
 436 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
 437
 438 /* multiple of 8 bytes => can array */
 439 struct niobuf_remote {
 440         __u64 offset;
 441         __u32 len;
 442         __u32 flags;
 443 };
 444
 445 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
 446
 447 /* request structure for OST's */
 448
 449 #define OST_REQ_HAS_OA1  0x1
 450
 451 struct ost_body {
 452         struct  obdo oa;
 453 };
 454
 455 extern void lustre_swab_ost_body (struct ost_body *b);
 456 extern void lustre_swab_ost_last_id(obd_id *id);
 457
 458 /* lock value block communicated between the filter and llite */
 459
 460 struct ost_lvb {
 461         __u64 lvb_size;
 462         __u64 lvb_mtime;
 463         __u64 lvb_atime;
 464         __u64 lvb_ctime;
 465         __u64 lvb_blocks;
 466 };
 467
 468 extern void lustre_swab_ost_lvb(struct ost_lvb *);
 469
 470 /*
 471  *   MDS REQ RECORDS
 472  */
 473
 474 /* opcodes */
 475 typedef enum {
 476         MDS_GETATTR      = 33,
 477         MDS_GETATTR_NAME = 34,
 478         MDS_CLOSE        = 35,
 479         MDS_REINT        = 36,
 480         MDS_READPAGE     = 37,
 481         MDS_CONNECT      = 38,
 482         MDS_DISCONNECT   = 39,
 483         MDS_GETSTATUS    = 40,
 484         MDS_STATFS       = 41,
 485         MDS_PIN          = 42,
 486         MDS_UNPIN        = 43,
 487         MDS_SYNC         = 44,
 488         MDS_DONE_WRITING = 45,
 489         MDS_LAST_OPC
 490 } mds_cmd_t;
 491 #define MDS_FIRST_OPC    MDS_GETATTR
 492
 493 /*
 494  * Do not exceed 63
 495  */
 496
 497 #define REINT_SETATTR  1
 498 #define REINT_CREATE   2
 499 #define REINT_LINK     3
 500 #define REINT_UNLINK   4
 501 #define REINT_RENAME   5
 502 #define REINT_OPEN     6
 503 #define REINT_MAX      6
 504
 505 /* the disposition of the intent outlines what was executed */
 506 #define DISP_IT_EXECD   1
 507 #define DISP_LOOKUP_EXECD  (1 << 1)
 508 #define DISP_LOOKUP_NEG     (1 << 2)
 509 #define DISP_LOOKUP_POS     (1 << 3)
 510 #define DISP_OPEN_CREATE  (1 << 4)
 511 #define DISP_OPEN_OPEN    (1 << 5)
 512 #define DISP_ENQ_COMPLETE (1<<6)
 513
 514 /* INODE LOCK PARTS */
 515 #define MDS_INODELOCK_LOOKUP 0x000001       /* dentry, mode, owner, group */
 516 #define MDS_INODELOCK_UPDATE 0x000002       /* size, links, timestamps */
 517 //#define MDS_INODELOCK_MAXSHIFT 1
 518 //#define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
 519
 520 struct ll_fid {
 521         __u64 id;
 522         __u32 generation;
 523         __u32 f_type;
 524 };
 525
 526 struct ll_recreate_obj {
 527         __u64 lrc_id;
 528         __u32 lrc_ost_idx;
 529 };
 530
 531 extern void lustre_swab_ll_fid (struct ll_fid *fid);
 532
 533 #define MDS_STATUS_CONN 1
 534 #define MDS_STATUS_LOV 2
 535
 536 struct mds_status_req {
 537         __u32  flags;
 538         __u32  repbuf;
 539 };
 540
 541 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
 542
 543 #define MDS_BFLAG_UNCOMMITTED_WRITES   0x1
 544
 545 struct mds_body {
 546         struct ll_fid  fid1;
 547         struct ll_fid  fid2;
 548         struct lustre_handle handle;
 549         __u64          size;   /* Offset, in the case of MDS_READPAGE */
 550         __u64          blocks; /* XID, in the case of MDS_READPAGE */
 551         __u64          io_epoch;
 552         __u32          ino;   /* make this a __u64 */
 553         __u32          valid;
 554         __u32          fsuid;
 555         __u32          fsgid;
 556         __u32          capability;
 557         __u32          mode;
 558         __u32          uid;
 559         __u32          gid;
 560         __u32          mtime;
 561         __u32          ctime;
 562         __u32          atime;
 563         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
 564         __u32          rdev;
 565         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
 566         __u32          generation;
 567         __u32          suppgid;
 568         __u32          eadatasize;
 569         __u32          packing;
 570 };
 571
 572 extern void lustre_swab_mds_body (struct mds_body *b);
 573
 574
 575 /* MDS update records */
 576
 577 //struct mds_update_record_hdr {
 578 //        __u32 ur_opcode;
 579 //};
 580
 581 struct mds_rec_setattr {
 582         __u32           sa_opcode;
 583         __u32           sa_fsuid;
 584         __u32           sa_fsgid;
 585         __u32           sa_cap;
 586         __u32           sa_suppgid;
 587         __u32           sa_valid;
 588         struct ll_fid   sa_fid;
 589         __u32           sa_mode;
 590         __u32           sa_uid;
 591         __u32           sa_gid;
 592         __u32           sa_attr_flags;
 593         __u64           sa_size;
 594         __u64           sa_atime;
 595         __u64           sa_mtime;
 596         __u64           sa_ctime;
 597 };
 598
 599 /* Remove this once we declare it in include/linux/fs.h (v21 kernel patch?) */
 600 #ifndef ATTR_CTIME_SET
 601 #define ATTR_CTIME_SET 0x2000
 602 #endif
 603
 604 extern void lustre_swab_mds_rec_setattr (struct mds_rec_setattr *sa);
 605
 606 #ifndef FMODE_READ
 607 #define FMODE_READ               00000001
 608 #define FMODE_WRITE              00000002
 609 #endif
 610 #ifndef FMODE_EXEC
 611 #define FMODE_EXEC               00000004
 612 #endif
 613 #define MDS_OPEN_CREAT           00000100
 614 #define MDS_OPEN_EXCL            00000200
 615 #define MDS_OPEN_TRUNC           00001000
 616 #define MDS_OPEN_APPEND          00002000
 617 #define MDS_OPEN_SYNC            00010000
 618 #define MDS_OPEN_DIRECTORY       00200000
 619
 620 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
 621 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
 622 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
 623
 624 struct mds_rec_create {
 625         __u32           cr_opcode;
 626         __u32           cr_fsuid;
 627         __u32           cr_fsgid;
 628         __u32           cr_cap;
 629         __u32           cr_flags; /* for use with open */
 630         __u32           cr_mode;
 631         struct ll_fid   cr_fid;
 632         struct ll_fid   cr_replayfid;
 633         __u64           cr_time;
 634         __u64           cr_rdev;
 635         __u32           cr_suppgid;
 636         __u32           cr_packing;
 637 };
 638
 639 extern void lustre_swab_mds_rec_create (struct mds_rec_create *cr);
 640
 641 struct mds_rec_link {
 642         __u32           lk_opcode;
 643         __u32           lk_fsuid;
 644         __u32           lk_fsgid;
 645         __u32           lk_cap;
 646         __u32           lk_suppgid1;
 647         __u32           lk_suppgid2;
 648         struct ll_fid   lk_fid1;
 649         struct ll_fid   lk_fid2;
 650         __u64           lk_time;
 651 };
 652
 653 extern void lustre_swab_mds_rec_link (struct mds_rec_link *lk);
 654
 655 struct mds_rec_unlink {
 656         __u32           ul_opcode;
 657         __u32           ul_fsuid;
 658         __u32           ul_fsgid;
 659         __u32           ul_cap;
 660         __u32           ul_suppgid;
 661         __u32           ul_mode;
 662         struct ll_fid   ul_fid1;
 663         struct ll_fid   ul_fid2;
 664         __u64           ul_time;
 665 };
 666
 667 extern void lustre_swab_mds_rec_unlink (struct mds_rec_unlink *ul);
 668
 669 struct mds_rec_rename {
 670         __u32           rn_opcode;
 671         __u32           rn_fsuid;
 672         __u32           rn_fsgid;
 673         __u32           rn_cap;
 674         __u32           rn_suppgid1;
 675         __u32           rn_suppgid2;
 676         struct ll_fid   rn_fid1;
 677         struct ll_fid   rn_fid2;
 678         __u64           rn_time;
 679 };
 680
 681 extern void lustre_swab_mds_rec_rename (struct mds_rec_rename *rn);
 682
 683 /*
 684  *  LOV data structures
 685  */
 686
 687 #define LOV_MAX_UUID_BUFFER_SIZE  8192
 688 /* The size of the buffer the lov/mdc reserves for the
 689  * array of UUIDs returned by the MDS.  With the current
 690  * protocol, this will limit the max number of OSTs per LOV */
 691
 692 struct lov_desc {
 693         __u32 ld_tgt_count;                /* how many OBD's */
 694         __u32 ld_active_tgt_count;         /* how many active */
 695         __u32 ld_default_stripe_count;     /* how many objects are used */
 696         __u32 ld_pattern;                  /* PATTERN_RAID0, PATTERN_RAID1 */
 697         __u64 ld_default_stripe_size;      /* in bytes */
 698         __u64 ld_default_stripe_offset;    /* in bytes */
 699         struct obd_uuid ld_uuid;
 700 };
 701
 702 extern void lustre_swab_lov_desc (struct lov_desc *ld);
 703
 704 /*
 705  *   LDLM requests:
 706  */
 707 /* opcodes -- MUST be distinct from OST/MDS opcodes */
 708 typedef enum {
 709         LDLM_ENQUEUE     = 101,
 710         LDLM_CONVERT     = 102,
 711         LDLM_CANCEL      = 103,
 712         LDLM_BL_CALLBACK = 104,
 713         LDLM_CP_CALLBACK = 105,
 714         LDLM_GL_CALLBACK = 106,
 715         LDLM_LAST_OPC
 716 } ldlm_cmd_t;
 717 #define LDLM_FIRST_OPC LDLM_ENQUEUE
 718
 719 #define RES_NAME_SIZE 4
 720 struct ldlm_res_id {
 721         __u64 name[RES_NAME_SIZE];
 722 };
 723
 724 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
 725
 726 /* lock types */
 727 typedef enum {
 728         LCK_EX = 1,
 729         LCK_PW = 2,
 730         LCK_PR = 4,
 731         LCK_CW = 8,
 732         LCK_CR = 16,
 733         LCK_NL = 32,
 734         LCK_GROUP = 64
 735 } ldlm_mode_t;
 736
 737 struct ldlm_extent {
 738         __u64 start;
 739         __u64 end;
 740         __u64 gid;
 741 };
 742 struct ldlm_inodebits {
 743         __u64 bits;
 744 };
 745
 746 struct ldlm_flock {
 747         __u64 start;
 748         __u64 end;
 749         __u64 pid;
 750         __u64 blocking_pid;
 751         __u64 blocking_export;
 752 };
 753
 754 /* it's important that the fields of the ldlm_extent structure match
 755  * the first fields of the ldlm_flock structure because there is only
 756  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
 757  * this ever changes we will need to swab the union differently based
 758  * on the resource type. */
 759
 760 typedef union {
 761         struct ldlm_extent l_extent;
 762         struct ldlm_flock  l_flock;
 763         struct ldlm_inodebits l_inodebits;
 764 } ldlm_policy_data_t;
 765
 766 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
 767
 768 struct ldlm_intent {
 769         __u64 opc;
 770 };
 771
 772 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
 773
 774 struct ldlm_resource_desc {
 775         __u32 lr_type;
 776         __u32 lr_padding;
 777         struct ldlm_res_id lr_name;
 778 };
 779
 780 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
 781
 782 struct ldlm_lock_desc {
 783         struct ldlm_resource_desc l_resource;
 784         ldlm_mode_t l_req_mode;
 785         ldlm_mode_t l_granted_mode;
 786         ldlm_policy_data_t l_policy_data;
 787 };
 788
 789 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
 790
 791 struct ldlm_request {
 792         __u32 lock_flags;
 793         __u32 lock_padding;
 794         struct ldlm_lock_desc lock_desc;
 795         struct lustre_handle lock_handle1;
 796         struct lustre_handle lock_handle2;
 797 };
 798
 799 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
 800
 801 struct ldlm_reply {
 802         __u32 lock_flags;
 803         __u32 lock_padding;
 804         struct ldlm_lock_desc lock_desc;
 805         struct lustre_handle lock_handle;
 806         __u64  lock_policy_res1;
 807         __u64  lock_policy_res2;
 808 };
 809
 810 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
 811
 812 /*
 813  * ptlbd, portal block device requests
 814  */
 815 typedef enum {
 816         PTLBD_QUERY = 200,
 817         PTLBD_READ = 201,
 818         PTLBD_WRITE = 202,
 819         PTLBD_FLUSH = 203,
 820         PTLBD_CONNECT = 204,
 821         PTLBD_DISCONNECT = 205,
 822         PTLBD_LAST_OPC
 823 } ptlbd_cmd_t;
 824 #define PTLBD_FIRST_OPC PTLBD_QUERY
 825
 826 struct ptlbd_op {
 827         __u16 op_cmd;
 828         __u16 op_lun;
 829         __u16 op_niob_cnt;
 830         __u16 op__padding;
 831         __u32 op_block_cnt;
 832 };
 833
 834 extern void lustre_swab_ptlbd_op (struct ptlbd_op *op);
 835
 836 struct ptlbd_niob {
 837         __u64 n_xid;
 838         __u64 n_block_nr;
 839         __u32 n_offset;
 840         __u32 n_length;
 841 };
 842
 843 extern void lustre_swab_ptlbd_niob (struct ptlbd_niob *n);
 844
 845 struct ptlbd_rsp {
 846         __u16 r_status;
 847         __u16 r_error_cnt;
 848 };
 849
 850 extern void lustre_swab_ptlbd_rsp (struct ptlbd_rsp *r);
 851
 852 /*
 853  * Opcodes for management/monitoring node.
 854  */
 855 typedef enum {
 856         MGMT_CONNECT = 250,
 857         MGMT_DISCONNECT,
 858         MGMT_EXCEPTION,         /* node died, etc. */
 859         MGMT_LAST_OPC
 860 } mgmt_cmd_t;
 861 #define MGMT_FIRST_OPC MGMT_CONNECT
 862
 863 /*
 864  * Opcodes for multiple servers.
 865  */
 866
 867 typedef enum {
 868         OBD_PING = 400,
 869         OBD_LOG_CANCEL,
 870         OBD_LAST_OPC
 871 } obd_cmd_t;
 872 #define OBD_FIRST_OPC OBD_PING
 873
 874 /* catalog of log objects */
 875
 876 /* Identifier for a single log object */
 877 struct llog_logid {
 878         __u64                   lgl_oid;
 879         __u64                   lgl_ogr;
 880         __u32                   lgl_ogen;
 881 } __attribute__((packed));
 882
 883 /* Records written to the CATALOGS list */
 884 #define CATLIST "CATALOGS"
 885 struct llog_catid {
 886         struct llog_logid       lci_logid;
 887         __u32                   lci_padding[3];
 888 } __attribute__((packed));
 889
 890 /* Log data record types - there is no specific reason that these need to
 891  * be related to the RPC opcodes, but no reason not to (may be handy later?)
 892  */
 893 typedef enum {
 894         OST_SZ_REC       = 0x10600000 | (OST_SAN_WRITE << 8),
 895         OST_RAID1_REC    = 0x10600000 | ((OST_SAN_WRITE + 1) << 8),
 896         MDS_UNLINK_REC   = 0x10610000 | (MDS_REINT << 8) | REINT_UNLINK,
 897         OBD_CFG_REC      = 0x10620000,
 898         PTL_CFG_REC      = 0x10630000,
 899         LLOG_GEN_REC     = 0x10640000,
 900         LLOG_HDR_MAGIC   = 0x10645539,
 901         LLOG_LOGID_MAGIC = 0x1064553b,
 902 } llog_op_type;
 903
 904 /* Log record header - stored in little endian order.
 905  * Each record must start with this struct, end with a llog_rec_tail,
 906  * and be a multiple of 256 bits in size.
 907  */
 908 struct llog_rec_hdr {
 909         __u32                   lrh_len;
 910         __u32                   lrh_index;
 911         __u32                   lrh_type;
 912         __u32                   padding;
 913 };
 914
 915 struct llog_rec_tail {
 916         __u32 lrt_len;
 917         __u32 lrt_index;
 918 };
 919
 920 struct llog_logid_rec {
 921         struct llog_rec_hdr     lid_hdr;
 922         struct llog_logid       lid_id;
 923         __u32                   padding[5];
 924         struct llog_rec_tail    lid_tail;
 925 } __attribute__((packed));
 926
 927 struct llog_create_rec {
 928         struct llog_rec_hdr     lcr_hdr;
 929         struct ll_fid           lcr_fid;
 930         obd_id                  lcr_oid;
 931         obd_count               lcr_ogen;
 932         __u32                   padding;
 933         struct llog_rec_tail    lcr_tail;
 934 } __attribute__((packed));
 935
 936 struct llog_orphan_rec {
 937         struct llog_rec_hdr     lor_hdr;
 938         obd_id                  lor_oid;
 939         obd_count               lor_ogen;
 940         __u32                   padding;
 941         struct llog_rec_tail    lor_tail;
 942 } __attribute__((packed));
 943
 944 struct llog_unlink_rec {
 945         struct llog_rec_hdr     lur_hdr;
 946         obd_id                  lur_oid;
 947         obd_count               lur_ogen;
 948         __u32                   padding;
 949         struct llog_rec_tail    lur_tail;
 950 } __attribute__((packed));
 951
 952 struct llog_size_change_rec {
 953         struct llog_rec_hdr     lsc_hdr;
 954         struct ll_fid           lsc_fid;
 955         __u32                   lsc_io_epoch;
 956         __u32                   padding;
 957         struct llog_rec_tail    lsc_tail;
 958 } __attribute__((packed));
 959
 960 struct llog_gen {
 961         __u64 mnt_cnt;
 962         __u64 conn_cnt;
 963 } __attribute__((packed));
 964
 965 struct llog_gen_rec {
 966         struct llog_rec_hdr     lgr_hdr;
 967         struct llog_gen         lgr_gen;
 968         struct llog_rec_tail    lgr_tail;
 969 };
 970 /* On-disk header structure of each log object, stored in little endian order */
 971 #define LLOG_CHUNK_SIZE         8192
 972 #define LLOG_HEADER_SIZE        (96)
 973 #define LLOG_BITMAP_BYTES       (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
 974
 975 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
 976
 977 /* flags for the logs */
 978 #define LLOG_F_ZAP_WHEN_EMPTY   0x1
 979 #define LLOG_F_IS_CAT           0x2
 980 #define LLOG_F_IS_PLAIN         0x4
 981
 982 struct llog_log_hdr {
 983         struct llog_rec_hdr     llh_hdr;
 984         __u64                   llh_timestamp;
 985         __u32                   llh_count;
 986         __u32                   llh_bitmap_offset;
 987         __u32                   llh_size;
 988         __u32                   llh_flags;
 989         __u32                   llh_cat_idx;
 990         /* for a catlog the first plain slot is next to it */
 991         struct obd_uuid         llh_tgtuuid;
 992         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
 993         __u32                   llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
 994         struct llog_rec_tail    llh_tail;
 995 } __attribute__((packed));
 996
 997 /* log cookies are used to reference a specific log file and a record therein */
 998 struct llog_cookie {
 999         struct llog_logid       lgc_lgl;
1000         __u32                   lgc_subsys;
1001         __u32                   lgc_index;
1002         __u32                   lgc_padding;
1003 } __attribute__((packed));
1004
1005 /* llog protocol */
1006 enum llogd_rpc_ops {
1007         LLOG_ORIGIN_HANDLE_CREATE       = 501,
1008         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
1009         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
1010         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
1011         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
1012         LLOG_ORIGIN_CONNECT             = 506,
1013         LLOG_CATINFO                    = 507,  /* for lfs catinfo */
1014 };
1015
1016 struct llogd_body {
1017         struct llog_logid  lgd_logid;
1018         __u32 lgd_ctxt_idx;
1019         __u32 lgd_llh_flags;
1020         __u32 lgd_index;
1021         __u32 lgd_saved_index;
1022         __u32 lgd_len;
1023         __u64 lgd_cur_offset;
1024 } __attribute__((packed));
1025
1026 struct llogd_conn_body {
1027         struct llog_gen         lgdc_gen;
1028         struct llog_logid       lgdc_logid;
1029         __u32                   lgdc_ctxt_idx;
1030 } __attribute__((packed));
1031
1032 extern void lustre_swab_llogd_body (struct llogd_body *d);
1033 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
1034 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
1035
1036 static inline struct ll_fid *obdo_fid(struct obdo *oa)
1037 {
1038         return (struct ll_fid *)(oa->o_inline + sizeof(struct lustre_handle) +
1039                                  sizeof(struct llog_cookie));
1040 }
1041
1042 #endif