lustre/include/lustre/lustre_idl.h

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