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 /* initial pid  */
 141 #define LUSTRE_PTL_PID          999999
 142 #define LUSTRE_SRV_PTL_PID      LUSTRE_PTL_PID
 143
 144 struct lustre_handle {
 145         __u64 cookie;
 146 };
 147 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
 148
 149 /* we depend on this structure to be 8-byte aligned */
 150 /* this type is only endian-adjusted in lustre_unpack_msg() */
 151 struct lustre_msg {
 152         struct lustre_handle handle;
 153         __u32 magic;
 154         __u32 type;
 155         __u32 version;
 156         __u32 opc;
 157         __u64 last_xid;
 158         __u64 last_committed;
 159         __u64 transno;
 160         __u32 status;
 161         __u32 flags;
 162         __u32 conn_cnt;
 163         __u32 bufcount;
 164         __u32 buflens[0];
 165 };
 166
 167 /* Flags that are operation-specific go in the top 16 bits. */
 168 #define MSG_OP_FLAG_MASK   0xffff0000
 169 #define MSG_OP_FLAG_SHIFT  16
 170
 171 /* Flags that apply to all requests are in the bottom 16 bits */
 172 #define MSG_GEN_FLAG_MASK      0x0000ffff
 173 #define MSG_LAST_REPLAY        1
 174 #define MSG_RESENT             2
 175 #define MSG_REPLAY             4
 176
 177 static inline int lustre_msg_get_flags(struct lustre_msg *msg)
 178 {
 179         return (msg->flags & MSG_GEN_FLAG_MASK);
 180 }
 181
 182 static inline void lustre_msg_add_flags(struct lustre_msg *msg, int flags)
 183 {
 184         msg->flags |= MSG_GEN_FLAG_MASK & flags;
 185 }
 186
 187 static inline void lustre_msg_set_flags(struct lustre_msg *msg, int flags)
 188 {
 189         msg->flags &= ~MSG_GEN_FLAG_MASK;
 190         lustre_msg_add_flags(msg, flags);
 191 }
 192
 193 static inline void lustre_msg_clear_flags(struct lustre_msg *msg, int flags)
 194 {
 195         msg->flags &= ~(MSG_GEN_FLAG_MASK & flags);
 196 }
 197
 198 static inline int lustre_msg_get_op_flags(struct lustre_msg *msg)
 199 {
 200         return (msg->flags >> MSG_OP_FLAG_SHIFT);
 201 }
 202
 203 static inline void lustre_msg_add_op_flags(struct lustre_msg *msg, int flags)
 204 {
 205         msg->flags |= ((flags & MSG_GEN_FLAG_MASK) << MSG_OP_FLAG_SHIFT);
 206 }
 207
 208 static inline void lustre_msg_set_op_flags(struct lustre_msg *msg, int flags)
 209 {
 210         msg->flags &= ~MSG_OP_FLAG_MASK;
 211         lustre_msg_add_op_flags(msg, flags);
 212 }
 213
 214 /*
 215  * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
 216  */
 217
 218 #define MSG_CONNECT_RECOVERING  0x1
 219 #define MSG_CONNECT_RECONNECT   0x2
 220 #define MSG_CONNECT_REPLAYABLE  0x4
 221 //#define MSG_CONNECT_PEER        0x8
 222 #define MSG_CONNECT_LIBCLIENT   0x10
 223 #define MSG_CONNECT_INITIAL     0x20
 224
 225 /*
 226  *   OST requests: OBDO & OBD request records
 227  */
 228
 229 /* opcodes */
 230 typedef enum {
 231         OST_REPLY      =  0,       /* reply ? */
 232         OST_GETATTR    =  1,
 233         OST_SETATTR    =  2,
 234         OST_READ       =  3,
 235         OST_WRITE      =  4,
 236         OST_CREATE     =  5,
 237         OST_DESTROY    =  6,
 238         OST_GET_INFO   =  7,
 239         OST_CONNECT    =  8,
 240         OST_DISCONNECT =  9,
 241         OST_PUNCH      = 10,
 242         OST_OPEN       = 11,
 243         OST_CLOSE      = 12,
 244         OST_STATFS     = 13,
 245         OST_SAN_READ   = 14,
 246         OST_SAN_WRITE  = 15,
 247         OST_SYNC       = 16,
 248         OST_SET_INFO   = 17,
 249         OST_LAST_OPC
 250 } ost_cmd_t;
 251 #define OST_FIRST_OPC  OST_REPLY
 252
 253 typedef uint64_t        obd_id;
 254 typedef uint64_t        obd_gr;
 255 typedef uint64_t        obd_time;
 256 typedef uint64_t        obd_size;
 257 typedef uint64_t        obd_off;
 258 typedef uint64_t        obd_blocks;
 259 typedef uint32_t        obd_blksize;
 260 typedef uint32_t        obd_mode;
 261 typedef uint32_t        obd_uid;
 262 typedef uint32_t        obd_gid;
 263 typedef uint32_t        obd_flag;
 264 typedef uint32_t        obd_count;
 265
 266 #define OBD_FL_INLINEDATA   (0x00000001)
 267 #define OBD_FL_OBDMDEXISTS  (0x00000002)
 268 #define OBD_FL_DELORPHAN    (0x00000004) /* if set in o_flags delete orphans */
 269 #define OBD_FL_NORPC        (0x00000008) // if set in o_flags set in OSC not OST
 270 #define OBD_FL_IDONLY       (0x00000010) // if set in o_flags only adjust obj id
 271 #define OBD_FL_RECREATE_OBJS (0x00000020) // recreate missing obj
 272
 273 #define OBD_INLINESZ    64
 274
 275 /* Note: 64-bit types are 64-bit aligned in structure */
 276 struct obdo {
 277         obd_id                  o_id;
 278         obd_gr                  o_gr;
 279         obd_time                o_atime;
 280         obd_time                o_mtime;
 281         obd_time                o_ctime;
 282         obd_size                o_size;
 283         obd_blocks              o_blocks;       /* brw: cli sent cached bytes */
 284         obd_size                o_grant;
 285         obd_blksize             o_blksize;      /* optimal IO blocksize */
 286         obd_mode                o_mode;         /* brw: cli sent cache remain */
 287         obd_uid                 o_uid;
 288         obd_gid                 o_gid;
 289         obd_flag                o_flags;
 290         obd_count               o_nlink;        /* brw: checksum */
 291         obd_count               o_generation;
 292         obd_flag                o_valid;        /* hot fields in this obdo */
 293         obd_count               o_misc;
 294         __u32                   o_easize;       /* epoch in ost writes */
 295         __u32                   o_mds;
 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_FLNOTOBD (~(OBD_MD_FLBLOCKS | OBD_MD_LINKNAME|\
 382                            OBD_MD_FLEASIZE | OBD_MD_FLHANDLE | OBD_MD_FLCKSUM|\
 383                            OBD_MD_FLQOS | OBD_MD_FLOSCOPQ | OBD_MD_FLCOOKIE|\
 384                            OBD_MD_MDS))
 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 /* offsets in the request */
 474 #define MDS_REQ_SECDESC_OFF             0
 475 #define MDS_REQ_REC_OFF                 1
 476
 477 #define MDS_REQ_INTENT_LOCKREQ_OFF      1
 478 #define MDS_REQ_INTENT_IT_OFF           2
 479 #define MDS_REQ_INTENT_REC_OFF          3
 480
 481 /* maximum supplementary groups */
 482 #define LUSTRE_MAX_GROUPS               128
 483
 484 /*
 485  * security descriptor in mds request
 486  *
 487  * note gid & cap might need be removed later:
 488  *  - cap should be obtained on mds
 489  *  - gid is actually not used.
 490  */
 491 struct mds_req_sec_desc {
 492         __u32           rsd_uid;
 493         __u32           rsd_gid;
 494         __u32           rsd_fsuid;
 495         __u32           rsd_fsgid;
 496         __u32           rsd_cap;
 497         __u32           rsd_ngroups;
 498         __u32           rsd_groups[0];
 499 };
 500
 501 struct ptlrpc_request;
 502 struct mds_req_sec_desc *lustre_swab_mds_secdesc(struct ptlrpc_request *req,
 503                                                  int offset);
 504
 505 /* opcodes */
 506 typedef enum {
 507         MDS_GETATTR      = 33,
 508         MDS_GETATTR_NAME = 34,
 509         MDS_CLOSE        = 35,
 510         MDS_REINT        = 36,
 511         MDS_READPAGE     = 37,
 512         MDS_CONNECT      = 38,
 513         MDS_DISCONNECT   = 39,
 514         MDS_GETSTATUS    = 40,
 515         MDS_STATFS       = 41,
 516         MDS_PIN          = 42,
 517         MDS_UNPIN        = 43,
 518         MDS_SYNC         = 44,
 519         MDS_DONE_WRITING = 45,
 520         MDS_LAST_OPC
 521 } mds_cmd_t;
 522
 523 #define MDS_FIRST_OPC    MDS_GETATTR
 524
 525 /*
 526  * Do not exceed 63
 527  */
 528
 529 #define REINT_SETATTR    1
 530 #define REINT_CREATE     2
 531 #define REINT_LINK       3
 532 #define REINT_UNLINK     4
 533 #define REINT_RENAME     5
 534 #define REINT_OPEN       6
 535 #define REINT_CLOSE      7
 536 #define REINT_WRITE      8
 537 #define REINT_MAX        8
 538
 539 /* the disposition of the intent outlines what was executed */
 540 #define DISP_IT_EXECD   1
 541 #define DISP_LOOKUP_EXECD  (1 << 1)
 542 #define DISP_LOOKUP_NEG     (1 << 2)
 543 #define DISP_LOOKUP_POS     (1 << 3)
 544 #define DISP_OPEN_CREATE  (1 << 4)
 545 #define DISP_OPEN_OPEN    (1 << 5)
 546 #define DISP_ENQ_COMPLETE (1<<6)
 547
 548 /* INODE LOCK PARTS */
 549 #define MDS_INODELOCK_LOOKUP 0x000001       /* dentry, mode, owner, group */
 550 #define MDS_INODELOCK_UPDATE 0x000002       /* size, links, timestamps */
 551 //#define MDS_INODELOCK_MAXSHIFT 1
 552 //#define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
 553
 554 struct ll_fid {
 555         __u64 id;
 556         __u32 generation;
 557         __u32 f_type;
 558         __u32 mds;
 559         __u32 padding;
 560 };
 561
 562 struct mea_old {
 563         __u32 mea_count;
 564         __u32 mea_master;
 565         struct ll_fid mea_fids[0];
 566 };
 567
 568 #define MEA_MAGIC_LAST_CHAR      0xb2221ca1
 569 #define MEA_MAGIC_ALL_CHARS      0xb222a11c
 570
 571 struct mea {
 572         __u32 mea_magic;
 573         __u32 mea_count;
 574         __u32 mea_master;
 575         struct ll_fid mea_fids[0];
 576 };
 577
 578 extern void lustre_swab_ll_fid (struct ll_fid *fid);
 579
 580 #define MDS_STATUS_CONN 1
 581 #define MDS_STATUS_LOV 2
 582
 583 struct mds_status_req {
 584         __u32  flags;
 585         __u32  repbuf;
 586 };
 587
 588 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
 589
 590 #define MDS_BFLAG_UNCOMMITTED_WRITES   0x1
 591
 592 struct mds_body {
 593         struct ll_fid  fid1;
 594         struct ll_fid  fid2;
 595         struct lustre_handle handle;
 596         __u64          size;   /* Offset, in the case of MDS_READPAGE */
 597         __u64          blocks; /* XID, in the case of MDS_READPAGE */
 598         __u64          io_epoch;
 599         __u32          ino;   /* make this a __u64 */
 600         __u32          valid;
 601         __u32          mode;
 602         __u32          uid;
 603         __u32          gid;
 604         __u32          mtime;
 605         __u32          ctime;
 606         __u32          atime;
 607         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
 608         __u32          rdev;
 609         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
 610         __u32          generation;
 611         __u32          eadatasize;
 612         __u32          mds;
 613 };
 614
 615 extern void lustre_swab_mds_body (struct mds_body *b);
 616
 617 struct lustre_md {
 618         struct mds_body *body;
 619         struct lov_stripe_md *lsm;
 620         struct mea *mea;
 621 };
 622
 623 struct mdc_op_data {
 624         struct ll_fid fid1;
 625         struct ll_fid fid2;
 626         __u64 mod_time;
 627         const char *name;
 628         int namelen;
 629         __u32 create_mode;
 630         struct mea *mea1;       /* mea of inode1 */
 631         struct mea *mea2;       /* mea of inode2 */
 632 };
 633
 634 #define MDS_MODE_DONT_LOCK      (1 << 30)
 635 #define MDS_MODE_REPLAY         (1 << 31)
 636
 637 struct mds_rec_setattr {
 638         __u32           sa_opcode;
 639         __u32           sa_valid;
 640         struct ll_fid   sa_fid;
 641         __u32           sa_mode;
 642         __u32           sa_uid;
 643         __u32           sa_gid;
 644         __u32           sa_attr_flags;
 645         __u64           sa_size;
 646         __u64           sa_atime;
 647         __u64           sa_mtime;
 648         __u64           sa_ctime;
 649 };
 650
 651 /* Remove this once we declare it in include/linux/fs.h (v21 kernel patch?) */
 652 #ifndef ATTR_CTIME_SET
 653 #define ATTR_CTIME_SET 0x2000
 654 #endif
 655
 656 extern void lustre_swab_mds_rec_setattr (struct mds_rec_setattr *sa);
 657
 658 #ifndef FMODE_READ
 659 #define FMODE_READ               00000001
 660 #define FMODE_WRITE              00000002
 661 #endif
 662 #ifndef FMODE_EXEC
 663 #define FMODE_EXEC               00000004
 664 #endif
 665 #define MDS_OPEN_CREAT           00000100
 666 #define MDS_OPEN_EXCL            00000200
 667 #define MDS_OPEN_TRUNC           00001000
 668 #define MDS_OPEN_APPEND          00002000
 669 #define MDS_OPEN_SYNC            00010000
 670 #define MDS_OPEN_DIRECTORY       00200000
 671
 672 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
 673 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
 674 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
 675
 676 struct mds_rec_create {
 677         __u32           cr_opcode;
 678         __u32           cr_flags; /* for use with open */
 679         __u32           cr_mode;
 680         __u32           cr_padding;
 681         struct ll_fid   cr_fid;
 682         struct ll_fid   cr_replayfid;
 683         __u64           cr_time;
 684         __u64           cr_rdev;
 685 };
 686
 687 extern void lustre_swab_mds_rec_create (struct mds_rec_create *cr);
 688
 689 struct mds_rec_link {
 690         __u32           lk_opcode;
 691         __u32           lk_padding;
 692         struct ll_fid   lk_fid1;
 693         struct ll_fid   lk_fid2;
 694         __u64           lk_time;
 695 };
 696
 697 extern void lustre_swab_mds_rec_link (struct mds_rec_link *lk);
 698
 699 struct mds_rec_unlink {
 700         __u32           ul_opcode;
 701         __u32           ul_mode;
 702         struct ll_fid   ul_fid1;
 703         struct ll_fid   ul_fid2;
 704         __u64           ul_time;
 705 };
 706
 707 extern void lustre_swab_mds_rec_unlink (struct mds_rec_unlink *ul);
 708
 709 struct mds_rec_rename {
 710         __u32           rn_opcode;
 711         __u32           rn_padding;
 712         struct ll_fid   rn_fid1;
 713         struct ll_fid   rn_fid2;
 714         __u64           rn_time;
 715 };
 716
 717 extern void lustre_swab_mds_rec_rename (struct mds_rec_rename *rn);
 718
 719 /*
 720  *  LOV data structures
 721  */
 722
 723 #define LOV_MAX_UUID_BUFFER_SIZE  8192
 724 /* The size of the buffer the lov/mdc reserves for the
 725  * array of UUIDs returned by the MDS.  With the current
 726  * protocol, this will limit the max number of OSTs per LOV */
 727
 728 struct lov_desc {
 729         __u32 ld_tgt_count;                /* how many OBD's */
 730         __u32 ld_active_tgt_count;         /* how many active */
 731         __u32 ld_default_stripe_count;     /* how many objects are used */
 732         __u32 ld_pattern;                  /* PATTERN_RAID0, PATTERN_RAID1 */
 733         __u64 ld_default_stripe_size;      /* in bytes */
 734         __u64 ld_default_stripe_offset;    /* in bytes */
 735         struct obd_uuid ld_uuid;
 736 };
 737
 738 struct lmv_desc {
 739         __u32 ld_tgt_count;                /* how many MDS's */
 740         __u32 ld_active_tgt_count;         /* how many active */
 741         struct obd_uuid ld_uuid;
 742 };
 743
 744 extern void lustre_swab_lov_desc (struct lov_desc *ld);
 745
 746 /*
 747  *   LDLM requests:
 748  */
 749 /* opcodes -- MUST be distinct from OST/MDS opcodes */
 750 typedef enum {
 751         LDLM_ENQUEUE     = 101,
 752         LDLM_CONVERT     = 102,
 753         LDLM_CANCEL      = 103,
 754         LDLM_BL_CALLBACK = 104,
 755         LDLM_CP_CALLBACK = 105,
 756         LDLM_GL_CALLBACK = 106,
 757         LDLM_LAST_OPC
 758 } ldlm_cmd_t;
 759 #define LDLM_FIRST_OPC LDLM_ENQUEUE
 760
 761 #define RES_NAME_SIZE 4
 762 struct ldlm_res_id {
 763         __u64 name[RES_NAME_SIZE];
 764 };
 765
 766 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
 767
 768 /* lock types */
 769 typedef enum {
 770         LCK_EX = 1,
 771         LCK_PW = 2,
 772         LCK_PR = 4,
 773         LCK_CW = 8,
 774         LCK_CR = 16,
 775         LCK_NL = 32,
 776         LCK_GROUP = 64
 777 } ldlm_mode_t;
 778
 779 struct ldlm_extent {
 780         __u64 start;
 781         __u64 end;
 782         __u64 gid;
 783 };
 784 struct ldlm_inodebits {
 785         __u64 bits;
 786 };
 787
 788 struct ldlm_flock {
 789         __u64 start;
 790         __u64 end;
 791         __u64 pid;
 792         __u64 blocking_pid;
 793         __u64 blocking_export;
 794 };
 795
 796 /* it's important that the fields of the ldlm_extent structure match
 797  * the first fields of the ldlm_flock structure because there is only
 798  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
 799  * this ever changes we will need to swab the union differently based
 800  * on the resource type. */
 801
 802 typedef union {
 803         struct ldlm_extent l_extent;
 804         struct ldlm_flock  l_flock;
 805         struct ldlm_inodebits l_inodebits;
 806 } ldlm_policy_data_t;
 807
 808 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
 809
 810 struct ldlm_intent {
 811         __u64 opc;
 812 };
 813
 814 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
 815
 816 struct ldlm_resource_desc {
 817         __u32 lr_type;
 818         __u32 lr_padding;
 819         struct ldlm_res_id lr_name;
 820 };
 821
 822 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
 823
 824 struct ldlm_lock_desc {
 825         struct ldlm_resource_desc l_resource;
 826         ldlm_mode_t l_req_mode;
 827         ldlm_mode_t l_granted_mode;
 828         ldlm_policy_data_t l_policy_data;
 829 };
 830
 831 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
 832
 833 struct ldlm_request {
 834         __u32 lock_flags;
 835         __u32 lock_padding;
 836         struct ldlm_lock_desc lock_desc;
 837         struct lustre_handle lock_handle1;
 838         struct lustre_handle lock_handle2;
 839 };
 840
 841 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
 842
 843 struct ldlm_reply {
 844         __u32 lock_flags;
 845         __u32 lock_padding;
 846         struct ldlm_lock_desc lock_desc;
 847         struct lustre_handle lock_handle;
 848         __u64  lock_policy_res1;
 849         __u64  lock_policy_res2;
 850 };
 851
 852 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
 853
 854 /*
 855  * ptlbd, portal block device requests
 856  */
 857 typedef enum {
 858         PTLBD_QUERY = 200,
 859         PTLBD_READ = 201,
 860         PTLBD_WRITE = 202,
 861         PTLBD_FLUSH = 203,
 862         PTLBD_CONNECT = 204,
 863         PTLBD_DISCONNECT = 205,
 864         PTLBD_LAST_OPC
 865 } ptlbd_cmd_t;
 866 #define PTLBD_FIRST_OPC PTLBD_QUERY
 867
 868 struct ptlbd_op {
 869         __u16 op_cmd;
 870         __u16 op_lun;
 871         __u16 op_niob_cnt;
 872         __u16 op__padding;
 873         __u32 op_block_cnt;
 874 };
 875
 876 extern void lustre_swab_ptlbd_op (struct ptlbd_op *op);
 877
 878 struct ptlbd_niob {
 879         __u64 n_xid;
 880         __u64 n_block_nr;
 881         __u32 n_offset;
 882         __u32 n_length;
 883 };
 884
 885 extern void lustre_swab_ptlbd_niob (struct ptlbd_niob *n);
 886
 887 struct ptlbd_rsp {
 888         __u16 r_status;
 889         __u16 r_error_cnt;
 890 };
 891
 892 extern void lustre_swab_ptlbd_rsp (struct ptlbd_rsp *r);
 893
 894 #define CLONE_INFO_MAGIC 0x0218
 895 struct clonefs_info {
 896         int clone_magic;
 897         int clone_index;
 898         int clone_flags;
 899 };
 900 extern void lustre_swab_clonefs_info(struct clonefs_info *clone);
 901 /*
 902  * Opcodes for management/monitoring node.
 903  */
 904 typedef enum {
 905         MGMT_CONNECT = 250,
 906         MGMT_DISCONNECT,
 907         MGMT_EXCEPTION,         /* node died, etc. */
 908         MGMT_LAST_OPC
 909 } mgmt_cmd_t;
 910 #define MGMT_FIRST_OPC MGMT_CONNECT
 911
 912 /*
 913  * Opcodes for multiple servers.
 914  */
 915
 916 typedef enum {
 917         OBD_PING = 400,
 918         OBD_LOG_CANCEL,
 919         OBD_LAST_OPC
 920 } obd_cmd_t;
 921 #define OBD_FIRST_OPC OBD_PING
 922
 923 /* catalog of log objects */
 924
 925 /* Identifier for a single log object */
 926 struct llog_logid {
 927         __u64                   lgl_oid;
 928         __u64                   lgl_ogr;
 929         __u32                   lgl_ogen;
 930 } __attribute__((packed));
 931
 932 /* Records written to the CATALOGS list */
 933 #define CATLIST "CATALOGS"
 934 struct llog_catid {
 935         struct llog_logid       lci_logid;
 936         __u32                   lci_padding[3];
 937 } __attribute__((packed));
 938
 939 /* Log data record types - there is no specific reason that these need to
 940  * be related to the RPC opcodes, but no reason not to (may be handy later?)
 941  */
 942 typedef enum {
 943         OST_SZ_REC       = 0x10600000 | (OST_SAN_WRITE << 8),
 944         OST_RAID1_REC    = 0x10600000 | ((OST_SAN_WRITE + 1) << 8),
 945         MDS_UNLINK_REC   = 0x10610000 | (MDS_REINT << 8) | REINT_UNLINK,
 946         OBD_CFG_REC      = 0x10620000,
 947         PTL_CFG_REC      = 0x10630000,
 948         LLOG_GEN_REC     = 0x10640000,
 949         LLOG_HDR_MAGIC   = 0x10645539,
 950         LLOG_LOGID_MAGIC = 0x1064553b,
 951         SMFS_UPDATE_REC  = 0x10650000,
 952         CACHE_LRU_REC    = 0x10660000,
 953 } llog_op_type;
 954
 955 /* Log record header - stored in little endian order.
 956  * Each record must start with this struct, end with a llog_rec_tail,
 957  * and be a multiple of 256 bits in size.
 958  */
 959 struct llog_rec_hdr {
 960         __u32                   lrh_len;
 961         __u32                   lrh_index;
 962         __u32                   lrh_type;
 963         __u32                   padding;
 964 };
 965
 966 struct llog_rec_tail {
 967         __u32 lrt_len;
 968         __u32 lrt_index;
 969 };
 970
 971 struct llog_logid_rec {
 972         struct llog_rec_hdr     lid_hdr;
 973         struct llog_logid       lid_id;
 974         __u32                   padding[5];
 975         struct llog_rec_tail    lid_tail;
 976 } __attribute__((packed));
 977
 978 struct llog_create_rec {
 979         struct llog_rec_hdr     lcr_hdr;
 980         struct ll_fid           lcr_fid;
 981         obd_id                  lcr_oid;
 982         obd_count               lcr_ogen;
 983         __u32                   padding;
 984         struct llog_rec_tail    lcr_tail;
 985 } __attribute__((packed));
 986
 987 struct llog_orphan_rec {
 988         struct llog_rec_hdr     lor_hdr;
 989         obd_id                  lor_oid;
 990         obd_count               lor_ogen;
 991         __u32                   padding;
 992         struct llog_rec_tail    lor_tail;
 993 } __attribute__((packed));
 994
 995 struct llog_unlink_rec {
 996         struct llog_rec_hdr     lur_hdr;
 997         obd_id                  lur_oid;
 998         obd_count               lur_ogen;
 999         __u32                   padding;
1000         struct llog_rec_tail    lur_tail;
1001 } __attribute__((packed));
1002
1003 struct llog_size_change_rec {
1004         struct llog_rec_hdr     lsc_hdr;
1005         struct ll_fid           lsc_fid;
1006         __u32                   lsc_io_epoch;
1007         __u32                   padding;
1008         struct llog_rec_tail    lsc_tail;
1009 } __attribute__((packed));
1010
1011 struct llog_gen {
1012         __u64 mnt_cnt;
1013         __u64 conn_cnt;
1014 };
1015
1016 struct llog_gen_rec {
1017         struct llog_rec_hdr     lgr_hdr;
1018         struct llog_gen         lgr_gen;
1019         struct llog_rec_tail    lgr_tail;
1020 } __attribute__((packed));
1021
1022 struct llog_lru_rec {
1023         struct llog_rec_hdr     llr_hdr;
1024         struct ll_fid           llr_cfid;
1025         struct ll_fid           llr_pfid;
1026         struct llog_rec_tail    llr_tail;
1027 } __attribute__((packed));
1028
1029 /* On-disk header structure of each log object, stored in little endian order */
1030 #define LLOG_CHUNK_SIZE         8192
1031 #define LLOG_HEADER_SIZE        (96)
1032 #define LLOG_BITMAP_BYTES       (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
1033
1034 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
1035
1036 /* flags for the logs */
1037 #define LLOG_F_ZAP_WHEN_EMPTY   0x1
1038 #define LLOG_F_IS_CAT           0x2
1039 #define LLOG_F_IS_PLAIN         0x4
1040
1041 struct llog_log_hdr {
1042         struct llog_rec_hdr     llh_hdr;
1043         __u64                   llh_timestamp;
1044         __u32                   llh_count;
1045         __u32                   llh_bitmap_offset;
1046         __u32                   llh_size;
1047         __u32                   llh_flags;
1048         __u32                   llh_cat_idx;
1049         /* for a catalog the first plain slot is next to it */
1050         struct obd_uuid         llh_tgtuuid;
1051         __u32                 llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
1052         __u32                   llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
1053         struct llog_rec_tail    llh_tail;
1054 } __attribute__((packed));
1055
1056 #define LLOG_BITMAP_SIZE(llh)  ((llh->llh_hdr.lrh_len -         \
1057                                  llh->llh_bitmap_offset -       \
1058                                  sizeof(llh->llh_tail)) * 8)
1059
1060 /* log cookies are used to reference a specific log file and a record therein */
1061 struct llog_cookie {
1062         struct llog_logid       lgc_lgl;
1063         __u32                   lgc_subsys;
1064         __u32                   lgc_index;
1065         __u32                   lgc_flags;
1066 } __attribute__((packed));
1067
1068 /* llog protocol */
1069 enum llogd_rpc_ops {
1070         LLOG_ORIGIN_HANDLE_OPEN         = 501,
1071         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
1072         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
1073         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
1074         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
1075         LLOG_ORIGIN_CONNECT             = 506,
1076         LLOG_CATINFO                    = 507,  /* for lfs catinfo */
1077         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
1078 };
1079
1080 struct llogd_body {
1081         struct llog_logid  lgd_logid;
1082         __u32 lgd_ctxt_idx;
1083         __u32 lgd_llh_flags;
1084         __u32 lgd_index;
1085         __u32 lgd_saved_index;
1086         __u32 lgd_len;
1087         __u64 lgd_cur_offset;
1088 } __attribute__((packed));
1089
1090 struct llogd_conn_body {
1091         struct llog_gen         lgdc_gen;
1092         struct llog_logid       lgdc_logid;
1093         __u32                   lgdc_ctxt_idx;
1094 } __attribute__((packed));
1095
1096 extern void lustre_swab_llogd_body (struct llogd_body *d);
1097 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
1098 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
1099
1100 static inline struct ll_fid *obdo_fid(struct obdo *oa)
1101 {
1102         return (struct ll_fid *)(oa->o_inline + sizeof(struct lustre_handle) +
1103                                  sizeof(struct llog_cookie));
1104 }
1105
1106 #endif