4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/lov/lov_pool.c
36 * Author: Jacques-Charles LAFOUCRIERE <jc.lafoucriere@cea.fr>
37 * Author: Alex Lyashkov <Alexey.Lyashkov@Sun.COM>
38 * Author: Nathaniel Rutman <Nathan.Rutman@Sun.COM>
41 #define DEBUG_SUBSYSTEM S_LOV
43 #include <libcfs/libcfs.h>
46 #include "lov_internal.h"
48 #define pool_tgt(_p, _i) \
49 _p->pool_lobd->u.lov.lov_tgts[_p->pool_obds.op_array[_i]]
51 static void lov_pool_getref(struct pool_desc *pool)
53 CDEBUG(D_INFO, "pool %p\n", pool);
54 atomic_inc(&pool->pool_refcount);
57 static void lov_pool_putref(struct pool_desc *pool)
59 CDEBUG(D_INFO, "pool %p\n", pool);
60 if (atomic_dec_and_test(&pool->pool_refcount)) {
61 LASSERT(hlist_unhashed(&pool->pool_hash));
62 LASSERT(list_empty(&pool->pool_list));
63 LASSERT(pool->pool_proc_entry == NULL);
64 lov_ost_pool_free(&(pool->pool_obds));
70 static void lov_pool_putref_locked(struct pool_desc *pool)
72 CDEBUG(D_INFO, "pool %p\n", pool);
73 LASSERT(atomic_read(&pool->pool_refcount) > 1);
75 atomic_dec(&pool->pool_refcount);
79 * hash function using a Rotating Hash algorithm
80 * Knuth, D. The Art of Computer Programming,
81 * Volume 3: Sorting and Searching,
83 * Addison Wesley, 1973
85 static __u32 pool_hashfn(struct cfs_hash *hash_body, const void *key,
93 poolname = (char *)key;
94 for (i = 0; i < LOV_MAXPOOLNAME; i++) {
95 if (poolname[i] == '\0')
97 result = (result << 4)^(result >> 28) ^ poolname[i];
99 return (result % mask);
102 static void *pool_key(struct hlist_node *hnode)
104 struct pool_desc *pool;
106 pool = hlist_entry(hnode, struct pool_desc, pool_hash);
107 return (pool->pool_name);
111 pool_hashkey_keycmp(const void *key, struct hlist_node *compared_hnode)
114 struct pool_desc *pool;
116 pool_name = (char *)key;
117 pool = hlist_entry(compared_hnode, struct pool_desc, pool_hash);
118 return !strncmp(pool_name, pool->pool_name, LOV_MAXPOOLNAME);
121 static void *pool_hashobject(struct hlist_node *hnode)
123 return hlist_entry(hnode, struct pool_desc, pool_hash);
126 static void pool_hashrefcount_get(struct cfs_hash *hs, struct hlist_node *hnode)
128 struct pool_desc *pool;
130 pool = hlist_entry(hnode, struct pool_desc, pool_hash);
131 lov_pool_getref(pool);
134 static void pool_hashrefcount_put_locked(struct cfs_hash *hs,
135 struct hlist_node *hnode)
137 struct pool_desc *pool;
139 pool = hlist_entry(hnode, struct pool_desc, pool_hash);
140 lov_pool_putref_locked(pool);
143 struct cfs_hash_ops pool_hash_operations = {
144 .hs_hash = pool_hashfn,
146 .hs_keycmp = pool_hashkey_keycmp,
147 .hs_object = pool_hashobject,
148 .hs_get = pool_hashrefcount_get,
149 .hs_put_locked = pool_hashrefcount_put_locked,
153 #ifdef CONFIG_PROC_FS
155 * pool /proc seq_file methods
158 * iterator is used to go through the target pool entries
159 * index is the current entry index in the lp_array[] array
160 * index >= pos returned to the seq_file interface
161 * pos is from 0 to (pool->pool_obds.op_count - 1)
163 #define POOL_IT_MAGIC 0xB001CEA0
164 struct pool_iterator {
166 struct pool_desc *pool;
167 int idx; /* from 0 to pool_tgt_size - 1 */
170 static void *pool_proc_next(struct seq_file *s, void *v, loff_t *pos)
172 struct pool_iterator *iter = (struct pool_iterator *)s->private;
175 LASSERTF(iter->magic == POOL_IT_MAGIC, "%08X\n", iter->magic);
177 /* test if end of file */
178 if (*pos >= pool_tgt_count(iter->pool))
181 /* iterate to find a non empty entry */
182 prev_idx = iter->idx;
184 if (iter->idx >= pool_tgt_count(iter->pool)) {
185 iter->idx = prev_idx; /* we stay on the last entry */
189 /* return != NULL to continue */
193 static void *pool_proc_start(struct seq_file *s, loff_t *pos)
195 struct pool_desc *pool = (struct pool_desc *)s->private;
196 struct pool_iterator *iter;
198 lov_pool_getref(pool);
199 if ((pool_tgt_count(pool) == 0) ||
200 (*pos >= pool_tgt_count(pool))) {
201 /* iter is not created, so stop() has no way to
202 * find pool to dec ref */
203 lov_pool_putref(pool);
209 return ERR_PTR(-ENOMEM);
210 iter->magic = POOL_IT_MAGIC;
214 /* we use seq_file private field to memorized iterator so
215 * we can free it at stop() */
216 /* /!\ do not forget to restore it to pool before freeing it */
218 down_read(&pool_tgt_rw_sem(pool));
225 ptr = pool_proc_next(s, &iter, &i);
226 } while ((i < *pos) && (ptr != NULL));
232 static void pool_proc_stop(struct seq_file *s, void *v)
234 struct pool_iterator *iter = (struct pool_iterator *)s->private;
236 /* in some cases stop() method is called 2 times, without
237 * calling start() method (see seq_read() from fs/seq_file.c)
238 * we have to free only if s->private is an iterator */
239 if ((iter) && (iter->magic == POOL_IT_MAGIC)) {
240 up_read(&pool_tgt_rw_sem(iter->pool));
241 /* we restore s->private so next call to pool_proc_start()
243 s->private = iter->pool;
244 lov_pool_putref(iter->pool);
250 static int pool_proc_show(struct seq_file *s, void *v)
252 struct pool_iterator *iter = (struct pool_iterator *)v;
253 struct lov_tgt_desc *tgt;
255 LASSERTF(iter->magic == POOL_IT_MAGIC, "%08X\n", iter->magic);
256 LASSERT(iter->pool != NULL);
257 LASSERT(iter->idx <= pool_tgt_count(iter->pool));
259 tgt = pool_tgt(iter->pool, iter->idx);
261 seq_printf(s, "%s\n", obd_uuid2str(&(tgt->ltd_uuid)));
266 static struct seq_operations pool_proc_ops = {
267 .start = pool_proc_start,
268 .next = pool_proc_next,
269 .stop = pool_proc_stop,
270 .show = pool_proc_show,
273 static int pool_proc_open(struct inode *inode, struct file *file)
277 rc = seq_open(file, &pool_proc_ops);
279 struct seq_file *s = file->private_data;
280 s->private = PDE_DATA(inode);
285 static struct file_operations pool_proc_operations = {
286 .open = pool_proc_open,
289 .release = seq_release,
291 #endif /* CONFIG_PROC_FS */
293 void lov_dump_pool(int level, struct pool_desc *pool)
297 lov_pool_getref(pool);
299 CDEBUG(level, "pool "LOV_POOLNAMEF" has %d members\n",
300 pool->pool_name, pool->pool_obds.op_count);
301 down_read(&pool_tgt_rw_sem(pool));
303 for (i = 0; i < pool_tgt_count(pool) ; i++) {
304 if (!pool_tgt(pool, i) || !(pool_tgt(pool, i))->ltd_exp)
306 CDEBUG(level, "pool "LOV_POOLNAMEF"[%d] = %s\n",
308 obd_uuid2str(&((pool_tgt(pool, i))->ltd_uuid)));
311 up_read(&pool_tgt_rw_sem(pool));
312 lov_pool_putref(pool);
315 #define LOV_POOL_INIT_COUNT 2
316 int lov_ost_pool_init(struct ost_pool *op, unsigned int count)
321 count = LOV_POOL_INIT_COUNT;
324 init_rwsem(&op->op_rw_sem);
325 op->op_size = count * sizeof(op->op_array[0]);
326 OBD_ALLOC(op->op_array, op->op_size);
327 if (op->op_array == NULL) {
335 /* Caller must hold write op_rwlock */
336 int lov_ost_pool_extend(struct ost_pool *op, unsigned int min_count)
341 LASSERT(min_count != 0);
343 if (op->op_count * sizeof(op->op_array[0]) < op->op_size)
346 new_size = max_t(__u32, min_count * sizeof(op->op_array[0]),
348 OBD_ALLOC(new, new_size);
352 /* copy old array to new one */
353 memcpy(new, op->op_array, op->op_size);
354 OBD_FREE(op->op_array, op->op_size);
356 op->op_size = new_size;
360 int lov_ost_pool_add(struct ost_pool *op, __u32 idx, unsigned int min_count)
365 down_write(&op->op_rw_sem);
367 rc = lov_ost_pool_extend(op, min_count);
371 /* search ost in pool array */
372 for (i = 0; i < op->op_count; i++) {
373 if (op->op_array[i] == idx)
374 GOTO(out, rc = -EEXIST);
376 /* ost not found we add it */
377 op->op_array[op->op_count] = idx;
381 up_write(&op->op_rw_sem);
385 int lov_ost_pool_remove(struct ost_pool *op, __u32 idx)
390 down_write(&op->op_rw_sem);
392 for (i = 0; i < op->op_count; i++) {
393 if (op->op_array[i] == idx) {
394 memmove(&op->op_array[i], &op->op_array[i + 1],
395 (op->op_count - i - 1) * sizeof(op->op_array[0]));
397 up_write(&op->op_rw_sem);
403 up_write(&op->op_rw_sem);
407 int lov_ost_pool_free(struct ost_pool *op)
411 if (op->op_size == 0)
414 down_write(&op->op_rw_sem);
416 OBD_FREE(op->op_array, op->op_size);
421 up_write(&op->op_rw_sem);
426 int lov_pool_new(struct obd_device *obd, char *poolname)
429 struct pool_desc *new_pool;
435 if (strlen(poolname) > LOV_MAXPOOLNAME)
436 RETURN(-ENAMETOOLONG);
438 OBD_ALLOC_PTR(new_pool);
439 if (new_pool == NULL)
442 strlcpy(new_pool->pool_name, poolname, sizeof(new_pool->pool_name));
443 new_pool->pool_lobd = obd;
444 /* ref count init to 1 because when created a pool is always used
447 atomic_set(&new_pool->pool_refcount, 1);
448 rc = lov_ost_pool_init(&new_pool->pool_obds, 0);
452 INIT_HLIST_NODE(&new_pool->pool_hash);
454 #ifdef CONFIG_PROC_FS
455 /* get ref for /proc file */
456 lov_pool_getref(new_pool);
457 new_pool->pool_proc_entry = lprocfs_add_simple(lov->lov_pool_proc_entry,
459 &pool_proc_operations);
460 if (IS_ERR(new_pool->pool_proc_entry)) {
461 CWARN("Cannot add proc pool entry "LOV_POOLNAMEF"\n", poolname);
462 new_pool->pool_proc_entry = NULL;
463 lov_pool_putref(new_pool);
465 CDEBUG(D_INFO, "pool %p - proc %p\n",
466 new_pool, new_pool->pool_proc_entry);
469 spin_lock(&obd->obd_dev_lock);
470 list_add_tail(&new_pool->pool_list, &lov->lov_pool_list);
471 lov->lov_pool_count++;
472 spin_unlock(&obd->obd_dev_lock);
474 /* add to find only when it fully ready */
475 rc = cfs_hash_add_unique(lov->lov_pools_hash_body, poolname,
476 &new_pool->pool_hash);
478 GOTO(out_err, rc = -EEXIST);
480 CDEBUG(D_CONFIG, LOV_POOLNAMEF" is pool #%d\n",
481 poolname, lov->lov_pool_count);
486 spin_lock(&obd->obd_dev_lock);
487 list_del_init(&new_pool->pool_list);
488 lov->lov_pool_count--;
489 spin_unlock(&obd->obd_dev_lock);
490 lprocfs_remove(&new_pool->pool_proc_entry);
491 lov_ost_pool_free(&new_pool->pool_obds);
492 OBD_FREE_PTR(new_pool);
497 int lov_pool_del(struct obd_device *obd, char *poolname)
500 struct pool_desc *pool;
505 /* lookup and kill hash reference */
506 pool = cfs_hash_del_key(lov->lov_pools_hash_body, poolname);
510 if (pool->pool_proc_entry != NULL) {
511 CDEBUG(D_INFO, "proc entry %p\n", pool->pool_proc_entry);
512 lprocfs_remove(&pool->pool_proc_entry);
513 lov_pool_putref(pool);
516 spin_lock(&obd->obd_dev_lock);
517 list_del_init(&pool->pool_list);
518 lov->lov_pool_count--;
519 spin_unlock(&obd->obd_dev_lock);
521 /* release last reference */
522 lov_pool_putref(pool);
528 int lov_pool_add(struct obd_device *obd, char *poolname, char *ostname)
530 struct obd_uuid ost_uuid;
532 struct pool_desc *pool;
533 unsigned int lov_idx;
539 pool = cfs_hash_lookup(lov->lov_pools_hash_body, poolname);
543 obd_str2uuid(&ost_uuid, ostname);
546 /* search ost in lov array */
547 lov_tgts_getref(obd);
548 for (lov_idx = 0; lov_idx < lov->desc.ld_tgt_count; lov_idx++) {
549 if (!lov->lov_tgts[lov_idx])
551 if (obd_uuid_equals(&ost_uuid,
552 &(lov->lov_tgts[lov_idx]->ltd_uuid)))
555 /* test if ost found in lov */
556 if (lov_idx == lov->desc.ld_tgt_count)
557 GOTO(out, rc = -EINVAL);
559 rc = lov_ost_pool_add(&pool->pool_obds, lov_idx, lov->lov_tgt_size);
563 CDEBUG(D_CONFIG, "Added %s to "LOV_POOLNAMEF" as member %d\n",
564 ostname, poolname, pool_tgt_count(pool));
568 lov_tgts_putref(obd);
569 lov_pool_putref(pool);
574 int lov_pool_remove(struct obd_device *obd, char *poolname, char *ostname)
576 struct obd_uuid ost_uuid;
578 struct pool_desc *pool;
579 unsigned int lov_idx;
585 pool = cfs_hash_lookup(lov->lov_pools_hash_body, poolname);
589 obd_str2uuid(&ost_uuid, ostname);
591 lov_tgts_getref(obd);
592 /* search ost in lov array, to get index */
593 for (lov_idx = 0; lov_idx < lov->desc.ld_tgt_count; lov_idx++) {
594 if (!lov->lov_tgts[lov_idx])
597 if (obd_uuid_equals(&ost_uuid,
598 &(lov->lov_tgts[lov_idx]->ltd_uuid)))
602 /* test if ost found in lov */
603 if (lov_idx == lov->desc.ld_tgt_count)
604 GOTO(out, rc = -EINVAL);
606 lov_ost_pool_remove(&pool->pool_obds, lov_idx);
608 CDEBUG(D_CONFIG, "%s removed from "LOV_POOLNAMEF"\n", ostname,
613 lov_tgts_putref(obd);
614 lov_pool_putref(pool);