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