lustre/include/linux/lustre_idl.h

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