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