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