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