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