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