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