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