lustre/include/lustre/lustre_idl.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *   This file is part of Lustre, http://www.lustre.org
   5  *
   6  * Lustre wire protocol definitions.
   7  *
   8  *
   9  * We assume all nodes are either little-endian or big-endian, and we
  10  * always send messages in the sender's native format.  The receiver
  11  * detects the message format by checking the 'magic' field of the message
  12  * (see lustre_msg_swabbed() below).
  13  * ALL structs passing over the wire should be declared here.  Structs
  14  * that are used in interfaces with userspace should go in lustre_user.h.
  15  *
  16  * All structs being declared here should be built from simple fixed-size
  17  * types (__u8, __u16, __u32, __u64) or be built from other types or
  18  * structs also declared in this file.  Similarly, all flags and magic
  19  * values in those structs should also be declared here.  This ensures
  20  * that the Lustre wire protocol is not influenced by external dependencies.
  21  *
  22  * The only other acceptable items in this file are VERY SIMPLE accessor
  23  * functions to avoid callers grubbing inside the structures, and the
  24  * prototypes of the swabber functions for each struct.  Nothing that
  25  * depends on external functions or definitions should be in here.
  26  *
  27  * Structs must be properly aligned to put 64-bit values on an 8-byte
  28  * boundary.  Any structs being added here must also be added to
  29  * utils/wirecheck.c and "make newwiretest" run to regenerate the
  30  * utils/wiretest.c sources.  This allows us to verify that wire structs
  31  * have the proper alignment/size on all architectures.
  32  *
  33  * DO NOT CHANGE any of the structs, flags, values declared here and used
  34  * in released Lustre versions.  Some structs may have padding fields that
  35  * can be used.  Some structs might allow addition at the end (verify this
  36  * in the code to ensure that new/old clients that see this larger struct
  37  * do not fail, otherwise you need to implement protocol compatibility).
  38  *
  39  * Each wire type has corresponding 'lustre_swab_xxxtypexxx()' routines,
  40  * implemented either here, inline (trivial implementations) or in
  41  * ptlrpc/pack_generic.c.  These 'swabbers' convert the type from "other"
  42  * endian, in-place in the message buffer.
  43  *
  44  * A swabber takes a single pointer argument.  The caller must already have
  45  * verified that the length of the message buffer >= sizeof (type).
  46  *
  47  * For variable length types, a second 'lustre_swab_v_xxxtypexxx()' routine
  48  * may be defined that swabs just the variable part, after the caller has
  49  * verified that the message buffer is large enough.
  50  */
  51
  52 #ifndef _LUSTRE_IDL_H_
  53 #define _LUSTRE_IDL_H_
  54
  55 #include <libcfs/kp30.h>
  56
  57 #if defined(__linux__)
  58 #include <linux/lustre_types.h>
  59 #elif defined(__APPLE__)
  60 #include <darwin/lustre_types.h>
  61 #elif defined(__WINNT__)
  62 #include <winnt/lustre_types.h>
  63 #else
  64 #error Unsupported operating system.
  65 #endif
  66
  67 /* Defn's shared with user-space. */
  68 #include <lustre/lustre_user.h>
  69
  70 /*
  71  *  GENERAL STUFF
  72  */
  73 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
  74  * FOO_REPLY_PORTAL   is for incoming replies on the FOO
  75  * FOO_BULK_PORTAL    is for incoming bulk on the FOO
  76  */
  77
  78 #define CONNMGR_REQUEST_PORTAL          1
  79 #define CONNMGR_REPLY_PORTAL            2
  80 //#define OSC_REQUEST_PORTAL            3
  81 #define OSC_REPLY_PORTAL                4
  82 //#define OSC_BULK_PORTAL               5
  83 #define OST_IO_PORTAL                   6
  84 #define OST_CREATE_PORTAL               7
  85 #define OST_BULK_PORTAL                 8
  86 //#define MDC_REQUEST_PORTAL            9
  87 #define MDC_REPLY_PORTAL               10
  88 //#define MDC_BULK_PORTAL              11
  89 #define MDS_REQUEST_PORTAL             12
  90 //#define MDS_REPLY_PORTAL             13
  91 #define MDS_BULK_PORTAL                14
  92 #define LDLM_CB_REQUEST_PORTAL         15
  93 #define LDLM_CB_REPLY_PORTAL           16
  94 #define LDLM_CANCEL_REQUEST_PORTAL     17
  95 #define LDLM_CANCEL_REPLY_PORTAL       18
  96 //#define PTLBD_REQUEST_PORTAL           19
  97 //#define PTLBD_REPLY_PORTAL             20
  98 //#define PTLBD_BULK_PORTAL              21
  99 #define MDS_SETATTR_PORTAL             22
 100 #define MDS_READPAGE_PORTAL            23
 101 #define MDS_MDS_PORTAL                 24
 102
 103 #define MGC_REPLY_PORTAL               25
 104 #define MGS_REQUEST_PORTAL             26
 105 #define MGS_REPLY_PORTAL               27
 106 #define OST_REQUEST_PORTAL             28
 107 #define FLD_REQUEST_PORTAL             29
 108 #define SEQ_METADATA_PORTAL            30
 109 #define SEQ_DATA_PORTAL                31
 110 #define SEQ_CONTROLLER_PORTAL          32
 111
 112 #define SVC_KILLED               1
 113 #define SVC_EVENT                2
 114 #define SVC_SIGNAL               4
 115 #define SVC_RUNNING              8
 116 #define SVC_STOPPING            16
 117 #define SVC_STOPPED             32
 118
 119 /* packet types */
 120 #define PTL_RPC_MSG_REQUEST 4711
 121 #define PTL_RPC_MSG_ERR     4712
 122 #define PTL_RPC_MSG_REPLY   4713
 123
 124 /* DON'T use swabbed values of MAGIC as magic! */
 125 #define LUSTRE_MSG_MAGIC_V1 0x0BD00BD0
 126 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
 127
 128 #define LUSTRE_MSG_MAGIC_V1_SWABBED 0xD00BD00B
 129 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
 130
 131 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
 132
 133 #define PTLRPC_MSG_VERSION  0x00000003
 134 #define LUSTRE_VERSION_MASK 0xffff0000
 135 #define LUSTRE_OBD_VERSION  0x00010000
 136 #define LUSTRE_MDS_VERSION  0x00020000
 137 #define LUSTRE_OST_VERSION  0x00030000
 138 #define LUSTRE_DLM_VERSION  0x00040000
 139 #define LUSTRE_LOG_VERSION  0x00050000
 140 #define LUSTRE_MGS_VERSION  0x00060000
 141
 142 typedef __u64 mdsno_t;
 143 typedef __u64 seqno_t;
 144
 145 struct lu_range {
 146         __u64 lr_start;
 147         __u64 lr_end;
 148 };
 149
 150 static inline __u64 range_space(struct lu_range *r)
 151 {
 152         return r->lr_end - r->lr_start;
 153 }
 154
 155 static inline void range_zero(struct lu_range *r)
 156 {
 157         r->lr_start = r->lr_end = 0;
 158 }
 159
 160 static inline int range_within(struct lu_range *r,
 161                                __u64 s)
 162 {
 163         return s >= r->lr_start && s < r->lr_end;
 164 }
 165
 166 static inline void range_alloc(struct lu_range *r,
 167                                struct lu_range *s,
 168                                __u64 w)
 169 {
 170         r->lr_start = s->lr_start;
 171         r->lr_end = s->lr_start + w;
 172         s->lr_start += w;
 173 }
 174
 175 static inline int range_is_sane(struct lu_range *r)
 176 {
 177         return (r->lr_end >= r->lr_start);
 178 }
 179
 180 static inline int range_is_zero(struct lu_range *r)
 181 {
 182         return (r->lr_start == 0 && r->lr_end == 0);
 183 }
 184
 185 static inline int range_is_exhausted(struct lu_range *r)
 186 {
 187         return range_space(r) == 0;
 188 }
 189
 190 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x]"
 191
 192 #define PRANGE(range)      \
 193         (range)->lr_start, \
 194         (range)->lr_end
 195
 196 struct lu_fid {
 197         __u64 f_seq;  /* holds fid sequence. Lustre should support 2 ^ 64
 198                        * objects, thus even if one sequence has one object we
 199                        * reach this value. */
 200         __u32 f_oid;  /* fid number within its sequence. */
 201         __u32 f_ver;  /* holds fid version. */
 202 };
 203
 204 /*
 205  * fid constants
 206  */
 207 enum {
 208         LUSTRE_ROOT_FID_SEQ  = 1ULL, /* XXX: should go into mkfs. */
 209
 210         /* initial fid id value */
 211         LUSTRE_FID_INIT_OID  = 1UL
 212 };
 213
 214 /* get object sequence */
 215 static inline __u64 fid_seq(const struct lu_fid *fid)
 216 {
 217         return fid->f_seq;
 218 }
 219
 220 /* get object id */
 221 static inline __u32 fid_oid(const struct lu_fid *fid)
 222 {
 223         return fid->f_oid;
 224 }
 225
 226 /* get object version */
 227 static inline __u32 fid_ver(const struct lu_fid *fid)
 228 {
 229         return fid->f_ver;
 230 }
 231
 232 static inline int fid_seq_is_sane(__u64 seq)
 233 {
 234         return seq != 0;
 235 }
 236
 237 static inline void fid_zero(struct lu_fid *fid)
 238 {
 239         memset(fid, 0, sizeof(*fid));
 240 }
 241
 242 static inline int fid_is_igif(const struct lu_fid *fid)
 243 {
 244         return fid_seq(fid) == LUSTRE_ROOT_FID_SEQ;
 245 }
 246
 247 #define DFID "[0x%16.16"LPF64"x/0x%8.8x:0x%8.8x]"
 248
 249 #define PFID(fid)     \
 250         fid_seq(fid), \
 251         fid_oid(fid), \
 252         fid_ver(fid)
 253
 254 #ifdef __KERNEL__
 255 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
 256 {
 257         /* check that all fields are converted */
 258         CLASSERT(sizeof *src ==
 259                  sizeof fid_seq(src) +
 260                  sizeof fid_oid(src) + sizeof fid_ver(src));
 261         LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
 262         dst->f_seq = cpu_to_be64(fid_seq(src));
 263         dst->f_oid = cpu_to_be32(fid_oid(src));
 264         dst->f_ver = cpu_to_be32(fid_ver(src));
 265 }
 266
 267 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
 268 {
 269         /* check that all fields are converted */
 270         CLASSERT(sizeof *src ==
 271                  sizeof fid_seq(src) +
 272                  sizeof fid_oid(src) + sizeof fid_ver(src));
 273         dst->f_seq = be64_to_cpu(fid_seq(src));
 274         dst->f_oid = be32_to_cpu(fid_oid(src));
 275         dst->f_ver = be32_to_cpu(fid_ver(src));
 276         LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
 277 }
 278
 279 /*
 280  * Storage representation for fids.
 281  *
 282  * Variable size, first byte contains the length of the whole record.
 283  */
 284
 285 struct lu_fid_pack {
 286         char fp_len;
 287         char fp_area[sizeof(struct lu_fid)];
 288 };
 289
 290 void fid_pack(struct lu_fid_pack *pack, const struct lu_fid *fid,
 291               struct lu_fid *befider);
 292 void fid_unpack(const struct lu_fid_pack *pack, struct lu_fid *fid);
 293
 294 /* __KERNEL__ */
 295 #endif
 296
 297 static inline int fid_is_sane(const struct lu_fid *fid)
 298 {
 299         return
 300                 fid != NULL &&
 301                 ((fid_seq_is_sane(fid_seq(fid)) && fid_oid(fid) != 0
 302                                                 && fid_ver(fid) == 0) ||
 303                 fid_is_igif(fid));
 304 }
 305
 306 static inline int fid_is_zero(const struct lu_fid *fid)
 307 {
 308         return fid_seq(fid) == 0 && fid_oid(fid) == 0;
 309 }
 310
 311 extern void lustre_swab_lu_fid(struct lu_fid *fid);
 312 extern void lustre_swab_lu_range(struct lu_range *range);
 313
 314 static inline int lu_fid_eq(const struct lu_fid *f0,
 315                             const struct lu_fid *f1)
 316 {
 317         /* Check that there is no alignment padding. */
 318         CLASSERT(sizeof *f0 ==
 319                  sizeof f0->f_seq + sizeof f0->f_oid + sizeof f0->f_ver);
 320         LASSERTF(fid_is_igif(f0) || fid_ver(f0) == 0, DFID, PFID(f0));
 321         LASSERTF(fid_is_igif(f1) || fid_ver(f1) == 0, DFID, PFID(f1));
 322         return memcmp(f0, f1, sizeof *f0) == 0;
 323 }
 324
 325 /*
 326  * Layout of readdir pages, as transmitted on wire.
 327  */
 328 struct lu_dirent {
 329         struct lu_fid lde_fid;
 330         __u32         lde_hash;
 331         __u16         lde_reclen;
 332         __u16         lde_namelen;
 333         char          lde_name[0];
 334 };
 335
 336 struct lu_dirpage {
 337         __u32            ldp_hash_start;
 338         __u32            ldp_hash_end;
 339         __u16            ldp_flags;
 340         __u32            ldp_pad0;
 341         struct lu_dirent ldp_entries[0];
 342 };
 343
 344 enum lu_dirpage_flags {
 345         LDF_EMPTY = 1 << 0
 346 };
 347
 348 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
 349 {
 350         if (le16_to_cpu(dp->ldp_flags) & LDF_EMPTY)
 351                 return NULL;
 352         else
 353                 return dp->ldp_entries;
 354 }
 355
 356 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
 357 {
 358         struct lu_dirent *next;
 359
 360         if (le16_to_cpu(ent->lde_reclen) != 0)
 361                 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
 362         else
 363                 next = NULL;
 364
 365         return next;
 366 }
 367
 368 static inline int lu_dirent_size(struct lu_dirent *ent)
 369 {
 370         if (le16_to_cpu(ent->lde_reclen) == 0) {
 371                 return (sizeof(*ent) +
 372                         le16_to_cpu(ent->lde_namelen) + 3) & ~3;
 373         }
 374         return le16_to_cpu(ent->lde_reclen);
 375 }
 376
 377 #define DIR_END_OFF              0xfffffffeUL
 378
 379 struct lustre_handle {
 380         __u64 cookie;
 381 };
 382 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
 383
 384 static inline int lustre_handle_is_used(struct lustre_handle *lh)
 385 {
 386         return lh->cookie != 0ull;
 387 }
 388
 389 static inline int lustre_handle_equal(struct lustre_handle *lh1,
 390                                       struct lustre_handle *lh2)
 391 {
 392         return lh1->cookie == lh2->cookie;
 393 }
 394
 395 static inline void lustre_handle_copy(struct lustre_handle *tgt,
 396                                       struct lustre_handle *src)
 397 {
 398         tgt->cookie = src->cookie;
 399 }
 400
 401 /* we depend on this structure to be 8-byte aligned */
 402 /* this type is only endian-adjusted in lustre_unpack_msg() */
 403 struct lustre_msg_v1 {
 404         struct lustre_handle lm_handle;
 405         __u32 lm_magic;
 406         __u32 lm_type;
 407         __u32 lm_version;
 408         __u32 lm_opc;
 409         __u64 lm_last_xid;
 410         __u64 lm_last_committed;
 411         __u64 lm_transno;
 412         __u32 lm_status;
 413         __u32 lm_flags;
 414         __u32 lm_conn_cnt;
 415         __u32 lm_bufcount;
 416         __u32 lm_buflens[0];
 417 };
 418
 419 #define lustre_msg lustre_msg_v2
 420 /* we depend on this structure to be 8-byte aligned */
 421 /* this type is only endian-adjusted in lustre_unpack_msg() */
 422 struct lustre_msg_v2 {
 423         __u32 lm_bufcount;
 424         __u32 lm_secflvr;
 425         __u32 lm_magic;
 426         __u32 lm_repsize;
 427         __u32 lm_timeout;
 428         __u32 lm_padding_1;
 429         __u32 lm_padding_2;
 430         __u32 lm_padding_3;
 431         __u32 lm_buflens[0];
 432 };
 433
 434 /* without gss, ptlrpc_body is put at the first buffer. */
 435 struct ptlrpc_body {
 436         struct lustre_handle pb_handle;
 437         __u32 pb_type;
 438         __u32 pb_version;
 439         __u32 pb_opc;
 440         __u32 pb_status;
 441         __u64 pb_last_xid;
 442         __u64 pb_last_seen;
 443         __u64 pb_last_committed;
 444         __u64 pb_transno;
 445         __u32 pb_flags;
 446         __u32 pb_op_flags;
 447         __u32 pb_conn_cnt;
 448         __u32 pb_padding_1;
 449         __u32 pb_padding_2;
 450         __u32 pb_padding_3;
 451         __u32 pb_padding_4;
 452         __u32 pb_padding_5;
 453 };
 454
 455 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
 456
 457 /* message body offset for lustre_msg_v2 */
 458 /* ptlrpc body offset in all request/reply messages */
 459 #define MSG_PTLRPC_BODY_OFF             0
 460
 461 /* normal request/reply message record offset */
 462 #define REQ_REC_OFF                     1
 463 #define REPLY_REC_OFF                   1
 464
 465 /* ldlm request message body offset */
 466 #define DLM_LOCKREQ_OFF                 1 /* lockreq offset */
 467 #define DLM_REQ_REC_OFF                 2 /* normal dlm request record offset */
 468
 469 /* ldlm intent lock message body offset */
 470 #define DLM_INTENT_IT_OFF               2 /* intent lock it offset */
 471 #define DLM_INTENT_REC_OFF              3 /* intent lock record offset */
 472
 473 /* ldlm reply message body offset */
 474 #define DLM_LOCKREPLY_OFF               1 /* lockrep offset */
 475 #define DLM_REPLY_REC_OFF               2 /* reply record offset */
 476
 477 /* Flags that are operation-specific go in the top 16 bits. */
 478 #define MSG_OP_FLAG_MASK   0xffff0000
 479 #define MSG_OP_FLAG_SHIFT  16
 480
 481 /* Flags that apply to all requests are in the bottom 16 bits */
 482 #define MSG_GEN_FLAG_MASK      0x0000ffff
 483 #define MSG_LAST_REPLAY        1
 484 #define MSG_RESENT             2
 485 #define MSG_REPLAY             4
 486 #define MSG_REQ_REPLAY_DONE    8
 487 #define MSG_LOCK_REPLAY_DONE  16
 488
 489 /*
 490  * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
 491  */
 492
 493 #define MSG_CONNECT_RECOVERING  0x1
 494 #define MSG_CONNECT_RECONNECT   0x2
 495 #define MSG_CONNECT_REPLAYABLE  0x4
 496 //#define MSG_CONNECT_PEER        0x8
 497 #define MSG_CONNECT_LIBCLIENT   0x10
 498 #define MSG_CONNECT_INITIAL     0x20
 499 #define MSG_CONNECT_ASYNC       0x40
 500 #define MSG_CONNECT_NEXT_VER    0x80  /* use next version of lustre_msg */
 501 #define MSG_CONNECT_TRANSNO     0x100 /* report transno */
 502
 503 /* Connect flags */
 504 #define OBD_CONNECT_RDONLY     0x00000001ULL /* client allowed read-only access */
 505 #define OBD_CONNECT_INDEX      0x00000002ULL /* connect to specific LOV idx */
 506 #define OBD_CONNECT_GRANT      0x00000008ULL /* OSC acquires grant at connect */
 507 #define OBD_CONNECT_SRVLOCK    0x00000010ULL /* server takes locks for client */
 508 #define OBD_CONNECT_VERSION    0x00000020ULL /* Server supports versions in ocd */
 509 #define OBD_CONNECT_REQPORTAL  0x00000040ULL /* Separate portal for non-IO reqs */
 510 #define OBD_CONNECT_ACL        0x00000080ULL /* client uses access control lists */
 511 #define OBD_CONNECT_XATTR      0x00000100ULL /* client using extended attributes*/
 512 #define OBD_CONNECT_TRUNCLOCK  0x00000400ULL /* locks on server for punch b=9528 */
 513 #define OBD_CONNECT_IBITS      0x00001000ULL /* support for inodebits locks */
 514 #define OBD_CONNECT_JOIN       0x00002000ULL /* files can be concatenated */
 515 #define OBD_CONNECT_ATTRFID    0x00004000ULL /* Server supports GetAttr By Fid */
 516 #define OBD_CONNECT_NODEVOH    0x00008000ULL /* No open handle for special nodes */
 517 #define OBD_CONNECT_LCL_CLIENT 0x00010000ULL /* local 1.8 client */
 518 #define OBD_CONNECT_RMT_CLIENT 0x00020000ULL /* Remote 1.8 client */
 519 #define OBD_CONNECT_BRW_SIZE   0x00040000ULL /* Max bytes per rpc */
 520 #define OBD_CONNECT_QUOTA64    0x00080000ULL /* 64bit qunit_data.qd_count b=10707*/
 521 #define OBD_CONNECT_MDS_CAPA   0x00100000ULL /* MDS capability */
 522 #define OBD_CONNECT_OSS_CAPA   0x00200000ULL /* OSS capability */
 523 #define OBD_CONNECT_MDS_MDS    0x00400000ULL /* MDS-MDS connection*/
 524 #define OBD_CONNECT_SOM        0x00800000ULL /* SOM feature */
 525 #define OBD_CONNECT_REAL       0x00000200ULL /* real connection */
 526 /* also update obd_connect_names[] for lprocfs_rd_connect_flags()
 527  * and lustre/utils/wirecheck.c */
 528
 529 #define MDT_CONNECT_SUPPORTED  (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
 530                                 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
 531                                 OBD_CONNECT_IBITS | OBD_CONNECT_JOIN | \
 532                                 OBD_CONNECT_NODEVOH |/* OBD_CONNECT_ATTRFID |*/\
 533                                 OBD_CONNECT_LCL_CLIENT | \
 534                                 OBD_CONNECT_RMT_CLIENT | \
 535                                 OBD_CONNECT_MDS_CAPA | OBD_CONNECT_OSS_CAPA | \
 536                                 OBD_CONNECT_MDS_MDS)
 537 #define OST_CONNECT_SUPPORTED  (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
 538                                 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
 539                                 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
 540                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_QUOTA64 | \
 541                                 OBD_CONNECT_OSS_CAPA)
 542 #define ECHO_CONNECT_SUPPORTED (0)
 543 #define MGS_CONNECT_SUPPORTED  (OBD_CONNECT_VERSION)
 544
 545 #define MAX_QUOTA_COUNT32 ((0xffffffffULL >> QUOTABLOCK_BITS) << QUOTABLOCK_BITS)
 546
 547 #define OBD_OCD_VERSION(major,minor,patch,fix) (((major)<<24) + ((minor)<<16) +\
 548                                                 ((patch)<<8) + (fix))
 549 #define OBD_OCD_VERSION_MAJOR(version) ((int)((version)>>24)&255)
 550 #define OBD_OCD_VERSION_MINOR(version) ((int)((version)>>16)&255)
 551 #define OBD_OCD_VERSION_PATCH(version) ((int)((version)>>8)&255)
 552 #define OBD_OCD_VERSION_FIX(version)   ((int)(version)&255)
 553
 554 /* This structure is used for both request and reply.
 555  *
 556  * If we eventually have separate connect data for different types, which we
 557  * almost certainly will, then perhaps we stick a union in here. */
 558 struct obd_connect_data {
 559         __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
 560         __u32 ocd_version;       /* lustre release version number */
 561         __u32 ocd_grant;         /* initial cache grant amount (bytes) */
 562         __u32 ocd_index;         /* LOV index to connect to */
 563         __u32 ocd_brw_size;      /* Maximum BRW size in bytes */
 564         __u64 ocd_ibits_known;   /* inode bits this client understands */
 565         __u32 ocd_nllu;          /* non-local-lustre-user */
 566         __u32 ocd_nllg;          /* non-local-lustre-group */
 567         __u64 ocd_transno;       /* first transno from client to be replayed */
 568         __u32 ocd_group;         /* MDS group on OST */
 569         __u32 padding1;          /* also fix lustre_swab_connect */
 570         __u64 padding2;          /* also fix lustre_swab_connect */
 571         __u64 padding3;          /* also fix lustre_swab_connect */
 572 };
 573
 574 extern void lustre_swab_connect(struct obd_connect_data *ocd);
 575
 576 /*
 577  *   OST requests: OBDO & OBD request records
 578  */
 579
 580 /* opcodes */
 581 typedef enum {
 582         OST_REPLY      =  0,       /* reply ? */
 583         OST_GETATTR    =  1,
 584         OST_SETATTR    =  2,
 585         OST_READ       =  3,
 586         OST_WRITE      =  4,
 587         OST_CREATE     =  5,
 588         OST_DESTROY    =  6,
 589         OST_GET_INFO   =  7,
 590         OST_CONNECT    =  8,
 591         OST_DISCONNECT =  9,
 592         OST_PUNCH      = 10,
 593         OST_OPEN       = 11,
 594         OST_CLOSE      = 12,
 595         OST_STATFS     = 13,
 596         OST_SYNC       = 16,
 597         OST_SET_INFO   = 17,
 598         OST_QUOTACHECK = 18,
 599         OST_QUOTACTL   = 19,
 600         OST_LAST_OPC
 601 } ost_cmd_t;
 602 #define OST_FIRST_OPC  OST_REPLY
 603
 604 typedef uint64_t        obd_id;
 605 typedef uint64_t        obd_gr;
 606 typedef uint64_t        obd_time;
 607 typedef uint64_t        obd_size;
 608 typedef uint64_t        obd_off;
 609 typedef uint64_t        obd_blocks;
 610 typedef uint32_t        obd_blksize;
 611 typedef uint32_t        obd_mode;
 612 typedef uint32_t        obd_uid;
 613 typedef uint32_t        obd_gid;
 614 typedef uint32_t        obd_flag;
 615 typedef uint64_t        obd_valid;
 616 typedef uint32_t        obd_count;
 617
 618 #define OBD_FL_INLINEDATA    (0x00000001)
 619 #define OBD_FL_OBDMDEXISTS   (0x00000002)
 620 #define OBD_FL_DELORPHAN     (0x00000004) /* if set in o_flags delete orphans */
 621 #define OBD_FL_NORPC         (0x00000008) /* set in o_flags do in OSC not OST */
 622 #define OBD_FL_IDONLY        (0x00000010) /* set in o_flags only adjust obj id*/
 623 #define OBD_FL_RECREATE_OBJS (0x00000020) /* recreate missing obj */
 624 #define OBD_FL_DEBUG_CHECK   (0x00000040) /* echo client/server debug check */
 625 #define OBD_FL_NO_USRQUOTA   (0x00000100) /* the object's owner is over quota */
 626 #define OBD_FL_NO_GRPQUOTA   (0x00000200) /* the object's group is over quota */
 627
 628 /*
 629  * Set this to delegate DLM locking during obd_punch() to the OSTs. Only OSTs
 630  * that declared OBD_CONNECT_TRUNCLOCK in their connect flags support this
 631  * functionality.
 632  */
 633 #define OBD_FL_TRUNCLOCK     (0x00000800)
 634
 635 /*
 636  * This should not be smaller than sizeof(struct lustre_handle) + sizeof(struct
 637  * llog_cookie) + sizeof(struct ll_fid). Nevertheless struct ll_fid is not
 638  * longer stored in o_inline, we keep this just for case.
 639  */
 640 #define OBD_INLINESZ    80
 641
 642 /* Note: 64-bit types are 64-bit aligned in structure */
 643 struct obdo {
 644         obd_valid               o_valid;        /* hot fields in this obdo */
 645         obd_id                  o_id;
 646         obd_gr                  o_gr;
 647         obd_id                  o_fid;
 648         obd_size                o_size;         /* o_size-o_blocks == ost_lvb */
 649         obd_time                o_mtime;
 650         obd_time                o_atime;
 651         obd_time                o_ctime;
 652         obd_blocks              o_blocks;       /* brw: cli sent cached bytes */
 653         obd_size                o_grant;
 654
 655         /* 32-bit fields start here: keep an even number of them via padding */
 656         obd_blksize             o_blksize;      /* optimal IO blocksize */
 657         obd_mode                o_mode;         /* brw: cli sent cache remain */
 658         obd_uid                 o_uid;
 659         obd_gid                 o_gid;
 660         obd_flag                o_flags;
 661         obd_count               o_nlink;        /* brw: checksum */
 662         obd_count               o_generation;
 663         obd_count               o_misc;         /* brw: o_dropped */
 664         __u32                   o_easize;       /* epoch in ost writes */
 665         __u32                   o_mds;
 666         __u32                   o_stripe_idx;   /* holds stripe idx */
 667         __u32                   o_padding_1;
 668         char                    o_inline[OBD_INLINESZ];
 669                                 /* lustre_handle + llog_cookie */
 670 };
 671
 672 #define o_dirty   o_blocks
 673 #define o_undirty o_mode
 674 #define o_dropped o_misc
 675 #define o_cksum   o_nlink
 676
 677 extern void lustre_swab_obdo (struct obdo *o);
 678
 679
 680 #define LOV_MAGIC_V1      0x0BD10BD0
 681 #define LOV_MAGIC         LOV_MAGIC_V1
 682 #define LOV_MAGIC_JOIN    0x0BD20BD0
 683
 684 #define LOV_PATTERN_RAID0 0x001   /* stripes are used round-robin */
 685 #define LOV_PATTERN_RAID1 0x002   /* stripes are mirrors of each other */
 686 #define LOV_PATTERN_FIRST 0x100   /* first stripe is not in round-robin */
 687 #define LOV_PATTERN_CMOBD 0x200
 688
 689 #define lov_ost_data lov_ost_data_v1
 690 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
 691         __u64 l_object_id;        /* OST object ID */
 692         __u64 l_object_gr;        /* OST object group (creating MDS number) */
 693         __u32 l_ost_gen;          /* generation of this l_ost_idx */
 694         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
 695 };
 696
 697 #define lov_mds_md lov_mds_md_v1
 698 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
 699         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
 700         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 701         __u64 lmm_object_id;      /* LOV object ID */
 702         __u64 lmm_object_gr;      /* LOV object group */
 703         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 704         __u32 lmm_stripe_count;   /* num stripes in use for this object */
 705         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 706 };
 707
 708 extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm);
 709
 710 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
 711 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
 712
 713 #define XATTR_NAME_ACL_ACCESS   "system.posix_acl_access"
 714 #define XATTR_NAME_ACL_DEFAULT  "system.posix_acl_default"
 715 #define XATTR_NAME_LOV          "trusted.lov"
 716
 717 /* remote ACL */
 718 #define XATTR_NAME_LUSTRE_ACL   "system.lustre_acl"
 719
 720 #define OBD_MD_FLID        (0x00000001ULL) /* object ID */
 721 #define OBD_MD_FLATIME     (0x00000002ULL) /* access time */
 722 #define OBD_MD_FLMTIME     (0x00000004ULL) /* data modification time */
 723 #define OBD_MD_FLCTIME     (0x00000008ULL) /* change time */
 724 #define OBD_MD_FLSIZE      (0x00000010ULL) /* size */
 725 #define OBD_MD_FLBLOCKS    (0x00000020ULL) /* allocated blocks count */
 726 #define OBD_MD_FLBLKSZ     (0x00000040ULL) /* block size */
 727 #define OBD_MD_FLMODE      (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
 728 #define OBD_MD_FLTYPE      (0x00000100ULL) /* object type (mode & S_IFMT) */
 729 #define OBD_MD_FLUID       (0x00000200ULL) /* user ID */
 730 #define OBD_MD_FLGID       (0x00000400ULL) /* group ID */
 731 #define OBD_MD_FLFLAGS     (0x00000800ULL) /* flags word */
 732 #define OBD_MD_FLNLINK     (0x00002000ULL) /* link count */
 733 #define OBD_MD_FLGENER     (0x00004000ULL) /* generation number */
 734 #define OBD_MD_FLINLINE    (0x00008000ULL) /* inline data */
 735 #define OBD_MD_FLRDEV      (0x00010000ULL) /* device number */
 736 #define OBD_MD_FLEASIZE    (0x00020000ULL) /* extended attribute data */
 737 #define OBD_MD_LINKNAME    (0x00040000ULL) /* symbolic link target */
 738 #define OBD_MD_FLHANDLE    (0x00080000ULL) /* file handle */
 739 #define OBD_MD_FLCKSUM     (0x00100000ULL) /* bulk data checksum */
 740 #define OBD_MD_FLQOS       (0x00200000ULL) /* quality of service stats */
 741 #define OBD_MD_FLOSCOPQ    (0x00400000ULL) /* osc opaque data */
 742 #define OBD_MD_FLCOOKIE    (0x00800000ULL) /* log cancellation cookie */
 743 #define OBD_MD_FLGROUP     (0x01000000ULL) /* group */
 744 #define OBD_MD_FLFID       (0x02000000ULL) /* ->ost write inline fid */
 745 #define OBD_MD_FLEPOCH     (0x04000000ULL) /* ->ost write easize is epoch */
 746                                            /* ->mds if epoch opens or closes */
 747 #define OBD_MD_FLGRANT     (0x08000000ULL) /* ost preallocation space grant */
 748 #define OBD_MD_FLDIREA     (0x10000000ULL) /* dir's extended attribute data */
 749 #define OBD_MD_FLUSRQUOTA  (0x20000000ULL) /* over quota flags sent from ost */
 750 #define OBD_MD_FLGRPQUOTA  (0x40000000ULL) /* over quota flags sent from ost */
 751 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
 752
 753 #define OBD_MD_MDS         (0x0000000100000000ULL) /* where an inode lives on */
 754 #define OBD_MD_REINT       (0x0000000200000000ULL) /* reintegrate oa */
 755 #define OBD_MD_MEA         (0x0000000400000000ULL) /* CMD split EA  */
 756
 757 #define OBD_MD_FLXATTR     (0x0000001000000000ULL) /* xattr */
 758 #define OBD_MD_FLXATTRLS   (0x0000002000000000ULL) /* xattr list */
 759 #define OBD_MD_FLXATTRRM   (0x0000004000000000ULL) /* xattr remove */
 760 #define OBD_MD_FLACL       (0x0000008000000000ULL) /* ACL */
 761 #define OBD_MD_FLRMTPERM   (0x0000010000000000ULL) /* remote permission */
 762 #define OBD_MD_FLMDSCAPA   (0x0000020000000000ULL) /* MDS capability */
 763 #define OBD_MD_FLOSSCAPA   (0x0000040000000000ULL) /* OSS capability */
 764 #define OBD_MD_FLCKSPLIT   (0x0000080000000000ULL) /* Check split on server */
 765 #define OBD_MD_FLCROSSREF  (0x0000100000000000ULL) /* Cross-ref case */
 766
 767 #define OBD_MD_FLGETATTR (OBD_MD_FLID    | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
 768                           OBD_MD_FLCTIME | OBD_MD_FLSIZE  | OBD_MD_FLBLKSZ | \
 769                           OBD_MD_FLMODE  | OBD_MD_FLTYPE  | OBD_MD_FLUID   | \
 770                           OBD_MD_FLGID   | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
 771                           OBD_MD_FLGENER | OBD_MD_FLRDEV  | OBD_MD_FLGROUP)
 772
 773 static inline struct lustre_handle *obdo_handle(struct obdo *oa)
 774 {
 775         return (struct lustre_handle *)oa->o_inline;
 776 }
 777
 778 static inline struct llog_cookie *obdo_logcookie(struct obdo *oa)
 779 {
 780         return (struct llog_cookie *)(oa->o_inline +
 781                                       sizeof(struct lustre_handle));
 782 }
 783 /* don't forget obdo_fid which is way down at the bottom so it can
 784  * come after the definition of llog_cookie */
 785
 786 struct obd_statfs {
 787         __u64           os_type;
 788         __u64           os_blocks;
 789         __u64           os_bfree;
 790         __u64           os_bavail;
 791         __u64           os_files;
 792         __u64           os_ffree;
 793         __u8            os_fsid[40];
 794         __u32           os_bsize;
 795         __u32           os_namelen;
 796         __u64           os_maxbytes;
 797         __u32           os_state;       /* positive error code on server */
 798         __u32           os_spare1;
 799         __u32           os_spare2;
 800         __u32           os_spare3;
 801         __u32           os_spare4;
 802         __u32           os_spare5;
 803         __u32           os_spare6;
 804         __u32           os_spare7;
 805         __u32           os_spare8;
 806         __u32           os_spare9;
 807 };
 808
 809 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
 810
 811 /* ost_body.data values for OST_BRW */
 812
 813 #define OBD_BRW_READ            0x01
 814 #define OBD_BRW_WRITE           0x02
 815 #define OBD_BRW_RWMASK          (OBD_BRW_READ | OBD_BRW_WRITE)
 816 #define OBD_BRW_SYNC            0x08
 817 #define OBD_BRW_CHECK           0x10
 818 #define OBD_BRW_FROM_GRANT      0x20 /* the osc manages this under llite */
 819 #define OBD_BRW_GRANTED         0x40 /* the ost manages this */
 820 #define OBD_BRW_DROP            0x80 /* drop the page after IO */
 821 #define OBD_BRW_NOQUOTA        0x100
 822 #define OBD_BRW_SRVLOCK        0x200 /* Client holds no lock over this page */
 823
 824 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
 825
 826 #define OST_MIN_PRECREATE 32
 827 #define OST_MAX_PRECREATE 20000
 828
 829 struct obd_ioobj {
 830         obd_id               ioo_id;
 831         obd_gr               ioo_gr;
 832         __u32                ioo_type;
 833         __u32                ioo_bufcnt;
 834 };
 835
 836 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
 837
 838 /* multiple of 8 bytes => can array */
 839 struct niobuf_remote {
 840         __u64 offset;
 841         __u32 len;
 842         __u32 flags;
 843 };
 844
 845 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
 846
 847 /* request structure for OST's */
 848
 849 struct ost_body {
 850         struct  obdo oa;
 851 };
 852
 853 extern void lustre_swab_ost_body (struct ost_body *b);
 854 extern void lustre_swab_ost_last_id(obd_id *id);
 855
 856 /* lock value block communicated between the filter and llite */
 857
 858 struct ost_lvb {
 859         __u64 lvb_size;
 860         __u64 lvb_mtime;
 861         __u64 lvb_atime;
 862         __u64 lvb_ctime;
 863         __u64 lvb_blocks;
 864 };
 865
 866 extern void lustre_swab_ost_lvb(struct ost_lvb *);
 867
 868 /*
 869  *   MDS REQ RECORDS
 870  */
 871
 872 /* opcodes */
 873 typedef enum {
 874         MDS_GETATTR      = 33,
 875         MDS_GETATTR_NAME = 34,
 876         MDS_CLOSE        = 35,
 877         MDS_REINT        = 36,
 878         MDS_READPAGE     = 37,
 879         MDS_CONNECT      = 38,
 880         MDS_DISCONNECT   = 39,
 881         MDS_GETSTATUS    = 40,
 882         MDS_STATFS       = 41,
 883         MDS_PIN          = 42,
 884         MDS_UNPIN        = 43,
 885         MDS_SYNC         = 44,
 886         MDS_DONE_WRITING = 45,
 887         MDS_SET_INFO     = 46,
 888         MDS_QUOTACHECK   = 47,
 889         MDS_QUOTACTL     = 48,
 890         MDS_GETXATTR     = 49,
 891         MDS_SETXATTR     = 50,
 892         MDS_WRITEPAGE    = 51,
 893         MDS_IS_SUBDIR    = 52,
 894         MDS_LAST_OPC
 895 } mds_cmd_t;
 896
 897 #define MDS_FIRST_OPC    MDS_GETATTR
 898
 899 /*
 900  * Do not exceed 63
 901  */
 902
 903 typedef enum {
 904         REINT_SETATTR  = 1,
 905         REINT_CREATE   = 2,
 906         REINT_LINK     = 3,
 907         REINT_UNLINK   = 4,
 908         REINT_RENAME   = 5,
 909         REINT_OPEN     = 6,
 910         REINT_MAX
 911 } mds_reint_t, mdt_reint_t;
 912
 913 extern void lustre_swab_generic_32s (__u32 *val);
 914
 915 /* the disposition of the intent outlines what was executed */
 916 #define DISP_IT_EXECD        0x00000001
 917 #define DISP_LOOKUP_EXECD    0x00000002
 918 #define DISP_LOOKUP_NEG      0x00000004
 919 #define DISP_LOOKUP_POS      0x00000008
 920 #define DISP_OPEN_CREATE     0x00000010
 921 #define DISP_OPEN_OPEN       0x00000020
 922 #define DISP_ENQ_COMPLETE    0x00400000
 923 #define DISP_ENQ_OPEN_REF    0x00800000
 924 #define DISP_ENQ_CREATE_REF  0x01000000
 925 #define DISP_OPEN_LOCK       0x02000000
 926
 927 /* INODE LOCK PARTS */
 928 #define MDS_INODELOCK_LOOKUP 0x000001       /* dentry, mode, owner, group */
 929 #define MDS_INODELOCK_UPDATE 0x000002       /* size, links, timestamps */
 930 #define MDS_INODELOCK_OPEN   0x000004       /* For opened files */
 931
 932 /* Do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits */
 933 #define MDS_INODELOCK_MAXSHIFT 2
 934 /* This FULL lock is useful to take on unlink sort of operations */
 935 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
 936
 937 struct ll_fid {
 938         __u64 id;         /* holds object id */
 939         __u32 generation; /* holds object generation */
 940
 941         __u32 f_type;     /* holds object type or stripe idx when passing it to
 942                            * OST for saving into EA. */
 943 };
 944
 945 extern void lustre_swab_ll_fid (struct ll_fid *fid);
 946
 947 #define MDS_STATUS_CONN 1
 948 #define MDS_STATUS_LOV 2
 949
 950 struct mds_status_req {
 951         __u32  flags;
 952         __u32  repbuf;
 953 };
 954
 955 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
 956
 957 /* mdt_thread_info.mti_flags. */
 958 enum mdt_ioepoch_flags {
 959         /* The flag indicates Size-on-MDS attributes are changed. */
 960         MF_SOM_CHANGE   = (1 << 0),
 961         /* Flags indicates an epoch opens or closes. */
 962         MF_EPOCH_OPEN   = (1 << 1),
 963         MF_EPOCH_CLOSE  = (1 << 2),
 964 };
 965
 966 #define MDS_BFLAG_UNCOMMITTED_WRITES   0x1
 967 #define MDS_BFLAG_EXT_FLAGS     0x80000000 /* == EXT3_RESERVED_FL */
 968
 969 /* these should be identical to their EXT3_*_FL counterparts, and are
 970  * redefined here only to avoid dragging in ext3_fs.h */
 971 #define MDS_SYNC_FL             0x00000008 /* Synchronous updates */
 972 #define MDS_IMMUTABLE_FL        0x00000010 /* Immutable file */
 973 #define MDS_APPEND_FL           0x00000020 /* writes to file may only append */
 974 #define MDS_NOATIME_FL          0x00000080 /* do not update atime */
 975 #define MDS_DIRSYNC_FL          0x00010000 /* dirsync behaviour (dir only) */
 976
 977 #ifdef __KERNEL__
 978 /* If MDS_BFLAG_IOC_FLAGS is set it means we requested EXT3_*_FL inode flags
 979  * and we need to decode these into local S_* flags in the inode.  Otherwise
 980  * we pass flags straight through (see bug 9486). */
 981 static inline int ll_ext_to_inode_flags(int flags)
 982 {
 983         return (flags & MDS_BFLAG_EXT_FLAGS) ?
 984                (((flags & MDS_SYNC_FL)      ? S_SYNC      : 0) |
 985                 ((flags & MDS_NOATIME_FL)   ? S_NOATIME   : 0) |
 986                 ((flags & MDS_APPEND_FL)    ? S_APPEND    : 0) |
 987 #if defined(S_DIRSYNC)
 988                 ((flags & MDS_DIRSYNC_FL)   ? S_DIRSYNC   : 0) |
 989 #endif
 990                 ((flags & MDS_IMMUTABLE_FL) ? S_IMMUTABLE : 0)) :
 991                (flags & ~MDS_BFLAG_EXT_FLAGS);
 992 }
 993
 994 /* If MDS_BFLAG_EXT_FLAGS is set it means we requested EXT3_*_FL inode flags
 995  * and we pass these straight through.  Otherwise we need to convert from
 996  * S_* flags to their EXT3_*_FL equivalents (see bug 9486). */
 997 static inline int ll_inode_to_ext_flags(int oflags, int iflags)
 998 {
 999         return (oflags & MDS_BFLAG_EXT_FLAGS) ? (oflags & ~MDS_BFLAG_EXT_FLAGS):
1000                (((iflags & S_SYNC)      ? MDS_SYNC_FL      : 0) |
1001                 ((iflags & S_NOATIME)   ? MDS_NOATIME_FL   : 0) |
1002                 ((iflags & S_APPEND)    ? MDS_APPEND_FL    : 0) |
1003 #if defined(S_DIRSYNC)
1004                 ((iflags & S_DIRSYNC)   ? MDS_DIRSYNC_FL   : 0) |
1005 #endif
1006                 ((iflags & S_IMMUTABLE) ? MDS_IMMUTABLE_FL : 0));
1007 }
1008 #endif
1009
1010 struct mdt_body {
1011         struct lu_fid  fid1;
1012         struct lu_fid  fid2;
1013         struct lustre_handle handle;
1014         __u64          valid;
1015         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1016         __u64          mtime;
1017         __u64          atime;
1018         __u64          ctime;
1019         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1020         __u64          ioepoch;
1021         __u32          fsuid;
1022         __u32          fsgid;
1023         __u32          capability;
1024         __u32          mode;
1025         __u32          uid;
1026         __u32          gid;
1027         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1028         __u32          rdev;
1029         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1030         __u32          suppgid;
1031         __u32          eadatasize;
1032         __u32          aclsize;
1033         __u32          max_mdsize;
1034         __u32          max_cookiesize; /* also fix lustre_swab_mdt_body */
1035 };
1036
1037 struct mds_body {
1038         struct ll_fid  fid1;
1039         struct ll_fid  fid2;
1040         struct lustre_handle handle;
1041         __u64          valid;
1042         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1043         __u64          mtime;
1044         __u64          atime;
1045         __u64          ctime;
1046         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1047         __u64          io_epoch;
1048         __u64          ino;
1049         __u32          fsuid;
1050         __u32          fsgid;
1051         __u32          capability;
1052         __u32          mode;
1053         __u32          uid;
1054         __u32          gid;
1055         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1056         __u32          rdev;
1057         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1058         __u32          generation;
1059         __u32          suppgid;
1060         __u32          eadatasize;
1061         __u32          aclsize;
1062         __u32          max_mdsize;
1063         __u32          max_cookiesize; /* also fix lustre_swab_mds_body */
1064         __u32          padding_4; /* also fix lustre_swab_mds_body */
1065 };
1066
1067 extern void lustre_swab_mds_body (struct mds_body *b);
1068 extern void lustre_swab_mdt_body (struct mdt_body *b);
1069
1070 struct mdt_epoch {
1071         struct lustre_handle handle;
1072         __u64  ioepoch;
1073         __u32  flags;
1074         __u32  padding;
1075 };
1076
1077 extern void lustre_swab_mdt_epoch (struct mdt_epoch *b);
1078
1079 #define Q_QUOTACHECK    0x800100
1080 #define Q_INITQUOTA     0x800101        /* init slave limits */
1081 #define Q_GETOINFO      0x800102        /* get obd quota info */
1082 #define Q_GETOQUOTA     0x800103        /* get obd quotas */
1083
1084 #define Q_TYPESET(oqc, type) \
1085         ((oqc)->qc_type == type || (oqc)->qc_type == UGQUOTA)
1086
1087 #define Q_GETOCMD(oqc) \
1088         ((oqc)->qc_cmd == Q_GETOINFO || (oqc)->qc_cmd == Q_GETOQUOTA)
1089
1090 struct obd_quotactl {
1091         __u32                   qc_cmd;
1092         __u32                   qc_type;
1093         __u32                   qc_id;
1094         __u32                   qc_stat;
1095         struct obd_dqinfo       qc_dqinfo;
1096         struct obd_dqblk        qc_dqblk;
1097 };
1098
1099 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1100
1101 /* inode access permission for remote user, the inode info are omitted,
1102  * for client knows them. */
1103 struct mds_remote_perm {
1104         __u32           rp_uid;
1105         __u32           rp_gid;
1106         __u32           rp_fsuid;
1107         __u32           rp_fsgid;
1108         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
1109 };
1110
1111 /* setxid permissions for mds_setxid_perm.mp_perm */
1112 #define LUSTRE_SETUID_PERM 0x01
1113 #define LUSTRE_SETGID_PERM 0x02
1114 #define LUSTRE_SETGRP_PERM 0x04
1115
1116 extern void lustre_swab_mds_remote_perm(struct mds_remote_perm *p);
1117
1118 struct mdt_remote_perm {
1119         __u32           rp_uid;
1120         __u32           rp_gid;
1121         __u32           rp_fsuid;
1122         __u32           rp_fsgid;
1123         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
1124 };
1125
1126 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
1127
1128 struct mds_rec_setattr {
1129         __u32           sa_opcode;
1130         __u32           sa_fsuid;
1131         __u32           sa_fsgid;
1132         __u32           sa_cap;
1133         __u32           sa_suppgid;
1134         __u32           sa_mode;
1135         struct ll_fid   sa_fid;
1136         __u64           sa_valid;
1137         __u64           sa_size;
1138         __u64           sa_mtime;
1139         __u64           sa_atime;
1140         __u64           sa_ctime;
1141         __u32           sa_uid;
1142         __u32           sa_gid;
1143         __u32           sa_attr_flags;
1144         __u32           sa_padding; /* also fix lustre_swab_mds_rec_setattr */
1145 };
1146
1147 extern void lustre_swab_mds_rec_setattr (struct mds_rec_setattr *sa);
1148
1149 struct mdt_rec_setattr {
1150         __u32           sa_opcode;
1151         __u32           sa_fsuid;
1152         __u32           sa_fsgid;
1153         __u32           sa_cap;
1154         __u32           sa_suppgid;
1155         __u32           sa_mode;
1156         struct lu_fid   sa_fid;
1157         __u64           sa_valid;
1158         __u64           sa_size;
1159         __u64           sa_blocks;
1160         __u64           sa_mtime;
1161         __u64           sa_atime;
1162         __u64           sa_ctime;
1163         __u32           sa_uid;
1164         __u32           sa_gid;
1165         __u32           sa_attr_flags;
1166         __u32           sa_padding; /* also fix lustre_swab_mds_rec_setattr */
1167 };
1168
1169 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
1170
1171 /* Remove this once we declare it in include/linux/fs.h (v21 kernel patch?) */
1172 #ifndef ATTR_CTIME_SET
1173 #define ATTR_CTIME_SET 0x2000
1174 #endif
1175
1176 #ifndef FMODE_READ
1177 #define FMODE_READ               00000001
1178 #define FMODE_WRITE              00000002
1179 #endif
1180
1181 #define FMODE_EPOCH              01000000
1182 #define FMODE_EPOCHLCK           02000000
1183 #define FMODE_SOM                04000000
1184 #define FMODE_CLOSED             0
1185
1186 #define MDS_OPEN_CREATED         00000010
1187 #define MDS_OPEN_CROSS           00000020
1188
1189 #define MDS_FMODE_EXEC           00000004
1190 #define MDS_OPEN_CREAT           00000100
1191 #define MDS_OPEN_EXCL            00000200
1192 #define MDS_OPEN_TRUNC           00001000
1193 #define MDS_OPEN_APPEND          00002000
1194 #define MDS_OPEN_SYNC            00010000
1195 #define MDS_OPEN_DIRECTORY       00200000
1196
1197 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
1198 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1199 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file*/
1200 #define MDS_CREATE_RMT_ACL    01000000000 /* indicate create on remote server
1201                                            * with default ACL */
1202 #define MDS_CREATE_SLAVE_OBJ  02000000000 /* indicate create slave object
1203                                            * actually, this is for create, not
1204                                            * conflict with other open flags */
1205 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
1206 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
1207 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
1208
1209 /* permission for create non-directory file */
1210 #define MAY_CREATE      (1 << 7)
1211 /* permission for create directory file */
1212 #define MAY_LINK        (1 << 8)
1213 /* permission for delete from the directory */
1214 #define MAY_UNLINK      (1 << 9)
1215 /* source's permission for rename */
1216 #define MAY_RENAME_SRC  (1 << 10)
1217 /* target's permission for rename */
1218 #define MAY_RENAME_TAR  (1 << 11)
1219 /* part (parent's) VTX permission check */
1220 #define MAY_VTX_PART    (1 << 12)
1221 /* full VTX permission check */
1222 #define MAY_VTX_FULL    (1 << 13)
1223
1224 enum {
1225         MDS_CHECK_SPLIT  = 1 << 0,
1226         MDS_CROSS_REF    = 1 << 1,
1227         MDS_VTX_BYPASS   = 1 << 2,
1228         MDS_PERM_BYPASS  = 1 << 3
1229 };
1230
1231 struct mds_rec_join {
1232         struct ll_fid  jr_fid;
1233         __u64          jr_headsize;
1234 };
1235
1236 extern void lustre_swab_mds_rec_join (struct mds_rec_join *jr);
1237
1238 struct mdt_rec_join {
1239         struct lu_fid  jr_fid;
1240         __u64          jr_headsize;
1241 };
1242
1243 extern void lustre_swab_mdt_rec_join (struct mdt_rec_join *jr);
1244
1245 struct mds_rec_create {
1246         __u32           cr_opcode;
1247         __u32           cr_fsuid;
1248         __u32           cr_fsgid;
1249         __u32           cr_cap;
1250         __u32           cr_flags; /* for use with open */
1251         __u32           cr_mode;
1252         struct ll_fid   cr_fid;
1253         struct ll_fid   cr_replayfid;
1254         __u64           cr_time;
1255         __u64           cr_rdev;
1256         __u32           cr_suppgid;
1257         __u32           cr_padding_1; /* also fix lustre_swab_mds_rec_create */
1258         __u32           cr_padding_2; /* also fix lustre_swab_mds_rec_create */
1259         __u32           cr_padding_3; /* also fix lustre_swab_mds_rec_create */
1260         __u32           cr_padding_4; /* also fix lustre_swab_mds_rec_create */
1261         __u32           cr_padding_5; /* also fix lustre_swab_mds_rec_create */
1262 };
1263
1264 extern void lustre_swab_mds_rec_create (struct mds_rec_create *cr);
1265
1266 struct mdt_rec_create {
1267         __u32           cr_opcode;
1268         __u32           cr_fsuid;
1269         __u32           cr_fsgid;
1270         __u32           cr_cap;
1271         __u32           cr_flags; /* for use with open */
1272         __u32           cr_mode;
1273         struct lustre_handle cr_old_handle; /* u64 handle in case of open replay */
1274         struct lu_fid   cr_fid1;
1275         struct lu_fid   cr_fid2;
1276         __u64           cr_time;
1277         __u64           cr_rdev;
1278         __u64           cr_ioepoch;
1279         __u32           cr_suppgid1;
1280         __u32           cr_suppgid2;
1281         __u32           cr_bias;
1282         __u32           cr_padding_1; /* pad for 64 bits*/
1283 };
1284
1285 extern void lustre_swab_mdt_rec_create (struct mdt_rec_create *cr);
1286
1287 struct mds_rec_link {
1288         __u32           lk_opcode;
1289         __u32           lk_fsuid;
1290         __u32           lk_fsgid;
1291         __u32           lk_cap;
1292         __u32           lk_suppgid1;
1293         __u32           lk_suppgid2;
1294         struct ll_fid   lk_fid1;
1295         struct ll_fid   lk_fid2;
1296         __u64           lk_time;
1297         __u32           lk_padding_1;  /* also fix lustre_swab_mds_rec_link */
1298         __u32           lk_padding_2;  /* also fix lustre_swab_mds_rec_link */
1299         __u32           lk_padding_3;  /* also fix lustre_swab_mds_rec_link */
1300         __u32           lk_padding_4;  /* also fix lustre_swab_mds_rec_link */
1301 };
1302
1303 extern void lustre_swab_mds_rec_link (struct mds_rec_link *lk);
1304
1305 struct mdt_rec_link {
1306         __u32           lk_opcode;
1307         __u32           lk_fsuid;
1308         __u32           lk_fsgid;
1309         __u32           lk_cap;
1310         __u32           lk_suppgid1;
1311         __u32           lk_suppgid2;
1312         struct lu_fid   lk_fid1;
1313         struct lu_fid   lk_fid2;
1314         __u64           lk_time;
1315         __u32           lk_bias;
1316         __u32           lk_padding_2;  /* also fix lustre_swab_mds_rec_link */
1317         __u32           lk_padding_3;  /* also fix lustre_swab_mds_rec_link */
1318         __u32           lk_padding_4;  /* also fix lustre_swab_mds_rec_link */
1319 };
1320
1321 extern void lustre_swab_mdt_rec_link (struct mdt_rec_link *lk);
1322
1323 struct mds_rec_unlink {
1324         __u32           ul_opcode;
1325         __u32           ul_fsuid;
1326         __u32           ul_fsgid;
1327         __u32           ul_cap;
1328         __u32           ul_suppgid;
1329         __u32           ul_mode;
1330         struct ll_fid   ul_fid1;
1331         struct ll_fid   ul_fid2;
1332         __u64           ul_time;
1333         __u32           ul_padding_1; /* also fix lustre_swab_mds_rec_unlink */
1334         __u32           ul_padding_2; /* also fix lustre_swab_mds_rec_unlink */
1335         __u32           ul_padding_3; /* also fix lustre_swab_mds_rec_unlink */
1336         __u32           ul_padding_4; /* also fix lustre_swab_mds_rec_unlink */
1337 };
1338
1339 extern void lustre_swab_mds_rec_unlink (struct mds_rec_unlink *ul);
1340
1341 struct mdt_rec_unlink {
1342         __u32           ul_opcode;
1343         __u32           ul_fsuid;
1344         __u32           ul_fsgid;
1345         __u32           ul_cap;
1346         __u32           ul_suppgid;
1347         __u32           ul_mode;
1348         struct lu_fid   ul_fid1;
1349         struct lu_fid   ul_fid2;
1350         __u64           ul_time;
1351         __u32           ul_bias;
1352         __u32           ul_padding_2; /* also fix lustre_swab_mds_rec_unlink */
1353         __u32           ul_padding_3; /* also fix lustre_swab_mds_rec_unlink */
1354         __u32           ul_padding_4; /* also fix lustre_swab_mds_rec_unlink */
1355 };
1356
1357 extern void lustre_swab_mdt_rec_unlink (struct mdt_rec_unlink *ul);
1358
1359 struct mds_rec_rename {
1360         __u32           rn_opcode;
1361         __u32           rn_fsuid;
1362         __u32           rn_fsgid;
1363         __u32           rn_cap;
1364         __u32           rn_suppgid1;
1365         __u32           rn_suppgid2;
1366         struct ll_fid   rn_fid1;
1367         struct ll_fid   rn_fid2;
1368         __u64           rn_time;
1369         __u32           rn_padding_1; /* also fix lustre_swab_mds_rec_rename */
1370         __u32           rn_padding_2; /* also fix lustre_swab_mds_rec_rename */
1371         __u32           rn_padding_3; /* also fix lustre_swab_mds_rec_rename */
1372         __u32           rn_padding_4; /* also fix lustre_swab_mds_rec_rename */
1373 };
1374
1375 extern void lustre_swab_mds_rec_rename (struct mds_rec_rename *rn);
1376
1377 struct mdt_rec_rename {
1378         __u32           rn_opcode;
1379         __u32           rn_fsuid;
1380         __u32           rn_fsgid;
1381         __u32           rn_cap;
1382         __u32           rn_suppgid1;
1383         __u32           rn_suppgid2;
1384         struct lu_fid   rn_fid1;
1385         struct lu_fid   rn_fid2;
1386         __u64           rn_time;
1387         __u32           rn_mode;      /* cross-ref rename has mode */
1388         __u32           rn_bias;      /* some operation flags */
1389         __u32           rn_padding_3; /* also fix lustre_swab_mdt_rec_rename */
1390         __u32           rn_padding_4; /* also fix lustre_swab_mdt_rec_rename */
1391 };
1392
1393 extern void lustre_swab_mdt_rec_rename (struct mdt_rec_rename *rn);
1394
1395 /* begin adding MDT by huanghua@clusterfs.com */
1396 struct lmv_desc {
1397         __u32 ld_tgt_count;                /* how many MDS's */
1398         __u32 ld_active_tgt_count;         /* how many active */
1399         struct obd_uuid ld_uuid;
1400 };
1401
1402 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
1403 /* end adding MDT by huanghua@clusterfs.com */
1404
1405 struct md_fld {
1406         seqno_t mf_seq;
1407         mdsno_t mf_mds;
1408 };
1409
1410 extern void lustre_swab_md_fld (struct md_fld *mf);
1411
1412 enum fld_rpc_opc {
1413         FLD_QUERY                       = 600,
1414         FLD_LAST_OPC,
1415         FLD_FIRST_OPC                   = FLD_QUERY
1416 };
1417
1418 enum seq_rpc_opc {
1419         SEQ_QUERY                       = 700,
1420         SEQ_LAST_OPC,
1421         SEQ_FIRST_OPC                   = SEQ_QUERY
1422 };
1423
1424 enum seq_op {
1425         SEQ_ALLOC_SUPER = 0,
1426         SEQ_ALLOC_META = 1
1427 };
1428
1429 /*
1430  *  LOV data structures
1431  */
1432
1433 #define LOV_MIN_STRIPE_SIZE 65536   /* maximum PAGE_SIZE (ia64), power of 2 */
1434 #define LOV_MAX_STRIPE_COUNT  160   /* until bug 4424 is fixed */
1435
1436 #define LOV_MAX_UUID_BUFFER_SIZE  8192
1437 /* The size of the buffer the lov/mdc reserves for the
1438  * array of UUIDs returned by the MDS.  With the current
1439  * protocol, this will limit the max number of OSTs per LOV */
1440
1441 #define LOV_DESC_MAGIC 0xB0CCDE5C
1442
1443 /* LOV settings descriptor (should only contain static info) */
1444 struct lov_desc {
1445         __u32 ld_tgt_count;                /* how many OBD's */
1446         __u32 ld_active_tgt_count;         /* how many active */
1447         __u32 ld_default_stripe_count;     /* how many objects are used */
1448         __u32 ld_pattern;                  /* default PATTERN_RAID0 */
1449         __u64 ld_default_stripe_size;      /* in bytes */
1450         __u64 ld_default_stripe_offset;    /* in bytes */
1451         __u32 ld_padding_0;                /* unused */
1452         __u32 ld_qos_maxage;               /* in second */
1453         __u32 ld_padding_1;                /* also fix lustre_swab_lov_desc */
1454         __u32 ld_padding_2;                /* also fix lustre_swab_lov_desc */
1455         struct obd_uuid ld_uuid;
1456 };
1457
1458 #define ld_magic ld_active_tgt_count       /* for swabbing from llogs */
1459
1460 extern void lustre_swab_lov_desc (struct lov_desc *ld);
1461
1462 /*
1463  *   LDLM requests:
1464  */
1465 /* opcodes -- MUST be distinct from OST/MDS opcodes */
1466 typedef enum {
1467         LDLM_ENQUEUE     = 101,
1468         LDLM_CONVERT     = 102,
1469         LDLM_CANCEL      = 103,
1470         LDLM_BL_CALLBACK = 104,
1471         LDLM_CP_CALLBACK = 105,
1472         LDLM_GL_CALLBACK = 106,
1473         LDLM_LAST_OPC
1474 } ldlm_cmd_t;
1475 #define LDLM_FIRST_OPC LDLM_ENQUEUE
1476
1477 #define RES_NAME_SIZE 4
1478 struct ldlm_res_id {
1479         __u64 name[RES_NAME_SIZE];
1480 };
1481
1482 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
1483
1484 /* lock types */
1485 typedef enum {
1486         LCK_MINMODE = 0,
1487         LCK_EX      = 1,
1488         LCK_PW      = 2,
1489         LCK_PR      = 4,
1490         LCK_CW      = 8,
1491         LCK_CR      = 16,
1492         LCK_NL      = 32,
1493         LCK_GROUP   = 64,
1494         LCK_MAXMODE
1495 } ldlm_mode_t;
1496
1497 typedef enum {
1498         LDLM_PLAIN     = 10,
1499         LDLM_EXTENT    = 11,
1500         LDLM_FLOCK     = 12,
1501         LDLM_IBITS     = 13,
1502         LDLM_MAX_TYPE
1503 } ldlm_type_t;
1504
1505 #define LDLM_MIN_TYPE LDLM_PLAIN
1506
1507 struct ldlm_extent {
1508         __u64 start;
1509         __u64 end;
1510         __u64 gid;
1511 };
1512
1513 struct ldlm_inodebits {
1514         __u64 bits;
1515 };
1516
1517 struct ldlm_flock {
1518         __u64 start;
1519         __u64 end;
1520         __u64 blocking_export;  /* not actually used over the wire */
1521         __u32 blocking_pid;     /* not actually used over the wire */
1522         __u32 pid;
1523 };
1524
1525 /* it's important that the fields of the ldlm_extent structure match
1526  * the first fields of the ldlm_flock structure because there is only
1527  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
1528  * this ever changes we will need to swab the union differently based
1529  * on the resource type. */
1530
1531 typedef union {
1532         struct ldlm_extent l_extent;
1533         struct ldlm_flock  l_flock;
1534         struct ldlm_inodebits l_inodebits;
1535 } ldlm_policy_data_t;
1536
1537 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
1538
1539 struct ldlm_intent {
1540         __u64 opc;
1541 };
1542
1543 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
1544
1545 struct ldlm_resource_desc {
1546         ldlm_type_t lr_type;
1547         __u32 lr_padding;       /* also fix lustre_swab_ldlm_resource_desc */
1548         struct ldlm_res_id lr_name;
1549 };
1550
1551 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
1552
1553 struct ldlm_lock_desc {
1554         struct ldlm_resource_desc l_resource;
1555         ldlm_mode_t l_req_mode;
1556         ldlm_mode_t l_granted_mode;
1557         ldlm_policy_data_t l_policy_data;
1558 };
1559
1560 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
1561
1562 struct ldlm_request {
1563         __u32 lock_flags;
1564         __u32 lock_padding;     /* also fix lustre_swab_ldlm_request */
1565         struct ldlm_lock_desc lock_desc;
1566         struct lustre_handle lock_handle1;
1567         struct lustre_handle lock_handle2;
1568 };
1569
1570 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
1571
1572 struct ldlm_reply {
1573         __u32 lock_flags;
1574         __u32 lock_padding;     /* also fix lustre_swab_ldlm_reply */
1575         struct ldlm_lock_desc lock_desc;
1576         struct lustre_handle lock_handle;
1577         __u64  lock_policy_res1;
1578         __u64  lock_policy_res2;
1579 };
1580
1581 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
1582
1583
1584 /*
1585  * Opcodes for mountconf (mgs and mgc)
1586  */
1587 typedef enum {
1588         MGS_CONNECT = 250,
1589         MGS_DISCONNECT,
1590         MGS_EXCEPTION,         /* node died, etc. */
1591         MGS_TARGET_REG,        /* whenever target starts up */
1592         MGS_TARGET_DEL,
1593         MGS_LAST_OPC
1594 } mgs_cmd_t;
1595 #define MGS_FIRST_OPC MGS_CONNECT
1596
1597 /* We pass this info to the MGS so it can write config logs */
1598 #define MTI_NAME_MAXLEN 64
1599 #define MTI_PARAM_MAXLEN 4096
1600 #define MTI_NIDS_MAX 32
1601 struct mgs_target_info {
1602         __u32            mti_lustre_ver;
1603         __u32            mti_stripe_index;
1604         __u32            mti_config_ver;
1605         __u32            mti_flags;
1606         __u32            mti_nid_count;
1607         __u32            padding;                    /* 64 bit align */
1608         char             mti_fsname[MTI_NAME_MAXLEN];
1609         char             mti_svname[MTI_NAME_MAXLEN];
1610         char             mti_uuid[sizeof(struct obd_uuid)];
1611         __u64            mti_nids[MTI_NIDS_MAX];     /* host nids (lnet_nid_t)*/
1612         char             mti_params[MTI_PARAM_MAXLEN];
1613 };
1614
1615 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
1616
1617 /* Config marker flags (in config log) */
1618 #define CM_START       0x01
1619 #define CM_END         0x02
1620 #define CM_SKIP        0x04
1621 #define CM_UPGRADE146  0x08
1622 #define CM_EXCLUDE     0x10
1623 #define CM_START_SKIP (CM_START | CM_SKIP)
1624
1625 struct cfg_marker {
1626         __u32             cm_step;       /* aka config version */
1627         __u32             cm_flags;
1628         __u32             cm_vers;       /* lustre release version number */
1629         __u32             padding;       /* 64 bit align */
1630         time_t            cm_createtime; /*when this record was first created */
1631         time_t            cm_canceltime; /*when this record is no longer valid*/
1632         char              cm_tgtname[MTI_NAME_MAXLEN];
1633         char              cm_comment[MTI_NAME_MAXLEN];
1634 };
1635
1636 /*
1637  * Opcodes for multiple servers.
1638  */
1639
1640 typedef enum {
1641         OBD_PING = 400,
1642         OBD_LOG_CANCEL,
1643         OBD_QC_CALLBACK,
1644         OBD_LAST_OPC
1645 } obd_cmd_t;
1646 #define OBD_FIRST_OPC OBD_PING
1647
1648 /* catalog of log objects */
1649
1650 /* Identifier for a single log object */
1651 struct llog_logid {
1652         __u64                   lgl_oid;
1653         __u64                   lgl_ogr;
1654         __u32                   lgl_ogen;
1655 } __attribute__((packed));
1656
1657 /* Records written to the CATALOGS list */
1658 #define CATLIST "CATALOGS"
1659 struct llog_catid {
1660         struct llog_logid       lci_logid;
1661         __u32                   lci_padding1;
1662         __u32                   lci_padding2;
1663         __u32                   lci_padding3;
1664 } __attribute__((packed));
1665
1666 /*join file lov mds md*/
1667 struct lov_mds_md_join {
1668         struct lov_mds_md lmmj_md;
1669         /*join private info*/
1670         struct llog_logid lmmj_array_id; /*array object id*/
1671         __u32  lmmj_extent_count;        /*array extent count*/
1672 };
1673
1674 /* Log data record types - there is no specific reason that these need to
1675  * be related to the RPC opcodes, but no reason not to (may be handy later?)
1676  */
1677 #define LLOG_OP_MAGIC 0x10600000
1678 #define LLOG_OP_MASK  0xfff00000
1679
1680 typedef enum {
1681         LLOG_PAD_MAGIC   = LLOG_OP_MAGIC | 0x00000,
1682         OST_SZ_REC       = LLOG_OP_MAGIC | 0x00f00,
1683         OST_RAID1_REC    = LLOG_OP_MAGIC | 0x01000,
1684         MDS_UNLINK_REC   = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_UNLINK,
1685         MDS_SETATTR_REC  = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_SETATTR,
1686         OBD_CFG_REC      = LLOG_OP_MAGIC | 0x20000,
1687         PTL_CFG_REC      = LLOG_OP_MAGIC | 0x30000, /* obsolete */
1688         LLOG_GEN_REC     = LLOG_OP_MAGIC | 0x40000,
1689         LLOG_JOIN_REC    = LLOG_OP_MAGIC | 0x50000,
1690         LLOG_HDR_MAGIC   = LLOG_OP_MAGIC | 0x45539,
1691         LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
1692 } llog_op_type;
1693
1694 /*
1695  * for now, continue to support old pad records which have 0 for their
1696  * type but still need to be swabbed for their length
1697  */
1698 #define LLOG_REC_HDR_NEEDS_SWABBING(r)                                  \
1699         (((r)->lrh_type & __swab32(LLOG_OP_MASK)) ==                    \
1700          __swab32(LLOG_OP_MAGIC) ||                                     \
1701          (((r)->lrh_type == 0) && ((r)->lrh_len > LLOG_CHUNK_SIZE)))
1702
1703 /* Log record header - stored in little endian order.
1704  * Each record must start with this struct, end with a llog_rec_tail,
1705  * and be a multiple of 256 bits in size.
1706  */
1707 struct llog_rec_hdr {
1708         __u32                   lrh_len;
1709         __u32                   lrh_index;
1710         __u32                   lrh_type;
1711         __u32                   padding;
1712 };
1713
1714 struct llog_rec_tail {
1715         __u32 lrt_len;
1716         __u32 lrt_index;
1717 };
1718
1719 struct llog_logid_rec {
1720         struct llog_rec_hdr     lid_hdr;
1721         struct llog_logid       lid_id;
1722         __u32                   padding1;
1723         __u32                   padding2;
1724         __u32                   padding3;
1725         __u32                   padding4;
1726         __u32                   padding5;
1727         struct llog_rec_tail    lid_tail;
1728 } __attribute__((packed));
1729
1730 /* MDS extent description
1731  * It is for joined file extent info, each extent info for joined file
1732  * just like (start, end, lmm).
1733  */
1734 struct mds_extent_desc {
1735         __u64                   med_start; /* extent start */
1736         __u64                   med_len;   /* extent length */
1737         struct lov_mds_md       med_lmm;   /* extent's lmm  */
1738 };
1739 /*Joined file array extent log record*/
1740 struct llog_array_rec {
1741         struct llog_rec_hdr     lmr_hdr;
1742         struct mds_extent_desc  lmr_med;
1743         struct llog_rec_tail    lmr_tail;
1744 };
1745
1746 struct llog_create_rec {
1747         struct llog_rec_hdr     lcr_hdr;
1748         struct ll_fid           lcr_fid;
1749         obd_id                  lcr_oid;
1750         obd_count               lcr_ogen;
1751         __u32                   padding;
1752         struct llog_rec_tail    lcr_tail;
1753 } __attribute__((packed));
1754
1755 struct llog_orphan_rec {
1756         struct llog_rec_hdr     lor_hdr;
1757         obd_id                  lor_oid;
1758         obd_count               lor_ogen;
1759         __u32                   padding;
1760         struct llog_rec_tail    lor_tail;
1761 } __attribute__((packed));
1762
1763 struct llog_unlink_rec {
1764         struct llog_rec_hdr     lur_hdr;
1765         obd_id                  lur_oid;
1766         obd_count               lur_ogen;
1767         __u32                   padding;
1768         struct llog_rec_tail    lur_tail;
1769 } __attribute__((packed));
1770
1771 struct llog_setattr_rec {
1772         struct llog_rec_hdr     lsr_hdr;
1773         obd_id                  lsr_oid;
1774         obd_count               lsr_ogen;
1775         __u32                   lsr_uid;
1776         __u32                   lsr_gid;
1777         __u32                   padding;
1778         struct llog_rec_tail    lsr_tail;
1779 } __attribute__((packed));
1780
1781 struct llog_size_change_rec {
1782         struct llog_rec_hdr     lsc_hdr;
1783         struct ll_fid           lsc_fid;
1784         __u32                   lsc_ioepoch;
1785         __u32                   padding;
1786         struct llog_rec_tail    lsc_tail;
1787 } __attribute__((packed));
1788
1789 struct llog_gen {
1790         __u64 mnt_cnt;
1791         __u64 conn_cnt;
1792 } __attribute__((packed));
1793
1794 struct llog_gen_rec {
1795         struct llog_rec_hdr     lgr_hdr;
1796         struct llog_gen         lgr_gen;
1797         struct llog_rec_tail    lgr_tail;
1798 };
1799 /* On-disk header structure of each log object, stored in little endian order */
1800 #define LLOG_CHUNK_SIZE         8192
1801 #define LLOG_HEADER_SIZE        (96)
1802 #define LLOG_BITMAP_BYTES       (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
1803
1804 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
1805
1806 /* flags for the logs */
1807 #define LLOG_F_ZAP_WHEN_EMPTY   0x1
1808 #define LLOG_F_IS_CAT           0x2
1809 #define LLOG_F_IS_PLAIN         0x4
1810
1811 struct llog_log_hdr {
1812         struct llog_rec_hdr     llh_hdr;
1813         __u64                   llh_timestamp;
1814         __u32                   llh_count;
1815         __u32                   llh_bitmap_offset;
1816         __u32                   llh_size;
1817         __u32                   llh_flags;
1818         __u32                   llh_cat_idx;
1819         /* for a catalog the first plain slot is next to it */
1820         struct obd_uuid         llh_tgtuuid;
1821         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
1822         __u32                   llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
1823         struct llog_rec_tail    llh_tail;
1824 } __attribute__((packed));
1825
1826 #define LLOG_BITMAP_SIZE(llh)  ((llh->llh_hdr.lrh_len -         \
1827                                  llh->llh_bitmap_offset -       \
1828                                  sizeof(llh->llh_tail)) * 8)
1829
1830 /* log cookies are used to reference a specific log file and a record therein */
1831 struct llog_cookie {
1832         struct llog_logid       lgc_lgl;
1833         __u32                   lgc_subsys;
1834         __u32                   lgc_index;
1835         __u32                   lgc_padding;
1836 } __attribute__((packed));
1837
1838 /* llog protocol */
1839 enum llogd_rpc_ops {
1840         LLOG_ORIGIN_HANDLE_CREATE       = 501,
1841         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
1842         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
1843         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
1844         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
1845         LLOG_ORIGIN_CONNECT             = 506,
1846         LLOG_CATINFO                    = 507,  /* for lfs catinfo */
1847         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
1848         LLOG_ORIGIN_HANDLE_DESTROY      = 509,  /* for destroy llog object*/
1849         LLOG_LAST_OPC,
1850         LLOG_FIRST_OPC                  = LLOG_ORIGIN_HANDLE_CREATE
1851 };
1852
1853 struct llogd_body {
1854         struct llog_logid  lgd_logid;
1855         __u32 lgd_ctxt_idx;
1856         __u32 lgd_llh_flags;
1857         __u32 lgd_index;
1858         __u32 lgd_saved_index;
1859         __u32 lgd_len;
1860         __u64 lgd_cur_offset;
1861 } __attribute__((packed));
1862
1863 struct llogd_conn_body {
1864         struct llog_gen         lgdc_gen;
1865         struct llog_logid       lgdc_logid;
1866         __u32                   lgdc_ctxt_idx;
1867 } __attribute__((packed));
1868
1869 struct lov_user_ost_data_join {   /* per-stripe data structure */
1870         __u64 l_extent_start;     /* extent start*/
1871         __u64 l_extent_end;       /* extent end*/
1872         __u64 l_object_id;        /* OST object ID */
1873         __u64 l_object_gr;        /* OST object group (creating MDS number) */
1874         __u32 l_ost_gen;          /* generation of this OST index */
1875         __u32 l_ost_idx;          /* OST index in LOV */
1876 } __attribute__((packed));
1877
1878 struct lov_user_md_join {         /* LOV EA user data (host-endian) */
1879         __u32 lmm_magic;          /* magic number = LOV_MAGIC_JOIN */
1880         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1881         __u64 lmm_object_id;      /* LOV object ID */
1882         __u64 lmm_object_gr;      /* LOV object group */
1883         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1884         __u32 lmm_stripe_count;   /* num stripes in use for this object */
1885         __u32 lmm_extent_count;   /* extent count of lmm*/
1886         __u64 lmm_tree_id;        /* mds tree object id */
1887         __u64 lmm_tree_gen;       /* mds tree object gen */
1888         struct llog_logid lmm_array_id; /* mds extent desc llog object id */
1889         struct lov_user_ost_data_join lmm_objects[0]; /* per-stripe data */
1890 } __attribute__((packed));
1891
1892 extern void lustre_swab_lov_user_md(struct lov_user_md *lum);
1893 extern void lustre_swab_lov_user_md_objects(struct lov_user_md *lum);
1894 extern void lustre_swab_lov_user_md_join(struct lov_user_md_join *lumj);
1895
1896 /* llog_swab.c */
1897 extern void lustre_swab_llogd_body (struct llogd_body *d);
1898 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
1899 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
1900 extern void lustre_swab_llog_rec(struct llog_rec_hdr  *rec,
1901                                  struct llog_rec_tail *tail);
1902
1903 struct lustre_cfg;
1904 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
1905
1906 /* quota. fixed by tianzy for bug10707 */
1907 #define QUOTA_IS_GRP   0X1UL  /* 0 is user, 1 is group. Used by qd_flags*/
1908 #define QUOTA_IS_BLOCK 0x2UL  /* 0 is inode, 1 is block. Used by qd_flags*/
1909
1910 struct qunit_data {
1911         __u32 qd_id; /* ID appiles to (uid, gid) */
1912         __u32 qd_flags; /* Quota type (USRQUOTA, GRPQUOTA) occupy one bit;
1913                          * Block quota or file quota occupy one bit */
1914         __u64 qd_count; /* acquire/release count (bytes for block quota) */
1915 };
1916
1917 struct qunit_data_old {
1918         __u32 qd_id;    /* ID appiles to (uid, gid) */
1919         __u32 qd_type;  /* Quota type (USRQUOTA, GRPQUOTA) */
1920         __u32 qd_count; /* acquire/release count (bytes for block quota) */
1921         __u32 qd_isblk; /* Block quota or file quota */
1922 };
1923
1924 extern void lustre_swab_qdata(struct qunit_data *d);
1925 extern void lustre_swab_qdata_old(struct qunit_data_old *d);
1926 extern struct qunit_data *lustre_quota_old_to_new(struct qunit_data_old *d);
1927 extern struct qunit_data_old *lustre_quota_new_to_old(struct qunit_data *d);
1928
1929 typedef enum {
1930         QUOTA_DQACQ     = 601,
1931         QUOTA_DQREL     = 602,
1932 } quota_cmd_t;
1933
1934 #define JOIN_FILE_ALIGN 4096
1935
1936 /* security opcodes */
1937 typedef enum {
1938         SEC_CTX_INIT            = 801,
1939         SEC_CTX_INIT_CONT       = 802,
1940         SEC_CTX_FINI            = 803,
1941         SEC_LAST_OPC,
1942         SEC_FIRST_OPC           = SEC_CTX_INIT
1943 } sec_cmd_t;
1944
1945 /*
1946  * capa related definitions
1947  */
1948 #define CAPA_HMAC_MAX_LEN       64
1949 #define CAPA_HMAC_KEY_MAX_LEN   56
1950
1951 /* NB take care when changing the sequence of elements this struct,
1952  * because the offset info is used in find_capa() */
1953 struct lustre_capa {
1954         struct lu_fid   lc_fid;       /* fid */
1955         __u64           lc_opc;       /* operations allowed */
1956         __u32           lc_uid;       /* uid, this is legacy and for OSS only */
1957         __u32           lc_flags;     /* HMAC algorithm & flags */
1958         __u32           lc_keyid;     /* key used for the capability */
1959         __u32           lc_timeout;   /* capa timeout value (sec) */
1960         __u64           lc_expiry;    /* expiry time (sec) */
1961         __u8            lc_hmac[CAPA_HMAC_MAX_LEN];   /* HMAC */
1962 } __attribute__((packed));
1963
1964 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
1965
1966 /* lustre_capa.lc_opc */
1967 enum {
1968         CAPA_OPC_BODY_WRITE   = 1<<0,  /* write object data */
1969         CAPA_OPC_BODY_READ    = 1<<1,  /* read object data */
1970         CAPA_OPC_INDEX_LOOKUP = 1<<2,  /* lookup object fid */
1971         CAPA_OPC_INDEX_INSERT = 1<<3,  /* insert object fid */
1972         CAPA_OPC_INDEX_DELETE = 1<<4,  /* delete object fid */
1973         CAPA_OPC_OSS_WRITE    = 1<<5,  /* write oss object data */
1974         CAPA_OPC_OSS_READ     = 1<<6,  /* read oss object data */
1975         CAPA_OPC_OSS_TRUNC    = 1<<7,  /* truncate oss object */
1976         CAPA_OPC_META_WRITE   = 1<<8,  /* write object meta data */
1977         CAPA_OPC_META_READ    = 1<<9,  /* read object meta data */
1978
1979 };
1980
1981 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
1982 #define CAPA_OPC_MDS_ONLY                                                   \
1983         (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
1984          CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
1985 #define CAPA_OPC_OSS_ONLY                                                   \
1986         (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC)
1987 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
1988 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
1989
1990 /* MDS capability covers object capability for operations of body r/w
1991  * (dir readpage/sendpage), index lookup/insert/delete and meta data r/w,
1992  * while OSS capability only covers object capability for operations of
1993  * oss data(file content) r/w/truncate.
1994  */
1995 static inline int capa_for_mds(struct lustre_capa *c)
1996 {
1997         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) != 0;
1998 }
1999
2000 static inline int capa_for_oss(struct lustre_capa *c)
2001 {
2002         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) == 0;
2003 }
2004
2005 /* lustre_capa.lc_hmac_alg */
2006 enum {
2007         CAPA_HMAC_ALG_SHA1 = 1, /* sha1 algorithm */
2008         CAPA_HMAC_ALG_MAX,
2009 };
2010
2011 #define CAPA_FL_MASK            0x00ffffff
2012 #define CAPA_HMAC_ALG_MASK      0xff000000
2013
2014 struct lustre_capa_key {
2015         __u64   lk_mdsid;     /* mds# */
2016         __u32   lk_keyid;     /* key# */
2017         __u32   lk_padding;
2018         __u8    lk_key[CAPA_HMAC_KEY_MAX_LEN];    /* key */
2019 } __attribute__((packed));
2020
2021 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
2022
2023 /* quota check function */
2024 #define QUOTA_RET_OK           0 /* return successfully */
2025 #define QUOTA_RET_NOQUOTA      1 /* not support quota */
2026 #define QUOTA_RET_NOLIMIT      2 /* quota limit isn't set */
2027 #define QUOTA_RET_ACQUOTA      3 /* need to acquire extra quota */
2028 #endif