Whamcloud - gitweb
c1426f36ff42d5eef925e6798fced8fbb8f9f1e2
[fs/lustre-release.git] / lustre / lod / lod_pool.c
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  2008 Sun Microsystems, Inc. All rights reserved
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2017, 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  * lustre/lod/lod_pool.c
34  *
35  * OST pool methods
36  *
37  * This file provides code related to the Logical Object Device (LOD)
38  * handling of OST Pools on the MDT.  Pools are named lists of targets
39  * that allow userspace to group targets that share a particlar property
40  * together so that users or kernel helpers can make decisions about file
41  * allocation based on these properties.  For example, pools could be
42  * defined based on fault domains (e.g. separate racks of server nodes) so
43  * that RAID-1 mirroring could select targets from independent fault
44  * domains, or pools could define target performance characteristics so
45  * that applicatins could select IOP-optimized storage or stream-optimized
46  * storage for a particular output file.
47  *
48  * This file handles creation, lookup, and removal of pools themselves, as
49  * well as adding and removing targets to pools.  It also handles lprocfs
50  * display of configured pool.  The pools are accessed by name in the pool
51  * hash, and are refcounted to ensure proper pool structure lifetimes.
52  *
53  * Author: Jacques-Charles LAFOUCRIERE <jc.lafoucriere@cea.fr>
54  * Author: Alex Lyashkov <Alexey.Lyashkov@Sun.COM>
55  * Author: Nathaniel Rutman <Nathan.Rutman@Sun.COM>
56  */
57
58 #define DEBUG_SUBSYSTEM S_LOV
59
60 #include <libcfs/libcfs.h>
61 #include <obd.h>
62 #include "lod_internal.h"
63
64 #define pool_tgt(_p, _i) OST_TGT(lu2lod_dev((_p)->pool_lobd->obd_lu_dev), \
65                                  (_p)->pool_obds.op_array[_i])
66
67 /**
68  * Get a reference on the specified pool.
69  *
70  * To ensure the pool descriptor is not freed before the caller is finished
71  * with it.  Any process that is accessing \a pool directly needs to hold
72  * reference on it, including /proc since a userspace thread may be holding
73  * the /proc file open and busy in the kernel.
74  *
75  * \param[in] pool      pool descriptor on which to gain reference
76  */
77 static void pool_getref(struct pool_desc *pool)
78 {
79         CDEBUG(D_INFO, "pool %p\n", pool);
80         atomic_inc(&pool->pool_refcount);
81 }
82
83 /**
84  * Drop a reference on the specified pool and free its memory if needed.
85  *
86  * One reference is held by the LOD OBD device while it is configured, from
87  * the time the configuration log defines the pool until the time when it is
88  * dropped when the LOD OBD is cleaned up or the pool is deleted.  This means
89  * that the pool will not be freed while the LOD device is configured, unless
90  * it is explicitly destroyed by the sysadmin.  The pool structure is freed
91  * after the last reference on the structure is released.
92  *
93  * \param[in] pool      pool descriptor to drop reference on and possibly free
94  */
95 void lod_pool_putref(struct pool_desc *pool)
96 {
97         CDEBUG(D_INFO, "pool %p\n", pool);
98         if (atomic_dec_and_test(&pool->pool_refcount)) {
99                 LASSERT(hlist_unhashed(&pool->pool_hash));
100                 LASSERT(list_empty(&pool->pool_list));
101                 LASSERT(pool->pool_proc_entry == NULL);
102                 lod_ost_pool_free(&(pool->pool_rr.lqr_pool));
103                 lod_ost_pool_free(&(pool->pool_obds));
104                 OBD_FREE_PTR(pool);
105                 EXIT;
106         }
107 }
108
109 /**
110  * Drop the refcount in cases where the caller holds a spinlock.
111  *
112  * This is needed if the caller cannot be blocked while freeing memory.
113  * It assumes that there is some other known refcount held on the \a pool
114  * and the memory cannot actually be freed, but the refcounting needs to
115  * be kept accurate.
116  *
117  * \param[in] pool      pool descriptor on which to drop reference
118  */
119 static void pool_putref_locked(struct pool_desc *pool)
120 {
121         CDEBUG(D_INFO, "pool %p\n", pool);
122         LASSERT(atomic_read(&pool->pool_refcount) > 1);
123
124         atomic_dec(&pool->pool_refcount);
125 }
126
127 /*
128  * Group of functions needed for cfs_hash implementation.  This
129  * includes pool lookup, refcounting, and cleanup.
130  */
131
132 /**
133  * Hash the pool name for use by the cfs_hash handlers.
134  *
135  * Use the standard DJB2 hash function for ASCII strings in Lustre.
136  *
137  * \param[in] hash_body hash structure where this key is embedded (unused)
138  * \param[in] key       key to be hashed (in this case the pool name)
139  * \param[in] mask      bitmask to limit the hash value to the desired size
140  *
141  * \retval              computed hash value from \a key and limited by \a mask
142  */
143 static __u32 pool_hashfn(struct cfs_hash *hash_body, const void *key,
144                          unsigned mask)
145 {
146         return cfs_hash_djb2_hash(key, strnlen(key, LOV_MAXPOOLNAME), mask);
147 }
148
149 /**
150  * Return the actual key (pool name) from the hashed \a hnode.
151  *
152  * Allows extracting the key name when iterating over all hash entries.
153  *
154  * \param[in] hnode     hash node found by lookup or iteration
155  *
156  * \retval              char array referencing the pool name (no refcount)
157  */
158 static void *pool_key(struct hlist_node *hnode)
159 {
160         struct pool_desc *pool;
161
162         pool = hlist_entry(hnode, struct pool_desc, pool_hash);
163         return pool->pool_name;
164 }
165
166 /**
167  * Check if the specified hash key matches the hash node.
168  *
169  * This is needed in case there is a hash key collision, allowing the hash
170  * table lookup/iteration to distinguish between the two entries.
171  *
172  * \param[in] key       key (pool name) being searched for
173  * \param[in] compared  current entry being compared
174  *
175  * \retval              0 if \a key is the same as the key of \a compared
176  * \retval              1 if \a key is different from the key of \a compared
177  */
178 static int pool_hashkey_keycmp(const void *key, struct hlist_node *compared)
179 {
180         return !strncmp(key, pool_key(compared), LOV_MAXPOOLNAME);
181 }
182
183 /**
184  * Return the actual pool data structure from the hash table entry.
185  *
186  * Once the hash table entry is found, extract the pool data from it.
187  * The return type of this function is void * because it needs to be
188  * assigned to the generic hash operations table.
189  *
190  * \param[in] hnode     hash table entry
191  *
192  * \retval              struct pool_desc for the specified \a hnode
193  */
194 static void *pool_hashobject(struct hlist_node *hnode)
195 {
196         return hlist_entry(hnode, struct pool_desc, pool_hash);
197 }
198
199 static void pool_hashrefcount_get(struct cfs_hash *hs, struct hlist_node *hnode)
200 {
201         struct pool_desc *pool;
202
203         pool = hlist_entry(hnode, struct pool_desc, pool_hash);
204         pool_getref(pool);
205 }
206
207 static void pool_hashrefcount_put_locked(struct cfs_hash *hs,
208                                          struct hlist_node *hnode)
209 {
210         struct pool_desc *pool;
211
212         pool = hlist_entry(hnode, struct pool_desc, pool_hash);
213         pool_putref_locked(pool);
214 }
215
216 struct cfs_hash_ops pool_hash_operations = {
217         .hs_hash        = pool_hashfn,
218         .hs_key         = pool_key,
219         .hs_keycmp      = pool_hashkey_keycmp,
220         .hs_object      = pool_hashobject,
221         .hs_get         = pool_hashrefcount_get,
222         .hs_put_locked  = pool_hashrefcount_put_locked,
223 };
224
225 /*
226  * Methods for /proc seq_file iteration of the defined pools.
227  */
228
229 #define POOL_IT_MAGIC 0xB001CEA0
230 struct lod_pool_iterator {
231         unsigned int      lpi_magic;    /* POOL_IT_MAGIC */
232         unsigned int      lpi_idx;      /* from 0 to pool_tgt_size - 1 */
233         struct pool_desc *lpi_pool;
234 };
235
236 /**
237  * Return the next configured target within one pool for seq_file iteration.
238  *
239  * Iterator is used to go through the target entries of a single pool
240  * (i.e. the list of OSTs configured for a named pool).
241  * lpi_idx is the current target index in the pool's op_array[].
242  *
243  * The return type is a void * because this function is one of the
244  * struct seq_operations methods and must match the function template.
245  *
246  * \param[in] seq       /proc sequence file iteration tracking structure
247  * \param[in] v         unused
248  * \param[in] pos       position within iteration; 0 to number of targets - 1
249  *
250  * \retval      struct pool_iterator of the next pool descriptor
251  */
252 static void *pool_proc_next(struct seq_file *seq, void *v, loff_t *pos)
253 {
254         struct lod_pool_iterator *iter = seq->private;
255         int prev_idx;
256
257         LASSERTF(iter->lpi_magic == POOL_IT_MAGIC, "%08X\n", iter->lpi_magic);
258
259         /* test if end of file */
260         if (*pos >= pool_tgt_count(iter->lpi_pool))
261                 return NULL;
262
263         OBD_FAIL_TIMEOUT(OBD_FAIL_OST_LIST_ASSERT, cfs_fail_val);
264
265         /* iterate to find a non empty entry */
266         prev_idx = iter->lpi_idx;
267         iter->lpi_idx++;
268         if (iter->lpi_idx >= pool_tgt_count(iter->lpi_pool)) {
269                 iter->lpi_idx = prev_idx; /* we stay on the last entry */
270                 return NULL;
271         }
272         (*pos)++;
273         /* return != NULL to continue */
274         return iter;
275 }
276
277 /**
278  * Start seq_file iteration via /proc for a single pool.
279  *
280  * The \a pos parameter may be non-zero, indicating that the iteration
281  * is starting at some offset in the target list.  Use the seq_file
282  * private field to memorize the iterator so we can free it at stop().
283  * Need to restore the private pointer to the pool before freeing it.
284  *
285  * \param[in] seq       new sequence file structure to initialize
286  * \param[in] pos       initial target number at which to start iteration
287  *
288  * \retval              initialized pool iterator private structure
289  * \retval              NULL if \a pos exceeds the number of targets in \a pool
290  * \retval              negative error number on failure
291  */
292 static void *pool_proc_start(struct seq_file *seq, loff_t *pos)
293 {
294         struct pool_desc *pool = seq->private;
295         struct lod_pool_iterator *iter;
296
297         pool_getref(pool);
298         if ((pool_tgt_count(pool) == 0) ||
299             (*pos >= pool_tgt_count(pool))) {
300                 /* iter is not created, so stop() has no way to
301                  * find pool to dec ref */
302                 lod_pool_putref(pool);
303                 return NULL;
304         }
305
306         OBD_ALLOC_PTR(iter);
307         if (iter == NULL)
308                 return ERR_PTR(-ENOMEM);
309         iter->lpi_magic = POOL_IT_MAGIC;
310         iter->lpi_pool = pool;
311         iter->lpi_idx = 0;
312
313         seq->private = iter;
314         down_read(&pool_tgt_rw_sem(pool));
315         if (*pos > 0) {
316                 loff_t i;
317                 void *ptr;
318
319                 i = 0;
320                 do {
321                         ptr = pool_proc_next(seq, &iter, &i);
322                 } while ((i < *pos) && (ptr != NULL));
323
324                 return ptr;
325         }
326
327         return iter;
328 }
329
330 /**
331  * Finish seq_file iteration for a single pool.
332  *
333  * Once iteration has been completed, the pool_iterator struct must be
334  * freed, and the seq_file private pointer restored to the pool, as it
335  * was initially when pool_proc_start() was called.
336  *
337  * In some cases the stop() method may be called 2 times, without calling
338  * the start() method (see seq_read() from fs/seq_file.c). We have to free
339  * the private iterator struct only if seq->private points to the iterator.
340  *
341  * \param[in] seq       sequence file structure to clean up
342  * \param[in] v         (unused)
343  */
344 static void pool_proc_stop(struct seq_file *seq, void *v)
345 {
346         struct lod_pool_iterator *iter = seq->private;
347
348         if (iter != NULL && iter->lpi_magic == POOL_IT_MAGIC) {
349                 up_read(&pool_tgt_rw_sem(iter->lpi_pool));
350                 seq->private = iter->lpi_pool;
351                 lod_pool_putref(iter->lpi_pool);
352                 OBD_FREE_PTR(iter);
353         }
354 }
355
356 /**
357  * Print out one target entry from the pool for seq_file iteration.
358  *
359  * The currently referenced pool target is given by op_array[lpi_idx].
360  *
361  * \param[in] seq       new sequence file structure to initialize
362  * \param[in] v         (unused)
363  */
364 static int pool_proc_show(struct seq_file *seq, void *v)
365 {
366         struct lod_pool_iterator *iter = v;
367         struct lod_tgt_desc  *tgt;
368
369         LASSERTF(iter->lpi_magic == POOL_IT_MAGIC, "%08X\n", iter->lpi_magic);
370         LASSERT(iter->lpi_pool != NULL);
371         LASSERT(iter->lpi_idx <= pool_tgt_count(iter->lpi_pool));
372
373         tgt = pool_tgt(iter->lpi_pool, iter->lpi_idx);
374         if (tgt != NULL)
375                 seq_printf(seq, "%s\n", obd_uuid2str(&(tgt->ltd_uuid)));
376
377         return 0;
378 }
379
380 static const struct seq_operations pool_proc_ops = {
381         .start  = pool_proc_start,
382         .next   = pool_proc_next,
383         .stop   = pool_proc_stop,
384         .show   = pool_proc_show,
385 };
386
387 /**
388  * Open a new /proc file for seq_file iteration of targets in one pool.
389  *
390  * Initialize the seq_file private pointer to reference the pool.
391  *
392  * \param inode inode to store iteration state for /proc
393  * \param file  file descriptor to store iteration methods
394  *
395  * \retval      0 for success
396  * \retval      negative error number on failure
397  */
398 static int pool_proc_open(struct inode *inode, struct file *file)
399 {
400         int rc;
401
402         rc = seq_open(file, &pool_proc_ops);
403         if (!rc) {
404                 struct seq_file *seq = file->private_data;
405                 seq->private = PDE_DATA(inode);
406         }
407         return rc;
408 }
409
410 static struct file_operations pool_proc_operations = {
411         .open           = pool_proc_open,
412         .read           = seq_read,
413         .llseek         = seq_lseek,
414         .release        = seq_release,
415 };
416
417 /**
418  * Dump the pool target list into the Lustre debug log.
419  *
420  * This is a debugging function to allow dumping the list of targets
421  * in \a pool to the Lustre kernel debug log at the given \a level.
422  *
423  * This is not currently called by any existing code, but can be called
424  * from within gdb/crash to display the contents of the pool, or from
425  * code under development.
426  *
427  * \param[in] level     Lustre debug level (D_INFO, D_WARN, D_ERROR, etc)
428  * \param[in] pool      pool descriptor to be dumped
429  */
430 void lod_dump_pool(int level, struct pool_desc *pool)
431 {
432         unsigned int i;
433
434         pool_getref(pool);
435
436         CDEBUG(level, "pool "LOV_POOLNAMEF" has %d members\n",
437                pool->pool_name, pool->pool_obds.op_count);
438         down_read(&pool_tgt_rw_sem(pool));
439
440         for (i = 0; i < pool_tgt_count(pool) ; i++) {
441                 if (!pool_tgt(pool, i) || !(pool_tgt(pool, i))->ltd_exp)
442                         continue;
443                 CDEBUG(level, "pool "LOV_POOLNAMEF"[%d] = %s\n",
444                        pool->pool_name, i,
445                        obd_uuid2str(&((pool_tgt(pool, i))->ltd_uuid)));
446         }
447
448         up_read(&pool_tgt_rw_sem(pool));
449         lod_pool_putref(pool);
450 }
451
452 /**
453  * Initialize the pool data structures at startup.
454  *
455  * Allocate and initialize the pool data structures with the specified
456  * array size.  If pool count is not specified (\a count == 0), then
457  * POOL_INIT_COUNT will be used.  Allocating a non-zero initial array
458  * size avoids the need to reallocate as new pools are added.
459  *
460  * \param[in] op        pool structure
461  * \param[in] count     initial size of the target op_array[] array
462  *
463  * \retval              0 indicates successful pool initialization
464  * \retval              negative error number on failure
465  */
466 #define POOL_INIT_COUNT 2
467 int lod_ost_pool_init(struct ost_pool *op, unsigned int count)
468 {
469         ENTRY;
470
471         if (count == 0)
472                 count = POOL_INIT_COUNT;
473         op->op_array = NULL;
474         op->op_count = 0;
475         init_rwsem(&op->op_rw_sem);
476         op->op_size = count * sizeof(op->op_array[0]);
477         OBD_ALLOC(op->op_array, op->op_size);
478         if (op->op_array == NULL) {
479                 op->op_size = 0;
480                 RETURN(-ENOMEM);
481         }
482         EXIT;
483         return 0;
484 }
485
486 /**
487  * Increase the op_array size to hold more targets in this pool.
488  *
489  * The size is increased to at least \a min_count, but may be larger
490  * for an existing pool since ->op_array[] is growing exponentially.
491  * Caller must hold write op_rwlock.
492  *
493  * \param[in] op        pool structure
494  * \param[in] min_count minimum number of entries to handle
495  *
496  * \retval              0 on success
497  * \retval              negative error number on failure.
498  */
499 int lod_ost_pool_extend(struct ost_pool *op, unsigned int min_count)
500 {
501         __u32 *new;
502         __u32 new_size;
503
504         LASSERT(min_count != 0);
505
506         if (op->op_count * sizeof(op->op_array[0]) < op->op_size)
507                 return 0;
508
509         new_size = max_t(__u32, min_count * sizeof(op->op_array[0]),
510                          2 * op->op_size);
511         OBD_ALLOC(new, new_size);
512         if (new == NULL)
513                 return -ENOMEM;
514
515         /* copy old array to new one */
516         memcpy(new, op->op_array, op->op_size);
517         OBD_FREE(op->op_array, op->op_size);
518         op->op_array = new;
519         op->op_size = new_size;
520
521         return 0;
522 }
523
524 /**
525  * Add a new target to an existing pool.
526  *
527  * Add a new target device to the pool previously created and returned by
528  * lod_pool_new().  Each target can only be in each pool at most one time.
529  *
530  * \param[in] op        target pool to add new entry
531  * \param[in] idx       pool index number to add to the \a op array
532  * \param[in] min_count minimum number of entries to expect in the pool
533  *
534  * \retval              0 if target could be added to the pool
535  * \retval              negative error if target \a idx was not added
536  */
537 int lod_ost_pool_add(struct ost_pool *op, __u32 idx, unsigned int min_count)
538 {
539         unsigned int i;
540         int rc = 0;
541         ENTRY;
542
543         down_write(&op->op_rw_sem);
544
545         rc = lod_ost_pool_extend(op, min_count);
546         if (rc)
547                 GOTO(out, rc);
548
549         /* search ost in pool array */
550         for (i = 0; i < op->op_count; i++) {
551                 if (op->op_array[i] == idx)
552                         GOTO(out, rc = -EEXIST);
553         }
554         /* ost not found we add it */
555         op->op_array[op->op_count] = idx;
556         op->op_count++;
557         EXIT;
558 out:
559         up_write(&op->op_rw_sem);
560         return rc;
561 }
562
563 /**
564  * Remove an existing pool from the system.
565  *
566  * The specified pool must have previously been allocated by
567  * lod_pool_new() and not have any target members in the pool.
568  * If the removed target is not the last, compact the array
569  * to remove empty spaces.
570  *
571  * \param[in] op        pointer to the original data structure
572  * \param[in] idx       target index to be removed
573  *
574  * \retval              0 on success
575  * \retval              negative error number on failure
576  */
577 int lod_ost_pool_remove(struct ost_pool *op, __u32 idx)
578 {
579         unsigned int i;
580         ENTRY;
581
582         down_write(&op->op_rw_sem);
583
584         for (i = 0; i < op->op_count; i++) {
585                 if (op->op_array[i] == idx) {
586                         memmove(&op->op_array[i], &op->op_array[i + 1],
587                                 (op->op_count - i - 1) *
588                                 sizeof(op->op_array[0]));
589                         op->op_count--;
590                         up_write(&op->op_rw_sem);
591                         EXIT;
592                         return 0;
593                 }
594         }
595
596         up_write(&op->op_rw_sem);
597         RETURN(-EINVAL);
598 }
599
600 /**
601  * Free the pool after it was emptied and removed from /proc.
602  *
603  * Note that all of the child/target entries referenced by this pool
604  * must have been removed by lod_ost_pool_remove() before it can be
605  * deleted from memory.
606  *
607  * \param[in] op        pool to be freed.
608  *
609  * \retval              0 on success or if pool was already freed
610  */
611 int lod_ost_pool_free(struct ost_pool *op)
612 {
613         ENTRY;
614
615         if (op->op_size == 0)
616                 RETURN(0);
617
618         down_write(&op->op_rw_sem);
619
620         OBD_FREE(op->op_array, op->op_size);
621         op->op_array = NULL;
622         op->op_count = 0;
623         op->op_size = 0;
624
625         up_write(&op->op_rw_sem);
626         RETURN(0);
627 }
628
629 /**
630  * Allocate a new pool for the specified device.
631  *
632  * Allocate a new pool_desc structure for the specified \a new_pool
633  * device to create a pool with the given \a poolname.  The new pool
634  * structure is created with a single reference, and is freed when the
635  * reference count drops to zero.
636  *
637  * \param[in] obd       Lustre OBD device on which to add a pool iterator
638  * \param[in] poolname  the name of the pool to be created
639  *
640  * \retval              0 in case of success
641  * \retval              negative error code in case of error
642  */
643 int lod_pool_new(struct obd_device *obd, char *poolname)
644 {
645         struct lod_device *lod = lu2lod_dev(obd->obd_lu_dev);
646         struct pool_desc  *new_pool;
647         int rc;
648         ENTRY;
649
650         if (strlen(poolname) > LOV_MAXPOOLNAME)
651                 RETURN(-ENAMETOOLONG);
652
653         OBD_ALLOC_PTR(new_pool);
654         if (new_pool == NULL)
655                 RETURN(-ENOMEM);
656
657         strlcpy(new_pool->pool_name, poolname, sizeof(new_pool->pool_name));
658         new_pool->pool_lobd = obd;
659         atomic_set(&new_pool->pool_refcount, 1);
660         rc = lod_ost_pool_init(&new_pool->pool_obds, 0);
661         if (rc)
662                 GOTO(out_err, rc);
663
664         lu_qos_rr_init(&new_pool->pool_rr);
665
666         rc = lod_ost_pool_init(&new_pool->pool_rr.lqr_pool, 0);
667         if (rc)
668                 GOTO(out_free_pool_obds, rc);
669
670         INIT_HLIST_NODE(&new_pool->pool_hash);
671
672 #ifdef CONFIG_PROC_FS
673         pool_getref(new_pool);
674         new_pool->pool_proc_entry = lprocfs_add_simple(lod->lod_pool_proc_entry,
675                                                        poolname, new_pool,
676                                                        &pool_proc_operations);
677         if (IS_ERR(new_pool->pool_proc_entry)) {
678                 CDEBUG(D_CONFIG, "%s: cannot add proc entry "LOV_POOLNAMEF"\n",
679                        obd->obd_name, poolname);
680                 new_pool->pool_proc_entry = NULL;
681                 lod_pool_putref(new_pool);
682         }
683         CDEBUG(D_INFO, "pool %p - proc %p\n", new_pool,
684                new_pool->pool_proc_entry);
685 #endif
686
687         spin_lock(&obd->obd_dev_lock);
688         list_add_tail(&new_pool->pool_list, &lod->lod_pool_list);
689         lod->lod_pool_count++;
690         spin_unlock(&obd->obd_dev_lock);
691
692         /* add to find only when it fully ready  */
693         rc = cfs_hash_add_unique(lod->lod_pools_hash_body, poolname,
694                                  &new_pool->pool_hash);
695         if (rc)
696                 GOTO(out_err, rc = -EEXIST);
697
698         CDEBUG(D_CONFIG, LOV_POOLNAMEF" is pool #%d\n",
699                         poolname, lod->lod_pool_count);
700
701         RETURN(0);
702
703 out_err:
704         spin_lock(&obd->obd_dev_lock);
705         list_del_init(&new_pool->pool_list);
706         lod->lod_pool_count--;
707         spin_unlock(&obd->obd_dev_lock);
708
709         lprocfs_remove(&new_pool->pool_proc_entry);
710
711         lod_ost_pool_free(&new_pool->pool_rr.lqr_pool);
712 out_free_pool_obds:
713         lod_ost_pool_free(&new_pool->pool_obds);
714         OBD_FREE_PTR(new_pool);
715         return rc;
716 }
717
718 /**
719  * Remove the named pool from the OBD device.
720  *
721  * \param[in] obd       OBD device on which pool was previously created
722  * \param[in] poolname  name of pool to remove from \a obd
723  *
724  * \retval              0 on successfully removing the pool
725  * \retval              negative error numbers for failures
726  */
727 int lod_pool_del(struct obd_device *obd, char *poolname)
728 {
729         struct lod_device *lod = lu2lod_dev(obd->obd_lu_dev);
730         struct pool_desc  *pool;
731         ENTRY;
732
733         /* lookup and kill hash reference */
734         pool = cfs_hash_del_key(lod->lod_pools_hash_body, poolname);
735         if (pool == NULL)
736                 RETURN(-ENOENT);
737
738         if (pool->pool_proc_entry != NULL) {
739                 CDEBUG(D_INFO, "proc entry %p\n", pool->pool_proc_entry);
740                 lprocfs_remove(&pool->pool_proc_entry);
741                 lod_pool_putref(pool);
742         }
743
744         spin_lock(&obd->obd_dev_lock);
745         list_del_init(&pool->pool_list);
746         lod->lod_pool_count--;
747         spin_unlock(&obd->obd_dev_lock);
748
749         /* release last reference */
750         lod_pool_putref(pool);
751
752         RETURN(0);
753 }
754
755 /**
756  * Add a single target device to the named pool.
757  *
758  * Add the target specified by \a ostname to the specified \a poolname.
759  *
760  * \param[in] obd       OBD device on which to add the pool
761  * \param[in] poolname  name of the pool to which to add the target \a ostname
762  * \param[in] ostname   name of the target device to be added
763  *
764  * \retval              0 if \a ostname was (previously) added to the named pool
765  * \retval              negative error number on failure
766  */
767 int lod_pool_add(struct obd_device *obd, char *poolname, char *ostname)
768 {
769         struct lod_device       *lod = lu2lod_dev(obd->obd_lu_dev);
770         struct obd_uuid          ost_uuid;
771         struct pool_desc        *pool;
772         unsigned int             idx;
773         int                      rc = -EINVAL;
774         ENTRY;
775
776         pool = cfs_hash_lookup(lod->lod_pools_hash_body, poolname);
777         if (pool == NULL)
778                 RETURN(-ENOENT);
779
780         obd_str2uuid(&ost_uuid, ostname);
781
782         /* search ost in lod array */
783         lod_getref(&lod->lod_ost_descs);
784         lod_foreach_ost(lod, idx) {
785                 if (obd_uuid_equals(&ost_uuid, &OST_TGT(lod, idx)->ltd_uuid)) {
786                         rc = 0;
787                         break;
788                 }
789         }
790
791         if (rc)
792                 GOTO(out, rc);
793
794         rc = lod_ost_pool_add(&pool->pool_obds, idx, lod->lod_osts_size);
795         if (rc)
796                 GOTO(out, rc);
797
798         pool->pool_rr.lqr_dirty = 1;
799
800         CDEBUG(D_CONFIG, "Added %s to "LOV_POOLNAMEF" as member %d\n",
801                         ostname, poolname,  pool_tgt_count(pool));
802
803         EXIT;
804 out:
805         lod_putref(lod, &lod->lod_ost_descs);
806         lod_pool_putref(pool);
807         return rc;
808 }
809
810 /**
811  * Remove the named target from the specified pool.
812  *
813  * Remove one target named \a ostname from \a poolname.  The \a ostname
814  * is searched for in the lod_device lod_ost_bitmap array, to ensure the
815  * specified name actually exists in the pool.
816  *
817  * \param[in] obd       OBD device from which to remove \a poolname
818  * \param[in] poolname  name of the pool to be changed
819  * \param[in] ostname   name of the target to remove from \a poolname
820  *
821  * \retval              0 on successfully removing \a ostname from the pool
822  * \retval              negative number on error (e.g. \a ostname not in pool)
823  */
824 int lod_pool_remove(struct obd_device *obd, char *poolname, char *ostname)
825 {
826         struct lod_device       *lod = lu2lod_dev(obd->obd_lu_dev);
827         struct obd_uuid          ost_uuid;
828         struct pool_desc        *pool;
829         unsigned int             idx;
830         int                      rc = -EINVAL;
831         ENTRY;
832
833         pool = cfs_hash_lookup(lod->lod_pools_hash_body, poolname);
834         if (pool == NULL)
835                 RETURN(-ENOENT);
836
837         obd_str2uuid(&ost_uuid, ostname);
838
839         lod_getref(&lod->lod_ost_descs);
840         cfs_foreach_bit(lod->lod_ost_bitmap, idx) {
841                 if (obd_uuid_equals(&ost_uuid, &OST_TGT(lod, idx)->ltd_uuid)) {
842                         rc = 0;
843                         break;
844                 }
845         }
846
847         /* test if ost found in lod array */
848         if (rc)
849                 GOTO(out, rc);
850
851         lod_ost_pool_remove(&pool->pool_obds, idx);
852
853         pool->pool_rr.lqr_dirty = 1;
854
855         CDEBUG(D_CONFIG, "%s removed from "LOV_POOLNAMEF"\n", ostname,
856                poolname);
857
858         EXIT;
859 out:
860         lod_putref(lod, &lod->lod_ost_descs);
861         lod_pool_putref(pool);
862         return rc;
863 }
864
865 /**
866  * Check if the specified target exists in the pool.
867  *
868  * The caller may not have a reference on \a pool if it got the pool without
869  * calling lod_find_pool() (e.g. directly from the lod pool list)
870  *
871  * \param[in] idx       Target index to check
872  * \param[in] pool      Pool in which to check if target is added.
873  *
874  * \retval              0 successfully found index in \a pool
875  * \retval              negative error if device not found in \a pool
876  */
877 int lod_check_index_in_pool(__u32 idx, struct pool_desc *pool)
878 {
879         unsigned int i;
880         int rc;
881         ENTRY;
882
883         pool_getref(pool);
884
885         down_read(&pool_tgt_rw_sem(pool));
886
887         for (i = 0; i < pool_tgt_count(pool); i++) {
888                 if (pool_tgt_array(pool)[i] == idx)
889                         GOTO(out, rc = 0);
890         }
891         rc = -ENOENT;
892         EXIT;
893 out:
894         up_read(&pool_tgt_rw_sem(pool));
895
896         lod_pool_putref(pool);
897         return rc;
898 }
899
900 /**
901  * Find the pool descriptor for the specified pool and return it with a
902  * reference to the caller if found.
903  *
904  * \param[in] lod       LOD on which the pools are configured
905  * \param[in] poolname  NUL-terminated name of the pool
906  *
907  * \retval      pointer to pool descriptor on success
908  * \retval      NULL if \a poolname could not be found or poolname is empty
909  */
910 struct pool_desc *lod_find_pool(struct lod_device *lod, char *poolname)
911 {
912         struct pool_desc *pool;
913
914         pool = NULL;
915         if (poolname[0] != '\0') {
916                 pool = cfs_hash_lookup(lod->lod_pools_hash_body, poolname);
917                 if (pool == NULL)
918                         CDEBUG(D_CONFIG, "%s: request for an unknown pool ("
919                                LOV_POOLNAMEF")\n",
920                                lod->lod_child_exp->exp_obd->obd_name, poolname);
921                 if (pool != NULL && pool_tgt_count(pool) == 0) {
922                         CDEBUG(D_CONFIG, "%s: request for an empty pool ("
923                                LOV_POOLNAMEF")\n",
924                                lod->lod_child_exp->exp_obd->obd_name, poolname);
925                         /* pool is ignored, so we remove ref on it */
926                         lod_pool_putref(pool);
927                         pool = NULL;
928                 }
929         }
930         return pool;
931 }
932