lustre/include/lustre/lustre_idl.h

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