// SPDX-License-Identifier: GPL-2.0

/*
 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
 * Use is subject to license terms.
 *
 * Copyright (c) 2012, 2017, Intel Corporation.
 */

/*
 * This file is part of Lustre, http://www.lustre.org/
 *
 * OST pool methods
 *
 * Author: Jacques-Charles LAFOUCRIERE <jc.lafoucriere@cea.fr>
 * Author: Alex Lyashkov <Alexey.Lyashkov@Sun.COM>
 * Author: Nathaniel Rutman <Nathan.Rutman@Sun.COM>
 */

#define DEBUG_SUBSYSTEM S_LOV

#include <linux/stringhash.h>
#include <linux/rhashtable.h>

#include <obd.h>

#include "lov_internal.h"

#define pool_tgt(_p, _i) \
		lov_tgt(&_p->pool_lobd->u.lov, _p->pool_obds.op_array[_i])

/**
 * pool_hashfh() - Hash the pool name for use by the hashtable handlers.
 * @data: poolname (null-terminated string to be hashed or key)
 * @len: length of key
 * @seed: Random seed or previous hash
 *
 * Returns computed hash value of the key(poolname)
 */
static u32 pool_hashfh(const void *data, u32 len, u32 seed)
{
	const char *pool_name = data;

	return hashlen_hash(hashlen_string((void *)(unsigned long)seed,
					   pool_name));
}

/**
 * pool_cmpfn() - Compare the pool name with key
 * @arg: key (poolname) to compare against
 * @obj: Entry that is being compared
 *
 * Return:
 * * %0 if matched
 * * %1 if not matched
 */
static int pool_cmpfn(struct rhashtable_compare_arg *arg, const void *obj)
{
	const struct lov_pool_desc *pool = obj;
	const char *pool_name = arg->key;

	return strcmp(pool_name, pool->pool_name);
}

static const struct rhashtable_params pools_hash_params = {
	.key_len	= 1, /* actually variable */
	.key_offset	= offsetof(struct lov_pool_desc, pool_name),
	.head_offset	= offsetof(struct lov_pool_desc, pool_hash),
	.hashfn		= pool_hashfh,
	.obj_cmpfn	= pool_cmpfn,
	.automatic_shrinking = true,
};

/**
 * lov_pool_getref() - Get a reference on the specified LOV pool.
 * @pool: pool descriptor on which to gain reference
 *
 * To ensure the pool descriptor is not freed before the caller is finished
 * with it.  Any process that is accessing @pool directly needs to hold
 * reference on it, including /proc since a userspace thread may be holding
 * the /proc file open and busy in the kernel.
 *
 */
static void lov_pool_getref(struct lov_pool_desc *pool)
{
	CDEBUG(D_INFO, "pool %p\n", pool);
	kref_get(&pool->pool_refcount);
}

static void lov_pool_putref_free(struct kref *kref)
{
	struct lov_pool_desc *pool = container_of(kref, struct lov_pool_desc,
						  pool_refcount);

	LASSERT(list_empty(&pool->pool_list));
	LASSERT(pool->pool_proc_entry == NULL);
	lu_tgt_pool_free(&(pool->pool_obds));
	OBD_FREE_RCU(pool, sizeof(*pool), pool_rcu);
	EXIT;
}

/**
 * lov_pool_putref() - Drop a reference on the specified LOV pool
 * @pool: LOV pool descriptor to drop reference on and possibly free
 *
 * Drop a reference on the specified LOV pool and free its memory if needed
 *
 * One reference is held by the LOD OBD device while it is configured, from
 * the time the configuration log defines the pool until the time when it is
 * dropped when the LOD OBD is cleaned up or the pool is deleted.  This means
 * that the pool will not be freed while the LOD device is configured, unless
 * it is explicitly destroyed by the sysadmin.  The pool structure is freed
 * after the last reference on the structure is released.
 */
void lov_pool_putref(struct lov_pool_desc *pool)
{
	CDEBUG(D_INFO, "pool %p\n", pool);
	kref_put(&pool->pool_refcount, lov_pool_putref_free);
}

#ifdef CONFIG_PROC_FS
/*
 * pool /proc seq_file methods
 */
/*
 * iterator is used to go through the target pool entries
 * index is the current entry index in the lp_array[] array
 * index >= pos returned to the seq_file interface
 * pos is from 0 to (pool->pool_obds.op_count - 1)
 */
#define POOL_IT_MAGIC 0xB001CEA0
struct pool_iterator {
	int magic; /* POOL_IT_MAGIC */
	int idx;   /* from 0 to pool_tgt_size - 1 */
	struct lov_pool_desc *pool;
};

/**
 * pool_proc_next() - Return the next configured target within one pool for
 *                    seq_file iteration
 * @s: /proc sequence file iteration tracking structure
 * @v: unused
 * @pos: position within iteration; 0 to number of targets - 1
 *
 * Iterator is used to go through the target entries of a single pool
 * (i.e. the list of OSTs configured for a named pool).
 * lpi_idx is the current target index in the pool's op_array[].
 *
 * The return type is a void * because this function is one of the
 * struct seq_operations methods and must match the function template.
 *
 * Returns struct pool_iterator of the next pool descriptor
 */
static void *pool_proc_next(struct seq_file *s, void *v, loff_t *pos)
{
	struct pool_iterator *iter = (struct pool_iterator *)s->private;
	int prev_idx;

	LASSERTF(iter->magic == POOL_IT_MAGIC, "%08X\n", iter->magic);

	(*pos)++;
	/* test if end of file */
	if (*pos > pool_tgt_count(iter->pool))
		return NULL;

	/* iterate to find a non empty entry */
	prev_idx = iter->idx;
	iter->idx++;
	if (iter->idx >= pool_tgt_count(iter->pool)) {
		iter->idx = prev_idx; /* we stay on the last entry */
		return NULL;
	}
	/* return != NULL to continue */
	return iter;
}

/**
 * pool_proc_start() - Start seq_file iteration via /proc for a single pool
 * @seq: new sequence file structure to initialize
 * @pos: initial target number at which to start iteration
 *
 * The @pos parameter may be non-zero, indicating that the iteration
 * is starting at some offset in the target list.  Use the seq_file
 * private field to memorize the iterator so we can free it at stop().
 * Need to restore the private pointer to the pool before freeing it.
 *
 * Returns:
 * * initialized pool iterator private structure
 * * %NULL if @pos exceeds the number of targets in @pool
 * * %negative error number on failure
 */
static void *pool_proc_start(struct seq_file *s, loff_t *pos)
{
	struct lov_pool_desc *pool = (struct lov_pool_desc *)s->private;
	struct pool_iterator *iter;

	lov_pool_getref(pool);
	if ((pool_tgt_count(pool) == 0) || (*pos >= pool_tgt_count(pool))) {
		/* iter is not created, so stop() has no way to
		 * find pool to dec ref */
		lov_pool_putref(pool);
		return NULL;
	}

	OBD_ALLOC_PTR(iter);
	if (!iter)
		return ERR_PTR(-ENOMEM);
	iter->magic = POOL_IT_MAGIC;
	iter->pool = pool;
	iter->idx = 0;

	/* we use seq_file private field to memorized iterator so
	 * we can free it at stop() */
	/* /!\ do not forget to restore it to pool before freeing it */
	s->private = iter;
	down_read(&pool_tgt_rw_sem(pool));
	if (*pos > 0) {
		loff_t i;
		void *ptr;

		i = 0;
		do {
			ptr = pool_proc_next(s, &iter, &i);
		} while ((i < *pos) && (ptr != NULL));
		return ptr;
	}
	return iter;
}

/**
 * pool_proc_stop() - Finish seq_file iteration for a single pool
 * @s: sequence file structure to clean up
 * @v: unused
 *
 * Once iteration has been completed, the pool_iterator struct must be
 * freed, and the seq_file private pointer restored to the pool, as it
 * was initially when pool_proc_start() was called.
 *
 * In some cases the stop() method may be called 2 times, without calling
 * the start() method (see seq_read() from fs/seq_file.c). We have to free
 * the private iterator struct only if seq->private points to the iterator.
 */
static void pool_proc_stop(struct seq_file *s, void *v)
{
	struct pool_iterator *iter = (struct pool_iterator *)s->private;

	/* in some cases stop() method is called 2 times, without
	 * calling start() method (see seq_read() from fs/seq_file.c)
	 * we have to free only if s->private is an iterator */
	if ((iter) && (iter->magic == POOL_IT_MAGIC)) {
		up_read(&pool_tgt_rw_sem(iter->pool));
		/* we restore s->private so next call to pool_proc_start()
		 * will work */
		s->private = iter->pool;
		lov_pool_putref(iter->pool);
		OBD_FREE_PTR(iter);
	}
}

/**
 * pool_proc_show() - Print out one target entry from the pool for seq_file
 *                    iteration
 * @s: new sequence file structure to initialize
 * @v: unused
 *
 * The currently referenced pool target is given by op_array[lpi_idx].
 *
 * Returns %0 always
 */
static int pool_proc_show(struct seq_file *s, void *v)
{
	struct pool_iterator *iter = (struct pool_iterator *)v;
	struct lov_tgt_desc *tgt;

	LASSERTF(iter->magic == POOL_IT_MAGIC, "%08X\n", iter->magic);
	LASSERT(iter->pool != NULL);
	LASSERT(iter->idx <= pool_tgt_count(iter->pool));

	tgt = pool_tgt(iter->pool, iter->idx);
	if (tgt)
		seq_printf(s, "%s\n", obd_uuid2str(&(tgt->ltd_uuid)));

	return 0;
}

static const struct seq_operations pool_proc_ops = {
	.start		= pool_proc_start,
	.next		= pool_proc_next,
	.stop		= pool_proc_stop,
	.show		= pool_proc_show,
};

/**
 * pool_proc_open() - Open a new /proc file for seq_file iteration of targets
 *                    in one pool
 * @inode: inode to store iteration state for /proc
 * @file: file descriptor to store iteration methods
 *
 * Initialize the seq_file private pointer to reference the pool.
 *
 * Return:
 * * %0 for success
 * * %negative error number on failure
 */
static int pool_proc_open(struct inode *inode, struct file *file)
{
	int rc;

	rc = seq_open(file, &pool_proc_ops);
	if (!rc) {
		struct seq_file *s = file->private_data;

		s->private = pde_data(inode);
	}
	return rc;
}

static const struct proc_ops pool_proc_operations = {
	.proc_open	= pool_proc_open,
	.proc_read	= seq_read,
	.proc_lseek	= seq_lseek,
	.proc_release	= seq_release,
};
#endif /* CONFIG_PROC_FS */

static void pools_hash_exit(void *vpool, void *data)
{
	struct lov_pool_desc *pool = vpool;

	lov_pool_putref(pool);
}

int lov_pool_hash_init(struct rhashtable *tbl)
{
	return rhashtable_init(tbl, &pools_hash_params);
}

void lov_pool_hash_destroy(struct rhashtable *tbl)
{
	rhashtable_free_and_destroy(tbl, pools_hash_exit, NULL);
}

/**
 * lov_pool_new() - Allocate a new pool for the specified device
 * @obd: Lustre OBD device on which to add a pool iterator
 * @poolname: the name of the pool to be created
 *
 * Allocate a new pool_desc structure for the specified @new_pool
 * device to create a pool with the given @poolname.  The new pool
 * structure is created with a single refrence, and is freed when the
 * reference count drops to zero.
 *
 * Return:
 * * %0 on successfully removing the pool
 * * %negative error numbers for failures
 */
int lov_pool_new(struct obd_device *obd, char *poolname)
{
	struct lov_obd *lov;
	struct lov_pool_desc *new_pool;
	int rc;
	ENTRY;

	lov = &(obd->u.lov);

	if (strlen(poolname) > LOV_MAXPOOLNAME)
		RETURN(-ENAMETOOLONG);

	OBD_ALLOC_PTR(new_pool);
	if (new_pool == NULL)
		RETURN(-ENOMEM);

	strscpy(new_pool->pool_name, poolname, sizeof(new_pool->pool_name));
	new_pool->pool_lobd = obd;
	/* ref count init to 1 because when created a pool is always used
	 * up to deletion
	 */
	kref_init(&new_pool->pool_refcount);
	rc = lu_tgt_pool_init(&new_pool->pool_obds, 0);
	if (rc)
		GOTO(out_free_pool, rc);

#ifdef CONFIG_PROC_FS
	/* get ref for /proc file */
	lov_pool_getref(new_pool);
	new_pool->pool_proc_entry = lprocfs_add_simple(lov->lov_pool_proc_entry,
						       poolname, new_pool,
						       &pool_proc_operations);
	if (IS_ERR(new_pool->pool_proc_entry)) {
		CWARN("Cannot add proc pool entry "LOV_POOLNAMEF"\n", poolname);
		new_pool->pool_proc_entry = NULL;
		lov_pool_putref(new_pool);
	}
	CDEBUG(D_INFO, "pool %p - proc %p\n",
	       new_pool, new_pool->pool_proc_entry);
#endif

	spin_lock(&obd->obd_dev_lock);
	list_add_tail(&new_pool->pool_list, &lov->lov_pool_list);
	lov->lov_pool_count++;
	spin_unlock(&obd->obd_dev_lock);

	/* Add to hash table only when it is fully ready. */
	rc = rhashtable_lookup_insert_fast(&lov->lov_pools_hash_body,
					   &new_pool->pool_hash,
					   pools_hash_params);
	if (rc) {
		if (rc != -EEXIST)
			/*
			 * Hide -E2BIG and -EBUSY which
			 * are not helpful.
			 */
			rc = -ENOMEM;
		GOTO(out_err, rc);
	}

	CDEBUG(D_CONFIG, LOV_POOLNAMEF" is pool #%d\n", poolname,
	       lov->lov_pool_count);

	RETURN(0);

out_err:
	spin_lock(&obd->obd_dev_lock);
	list_del_init(&new_pool->pool_list);
	lov->lov_pool_count--;
	spin_unlock(&obd->obd_dev_lock);
	lprocfs_remove(&new_pool->pool_proc_entry);
	lu_tgt_pool_free(&new_pool->pool_obds);
out_free_pool:
	OBD_FREE_PTR(new_pool);

	return rc;
}

struct lov_pool_desc *lov_pool_find(struct obd_device *obd, char *poolname)
{
	struct lov_pool_desc *pool;
	struct lov_obd *lov = &obd->u.lov;

	rcu_read_lock();
	pool = rhashtable_lookup(&lov->lov_pools_hash_body,
				 poolname,
				 pools_hash_params);
	if (pool && !kref_get_unless_zero(&pool->pool_refcount))
		pool = NULL;
	rcu_read_unlock();

	return pool;
}

/**
 * lov_pool_del() - Remove the named pool from the OBD device
 * @obd: OBD device on which pool was previously created
 * @poolname: name of pool to remove from @obd
 *
 * Return:
 * * %0 on successfully removing the pool
 * * %negative error numbers for failures
 */
int lov_pool_del(struct obd_device *obd, char *poolname)
{
	struct lov_obd *lov;
	struct lov_pool_desc *pool;
	ENTRY;

	lov = &(obd->u.lov);

	/* lookup and kill hash reference */
	rcu_read_lock();
	pool = rhashtable_lookup(&lov->lov_pools_hash_body, poolname,
				 pools_hash_params);
	if (pool && rhashtable_remove_fast(&lov->lov_pools_hash_body,
					   &pool->pool_hash,
					   pools_hash_params) != 0)
		pool = NULL;
	rcu_read_unlock();
	if (!pool)
		RETURN(-ENOENT);

	if (pool->pool_proc_entry != NULL) {
		CDEBUG(D_INFO, "proc entry %p\n", pool->pool_proc_entry);
		lprocfs_remove(&pool->pool_proc_entry);
		lov_pool_putref(pool);
	}

	spin_lock(&obd->obd_dev_lock);
	list_del_init(&pool->pool_list);
	lov->lov_pool_count--;
	spin_unlock(&obd->obd_dev_lock);

	/* release last reference */
	lov_pool_putref(pool);

	RETURN(0);
}

/**
 * lov_pool_add() - Add a single target device to the named pool
 * @obd: OBD device on which to add the pool
 * @poolname: name of the pool to which to add the target @ostname
 * @ostname: name of the target device to be added
 *
 * Add the target specified by @ostname to the specified @poolname.
 *
 * Return:
 * * %0 if @ostname was (previously) added to the named pool
 * * %negative error number on failure
 */
int lov_pool_add(struct obd_device *obd, char *poolname, char *ostname)
{
	struct lov_obd *lov = &(obd->u.lov);
	struct obd_uuid ost_uuid;
	struct lov_pool_desc *pool;
	struct lu_tgt_desc *tgt;
	int rc = -EINVAL;

	ENTRY;
	rcu_read_lock();
	pool = rhashtable_lookup(&lov->lov_pools_hash_body, poolname,
				 pools_hash_params);
	if (pool && !kref_get_unless_zero(&pool->pool_refcount))
		pool = NULL;
	rcu_read_unlock();
	if (!pool)
		RETURN(-ENOENT);

	obd_str2uuid(&ost_uuid, ostname);

	/* search OST in LOV array */
	lov_tgts_getref(obd);
	lov_foreach_tgt(lov, tgt) {
		if (obd_uuid_equals(&ost_uuid, &tgt->ltd_uuid)) {
			rc = 0;
			break;
		}
	}
	if (rc < 0)
		GOTO(out, rc);

	rc = lu_tgt_pool_add(&pool->pool_obds, tgt->ltd_index,
			     lov->lov_ost_descs.ltd_tgts_size);
	if (rc)
		GOTO(out, rc);

	CDEBUG(D_CONFIG, "Added %s to "LOV_POOLNAMEF" as member %d\n",
	       ostname, poolname,  pool_tgt_count(pool));

	EXIT;
out:
	lov_tgts_putref(obd);
	lov_pool_putref(pool);

	return rc;
}

/**
 * lov_pool_remove() - Remove the named target from the specified pool
 * @obd: OBD device from which to remove @poolname
 * @poolname: name of the pool to be changed
 * @ostname: name of the target to remove from @poolname
 *
 * Remove one target named @ostname from @poolname.  The @ostname
 * is searched for in the lod_device lod_ost_bitmap array, to ensure the
 * specified name actually exists in the pool.
 *
 * Return:
 * * %0 on successfully removing @ostname from the pool
 * * %negative number on error (e.g. @ostname not in pool)
 */
int lov_pool_remove(struct obd_device *obd, char *poolname, char *ostname)
{
	struct lov_obd *lov = &(obd->u.lov);
	struct obd_uuid ost_uuid;
	struct lov_pool_desc *pool;
	struct lu_tgt_desc *tgt;
	int rc = -EINVAL;

	ENTRY;
	/* lookup and kill hash reference */
	rcu_read_lock();
	pool = rhashtable_lookup(&lov->lov_pools_hash_body, poolname,
				 pools_hash_params);
	if (pool && !kref_get_unless_zero(&pool->pool_refcount))
		pool = NULL;
	rcu_read_unlock();
	if (!pool)
		RETURN(-ENOENT);

	obd_str2uuid(&ost_uuid, ostname);

	lov_tgts_getref(obd);
	/* search OST in LOV array, to get index */
	lov_foreach_tgt(lov, tgt) {
		if (obd_uuid_equals(&ost_uuid, &tgt->ltd_uuid)) {
			rc = 0;
			break;
		}
	}
	if (rc < 0)
		GOTO(out, rc);

	lu_tgt_pool_remove(&pool->pool_obds, tgt->ltd_index);

	CDEBUG(D_CONFIG, "%s removed from "LOV_POOLNAMEF"\n", ostname,
	       poolname);

	EXIT;
out:
	lov_tgts_putref(obd);
	lov_pool_putref(pool);

	return rc;
}
