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_CANCELSET  0x01000000ULL /* Early batched cancels. */
 526 #define OBD_CONNECT_REAL       0x00000200ULL /* real connection */
 527 /* also update obd_connect_names[] for lprocfs_rd_connect_flags()
 528  * and lustre/utils/wirecheck.c */
 529
 530 #define MDT_CONNECT_SUPPORTED  (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
 531                                 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
 532                                 OBD_CONNECT_IBITS | OBD_CONNECT_JOIN | \
 533                                 OBD_CONNECT_NODEVOH |/* OBD_CONNECT_ATTRFID |*/\
 534                                 OBD_CONNECT_LCL_CLIENT | \
 535                                 OBD_CONNECT_RMT_CLIENT | \
 536                                 OBD_CONNECT_MDS_CAPA | OBD_CONNECT_OSS_CAPA | \
 537                                 OBD_CONNECT_MDS_MDS | OBD_CONNECT_CANCELSET)
 538 #define OST_CONNECT_SUPPORTED  (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
 539                                 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
 540                                 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
 541                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_QUOTA64 | \
 542                                 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_CANCELSET)
 543 #define ECHO_CONNECT_SUPPORTED (0)
 544 #define MGS_CONNECT_SUPPORTED  (OBD_CONNECT_VERSION)
 545
 546 #define MAX_QUOTA_COUNT32 ((0xffffffffULL >> QUOTABLOCK_BITS) << QUOTABLOCK_BITS)
 547
 548 #define OBD_OCD_VERSION(major,minor,patch,fix) (((major)<<24) + ((minor)<<16) +\
 549                                                 ((patch)<<8) + (fix))
 550 #define OBD_OCD_VERSION_MAJOR(version) ((int)((version)>>24)&255)
 551 #define OBD_OCD_VERSION_MINOR(version) ((int)((version)>>16)&255)
 552 #define OBD_OCD_VERSION_PATCH(version) ((int)((version)>>8)&255)
 553 #define OBD_OCD_VERSION_FIX(version)   ((int)(version)&255)
 554
 555 #define exp_connect_cancelset(exp) \
 556         ((exp) ? (exp)->exp_connect_flags & OBD_CONNECT_CANCELSET : 0)
 557
 558 /* This structure is used for both request and reply.
 559  *
 560  * If we eventually have separate connect data for different types, which we
 561  * almost certainly will, then perhaps we stick a union in here. */
 562 struct obd_connect_data {
 563         __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
 564         __u32 ocd_version;       /* lustre release version number */
 565         __u32 ocd_grant;         /* initial cache grant amount (bytes) */
 566         __u32 ocd_index;         /* LOV index to connect to */
 567         __u32 ocd_brw_size;      /* Maximum BRW size in bytes */
 568         __u64 ocd_ibits_known;   /* inode bits this client understands */
 569         __u32 ocd_nllu;          /* non-local-lustre-user */
 570         __u32 ocd_nllg;          /* non-local-lustre-group */
 571         __u64 ocd_transno;       /* first transno from client to be replayed */
 572         __u32 ocd_group;         /* MDS group on OST */
 573         __u32 padding1;          /* also fix lustre_swab_connect */
 574         __u64 padding2;          /* also fix lustre_swab_connect */
 575         __u64 padding3;          /* also fix lustre_swab_connect */
 576 };
 577
 578 extern void lustre_swab_connect(struct obd_connect_data *ocd);
 579
 580 /*
 581  *   OST requests: OBDO & OBD request records
 582  */
 583
 584 /* opcodes */
 585 typedef enum {
 586         OST_REPLY      =  0,       /* reply ? */
 587         OST_GETATTR    =  1,
 588         OST_SETATTR    =  2,
 589         OST_READ       =  3,
 590         OST_WRITE      =  4,
 591         OST_CREATE     =  5,
 592         OST_DESTROY    =  6,
 593         OST_GET_INFO   =  7,
 594         OST_CONNECT    =  8,
 595         OST_DISCONNECT =  9,
 596         OST_PUNCH      = 10,
 597         OST_OPEN       = 11,
 598         OST_CLOSE      = 12,
 599         OST_STATFS     = 13,
 600         OST_SYNC       = 16,
 601         OST_SET_INFO   = 17,
 602         OST_QUOTACHECK = 18,
 603         OST_QUOTACTL   = 19,
 604         OST_LAST_OPC
 605 } ost_cmd_t;
 606 #define OST_FIRST_OPC  OST_REPLY
 607
 608 typedef uint64_t        obd_id;
 609 typedef uint64_t        obd_gr;
 610 typedef uint64_t        obd_time;
 611 typedef uint64_t        obd_size;
 612 typedef uint64_t        obd_off;
 613 typedef uint64_t        obd_blocks;
 614 typedef uint32_t        obd_blksize;
 615 typedef uint32_t        obd_mode;
 616 typedef uint32_t        obd_uid;
 617 typedef uint32_t        obd_gid;
 618 typedef uint32_t        obd_flag;
 619 typedef uint64_t        obd_valid;
 620 typedef uint32_t        obd_count;
 621
 622 #define OBD_FL_INLINEDATA    (0x00000001)
 623 #define OBD_FL_OBDMDEXISTS   (0x00000002)
 624 #define OBD_FL_DELORPHAN     (0x00000004) /* if set in o_flags delete orphans */
 625 #define OBD_FL_NORPC         (0x00000008) /* set in o_flags do in OSC not OST */
 626 #define OBD_FL_IDONLY        (0x00000010) /* set in o_flags only adjust obj id*/
 627 #define OBD_FL_RECREATE_OBJS (0x00000020) /* recreate missing obj */
 628 #define OBD_FL_DEBUG_CHECK   (0x00000040) /* echo client/server debug check */
 629 #define OBD_FL_NO_USRQUOTA   (0x00000100) /* the object's owner is over quota */
 630 #define OBD_FL_NO_GRPQUOTA   (0x00000200) /* the object's group is over quota */
 631
 632 /*
 633  * Set this to delegate DLM locking during obd_punch() to the OSTs. Only OSTs
 634  * that declared OBD_CONNECT_TRUNCLOCK in their connect flags support this
 635  * functionality.
 636  */
 637 #define OBD_FL_TRUNCLOCK     (0x00000800)
 638
 639 /*
 640  * This should not be smaller than sizeof(struct lustre_handle) + sizeof(struct
 641  * llog_cookie) + sizeof(struct ll_fid). Nevertheless struct ll_fid is not
 642  * longer stored in o_inline, we keep this just for case.
 643  */
 644 #define OBD_INLINESZ    80
 645
 646 /* Note: 64-bit types are 64-bit aligned in structure */
 647 struct obdo {
 648         obd_valid               o_valid;        /* hot fields in this obdo */
 649         obd_id                  o_id;
 650         obd_gr                  o_gr;
 651         obd_id                  o_fid;
 652         obd_size                o_size;         /* o_size-o_blocks == ost_lvb */
 653         obd_time                o_mtime;
 654         obd_time                o_atime;
 655         obd_time                o_ctime;
 656         obd_blocks              o_blocks;       /* brw: cli sent cached bytes */
 657         obd_size                o_grant;
 658
 659         /* 32-bit fields start here: keep an even number of them via padding */
 660         obd_blksize             o_blksize;      /* optimal IO blocksize */
 661         obd_mode                o_mode;         /* brw: cli sent cache remain */
 662         obd_uid                 o_uid;
 663         obd_gid                 o_gid;
 664         obd_flag                o_flags;
 665         obd_count               o_nlink;        /* brw: checksum */
 666         obd_count               o_generation;
 667         obd_count               o_misc;         /* brw: o_dropped */
 668         __u32                   o_easize;       /* epoch in ost writes */
 669         __u32                   o_mds;
 670         __u32                   o_stripe_idx;   /* holds stripe idx */
 671         __u32                   o_padding_1;
 672         char                    o_inline[OBD_INLINESZ];
 673                                 /* lustre_handle + llog_cookie */
 674 };
 675
 676 #define o_dirty   o_blocks
 677 #define o_undirty o_mode
 678 #define o_dropped o_misc
 679 #define o_cksum   o_nlink
 680
 681 extern void lustre_swab_obdo (struct obdo *o);
 682
 683
 684 #define LOV_MAGIC_V1      0x0BD10BD0
 685 #define LOV_MAGIC         LOV_MAGIC_V1
 686 #define LOV_MAGIC_JOIN    0x0BD20BD0
 687
 688 #define LOV_PATTERN_RAID0 0x001   /* stripes are used round-robin */
 689 #define LOV_PATTERN_RAID1 0x002   /* stripes are mirrors of each other */
 690 #define LOV_PATTERN_FIRST 0x100   /* first stripe is not in round-robin */
 691 #define LOV_PATTERN_CMOBD 0x200
 692
 693 #define lov_ost_data lov_ost_data_v1
 694 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
 695         __u64 l_object_id;        /* OST object ID */
 696         __u64 l_object_gr;        /* OST object group (creating MDS number) */
 697         __u32 l_ost_gen;          /* generation of this l_ost_idx */
 698         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
 699 };
 700
 701 #define lov_mds_md lov_mds_md_v1
 702 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
 703         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
 704         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 705         __u64 lmm_object_id;      /* LOV object ID */
 706         __u64 lmm_object_gr;      /* LOV object group */
 707         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 708         __u32 lmm_stripe_count;   /* num stripes in use for this object */
 709         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 710 };
 711
 712 extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm);
 713
 714 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
 715 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
 716
 717 #define XATTR_NAME_ACL_ACCESS   "system.posix_acl_access"
 718 #define XATTR_NAME_ACL_DEFAULT  "system.posix_acl_default"
 719 #define XATTR_NAME_LOV          "trusted.lov"
 720
 721 /* remote ACL */
 722 #define XATTR_NAME_LUSTRE_ACL   "system.lustre_acl"
 723
 724 #define OBD_MD_FLID        (0x00000001ULL) /* object ID */
 725 #define OBD_MD_FLATIME     (0x00000002ULL) /* access time */
 726 #define OBD_MD_FLMTIME     (0x00000004ULL) /* data modification time */
 727 #define OBD_MD_FLCTIME     (0x00000008ULL) /* change time */
 728 #define OBD_MD_FLSIZE      (0x00000010ULL) /* size */
 729 #define OBD_MD_FLBLOCKS    (0x00000020ULL) /* allocated blocks count */
 730 #define OBD_MD_FLBLKSZ     (0x00000040ULL) /* block size */
 731 #define OBD_MD_FLMODE      (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
 732 #define OBD_MD_FLTYPE      (0x00000100ULL) /* object type (mode & S_IFMT) */
 733 #define OBD_MD_FLUID       (0x00000200ULL) /* user ID */
 734 #define OBD_MD_FLGID       (0x00000400ULL) /* group ID */
 735 #define OBD_MD_FLFLAGS     (0x00000800ULL) /* flags word */
 736 #define OBD_MD_FLNLINK     (0x00002000ULL) /* link count */
 737 #define OBD_MD_FLGENER     (0x00004000ULL) /* generation number */
 738 #define OBD_MD_FLINLINE    (0x00008000ULL) /* inline data */
 739 #define OBD_MD_FLRDEV      (0x00010000ULL) /* device number */
 740 #define OBD_MD_FLEASIZE    (0x00020000ULL) /* extended attribute data */
 741 #define OBD_MD_LINKNAME    (0x00040000ULL) /* symbolic link target */
 742 #define OBD_MD_FLHANDLE    (0x00080000ULL) /* file handle */
 743 #define OBD_MD_FLCKSUM     (0x00100000ULL) /* bulk data checksum */
 744 #define OBD_MD_FLQOS       (0x00200000ULL) /* quality of service stats */
 745 #define OBD_MD_FLOSCOPQ    (0x00400000ULL) /* osc opaque data */
 746 #define OBD_MD_FLCOOKIE    (0x00800000ULL) /* log cancellation cookie */
 747 #define OBD_MD_FLGROUP     (0x01000000ULL) /* group */
 748 #define OBD_MD_FLFID       (0x02000000ULL) /* ->ost write inline fid */
 749 #define OBD_MD_FLEPOCH     (0x04000000ULL) /* ->ost write easize is epoch */
 750                                            /* ->mds if epoch opens or closes */
 751 #define OBD_MD_FLGRANT     (0x08000000ULL) /* ost preallocation space grant */
 752 #define OBD_MD_FLDIREA     (0x10000000ULL) /* dir's extended attribute data */
 753 #define OBD_MD_FLUSRQUOTA  (0x20000000ULL) /* over quota flags sent from ost */
 754 #define OBD_MD_FLGRPQUOTA  (0x40000000ULL) /* over quota flags sent from ost */
 755 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
 756
 757 #define OBD_MD_MDS         (0x0000000100000000ULL) /* where an inode lives on */
 758 #define OBD_MD_REINT       (0x0000000200000000ULL) /* reintegrate oa */
 759 #define OBD_MD_MEA         (0x0000000400000000ULL) /* CMD split EA  */
 760
 761 #define OBD_MD_FLXATTR     (0x0000001000000000ULL) /* xattr */
 762 #define OBD_MD_FLXATTRLS   (0x0000002000000000ULL) /* xattr list */
 763 #define OBD_MD_FLXATTRRM   (0x0000004000000000ULL) /* xattr remove */
 764 #define OBD_MD_FLACL       (0x0000008000000000ULL) /* ACL */
 765 #define OBD_MD_FLRMTPERM   (0x0000010000000000ULL) /* remote permission */
 766 #define OBD_MD_FLMDSCAPA   (0x0000020000000000ULL) /* MDS capability */
 767 #define OBD_MD_FLOSSCAPA   (0x0000040000000000ULL) /* OSS capability */
 768 #define OBD_MD_FLCKSPLIT   (0x0000080000000000ULL) /* Check split on server */
 769 #define OBD_MD_FLCROSSREF  (0x0000100000000000ULL) /* Cross-ref case */
 770
 771 #define OBD_MD_FLGETATTR (OBD_MD_FLID    | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
 772                           OBD_MD_FLCTIME | OBD_MD_FLSIZE  | OBD_MD_FLBLKSZ | \
 773                           OBD_MD_FLMODE  | OBD_MD_FLTYPE  | OBD_MD_FLUID   | \
 774                           OBD_MD_FLGID   | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
 775                           OBD_MD_FLGENER | OBD_MD_FLRDEV  | OBD_MD_FLGROUP)
 776
 777 static inline struct lustre_handle *obdo_handle(struct obdo *oa)
 778 {
 779         return (struct lustre_handle *)oa->o_inline;
 780 }
 781
 782 static inline struct llog_cookie *obdo_logcookie(struct obdo *oa)
 783 {
 784         return (struct llog_cookie *)(oa->o_inline +
 785                                       sizeof(struct lustre_handle));
 786 }
 787 /* don't forget obdo_fid which is way down at the bottom so it can
 788  * come after the definition of llog_cookie */
 789
 790 struct obd_statfs {
 791         __u64           os_type;
 792         __u64           os_blocks;
 793         __u64           os_bfree;
 794         __u64           os_bavail;
 795         __u64           os_files;
 796         __u64           os_ffree;
 797         __u8            os_fsid[40];
 798         __u32           os_bsize;
 799         __u32           os_namelen;
 800         __u64           os_maxbytes;
 801         __u32           os_state;       /* positive error code on server */
 802         __u32           os_spare1;
 803         __u32           os_spare2;
 804         __u32           os_spare3;
 805         __u32           os_spare4;
 806         __u32           os_spare5;
 807         __u32           os_spare6;
 808         __u32           os_spare7;
 809         __u32           os_spare8;
 810         __u32           os_spare9;
 811 };
 812
 813 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
 814
 815 /* ost_body.data values for OST_BRW */
 816
 817 #define OBD_BRW_READ            0x01
 818 #define OBD_BRW_WRITE           0x02
 819 #define OBD_BRW_RWMASK          (OBD_BRW_READ | OBD_BRW_WRITE)
 820 #define OBD_BRW_SYNC            0x08
 821 #define OBD_BRW_CHECK           0x10
 822 #define OBD_BRW_FROM_GRANT      0x20 /* the osc manages this under llite */
 823 #define OBD_BRW_GRANTED         0x40 /* the ost manages this */
 824 #define OBD_BRW_DROP            0x80 /* drop the page after IO */
 825 #define OBD_BRW_NOQUOTA        0x100
 826 #define OBD_BRW_SRVLOCK        0x200 /* Client holds no lock over this page */
 827
 828 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
 829
 830 #define OST_MIN_PRECREATE 32
 831 #define OST_MAX_PRECREATE 20000
 832
 833 struct obd_ioobj {
 834         obd_id               ioo_id;
 835         obd_gr               ioo_gr;
 836         __u32                ioo_type;
 837         __u32                ioo_bufcnt;
 838 };
 839
 840 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
 841
 842 /* multiple of 8 bytes => can array */
 843 struct niobuf_remote {
 844         __u64 offset;
 845         __u32 len;
 846         __u32 flags;
 847 };
 848
 849 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
 850
 851 /* request structure for OST's */
 852
 853 struct ost_body {
 854         struct  obdo oa;
 855 };
 856
 857 extern void lustre_swab_ost_body (struct ost_body *b);
 858 extern void lustre_swab_ost_last_id(obd_id *id);
 859
 860 /* lock value block communicated between the filter and llite */
 861
 862 struct ost_lvb {
 863         __u64 lvb_size;
 864         __u64 lvb_mtime;
 865         __u64 lvb_atime;
 866         __u64 lvb_ctime;
 867         __u64 lvb_blocks;
 868 };
 869
 870 extern void lustre_swab_ost_lvb(struct ost_lvb *);
 871
 872 /*
 873  *   MDS REQ RECORDS
 874  */
 875
 876 /* opcodes */
 877 typedef enum {
 878         MDS_GETATTR      = 33,
 879         MDS_GETATTR_NAME = 34,
 880         MDS_CLOSE        = 35,
 881         MDS_REINT        = 36,
 882         MDS_READPAGE     = 37,
 883         MDS_CONNECT      = 38,
 884         MDS_DISCONNECT   = 39,
 885         MDS_GETSTATUS    = 40,
 886         MDS_STATFS       = 41,
 887         MDS_PIN          = 42,
 888         MDS_UNPIN        = 43,
 889         MDS_SYNC         = 44,
 890         MDS_DONE_WRITING = 45,
 891         MDS_SET_INFO     = 46,
 892         MDS_QUOTACHECK   = 47,
 893         MDS_QUOTACTL     = 48,
 894         MDS_GETXATTR     = 49,
 895         MDS_SETXATTR     = 50,
 896         MDS_WRITEPAGE    = 51,
 897         MDS_IS_SUBDIR    = 52,
 898         MDS_LAST_OPC
 899 } mds_cmd_t;
 900
 901 #define MDS_FIRST_OPC    MDS_GETATTR
 902
 903 /*
 904  * Do not exceed 63
 905  */
 906
 907 typedef enum {
 908         REINT_SETATTR  = 1,
 909         REINT_CREATE   = 2,
 910         REINT_LINK     = 3,
 911         REINT_UNLINK   = 4,
 912         REINT_RENAME   = 5,
 913         REINT_OPEN     = 6,
 914         REINT_MAX
 915 } mds_reint_t, mdt_reint_t;
 916
 917 extern void lustre_swab_generic_32s (__u32 *val);
 918
 919 /* the disposition of the intent outlines what was executed */
 920 #define DISP_IT_EXECD        0x00000001
 921 #define DISP_LOOKUP_EXECD    0x00000002
 922 #define DISP_LOOKUP_NEG      0x00000004
 923 #define DISP_LOOKUP_POS      0x00000008
 924 #define DISP_OPEN_CREATE     0x00000010
 925 #define DISP_OPEN_OPEN       0x00000020
 926 #define DISP_ENQ_COMPLETE    0x00400000
 927 #define DISP_ENQ_OPEN_REF    0x00800000
 928 #define DISP_ENQ_CREATE_REF  0x01000000
 929 #define DISP_OPEN_LOCK       0x02000000
 930
 931 /* INODE LOCK PARTS */
 932 #define MDS_INODELOCK_LOOKUP 0x000001       /* dentry, mode, owner, group */
 933 #define MDS_INODELOCK_UPDATE 0x000002       /* size, links, timestamps */
 934 #define MDS_INODELOCK_OPEN   0x000004       /* For opened files */
 935
 936 /* Do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits */
 937 #define MDS_INODELOCK_MAXSHIFT 2
 938 /* This FULL lock is useful to take on unlink sort of operations */
 939 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
 940
 941 struct ll_fid {
 942         __u64 id;         /* holds object id */
 943         __u32 generation; /* holds object generation */
 944
 945         __u32 f_type;     /* holds object type or stripe idx when passing it to
 946                            * OST for saving into EA. */
 947 };
 948
 949 extern void lustre_swab_ll_fid (struct ll_fid *fid);
 950
 951 #define MDS_STATUS_CONN 1
 952 #define MDS_STATUS_LOV 2
 953
 954 struct mds_status_req {
 955         __u32  flags;
 956         __u32  repbuf;
 957 };
 958
 959 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
 960
 961 /* mdt_thread_info.mti_flags. */
 962 enum md_op_flags {
 963         /* The flag indicates Size-on-MDS attributes are changed. */
 964         MF_SOM_CHANGE           = (1 << 0),
 965         /* Flags indicates an epoch opens or closes. */
 966         MF_EPOCH_OPEN           = (1 << 1),
 967         MF_EPOCH_CLOSE          = (1 << 2),
 968         MF_MDC_CANCEL_FID1      = (1 << 3),
 969         MF_MDC_CANCEL_FID2      = (1 << 4),
 970         MF_MDC_CANCEL_FID3      = (1 << 5),
 971         MF_MDC_CANCEL_FID4      = (1 << 6),
 972 };
 973
 974 #define MF_SOM_LOCAL_FLAGS (MF_MDC_CANCEL_FID1 | MF_MDC_CANCEL_FID2 | \
 975                             MF_MDC_CANCEL_FID3 | MF_MDC_CANCEL_FID4)
 976
 977 #define MDS_BFLAG_UNCOMMITTED_WRITES   0x1
 978 #define MDS_BFLAG_EXT_FLAGS     0x80000000 /* == EXT3_RESERVED_FL */
 979
 980 /* these should be identical to their EXT3_*_FL counterparts, and are
 981  * redefined here only to avoid dragging in ext3_fs.h */
 982 #define MDS_SYNC_FL             0x00000008 /* Synchronous updates */
 983 #define MDS_IMMUTABLE_FL        0x00000010 /* Immutable file */
 984 #define MDS_APPEND_FL           0x00000020 /* writes to file may only append */
 985 #define MDS_NOATIME_FL          0x00000080 /* do not update atime */
 986 #define MDS_DIRSYNC_FL          0x00010000 /* dirsync behaviour (dir only) */
 987
 988 #ifdef __KERNEL__
 989 /* If MDS_BFLAG_IOC_FLAGS is set it means we requested EXT3_*_FL inode flags
 990  * and we need to decode these into local S_* flags in the inode.  Otherwise
 991  * we pass flags straight through (see bug 9486). */
 992 static inline int ll_ext_to_inode_flags(int flags)
 993 {
 994         return (flags & MDS_BFLAG_EXT_FLAGS) ?
 995                (((flags & MDS_SYNC_FL)      ? S_SYNC      : 0) |
 996                 ((flags & MDS_NOATIME_FL)   ? S_NOATIME   : 0) |
 997                 ((flags & MDS_APPEND_FL)    ? S_APPEND    : 0) |
 998 #if defined(S_DIRSYNC)
 999                 ((flags & MDS_DIRSYNC_FL)   ? S_DIRSYNC   : 0) |
1000 #endif
1001                 ((flags & MDS_IMMUTABLE_FL) ? S_IMMUTABLE : 0)) :
1002                (flags & ~MDS_BFLAG_EXT_FLAGS);
1003 }
1004
1005 /* If MDS_BFLAG_EXT_FLAGS is set it means we requested EXT3_*_FL inode flags
1006  * and we pass these straight through.  Otherwise we need to convert from
1007  * S_* flags to their EXT3_*_FL equivalents (see bug 9486). */
1008 static inline int ll_inode_to_ext_flags(int oflags, int iflags)
1009 {
1010         return (oflags & MDS_BFLAG_EXT_FLAGS) ? (oflags & ~MDS_BFLAG_EXT_FLAGS):
1011                (((iflags & S_SYNC)      ? MDS_SYNC_FL      : 0) |
1012                 ((iflags & S_NOATIME)   ? MDS_NOATIME_FL   : 0) |
1013                 ((iflags & S_APPEND)    ? MDS_APPEND_FL    : 0) |
1014 #if defined(S_DIRSYNC)
1015                 ((iflags & S_DIRSYNC)   ? MDS_DIRSYNC_FL   : 0) |
1016 #endif
1017                 ((iflags & S_IMMUTABLE) ? MDS_IMMUTABLE_FL : 0));
1018 }
1019 #endif
1020
1021 struct mdt_body {
1022         struct lu_fid  fid1;
1023         struct lu_fid  fid2;
1024         struct lustre_handle handle;
1025         __u64          valid;
1026         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1027         __u64          mtime;
1028         __u64          atime;
1029         __u64          ctime;
1030         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1031         __u64          ioepoch;
1032         __u32          fsuid;
1033         __u32          fsgid;
1034         __u32          capability;
1035         __u32          mode;
1036         __u32          uid;
1037         __u32          gid;
1038         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1039         __u32          rdev;
1040         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1041         __u32          suppgid;
1042         __u32          eadatasize;
1043         __u32          aclsize;
1044         __u32          max_mdsize;
1045         __u32          max_cookiesize; /* also fix lustre_swab_mdt_body */
1046 };
1047
1048 struct mds_body {
1049         struct ll_fid  fid1;
1050         struct ll_fid  fid2;
1051         struct lustre_handle handle;
1052         __u64          valid;
1053         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1054         __u64          mtime;
1055         __u64          atime;
1056         __u64          ctime;
1057         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1058         __u64          io_epoch;
1059         __u64          ino;
1060         __u32          fsuid;
1061         __u32          fsgid;
1062         __u32          capability;
1063         __u32          mode;
1064         __u32          uid;
1065         __u32          gid;
1066         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1067         __u32          rdev;
1068         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1069         __u32          generation;
1070         __u32          suppgid;
1071         __u32          eadatasize;
1072         __u32          aclsize;
1073         __u32          max_mdsize;
1074         __u32          max_cookiesize; /* also fix lustre_swab_mds_body */
1075         __u32          padding_4; /* also fix lustre_swab_mds_body */
1076 };
1077
1078 extern void lustre_swab_mds_body (struct mds_body *b);
1079 extern void lustre_swab_mdt_body (struct mdt_body *b);
1080
1081 struct mdt_epoch {
1082         struct lustre_handle handle;
1083         __u64  ioepoch;
1084         __u32  flags;
1085         __u32  padding;
1086 };
1087
1088 extern void lustre_swab_mdt_epoch (struct mdt_epoch *b);
1089
1090 #define Q_QUOTACHECK    0x800100
1091 #define Q_INITQUOTA     0x800101        /* init slave limits */
1092 #define Q_GETOINFO      0x800102        /* get obd quota info */
1093 #define Q_GETOQUOTA     0x800103        /* get obd quotas */
1094
1095 #define Q_TYPESET(oqc, type) \
1096         ((oqc)->qc_type == type || (oqc)->qc_type == UGQUOTA)
1097
1098 #define Q_GETOCMD(oqc) \
1099         ((oqc)->qc_cmd == Q_GETOINFO || (oqc)->qc_cmd == Q_GETOQUOTA)
1100
1101 struct obd_quotactl {
1102         __u32                   qc_cmd;
1103         __u32                   qc_type;
1104         __u32                   qc_id;
1105         __u32                   qc_stat;
1106         struct obd_dqinfo       qc_dqinfo;
1107         struct obd_dqblk        qc_dqblk;
1108 };
1109
1110 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1111
1112 /* inode access permission for remote user, the inode info are omitted,
1113  * for client knows them. */
1114 struct mds_remote_perm {
1115         __u32           rp_uid;
1116         __u32           rp_gid;
1117         __u32           rp_fsuid;
1118         __u32           rp_fsgid;
1119         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
1120 };
1121
1122 /* setxid permissions for mds_setxid_perm.mp_perm */
1123 #define LUSTRE_SETUID_PERM 0x01
1124 #define LUSTRE_SETGID_PERM 0x02
1125 #define LUSTRE_SETGRP_PERM 0x04
1126
1127 extern void lustre_swab_mds_remote_perm(struct mds_remote_perm *p);
1128
1129 struct mdt_remote_perm {
1130         __u32           rp_uid;
1131         __u32           rp_gid;
1132         __u32           rp_fsuid;
1133         __u32           rp_fsgid;
1134         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
1135 };
1136
1137 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
1138
1139 struct mds_rec_setattr {
1140         __u32           sa_opcode;
1141         __u32           sa_fsuid;
1142         __u32           sa_fsgid;
1143         __u32           sa_cap;
1144         __u32           sa_suppgid;
1145         __u32           sa_mode;
1146         struct ll_fid   sa_fid;
1147         __u64           sa_valid;
1148         __u64           sa_size;
1149         __u64           sa_mtime;
1150         __u64           sa_atime;
1151         __u64           sa_ctime;
1152         __u32           sa_uid;
1153         __u32           sa_gid;
1154         __u32           sa_attr_flags;
1155         __u32           sa_padding; /* also fix lustre_swab_mds_rec_setattr */
1156 };
1157
1158 extern void lustre_swab_mds_rec_setattr (struct mds_rec_setattr *sa);
1159
1160 struct mdt_rec_setattr {
1161         __u32           sa_opcode;
1162         __u32           sa_fsuid;
1163         __u32           sa_fsgid;
1164         __u32           sa_cap;
1165         __u32           sa_suppgid;
1166         __u32           sa_mode;
1167         struct lu_fid   sa_fid;
1168         __u64           sa_valid;
1169         __u64           sa_size;
1170         __u64           sa_blocks;
1171         __u64           sa_mtime;
1172         __u64           sa_atime;
1173         __u64           sa_ctime;
1174         __u32           sa_uid;
1175         __u32           sa_gid;
1176         __u32           sa_attr_flags;
1177         __u32           sa_padding; /* also fix lustre_swab_mds_rec_setattr */
1178 };
1179
1180 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
1181
1182 /* Remove this once we declare it in include/linux/fs.h (v21 kernel patch?) */
1183 #ifndef ATTR_CTIME_SET
1184 #define ATTR_CTIME_SET 0x2000
1185 #endif
1186
1187 #ifndef FMODE_READ
1188 #define FMODE_READ               00000001
1189 #define FMODE_WRITE              00000002
1190 #endif
1191
1192 #define FMODE_EPOCH              01000000
1193 #define FMODE_EPOCHLCK           02000000
1194 #define FMODE_SOM                04000000
1195 #define FMODE_CLOSED             0
1196
1197 #define MDS_OPEN_CREATED         00000010
1198 #define MDS_OPEN_CROSS           00000020
1199
1200 #define MDS_FMODE_EXEC           00000004
1201 #define MDS_OPEN_CREAT           00000100
1202 #define MDS_OPEN_EXCL            00000200
1203 #define MDS_OPEN_TRUNC           00001000
1204 #define MDS_OPEN_APPEND          00002000
1205 #define MDS_OPEN_SYNC            00010000
1206 #define MDS_OPEN_DIRECTORY       00200000
1207
1208 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
1209 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1210 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file*/
1211 #define MDS_CREATE_RMT_ACL    01000000000 /* indicate create on remote server
1212                                            * with default ACL */
1213 #define MDS_CREATE_SLAVE_OBJ  02000000000 /* indicate create slave object
1214                                            * actually, this is for create, not
1215                                            * conflict with other open flags */
1216 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
1217 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
1218 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
1219
1220 /* permission for create non-directory file */
1221 #define MAY_CREATE      (1 << 7)
1222 /* permission for create directory file */
1223 #define MAY_LINK        (1 << 8)
1224 /* permission for delete from the directory */
1225 #define MAY_UNLINK      (1 << 9)
1226 /* source's permission for rename */
1227 #define MAY_RENAME_SRC  (1 << 10)
1228 /* target's permission for rename */
1229 #define MAY_RENAME_TAR  (1 << 11)
1230 /* part (parent's) VTX permission check */
1231 #define MAY_VTX_PART    (1 << 12)
1232 /* full VTX permission check */
1233 #define MAY_VTX_FULL    (1 << 13)
1234
1235 enum {
1236         MDS_CHECK_SPLIT  = 1 << 0,
1237         MDS_CROSS_REF    = 1 << 1,
1238         MDS_VTX_BYPASS   = 1 << 2,
1239         MDS_PERM_BYPASS  = 1 << 3
1240 };
1241
1242 struct mds_rec_join {
1243         struct ll_fid  jr_fid;
1244         __u64          jr_headsize;
1245 };
1246
1247 extern void lustre_swab_mds_rec_join (struct mds_rec_join *jr);
1248
1249 struct mdt_rec_join {
1250         struct lu_fid  jr_fid;
1251         __u64          jr_headsize;
1252 };
1253
1254 extern void lustre_swab_mdt_rec_join (struct mdt_rec_join *jr);
1255
1256 struct mds_rec_create {
1257         __u32           cr_opcode;
1258         __u32           cr_fsuid;
1259         __u32           cr_fsgid;
1260         __u32           cr_cap;
1261         __u32           cr_flags; /* for use with open */
1262         __u32           cr_mode;
1263         struct ll_fid   cr_fid;
1264         struct ll_fid   cr_replayfid;
1265         __u64           cr_time;
1266         __u64           cr_rdev;
1267         __u32           cr_suppgid;
1268         __u32           cr_padding_1; /* also fix lustre_swab_mds_rec_create */
1269         __u32           cr_padding_2; /* also fix lustre_swab_mds_rec_create */
1270         __u32           cr_padding_3; /* also fix lustre_swab_mds_rec_create */
1271         __u32           cr_padding_4; /* also fix lustre_swab_mds_rec_create */
1272         __u32           cr_padding_5; /* also fix lustre_swab_mds_rec_create */
1273 };
1274
1275 extern void lustre_swab_mds_rec_create (struct mds_rec_create *cr);
1276
1277 struct mdt_rec_create {
1278         __u32           cr_opcode;
1279         __u32           cr_fsuid;
1280         __u32           cr_fsgid;
1281         __u32           cr_cap;
1282         __u32           cr_flags; /* for use with open */
1283         __u32           cr_mode;
1284         struct lustre_handle cr_old_handle; /* u64 handle in case of open replay */
1285         struct lu_fid   cr_fid1;
1286         struct lu_fid   cr_fid2;
1287         __u64           cr_time;
1288         __u64           cr_rdev;
1289         __u64           cr_ioepoch;
1290         __u32           cr_suppgid1;
1291         __u32           cr_suppgid2;
1292         __u32           cr_bias;
1293         __u32           cr_padding_1; /* pad for 64 bits*/
1294 };
1295
1296 extern void lustre_swab_mdt_rec_create (struct mdt_rec_create *cr);
1297
1298 struct mds_rec_link {
1299         __u32           lk_opcode;
1300         __u32           lk_fsuid;
1301         __u32           lk_fsgid;
1302         __u32           lk_cap;
1303         __u32           lk_suppgid1;
1304         __u32           lk_suppgid2;
1305         struct ll_fid   lk_fid1;
1306         struct ll_fid   lk_fid2;
1307         __u64           lk_time;
1308         __u32           lk_padding_1;  /* also fix lustre_swab_mds_rec_link */
1309         __u32           lk_padding_2;  /* also fix lustre_swab_mds_rec_link */
1310         __u32           lk_padding_3;  /* also fix lustre_swab_mds_rec_link */
1311         __u32           lk_padding_4;  /* also fix lustre_swab_mds_rec_link */
1312 };
1313
1314 extern void lustre_swab_mds_rec_link (struct mds_rec_link *lk);
1315
1316 struct mdt_rec_link {
1317         __u32           lk_opcode;
1318         __u32           lk_fsuid;
1319         __u32           lk_fsgid;
1320         __u32           lk_cap;
1321         __u32           lk_suppgid1;
1322         __u32           lk_suppgid2;
1323         struct lu_fid   lk_fid1;
1324         struct lu_fid   lk_fid2;
1325         __u64           lk_time;
1326         __u32           lk_bias;
1327         __u32           lk_padding_2;  /* also fix lustre_swab_mds_rec_link */
1328         __u32           lk_padding_3;  /* also fix lustre_swab_mds_rec_link */
1329         __u32           lk_padding_4;  /* also fix lustre_swab_mds_rec_link */
1330 };
1331
1332 extern void lustre_swab_mdt_rec_link (struct mdt_rec_link *lk);
1333
1334 struct mds_rec_unlink {
1335         __u32           ul_opcode;
1336         __u32           ul_fsuid;
1337         __u32           ul_fsgid;
1338         __u32           ul_cap;
1339         __u32           ul_suppgid;
1340         __u32           ul_mode;
1341         struct ll_fid   ul_fid1;
1342         struct ll_fid   ul_fid2;
1343         __u64           ul_time;
1344         __u32           ul_padding_1; /* also fix lustre_swab_mds_rec_unlink */
1345         __u32           ul_padding_2; /* also fix lustre_swab_mds_rec_unlink */
1346         __u32           ul_padding_3; /* also fix lustre_swab_mds_rec_unlink */
1347         __u32           ul_padding_4; /* also fix lustre_swab_mds_rec_unlink */
1348 };
1349
1350 extern void lustre_swab_mds_rec_unlink (struct mds_rec_unlink *ul);
1351
1352 struct mdt_rec_unlink {
1353         __u32           ul_opcode;
1354         __u32           ul_fsuid;
1355         __u32           ul_fsgid;
1356         __u32           ul_cap;
1357         __u32           ul_suppgid;
1358         __u32           ul_mode;
1359         struct lu_fid   ul_fid1;
1360         struct lu_fid   ul_fid2;
1361         __u64           ul_time;
1362         __u32           ul_bias;
1363         __u32           ul_padding_2; /* also fix lustre_swab_mds_rec_unlink */
1364         __u32           ul_padding_3; /* also fix lustre_swab_mds_rec_unlink */
1365         __u32           ul_padding_4; /* also fix lustre_swab_mds_rec_unlink */
1366 };
1367
1368 extern void lustre_swab_mdt_rec_unlink (struct mdt_rec_unlink *ul);
1369
1370 struct mds_rec_rename {
1371         __u32           rn_opcode;
1372         __u32           rn_fsuid;
1373         __u32           rn_fsgid;
1374         __u32           rn_cap;
1375         __u32           rn_suppgid1;
1376         __u32           rn_suppgid2;
1377         struct ll_fid   rn_fid1;
1378         struct ll_fid   rn_fid2;
1379         __u64           rn_time;
1380         __u32           rn_padding_1; /* also fix lustre_swab_mds_rec_rename */
1381         __u32           rn_padding_2; /* also fix lustre_swab_mds_rec_rename */
1382         __u32           rn_padding_3; /* also fix lustre_swab_mds_rec_rename */
1383         __u32           rn_padding_4; /* also fix lustre_swab_mds_rec_rename */
1384 };
1385
1386 extern void lustre_swab_mds_rec_rename (struct mds_rec_rename *rn);
1387
1388 struct mdt_rec_rename {
1389         __u32           rn_opcode;
1390         __u32           rn_fsuid;
1391         __u32           rn_fsgid;
1392         __u32           rn_cap;
1393         __u32           rn_suppgid1;
1394         __u32           rn_suppgid2;
1395         struct lu_fid   rn_fid1;
1396         struct lu_fid   rn_fid2;
1397         __u64           rn_time;
1398         __u32           rn_mode;      /* cross-ref rename has mode */
1399         __u32           rn_bias;      /* some operation flags */
1400         __u32           rn_padding_3; /* also fix lustre_swab_mdt_rec_rename */
1401         __u32           rn_padding_4; /* also fix lustre_swab_mdt_rec_rename */
1402 };
1403
1404 extern void lustre_swab_mdt_rec_rename (struct mdt_rec_rename *rn);
1405
1406 /* begin adding MDT by huanghua@clusterfs.com */
1407 struct lmv_desc {
1408         __u32 ld_tgt_count;                /* how many MDS's */
1409         __u32 ld_active_tgt_count;         /* how many active */
1410         struct obd_uuid ld_uuid;
1411 };
1412
1413 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
1414 /* end adding MDT by huanghua@clusterfs.com */
1415
1416 struct md_fld {
1417         seqno_t mf_seq;
1418         mdsno_t mf_mds;
1419 };
1420
1421 extern void lustre_swab_md_fld (struct md_fld *mf);
1422
1423 enum fld_rpc_opc {
1424         FLD_QUERY                       = 600,
1425         FLD_LAST_OPC,
1426         FLD_FIRST_OPC                   = FLD_QUERY
1427 };
1428
1429 enum seq_rpc_opc {
1430         SEQ_QUERY                       = 700,
1431         SEQ_LAST_OPC,
1432         SEQ_FIRST_OPC                   = SEQ_QUERY
1433 };
1434
1435 enum seq_op {
1436         SEQ_ALLOC_SUPER = 0,
1437         SEQ_ALLOC_META = 1
1438 };
1439
1440 /*
1441  *  LOV data structures
1442  */
1443
1444 #define LOV_MIN_STRIPE_SIZE 65536   /* maximum PAGE_SIZE (ia64), power of 2 */
1445 #define LOV_MAX_STRIPE_COUNT  160   /* until bug 4424 is fixed */
1446
1447 #define LOV_MAX_UUID_BUFFER_SIZE  8192
1448 /* The size of the buffer the lov/mdc reserves for the
1449  * array of UUIDs returned by the MDS.  With the current
1450  * protocol, this will limit the max number of OSTs per LOV */
1451
1452 #define LOV_DESC_MAGIC 0xB0CCDE5C
1453
1454 /* LOV settings descriptor (should only contain static info) */
1455 struct lov_desc {
1456         __u32 ld_tgt_count;                /* how many OBD's */
1457         __u32 ld_active_tgt_count;         /* how many active */
1458         __u32 ld_default_stripe_count;     /* how many objects are used */
1459         __u32 ld_pattern;                  /* default PATTERN_RAID0 */
1460         __u64 ld_default_stripe_size;      /* in bytes */
1461         __u64 ld_default_stripe_offset;    /* in bytes */
1462         __u32 ld_padding_0;                /* unused */
1463         __u32 ld_qos_maxage;               /* in second */
1464         __u32 ld_padding_1;                /* also fix lustre_swab_lov_desc */
1465         __u32 ld_padding_2;                /* also fix lustre_swab_lov_desc */
1466         struct obd_uuid ld_uuid;
1467 };
1468
1469 #define ld_magic ld_active_tgt_count       /* for swabbing from llogs */
1470
1471 extern void lustre_swab_lov_desc (struct lov_desc *ld);
1472
1473 /*
1474  *   LDLM requests:
1475  */
1476 /* opcodes -- MUST be distinct from OST/MDS opcodes */
1477 typedef enum {
1478         LDLM_ENQUEUE     = 101,
1479         LDLM_CONVERT     = 102,
1480         LDLM_CANCEL      = 103,
1481         LDLM_BL_CALLBACK = 104,
1482         LDLM_CP_CALLBACK = 105,
1483         LDLM_GL_CALLBACK = 106,
1484         LDLM_LAST_OPC
1485 } ldlm_cmd_t;
1486 #define LDLM_FIRST_OPC LDLM_ENQUEUE
1487
1488 #define RES_NAME_SIZE 4
1489 struct ldlm_res_id {
1490         __u64 name[RES_NAME_SIZE];
1491 };
1492
1493 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
1494
1495 /* lock types */
1496 typedef enum {
1497         LCK_MINMODE = 0,
1498         LCK_EX      = 1,
1499         LCK_PW      = 2,
1500         LCK_PR      = 4,
1501         LCK_CW      = 8,
1502         LCK_CR      = 16,
1503         LCK_NL      = 32,
1504         LCK_GROUP   = 64,
1505         LCK_MAXMODE
1506 } ldlm_mode_t;
1507
1508 typedef enum {
1509         LDLM_PLAIN     = 10,
1510         LDLM_EXTENT    = 11,
1511         LDLM_FLOCK     = 12,
1512         LDLM_IBITS     = 13,
1513         LDLM_MAX_TYPE
1514 } ldlm_type_t;
1515
1516 #define LDLM_MIN_TYPE LDLM_PLAIN
1517
1518 struct ldlm_extent {
1519         __u64 start;
1520         __u64 end;
1521         __u64 gid;
1522 };
1523
1524 struct ldlm_inodebits {
1525         __u64 bits;
1526 };
1527
1528 struct ldlm_flock {
1529         __u64 start;
1530         __u64 end;
1531         __u64 blocking_export;  /* not actually used over the wire */
1532         __u32 blocking_pid;     /* not actually used over the wire */
1533         __u32 pid;
1534 };
1535
1536 /* it's important that the fields of the ldlm_extent structure match
1537  * the first fields of the ldlm_flock structure because there is only
1538  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
1539  * this ever changes we will need to swab the union differently based
1540  * on the resource type. */
1541
1542 typedef union {
1543         struct ldlm_extent l_extent;
1544         struct ldlm_flock  l_flock;
1545         struct ldlm_inodebits l_inodebits;
1546 } ldlm_policy_data_t;
1547
1548 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
1549
1550 struct ldlm_intent {
1551         __u64 opc;
1552 };
1553
1554 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
1555
1556 struct ldlm_resource_desc {
1557         ldlm_type_t lr_type;
1558         __u32 lr_padding;       /* also fix lustre_swab_ldlm_resource_desc */
1559         struct ldlm_res_id lr_name;
1560 };
1561
1562 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
1563
1564 struct ldlm_lock_desc {
1565         struct ldlm_resource_desc l_resource;
1566         ldlm_mode_t l_req_mode;
1567         ldlm_mode_t l_granted_mode;
1568         ldlm_policy_data_t l_policy_data;
1569 };
1570
1571 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
1572
1573 #define LDLM_LOCKREQ_HANDLES 2
1574 #define LDLM_ENQUEUE_CANCEL_OFF 1
1575
1576 struct ldlm_request {
1577         __u32 lock_flags;
1578         __u32 lock_count;
1579         struct ldlm_lock_desc lock_desc;
1580         struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
1581 };
1582
1583 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
1584
1585 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
1586  * Otherwise, 2 are available. */
1587 #define ldlm_request_bufsize(count,type)                                \
1588 ({                                                                      \
1589         int _avail = LDLM_LOCKREQ_HANDLES;                              \
1590         _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
1591         sizeof(struct ldlm_request) +                                   \
1592         (count > _avail ? count - _avail : 0) *                         \
1593         sizeof(struct lustre_handle);                                   \
1594 })
1595
1596 struct ldlm_reply {
1597         __u32 lock_flags;
1598         __u32 lock_padding;     /* also fix lustre_swab_ldlm_reply */
1599         struct ldlm_lock_desc lock_desc;
1600         struct lustre_handle lock_handle;
1601         __u64  lock_policy_res1;
1602         __u64  lock_policy_res2;
1603 };
1604
1605 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
1606
1607 /*
1608  * Opcodes for mountconf (mgs and mgc)
1609  */
1610 typedef enum {
1611         MGS_CONNECT = 250,
1612         MGS_DISCONNECT,
1613         MGS_EXCEPTION,         /* node died, etc. */
1614         MGS_TARGET_REG,        /* whenever target starts up */
1615         MGS_TARGET_DEL,
1616         MGS_LAST_OPC
1617 } mgs_cmd_t;
1618 #define MGS_FIRST_OPC MGS_CONNECT
1619
1620 /* We pass this info to the MGS so it can write config logs */
1621 #define MTI_NAME_MAXLEN 64
1622 #define MTI_PARAM_MAXLEN 4096
1623 #define MTI_NIDS_MAX 32
1624 struct mgs_target_info {
1625         __u32            mti_lustre_ver;
1626         __u32            mti_stripe_index;
1627         __u32            mti_config_ver;
1628         __u32            mti_flags;
1629         __u32            mti_nid_count;
1630         __u32            padding;                    /* 64 bit align */
1631         char             mti_fsname[MTI_NAME_MAXLEN];
1632         char             mti_svname[MTI_NAME_MAXLEN];
1633         char             mti_uuid[sizeof(struct obd_uuid)];
1634         __u64            mti_nids[MTI_NIDS_MAX];     /* host nids (lnet_nid_t)*/
1635         char             mti_params[MTI_PARAM_MAXLEN];
1636 };
1637
1638 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
1639
1640 /* Config marker flags (in config log) */
1641 #define CM_START       0x01
1642 #define CM_END         0x02
1643 #define CM_SKIP        0x04
1644 #define CM_UPGRADE146  0x08
1645 #define CM_EXCLUDE     0x10
1646 #define CM_START_SKIP (CM_START | CM_SKIP)
1647
1648 struct cfg_marker {
1649         __u32             cm_step;       /* aka config version */
1650         __u32             cm_flags;
1651         __u32             cm_vers;       /* lustre release version number */
1652         __u32             padding;       /* 64 bit align */
1653         time_t            cm_createtime; /*when this record was first created */
1654         time_t            cm_canceltime; /*when this record is no longer valid*/
1655         char              cm_tgtname[MTI_NAME_MAXLEN];
1656         char              cm_comment[MTI_NAME_MAXLEN];
1657 };
1658
1659 /*
1660  * Opcodes for multiple servers.
1661  */
1662
1663 typedef enum {
1664         OBD_PING = 400,
1665         OBD_LOG_CANCEL,
1666         OBD_QC_CALLBACK,
1667         OBD_LAST_OPC
1668 } obd_cmd_t;
1669 #define OBD_FIRST_OPC OBD_PING
1670
1671 /* catalog of log objects */
1672
1673 /* Identifier for a single log object */
1674 struct llog_logid {
1675         __u64                   lgl_oid;
1676         __u64                   lgl_ogr;
1677         __u32                   lgl_ogen;
1678 } __attribute__((packed));
1679
1680 /* Records written to the CATALOGS list */
1681 #define CATLIST "CATALOGS"
1682 struct llog_catid {
1683         struct llog_logid       lci_logid;
1684         __u32                   lci_padding1;
1685         __u32                   lci_padding2;
1686         __u32                   lci_padding3;
1687 } __attribute__((packed));
1688
1689 /*join file lov mds md*/
1690 struct lov_mds_md_join {
1691         struct lov_mds_md lmmj_md;
1692         /*join private info*/
1693         struct llog_logid lmmj_array_id; /*array object id*/
1694         __u32  lmmj_extent_count;        /*array extent count*/
1695 };
1696
1697 /* Log data record types - there is no specific reason that these need to
1698  * be related to the RPC opcodes, but no reason not to (may be handy later?)
1699  */
1700 #define LLOG_OP_MAGIC 0x10600000
1701 #define LLOG_OP_MASK  0xfff00000
1702
1703 typedef enum {
1704         LLOG_PAD_MAGIC   = LLOG_OP_MAGIC | 0x00000,
1705         OST_SZ_REC       = LLOG_OP_MAGIC | 0x00f00,
1706         OST_RAID1_REC    = LLOG_OP_MAGIC | 0x01000,
1707         MDS_UNLINK_REC   = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_UNLINK,
1708         MDS_SETATTR_REC  = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_SETATTR,
1709         OBD_CFG_REC      = LLOG_OP_MAGIC | 0x20000,
1710         PTL_CFG_REC      = LLOG_OP_MAGIC | 0x30000, /* obsolete */
1711         LLOG_GEN_REC     = LLOG_OP_MAGIC | 0x40000,
1712         LLOG_JOIN_REC    = LLOG_OP_MAGIC | 0x50000,
1713         LLOG_HDR_MAGIC   = LLOG_OP_MAGIC | 0x45539,
1714         LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
1715 } llog_op_type;
1716
1717 /*
1718  * for now, continue to support old pad records which have 0 for their
1719  * type but still need to be swabbed for their length
1720  */
1721 #define LLOG_REC_HDR_NEEDS_SWABBING(r)                                  \
1722         (((r)->lrh_type & __swab32(LLOG_OP_MASK)) ==                    \
1723          __swab32(LLOG_OP_MAGIC) ||                                     \
1724          (((r)->lrh_type == 0) && ((r)->lrh_len > LLOG_CHUNK_SIZE)))
1725
1726 /* Log record header - stored in little endian order.
1727  * Each record must start with this struct, end with a llog_rec_tail,
1728  * and be a multiple of 256 bits in size.
1729  */
1730 struct llog_rec_hdr {
1731         __u32                   lrh_len;
1732         __u32                   lrh_index;
1733         __u32                   lrh_type;
1734         __u32                   padding;
1735 };
1736
1737 struct llog_rec_tail {
1738         __u32 lrt_len;
1739         __u32 lrt_index;
1740 };
1741
1742 struct llog_logid_rec {
1743         struct llog_rec_hdr     lid_hdr;
1744         struct llog_logid       lid_id;
1745         __u32                   padding1;
1746         __u32                   padding2;
1747         __u32                   padding3;
1748         __u32                   padding4;
1749         __u32                   padding5;
1750         struct llog_rec_tail    lid_tail;
1751 } __attribute__((packed));
1752
1753 /* MDS extent description
1754  * It is for joined file extent info, each extent info for joined file
1755  * just like (start, end, lmm).
1756  */
1757 struct mds_extent_desc {
1758         __u64                   med_start; /* extent start */
1759         __u64                   med_len;   /* extent length */
1760         struct lov_mds_md       med_lmm;   /* extent's lmm  */
1761 };
1762 /*Joined file array extent log record*/
1763 struct llog_array_rec {
1764         struct llog_rec_hdr     lmr_hdr;
1765         struct mds_extent_desc  lmr_med;
1766         struct llog_rec_tail    lmr_tail;
1767 };
1768
1769 struct llog_create_rec {
1770         struct llog_rec_hdr     lcr_hdr;
1771         struct ll_fid           lcr_fid;
1772         obd_id                  lcr_oid;
1773         obd_count               lcr_ogen;
1774         __u32                   padding;
1775         struct llog_rec_tail    lcr_tail;
1776 } __attribute__((packed));
1777
1778 struct llog_orphan_rec {
1779         struct llog_rec_hdr     lor_hdr;
1780         obd_id                  lor_oid;
1781         obd_count               lor_ogen;
1782         __u32                   padding;
1783         struct llog_rec_tail    lor_tail;
1784 } __attribute__((packed));
1785
1786 struct llog_unlink_rec {
1787         struct llog_rec_hdr     lur_hdr;
1788         obd_id                  lur_oid;
1789         obd_count               lur_ogen;
1790         __u32                   padding;
1791         struct llog_rec_tail    lur_tail;
1792 } __attribute__((packed));
1793
1794 struct llog_setattr_rec {
1795         struct llog_rec_hdr     lsr_hdr;
1796         obd_id                  lsr_oid;
1797         obd_count               lsr_ogen;
1798         __u32                   lsr_uid;
1799         __u32                   lsr_gid;
1800         __u32                   padding;
1801         struct llog_rec_tail    lsr_tail;
1802 } __attribute__((packed));
1803
1804 struct llog_size_change_rec {
1805         struct llog_rec_hdr     lsc_hdr;
1806         struct ll_fid           lsc_fid;
1807         __u32                   lsc_ioepoch;
1808         __u32                   padding;
1809         struct llog_rec_tail    lsc_tail;
1810 } __attribute__((packed));
1811
1812 struct llog_gen {
1813         __u64 mnt_cnt;
1814         __u64 conn_cnt;
1815 } __attribute__((packed));
1816
1817 struct llog_gen_rec {
1818         struct llog_rec_hdr     lgr_hdr;
1819         struct llog_gen         lgr_gen;
1820         struct llog_rec_tail    lgr_tail;
1821 };
1822 /* On-disk header structure of each log object, stored in little endian order */
1823 #define LLOG_CHUNK_SIZE         8192
1824 #define LLOG_HEADER_SIZE        (96)
1825 #define LLOG_BITMAP_BYTES       (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
1826
1827 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
1828
1829 /* flags for the logs */
1830 #define LLOG_F_ZAP_WHEN_EMPTY   0x1
1831 #define LLOG_F_IS_CAT           0x2
1832 #define LLOG_F_IS_PLAIN         0x4
1833
1834 struct llog_log_hdr {
1835         struct llog_rec_hdr     llh_hdr;
1836         __u64                   llh_timestamp;
1837         __u32                   llh_count;
1838         __u32                   llh_bitmap_offset;
1839         __u32                   llh_size;
1840         __u32                   llh_flags;
1841         __u32                   llh_cat_idx;
1842         /* for a catalog the first plain slot is next to it */
1843         struct obd_uuid         llh_tgtuuid;
1844         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
1845         __u32                   llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
1846         struct llog_rec_tail    llh_tail;
1847 } __attribute__((packed));
1848
1849 #define LLOG_BITMAP_SIZE(llh)  ((llh->llh_hdr.lrh_len -         \
1850                                  llh->llh_bitmap_offset -       \
1851                                  sizeof(llh->llh_tail)) * 8)
1852
1853 /* log cookies are used to reference a specific log file and a record therein */
1854 struct llog_cookie {
1855         struct llog_logid       lgc_lgl;
1856         __u32                   lgc_subsys;
1857         __u32                   lgc_index;
1858         __u32                   lgc_padding;
1859 } __attribute__((packed));
1860
1861 /* llog protocol */
1862 enum llogd_rpc_ops {
1863         LLOG_ORIGIN_HANDLE_CREATE       = 501,
1864         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
1865         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
1866         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
1867         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
1868         LLOG_ORIGIN_CONNECT             = 506,
1869         LLOG_CATINFO                    = 507,  /* for lfs catinfo */
1870         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
1871         LLOG_ORIGIN_HANDLE_DESTROY      = 509,  /* for destroy llog object*/
1872         LLOG_LAST_OPC,
1873         LLOG_FIRST_OPC                  = LLOG_ORIGIN_HANDLE_CREATE
1874 };
1875
1876 struct llogd_body {
1877         struct llog_logid  lgd_logid;
1878         __u32 lgd_ctxt_idx;
1879         __u32 lgd_llh_flags;
1880         __u32 lgd_index;
1881         __u32 lgd_saved_index;
1882         __u32 lgd_len;
1883         __u64 lgd_cur_offset;
1884 } __attribute__((packed));
1885
1886 struct llogd_conn_body {
1887         struct llog_gen         lgdc_gen;
1888         struct llog_logid       lgdc_logid;
1889         __u32                   lgdc_ctxt_idx;
1890 } __attribute__((packed));
1891
1892 struct lov_user_ost_data_join {   /* per-stripe data structure */
1893         __u64 l_extent_start;     /* extent start*/
1894         __u64 l_extent_end;       /* extent end*/
1895         __u64 l_object_id;        /* OST object ID */
1896         __u64 l_object_gr;        /* OST object group (creating MDS number) */
1897         __u32 l_ost_gen;          /* generation of this OST index */
1898         __u32 l_ost_idx;          /* OST index in LOV */
1899 } __attribute__((packed));
1900
1901 struct lov_user_md_join {         /* LOV EA user data (host-endian) */
1902         __u32 lmm_magic;          /* magic number = LOV_MAGIC_JOIN */
1903         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1904         __u64 lmm_object_id;      /* LOV object ID */
1905         __u64 lmm_object_gr;      /* LOV object group */
1906         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1907         __u32 lmm_stripe_count;   /* num stripes in use for this object */
1908         __u32 lmm_extent_count;   /* extent count of lmm*/
1909         __u64 lmm_tree_id;        /* mds tree object id */
1910         __u64 lmm_tree_gen;       /* mds tree object gen */
1911         struct llog_logid lmm_array_id; /* mds extent desc llog object id */
1912         struct lov_user_ost_data_join lmm_objects[0]; /* per-stripe data */
1913 } __attribute__((packed));
1914
1915 extern void lustre_swab_lov_user_md(struct lov_user_md *lum);
1916 extern void lustre_swab_lov_user_md_objects(struct lov_user_md *lum);
1917 extern void lustre_swab_lov_user_md_join(struct lov_user_md_join *lumj);
1918
1919 /* llog_swab.c */
1920 extern void lustre_swab_llogd_body (struct llogd_body *d);
1921 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
1922 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
1923 extern void lustre_swab_llog_rec(struct llog_rec_hdr  *rec,
1924                                  struct llog_rec_tail *tail);
1925
1926 struct lustre_cfg;
1927 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
1928
1929 /* quota. fixed by tianzy for bug10707 */
1930 #define QUOTA_IS_GRP   0X1UL  /* 0 is user, 1 is group. Used by qd_flags*/
1931 #define QUOTA_IS_BLOCK 0x2UL  /* 0 is inode, 1 is block. Used by qd_flags*/
1932
1933 struct qunit_data {
1934         __u32 qd_id; /* ID appiles to (uid, gid) */
1935         __u32 qd_flags; /* Quota type (USRQUOTA, GRPQUOTA) occupy one bit;
1936                          * Block quota or file quota occupy one bit */
1937         __u64 qd_count; /* acquire/release count (bytes for block quota) */
1938 };
1939
1940 struct qunit_data_old {
1941         __u32 qd_id;    /* ID appiles to (uid, gid) */
1942         __u32 qd_type;  /* Quota type (USRQUOTA, GRPQUOTA) */
1943         __u32 qd_count; /* acquire/release count (bytes for block quota) */
1944         __u32 qd_isblk; /* Block quota or file quota */
1945 };
1946
1947 extern void lustre_swab_qdata(struct qunit_data *d);
1948 extern void lustre_swab_qdata_old(struct qunit_data_old *d);
1949 extern struct qunit_data *lustre_quota_old_to_new(struct qunit_data_old *d);
1950 extern struct qunit_data_old *lustre_quota_new_to_old(struct qunit_data *d);
1951
1952 typedef enum {
1953         QUOTA_DQACQ     = 601,
1954         QUOTA_DQREL     = 602,
1955 } quota_cmd_t;
1956
1957 #define JOIN_FILE_ALIGN 4096
1958
1959 /* security opcodes */
1960 typedef enum {
1961         SEC_CTX_INIT            = 801,
1962         SEC_CTX_INIT_CONT       = 802,
1963         SEC_CTX_FINI            = 803,
1964         SEC_LAST_OPC,
1965         SEC_FIRST_OPC           = SEC_CTX_INIT
1966 } sec_cmd_t;
1967
1968 /*
1969  * capa related definitions
1970  */
1971 #define CAPA_HMAC_MAX_LEN       64
1972 #define CAPA_HMAC_KEY_MAX_LEN   56
1973
1974 /* NB take care when changing the sequence of elements this struct,
1975  * because the offset info is used in find_capa() */
1976 struct lustre_capa {
1977         struct lu_fid   lc_fid;       /* fid */
1978         __u64           lc_opc;       /* operations allowed */
1979         __u32           lc_uid;       /* uid, this is legacy and for OSS only */
1980         __u32           lc_flags;     /* HMAC algorithm & flags */
1981         __u32           lc_keyid;     /* key used for the capability */
1982         __u32           lc_timeout;   /* capa timeout value (sec) */
1983         __u64           lc_expiry;    /* expiry time (sec) */
1984         __u8            lc_hmac[CAPA_HMAC_MAX_LEN];   /* HMAC */
1985 } __attribute__((packed));
1986
1987 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
1988
1989 /* lustre_capa.lc_opc */
1990 enum {
1991         CAPA_OPC_BODY_WRITE   = 1<<0,  /* write object data */
1992         CAPA_OPC_BODY_READ    = 1<<1,  /* read object data */
1993         CAPA_OPC_INDEX_LOOKUP = 1<<2,  /* lookup object fid */
1994         CAPA_OPC_INDEX_INSERT = 1<<3,  /* insert object fid */
1995         CAPA_OPC_INDEX_DELETE = 1<<4,  /* delete object fid */
1996         CAPA_OPC_OSS_WRITE    = 1<<5,  /* write oss object data */
1997         CAPA_OPC_OSS_READ     = 1<<6,  /* read oss object data */
1998         CAPA_OPC_OSS_TRUNC    = 1<<7,  /* truncate oss object */
1999         CAPA_OPC_META_WRITE   = 1<<8,  /* write object meta data */
2000         CAPA_OPC_META_READ    = 1<<9,  /* read object meta data */
2001
2002 };
2003
2004 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
2005 #define CAPA_OPC_MDS_ONLY                                                   \
2006         (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
2007          CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
2008 #define CAPA_OPC_OSS_ONLY                                                   \
2009         (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC)
2010 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
2011 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
2012
2013 /* MDS capability covers object capability for operations of body r/w
2014  * (dir readpage/sendpage), index lookup/insert/delete and meta data r/w,
2015  * while OSS capability only covers object capability for operations of
2016  * oss data(file content) r/w/truncate.
2017  */
2018 static inline int capa_for_mds(struct lustre_capa *c)
2019 {
2020         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) != 0;
2021 }
2022
2023 static inline int capa_for_oss(struct lustre_capa *c)
2024 {
2025         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) == 0;
2026 }
2027
2028 /* lustre_capa.lc_hmac_alg */
2029 enum {
2030         CAPA_HMAC_ALG_SHA1 = 1, /* sha1 algorithm */
2031         CAPA_HMAC_ALG_MAX,
2032 };
2033
2034 #define CAPA_FL_MASK            0x00ffffff
2035 #define CAPA_HMAC_ALG_MASK      0xff000000
2036
2037 struct lustre_capa_key {
2038         __u64   lk_mdsid;     /* mds# */
2039         __u32   lk_keyid;     /* key# */
2040         __u32   lk_padding;
2041         __u8    lk_key[CAPA_HMAC_KEY_MAX_LEN];    /* key */
2042 } __attribute__((packed));
2043
2044 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
2045
2046 /* quota check function */
2047 #define QUOTA_RET_OK           0 /* return successfully */
2048 #define QUOTA_RET_NOQUOTA      1 /* not support quota */
2049 #define QUOTA_RET_NOLIMIT      2 /* quota limit isn't set */
2050 #define QUOTA_RET_ACQUOTA      3 /* need to acquire extra quota */
2051 #endif