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