lustre/fld/fld_internal.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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, 2013, Intel Corporation.
  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/fld/fld_internal.h
  37  *
  38  * Author: Yury Umanets <umka@clusterfs.com>
  39  * Author: Tom WangDi <wangdi@clusterfs.com>
  40  */
  41 #ifndef __FLD_INTERNAL_H
  42 #define __FLD_INTERNAL_H
  43
  44 #include <lustre/lustre_idl.h>
  45 #include <dt_object.h>
  46
  47 #include <libcfs/libcfs.h>
  48 #include <lustre_req_layout.h>
  49 #include <lustre_fld.h>
  50
  51 enum {
  52         LUSTRE_FLD_INIT = 1 << 0,
  53         LUSTRE_FLD_RUN  = 1 << 1
  54 };
  55
  56 struct fld_stats {
  57         __u64   fst_count;
  58         __u64   fst_cache;
  59         __u64   fst_inflight;
  60 };
  61
  62 typedef int (*fld_hash_func_t) (struct lu_client_fld *, __u64);
  63
  64 typedef struct lu_fld_target *
  65 (*fld_scan_func_t) (struct lu_client_fld *, __u64);
  66
  67 struct lu_fld_hash {
  68         const char              *fh_name;
  69         fld_hash_func_t          fh_hash_func;
  70         fld_scan_func_t          fh_scan_func;
  71 };
  72
  73 struct fld_cache_entry {
  74         cfs_list_t               fce_lru;
  75         cfs_list_t               fce_list;
  76         /**
  77          * fld cache entries are sorted on range->lsr_start field. */
  78         struct lu_seq_range      fce_range;
  79 };
  80
  81 struct fld_cache {
  82         /**
  83          * Cache guard, protects fci_hash mostly because others immutable after
  84          * init is finished.
  85          */
  86         spinlock_t               fci_lock;
  87
  88         /**
  89          * Cache shrink threshold */
  90         int                      fci_threshold;
  91
  92         /**
  93          * Prefered number of cached entries */
  94         int                      fci_cache_size;
  95
  96         /**
  97          * Current number of cached entries. Protected by \a fci_lock */
  98         int                      fci_cache_count;
  99
 100         /**
 101          * LRU list fld entries. */
 102         cfs_list_t               fci_lru;
 103
 104         /**
 105          * sorted fld entries. */
 106         cfs_list_t               fci_entries_head;
 107
 108         /**
 109          * Cache statistics. */
 110         struct fld_stats         fci_stat;
 111
 112         /**
 113          * Cache name used for debug and messages. */
 114         char                     fci_name[80];
 115         int                     fci_no_shrink:1;
 116 };
 117
 118 enum fld_op {
 119         FLD_CREATE = 0,
 120         FLD_DELETE = 1,
 121         FLD_LOOKUP = 2
 122 };
 123
 124 enum {
 125         /* 4M of FLD cache will not hurt client a lot. */
 126         FLD_SERVER_CACHE_SIZE      = (4 * 0x100000),
 127
 128         /* 1M of FLD cache will not hurt client a lot. */
 129         FLD_CLIENT_CACHE_SIZE      = (1 * 0x100000)
 130 };
 131
 132 enum {
 133         /* Cache threshold is 10 percent of size. */
 134         FLD_SERVER_CACHE_THRESHOLD = 10,
 135
 136         /* Cache threshold is 10 percent of size. */
 137         FLD_CLIENT_CACHE_THRESHOLD = 10
 138 };
 139
 140 extern struct lu_fld_hash fld_hash[];
 141
 142 #ifdef __KERNEL__
 143
 144 struct fld_thread_info {
 145         struct req_capsule *fti_pill;
 146         __u64               fti_key;
 147         struct lu_seq_range fti_rec;
 148         struct lu_seq_range fti_lrange;
 149         struct lu_seq_range fti_irange;
 150 };
 151
 152 extern struct lu_context_key fld_thread_key;
 153
 154 int fld_index_init(const struct lu_env *env, struct lu_server_fld *fld,
 155                    struct dt_device *dt);
 156
 157 void fld_index_fini(const struct lu_env *env, struct lu_server_fld *fld);
 158
 159 int fld_declare_index_create(const struct lu_env *env,
 160                              struct lu_server_fld *fld,
 161                              const struct lu_seq_range *new,
 162                              struct thandle *th);
 163
 164 int fld_index_create(const struct lu_env *env, struct lu_server_fld *fld,
 165                      const struct lu_seq_range *new, struct thandle *th);
 166
 167 int fld_index_lookup(const struct lu_env *env, struct lu_server_fld *fld,
 168                      seqno_t seq, struct lu_seq_range *range);
 169
 170 int fld_client_rpc(struct obd_export *exp,
 171                    struct lu_seq_range *range, __u32 fld_op);
 172
 173 #ifdef LPROCFS
 174 extern struct lprocfs_vars fld_server_proc_list[];
 175 extern struct lprocfs_vars fld_client_proc_list[];
 176 #endif
 177
 178 #endif
 179
 180 struct fld_cache *fld_cache_init(const char *name,
 181                                  int cache_size, int cache_threshold);
 182
 183 void fld_cache_fini(struct fld_cache *cache);
 184
 185 void fld_cache_flush(struct fld_cache *cache);
 186
 187 int fld_cache_insert(struct fld_cache *cache,
 188                      const struct lu_seq_range *range);
 189
 190 struct fld_cache_entry
 191 *fld_cache_entry_create(const struct lu_seq_range *range);
 192
 193 int fld_cache_insert_nolock(struct fld_cache *cache,
 194                             struct fld_cache_entry *f_new);
 195 void fld_cache_delete(struct fld_cache *cache,
 196                       const struct lu_seq_range *range);
 197 void fld_cache_delete_nolock(struct fld_cache *cache,
 198                              const struct lu_seq_range *range);
 199 int fld_cache_lookup(struct fld_cache *cache,
 200                      const seqno_t seq, struct lu_seq_range *range);
 201
 202 struct fld_cache_entry*
 203 fld_cache_entry_lookup(struct fld_cache *cache, struct lu_seq_range *range);
 204 void fld_cache_entry_delete(struct fld_cache *cache,
 205                             struct fld_cache_entry *node);
 206 void fld_dump_cache_entries(struct fld_cache *cache);
 207
 208 struct fld_cache_entry
 209 *fld_cache_entry_lookup_nolock(struct fld_cache *cache,
 210                               struct lu_seq_range *range);
 211 int fld_write_range(const struct lu_env *env, struct dt_object *dt,
 212                     const struct lu_seq_range *range, struct thandle *th);
 213
 214 static inline const char *
 215 fld_target_name(struct lu_fld_target *tar)
 216 {
 217         if (tar->ft_srv != NULL)
 218                 return tar->ft_srv->lsf_name;
 219
 220         return (const char *)tar->ft_exp->exp_obd->obd_name;
 221 }
 222
 223 extern cfs_proc_dir_entry_t *fld_type_proc_dir;
 224 extern struct file_operations fld_proc_seq_fops;
 225 #endif /* __FLD_INTERNAL_H */