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