drivers/staging/lustre/lustre/include/lustre_fld.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2015, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32
  33 #ifndef __LINUX_FLD_H
  34 #define __LINUX_FLD_H
  35
  36 /** \defgroup fld fld
  37  *
  38  * @{
  39  */
  40
  41 #include <uapi/linux/lustre/lustre_idl.h>
  42 #include <linux/libcfs/libcfs.h>
  43 #include <seq_range.h>
  44
  45 struct lu_client_fld;
  46 struct lu_server_fld;
  47 struct lu_fld_hash;
  48 struct fld_cache;
  49
  50 extern const struct dt_index_features fld_index_features;
  51 extern const char fld_index_name[];
  52
  53 /*
  54  * FLD (Fid Location Database) interface.
  55  */
  56 enum {
  57         LUSTRE_CLI_FLD_HASH_DHT = 0,
  58         LUSTRE_CLI_FLD_HASH_RRB
  59 };
  60
  61 struct lu_fld_target {
  62         struct list_head               ft_chain;
  63         struct obd_export       *ft_exp;
  64         struct lu_server_fld    *ft_srv;
  65         __u64               ft_idx;
  66 };
  67
  68 struct lu_server_fld {
  69         /**
  70          * super sequence controller export, needed to forward fld
  71          * lookup  request.
  72          */
  73         struct obd_export       *lsf_control_exp;
  74
  75         /** Client FLD cache. */
  76         struct fld_cache        *lsf_cache;
  77
  78         /** Protect index modifications */
  79         struct mutex            lsf_lock;
  80
  81         /** Fld service name in form "fld-srv-lustre-MDTXXX" */
  82         char                 lsf_name[LUSTRE_MDT_MAXNAMELEN];
  83
  84 };
  85
  86 struct lu_client_fld {
  87         /** Client side debugfs entry. */
  88         struct dentry           *lcf_debugfs_entry;
  89
  90         /** List of exports client FLD knows about. */
  91         struct list_head               lcf_targets;
  92
  93         /** Current hash to be used to chose an export. */
  94         struct lu_fld_hash      *lcf_hash;
  95
  96         /** Exports count. */
  97         int                   lcf_count;
  98
  99         /** Lock protecting exports list and fld_hash. */
 100         spinlock_t               lcf_lock;
 101
 102         /** Client FLD cache. */
 103         struct fld_cache        *lcf_cache;
 104
 105         /** Client fld debugfs entry name. */
 106         char                     lcf_name[LUSTRE_MDT_MAXNAMELEN];
 107 };
 108
 109 /* Client methods */
 110 int fld_client_init(struct lu_client_fld *fld,
 111                     const char *prefix, int hash);
 112
 113 void fld_client_fini(struct lu_client_fld *fld);
 114
 115 void fld_client_flush(struct lu_client_fld *fld);
 116
 117 int fld_client_lookup(struct lu_client_fld *fld, u64 seq, u32 *mds,
 118                       __u32 flags, const struct lu_env *env);
 119
 120 int fld_client_create(struct lu_client_fld *fld,
 121                       struct lu_seq_range *range,
 122                       const struct lu_env *env);
 123
 124 int fld_client_delete(struct lu_client_fld *fld, u64 seq,
 125                       const struct lu_env *env);
 126
 127 int fld_client_add_target(struct lu_client_fld *fld,
 128                           struct lu_fld_target *tar);
 129
 130 int fld_client_del_target(struct lu_client_fld *fld,
 131                           __u64 idx);
 132
 133 void fld_client_debugfs_fini(struct lu_client_fld *fld);
 134
 135 /** @} fld */
 136
 137 #endif