lustre/include/lustre/lustre_idl.h

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