lustre/include/linux/lustre_mds.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2001-2003 Cluster File Systems, Inc. <info@clusterfs.com>
   5  *
   6  *   This file is part of Lustre, http://www.lustre.org.
   7  *
   8  *   Lustre is free software; you can redistribute it and/or
   9  *   modify it under the terms of version 2 of the GNU General Public
  10  *   License as published by the Free Software Foundation.
  11  *
  12  *   Lustre is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with Lustre; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  * MDS data structures.
  22  * See also lustre_idl.h for wire formats of requests.
  23  *
  24  */
  25
  26 #ifndef _LUSTRE_MDS_H
  27 #define _LUSTRE_MDS_H
  28
  29 #ifdef __KERNEL__
  30 # include <linux/fs.h>
  31 # include <linux/dcache.h>
  32 #endif
  33
  34 #include <linux/lustre_handles.h>
  35 #include <libcfs/kp30.h>
  36 #include <linux/lustre_idl.h>
  37 #include <linux/lustre_lib.h>
  38 #include <linux/lustre_dlm.h>
  39 #include <linux/lustre_log.h>
  40 #include <linux/lustre_export.h>
  41 #include <linux/lustre_ucache.h>
  42
  43 struct ldlm_lock_desc;
  44 struct mds_obd;
  45 struct ptlrpc_connection;
  46 struct ptlrpc_client;
  47 struct obd_export;
  48 struct ptlrpc_request;
  49 struct obd_device;
  50 struct ll_file_data;
  51
  52 struct mds_update_record {
  53         __u32               ur_opcode;
  54         struct lustre_id   *ur_id1;
  55         struct lustre_id   *ur_id2;
  56         int                 ur_namelen;
  57         char               *ur_name;
  58         int                 ur_tgtlen;
  59         char               *ur_tgt;
  60         int                 ur_eadatalen;
  61         void               *ur_eadata;
  62         int                 ur_ea2datalen;
  63         void               *ur_ea2data;
  64         int                 ur_ea3datalen;
  65         void               *ur_ea3data;
  66         int                 ur_cookielen;       /* obsolete? */
  67         struct llog_cookie *ur_logcookies;      /* obsolete? */
  68         struct iattr        ur_iattr;
  69         struct lvfs_ucred   ur_uc;
  70         __u64               ur_rdev;
  71         __u32               ur_mode;
  72         __u64               ur_time;
  73         __u32               ur_flags;
  74 };
  75
  76 #define ur_fsuid    ur_uc.luc_fsuid
  77 #define ur_fsgid    ur_uc.luc_fsgid
  78 #define ur_cap      ur_uc.luc_cap
  79 #define ur_uid      ur_uc.luc_uid
  80
  81
  82 #define MDS_LR_SERVER_SIZE    512
  83
  84 #define MDS_LR_CLIENT_START  8192
  85 #define MDS_LR_CLIENT_SIZE    128
  86 #if MDS_LR_CLIENT_START < MDS_LR_SERVER_SIZE
  87 #error "Can't have MDS_LR_CLIENT_START < MDS_LR_SERVER_SIZE"
  88 #endif
  89
  90 #define MDS_CLIENT_SLOTS 17
  91
  92 #define MDS_ROCOMPAT_LOVOBJID   0x00000001
  93 #define MDS_ROCOMPAT_SUPP       (MDS_ROCOMPAT_LOVOBJID)
  94
  95 #define MDS_INCOMPAT_SUPP       (0)
  96
  97 #define MDS_MASTER_OBD           1
  98 #define MDS_CACHE_OBD            0
  99
 100 /*flags for indicate the record are come from cmobd reint or
 101   mdc create */
 102 #define REC_REINT_CREATE        0x0001
 103
 104 /* Data stored per server at the head of the last_rcvd file.  In le32 order.
 105  * Try to keep this the same as fsd_server_data so we might one day merge. */
 106 struct mds_server_data {
 107         __u8  msd_uuid[40];        /* server UUID */
 108         __u64 msd_last_transno;    /* last completed transaction ID */
 109         __u64 msd_mount_count;     /* MDS incarnation number */
 110         __u64 msd_unused;
 111         __u32 msd_feature_compat;  /* compatible feature flags */
 112         __u32 msd_feature_rocompat;/* read-only compatible feature flags */
 113         __u32 msd_feature_incompat;/* incompatible feature flags */
 114         __u32 msd_server_size;     /* size of server data area */
 115         __u32 msd_client_start;    /* start of per-client data area */
 116         __u16 msd_client_size;     /* size of per-client data area */
 117         __u16 msd_subdir_count;    /* number of subdirectories for objects */
 118         __u64 msd_catalog_oid;     /* recovery catalog object id */
 119         __u32 msd_catalog_ogen;    /* recovery catalog inode generation */
 120         __u8  msd_peeruuid[40];    /* UUID of LOV/OSC associated with MDS */
 121         __u8  msd_padding[MDS_LR_SERVER_SIZE - 140];
 122 };
 123
 124 /* Data stored per client in the last_rcvd file.  In le32 order. */
 125 struct mds_client_data {
 126         __u8 mcd_uuid[40];      /* client UUID */
 127         __u64 mcd_last_transno; /* last completed transaction ID */
 128         __u64 mcd_last_xid;     /* xid for the last transaction */
 129         __u32 mcd_last_result;  /* result from last RPC */
 130         __u32 mcd_last_data;    /* per-op data (disposition for open &c.) */
 131         /* for MDS_CLOSE requests */
 132         __u64 mcd_last_close_transno; /* last completed transaction ID */
 133         __u64 mcd_last_close_xid;     /* xid for the last transaction */
 134         __u32 mcd_last_close_result;  /* result from last RPC */
 135         __u32 mcd_last_close_data;  /* per-op data (disposition for open &c.) */
 136         __u8 mcd_padding[MDS_LR_CLIENT_SIZE - 88];
 137 };
 138
 139 /* uid/gid mapping support for remote client, some of them
 140  * probably consume too much space??
 141  */
 142 #define MDS_IDMAP_HASHSIZE      (32)
 143 #define MDS_IDMAP_HASHFUNC(id)  ((id) & (MDS_IDMAP_HASHSIZE - 1))
 144
 145 #define MDS_RMT_UIDMAP_IDX      (0)
 146 #define MDS_LCL_UIDMAP_IDX      (1)
 147 #define MDS_RMT_GIDMAP_IDX      (2)
 148 #define MDS_LCL_GIDMAP_IDX      (3)
 149 #define MDS_IDMAP_N_HASHES      (4)
 150
 151 #define MDS_IDMAP_NOTFOUND      (-1)
 152
 153 struct mds_idmap_entry {
 154         struct list_head rmt_hash; /* hashed as rmt_id; */
 155         struct list_head lcl_hash; /* hashed as lcl_id; */
 156         atomic_t         refcount;
 157         uid_t            rmt_id;   /* remote uid/gid */
 158         uid_t            lcl_id;   /* local uid/gid */
 159 };
 160
 161 struct mds_idmap_table {
 162         spinlock_t       mit_lock;
 163         struct list_head mit_idmaps[MDS_IDMAP_N_HASHES][MDS_IDMAP_HASHSIZE];
 164 };
 165
 166 /* file data for open files on MDS */
 167 struct mds_file_data {
 168         struct portals_handle mfd_handle; /* must be first */
 169         atomic_t              mfd_refcount;
 170         struct list_head      mfd_list;
 171         __u64                 mfd_xid;
 172         int                   mfd_mode;
 173         struct dentry        *mfd_dentry;
 174 };
 175
 176 /* group hash table */
 177 struct mds_grp_hash_entry {
 178         struct list_head        ge_hash;
 179         struct group_info      *ge_group_info;
 180         uid_t                   ge_uid;
 181         int                     ge_flags;
 182         atomic_t                ge_refcount;
 183         wait_queue_head_t       ge_waitq;
 184         long                    ge_acquisition_time;
 185         unsigned long           ge_acquire_expire;
 186         unsigned long           ge_expire;
 187 };
 188
 189 #define MDSGRP_HASH_SIZE        (128)
 190 #define MDSGRP_HASH_INDEX(id)   ((id) & (MDSGRP_HASH_SIZE - 1))
 191 #define MDSGRP_UPCALL_MAXPATH   (1024)
 192
 193 struct mds_grp_hash {
 194         struct list_head        gh_table[MDSGRP_HASH_SIZE];
 195         spinlock_t              gh_lock;
 196         char                    gh_upcall[MDSGRP_UPCALL_MAXPATH];
 197         int                     gh_entry_expire;
 198         int                     gh_acquire_expire;
 199         unsigned int            gh_allow_setgroups:1;
 200 };
 201
 202 #ifdef PTL_NETID_ANY
 203 #error "remove this"
 204 #endif
 205 #define PTL_NETID_ANY   ((ptl_netid_t) -1)
 206
 207 #define LSD_PERM_SETUID         0x00000001
 208 #define LSD_PERM_SETGID         0x00000002
 209 #define LSD_PERM_SETGRP         0x00000004
 210
 211 struct lsd_permission {
 212         ptl_nid_t       nid;
 213         ptl_netid_t     netid;
 214         __u32           perm;
 215 };
 216
 217 /* lustre security descriptor */
 218 struct lustre_sec_desc {
 219         unsigned int            lsd_invalid:1;
 220         uid_t                   lsd_uid;
 221         gid_t                   lsd_gid;
 222         struct group_info      *lsd_ginfo;
 223         __u32                   lsd_nperms;
 224         struct lsd_permission  *lsd_perms;
 225 };
 226
 227 struct lsd_cache_entry {
 228         struct upcall_cache_entry     base;
 229         struct lustre_sec_desc        lsd;
 230 };
 231
 232 struct lsd_downcall_args {
 233         int                     err;
 234         uid_t                   uid;
 235         gid_t                   gid;
 236         __u32                   ngroups;
 237         gid_t                  *groups;
 238         __u32                   nperms;
 239         struct lsd_permission  *perms;
 240 };
 241
 242 /* remote acl upcall */
 243 struct rmtacl_upcall_desc {
 244         int     status;         /* helper execution status */
 245         int     upcall_status;  /* error in upcall itself */
 246         int     get;            /* is getfacl */
 247         char   *cmd;            /* cmdline (up) */
 248         __u32   cmdlen;         /* cmdline length (up) */
 249         char   *res;            /* output (down) */
 250         __u32   reslen;         /* output length (down) */
 251         /* upcall internal use */
 252         uid_t   uid;
 253         char   *root;
 254 };
 255
 256 struct rmtacl_upcall_entry {
 257         struct upcall_cache_entry   base;
 258         struct rmtacl_upcall_desc  *desc;
 259 };
 260
 261 struct rmtacl_downcall_args {
 262         __u64   key;
 263         char   *res;            /* output text */
 264         __u32   reslen;         /* output text length */
 265         int     status;         /* helper exit code */
 266 };
 267
 268 /* mds/mds_reint.c  */
 269 int mds_reint_rec(struct mds_update_record *r, int offset,
 270                   struct ptlrpc_request *req, struct lustre_handle *);
 271
 272 /* mds/mds_lsd.c */
 273 __u32 mds_lsd_get_perms(struct lustre_sec_desc *lsd, __u32 is_remote,
 274                         ptl_netid_t netid, ptl_nid_t nid);
 275
 276 /* mds/handler.c */
 277 #ifdef __KERNEL__
 278 struct dentry *
 279 mds_id2dentry(struct obd_device *obd, struct lustre_id *id,
 280               struct vfsmount **mnt);
 281
 282 struct dentry *
 283 mds_id2locked_dentry(struct obd_device *obd, struct lustre_id *id,
 284                      struct vfsmount **mnt, int lock_mode,
 285                      struct lustre_handle *lockh, int *pmode,
 286                      char *name, int namelen, __u64 lockpart);
 287
 288 int mds_update_server_data(struct obd_device *, int force_sync);
 289 int mds_update_last_fid(struct obd_device *obd, void *handle,
 290                         int force_sync);
 291
 292 /* mds/mds_fs.c */
 293 int mds_fs_setup(struct obd_device *obddev, struct vfsmount *mnt);
 294 int mds_fs_cleanup(struct obd_device *obddev, int failover);
 295 #endif
 296
 297 /* mds/mds_lov.c */
 298
 299 /* mdc/mdc_locks.c */
 300 int it_disposition(struct lookup_intent *it, int flag);
 301 void it_set_disposition(struct lookup_intent *it, int flag);
 302 int it_open_error(int phase, struct lookup_intent *it);
 303 int mdc_set_lock_data(struct obd_export *exp, __u64 *lockh, void *data);
 304 int mdc_change_cbdata(struct obd_export *exp, struct lustre_id *id,
 305                       ldlm_iterator_t it, void *data);
 306 int mdc_intent_lock(struct obd_export *exp, struct lustre_id *parent,
 307                     const char *name, int len, void *lmm, int lmmsize,
 308                     struct lustre_id *child, struct lookup_intent *, int,
 309                     struct ptlrpc_request **reqp,
 310                     ldlm_blocking_callback cb_blocking);
 311 int mdc_enqueue(struct obd_export *exp,
 312                 int lock_type,
 313                 struct lookup_intent *it,
 314                 int lock_mode,
 315                 struct mdc_op_data *data,
 316                 struct lustre_handle *lockh,
 317                 void *lmm,
 318                 int lmmlen,
 319                 ldlm_completion_callback cb_completion,
 320                 ldlm_blocking_callback cb_blocking,
 321                 void *cb_data);
 322
 323 /* mdc/mdc_request.c */
 324 int mdc_req2lustre_md(struct obd_export *exp_lmv, struct ptlrpc_request *req,
 325                       unsigned int offset, struct obd_export *exp_lov,
 326                       struct lustre_md *md);
 327 int mdc_req2lustre_capa(struct ptlrpc_request *req, unsigned int offset,
 328                         struct lustre_capa **capa);
 329 int mdc_getstatus(struct obd_export *exp, struct lustre_id *rootid);
 330 int mdc_getattr(struct obd_export *exp, struct lustre_id *id,
 331                 __u64 valid, const char *xattr_name,
 332                 const void *xattr_data, unsigned int xattr_datalen,
 333                 unsigned int ea_size, struct obd_capa *ocapa,
 334                 struct ptlrpc_request **request);
 335 int mdc_getattr_lock(struct obd_export *exp, struct lustre_id *id,
 336                      char *filename, int namelen, __u64 valid,
 337                      unsigned int ea_size, struct ptlrpc_request **request);
 338 int mdc_setattr(struct obd_export *exp, struct mdc_op_data *data,
 339                 struct iattr *iattr, void *ea, int ealen, void *ea2, int ea2len,
 340                 void *ea3, int ea3len, struct ptlrpc_request **request);
 341 int mdc_open(struct obd_export *exp, obd_id ino, int type, int flags,
 342              struct lov_mds_md *lmm, int lmm_size, struct lustre_handle *fh,
 343              struct ptlrpc_request **);
 344
 345 struct obd_client_handle;
 346
 347 int mdc_set_open_replay_data(struct obd_export *exp,
 348                              struct obd_client_handle *och,
 349                              struct ptlrpc_request *open_req);
 350 int mdc_clear_open_replay_data(struct obd_export *exp,
 351                                struct obd_client_handle *och);
 352 int mdc_close(struct obd_export *, struct obdo *, struct obd_client_handle *,
 353               struct ptlrpc_request **);
 354 int mdc_readpage(struct obd_export *exp, struct lustre_id *id,
 355                  __u64, struct page *, struct ptlrpc_request **);
 356 int mdc_create(struct obd_export *exp, struct mdc_op_data *op_data,
 357                const void *data, int datalen, int mode, __u32 uid, __u32 gid,
 358                __u64 rdev, struct ptlrpc_request **request);
 359 int mdc_unlink(struct obd_export *exp, struct mdc_op_data *data,
 360                struct ptlrpc_request **request);
 361 int mdc_link(struct obd_export *exp, struct mdc_op_data *data,
 362              struct ptlrpc_request **);
 363 int mdc_rename(struct obd_export *exp, struct mdc_op_data *data,
 364                const char *old, int oldlen, const char *new, int newlen,
 365                struct ptlrpc_request **request);
 366 int mdc_sync(struct obd_export *exp, struct lustre_id *id,
 367              struct ptlrpc_request **);
 368 int mdc_create_client(struct obd_uuid uuid, struct ptlrpc_client *cl);
 369
 370 /* store the generation of a newly-created inode in |req| for replay. */
 371 int mdc_store_inode_generation(struct obd_export *exp,
 372                                struct ptlrpc_request *req,
 373                                int reqoff, int repoff);
 374
 375 int mdc_llog_process(struct obd_export *, char *, llog_cb_t,
 376                      void *);
 377
 378 int mdc_done_writing(struct obd_export *, struct obdo *);
 379
 380 /* mds_audit_path.c */
 381 int mds_audit_id2name(struct obd_device *obd, char **name, int *namelen,
 382                       struct lustre_id *id);
 383
 384 /* ioctls for trying requests */
 385 #define IOC_REQUEST_TYPE                 'f'
 386 #define IOC_REQUEST_MIN_NR               30
 387
 388 #define IOC_REQUEST_GETATTR             _IOWR('f', 30, long)
 389 #define IOC_REQUEST_READPAGE            _IOWR('f', 31, long)
 390 #define IOC_REQUEST_SETATTR             _IOWR('f', 32, long)
 391 #define IOC_REQUEST_CREATE              _IOWR('f', 33, long)
 392 #define IOC_REQUEST_OPEN                _IOWR('f', 34, long)
 393 #define IOC_REQUEST_CLOSE               _IOWR('f', 35, long)
 394 #define IOC_REQUEST_MAX_NR               35
 395
 396 #define MDS_CHECK_RESENT(req, reconstruct)                              \
 397 {                                                                       \
 398         if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) {        \
 399                 struct mds_client_data *mcd =                           \
 400                         req->rq_export->exp_mds_data.med_mcd;           \
 401                                                                         \
 402                 if (le64_to_cpu(mcd->mcd_last_xid) == req->rq_xid) {    \
 403                         reconstruct;                                    \
 404                         RETURN(le32_to_cpu(mcd->mcd_last_result));      \
 405                 }                                                       \
 406                 if (le64_to_cpu(mcd->mcd_last_close_xid) == req->rq_xid) { \
 407                         reconstruct;                                    \
 408                         RETURN(le32_to_cpu(mcd->mcd_last_close_result));\
 409                 }                                                       \
 410                 DEBUG_REQ(D_HA, req, "no reply for RESENT req"          \
 411                           "(have "LPD64", and "LPD64")",                \
 412                           mcd->mcd_last_xid, mcd->mcd_last_close_xid);  \
 413         }                                                               \
 414 }
 415
 416 #endif