sys/dev/disk/dm: Don't implement "status" as a subset of "table" [1/2]

[dragonfly.git] / sys / dev / disk / dm / dm.h

/*        $NetBSD: dm.h,v 1.17 2009/12/29 23:37:48 haad Exp $      */

/*
 * Copyright (c) 2008 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Adam Hamsik.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _DM_DEV_H_
#define _DM_DEV_H_


#ifdef _KERNEL

#include <sys/errno.h>
#include <sys/systm.h>
#include <sys/kernel.h>

#include <cpu/inttypes.h>
#include <cpu/atomic.h>
#include <sys/condvar.h>
#include <sys/lock.h>
#include <sys/queue.h>

#include <sys/buf.h>
#include <sys/device.h>
#include <sys/devicestat.h>
#include <sys/diskslice.h>
#include <sys/disklabel.h>

#include <libprop/proplib.h>

#define DM_MAX_TYPE_NAME 16
#define DM_NAME_LEN 128
#define DM_UUID_LEN 129

#define DM_VERSION_MAJOR	4
#define DM_VERSION_MINOR	16

#define DM_VERSION_PATCHLEVEL	0

/*** Internal device-mapper structures ***/

/*
 * A device mapper table is a list of physical ranges plus the mapping target
 * applied to them.
 */
typedef struct dm_table_entry {
	struct dm_dev *dm_dev;		/* backlink */
	uint64_t start;
	uint64_t length;

	struct dm_target *target;      /* Link to table target. */
	void *target_config;           /* Target specific data. */
	SLIST_ENTRY(dm_table_entry) next;
} dm_table_entry_t;

SLIST_HEAD(dm_table, dm_table_entry);

typedef struct dm_table dm_table_t;

typedef struct dm_table_head {
	/* Current active table is selected with this. */
	int cur_active_table; 
	struct dm_table tables[2];

	struct lock   table_mtx;

	int	 io_cnt;
} dm_table_head_t;

#define MAX_DEV_NAME 32

/*
 * This structure is used to store opened vnodes for disk with name.
 * I need this because devices can be opened only once, but I can
 * have more then one device on one partition.
 */

typedef struct dm_pdev {
	char name[MAX_DEV_NAME];
	struct partinfo pdev_pinfo; /* partinfo of the underlying device */

	struct vnode *pdev_vnode;
	int ref_cnt; /* reference counter for users ofthis pdev */

	SLIST_ENTRY(dm_pdev) next_pdev;
} dm_pdev_t;

/*
 * This structure is called for every device-mapper device.
 * It points to SLIST of device tables and mirrored, snapshoted etc. devices.
 */
TAILQ_HEAD(dm_dev_head, dm_dev);

typedef struct dm_dev {
	char name[DM_NAME_LEN];
	char uuid[DM_UUID_LEN];

	cdev_t devt; /* pointer to autoconf device_t structure */
	uint64_t minor;
	uint32_t flags; /* store communication protocol flags */

	struct lock dev_mtx; /* mutex for generall device lock */
	struct cv dev_cv; /* cv for between ioctl synchronisation */

	uint32_t event_nr;
	uint32_t ref_cnt;

	uint32_t dev_type;
	uint32_t is_open;

	dm_table_head_t table_head;

	struct dm_dev_head upcalls;

	struct disk *diskp;

	struct devstat stats;

	TAILQ_ENTRY(dm_dev) next_upcall; /* LIST of mirrored, snapshoted devices. */

	TAILQ_ENTRY(dm_dev) next_devlist; /* Major device list. */
} dm_dev_t;

/* Device types used for upcalls */
#define DM_ZERO_DEV            (1 << 0)
#define DM_ERROR_DEV           (1 << 1)
#define DM_LINEAR_DEV          (1 << 2)
#define DM_MIRROR_DEV          (1 << 3)
#define DM_STRIPE_DEV          (1 << 4)
#define DM_SNAPSHOT_DEV        (1 << 5)
#define DM_SNAPSHOT_ORIG_DEV   (1 << 6)
#define DM_RESERVED1_DEV       (1 << 7)
#define DM_RESERVED2_DEV       (1 << 8)
#define DM_CRYPTO_DEV          (1 << 9)
#define DM_RAID1_DEV           (1 << 10)
#define DM_DELAY_DEV           (1 << 11)

/* for zero, error : dm_target->target_config == NULL */

/*
 * Target config is initiated with target_init function.
 */

/* constant dm_target structures for error, zero, linear, stripes etc. */
typedef struct dm_target {
	char name[DM_MAX_TYPE_NAME];
	/* Initialize target_config area */
	int (*init)(dm_dev_t *, void **, char *);

	/* Message interface */
	int (*message)(dm_table_entry_t *, char *);

	/* Destroy target_config area */
	int (*destroy)(dm_table_entry_t *);

	int (*deps) (dm_table_entry_t *, prop_array_t);
	/*
	 * Info and status are called to get params string, which is target
	 * specific. When dm_table_status_ioctl is called with flag
	 * DM_STATUS_TABLE_FLAG I have to sent params string back.
	 */
	char *(*info)(void *);
	char *(*status)(void *);
	int (*strategy)(dm_table_entry_t *, struct buf *);
	int (*upcall)(dm_table_entry_t *, struct buf *);
	int (*dump)(dm_table_entry_t *, void *data, size_t length, off_t offset);

	uint32_t version[3];
	int ref_cnt;

	TAILQ_ENTRY(dm_target) dm_target_next;
} dm_target_t;

/* Interface structures */

/*
 * This structure is used to translate command sent to kernel driver in
 * <key>command</key>
 * <value></value>
 * to function which I can call.
 */
struct cmd_function {
	const char *cmd;
	int  (*fn)(prop_dictionary_t);
};

/* device-mapper */
void dmsetdiskinfo(struct disk *, dm_table_head_t *);

/* dm_ioctl.c */
int dm_dev_create_ioctl(prop_dictionary_t);
int dm_dev_list_ioctl(prop_dictionary_t);
int dm_dev_remove_ioctl(prop_dictionary_t);
int dm_dev_remove_all_ioctl(prop_dictionary_t);
int dm_dev_rename_ioctl(prop_dictionary_t);
int dm_dev_resume_ioctl(prop_dictionary_t);
int dm_dev_status_ioctl(prop_dictionary_t);
int dm_dev_suspend_ioctl(prop_dictionary_t);

int dm_check_version(prop_dictionary_t);
int dm_list_versions_ioctl(prop_dictionary_t);

int dm_table_clear_ioctl(prop_dictionary_t);
int dm_table_deps_ioctl(prop_dictionary_t);
int dm_table_load_ioctl(prop_dictionary_t);
int dm_table_status_ioctl(prop_dictionary_t);
int dm_message_ioctl(prop_dictionary_t);

/* dm_target.c */
int dm_target_init(void);
int dm_target_uninit(void);
dm_target_t* dm_target_alloc(const char *);
dm_target_t* dm_target_autoload(const char *);
int dm_target_insert(dm_target_t *);
prop_array_t dm_target_prop_list(void);
dm_target_t* dm_target_lookup(const char *);
int dm_target_rem(char *);
void dm_target_unbusy(dm_target_t *);
void dm_target_busy(dm_target_t *);

#define DM_MAX_PARAMS_SIZE 1024

/* Generic function used to convert char to string */
uint64_t atoi64(const char *);

/* dm_table.c  */
#define DM_TABLE_ACTIVE 0
#define DM_TABLE_INACTIVE 1

int dm_table_destroy(dm_table_head_t *, uint8_t);
uint64_t dm_table_size(dm_table_head_t *);
uint64_t dm_inactive_table_size(dm_table_head_t *);
dm_table_t *dm_table_get_entry(dm_table_head_t *, uint8_t);
int dm_table_get_target_count(dm_table_head_t *, uint8_t);
void dm_table_release(dm_table_head_t *, uint8_t s);
void dm_table_switch_tables(dm_table_head_t *);
void dm_table_head_init(dm_table_head_t *);
void dm_table_head_destroy(dm_table_head_t *);

/* dm_dev.c */
int dm_dev_init(void);
int dm_dev_uninit(void);
dm_dev_t* dm_dev_alloc(void);
void dm_dev_busy(dm_dev_t *);
int dm_dev_create(dm_dev_t **, const char *, const char *, int);
int dm_dev_remove(dm_dev_t *);
int dm_dev_remove_all(int);
int dm_dev_destroy(dm_dev_t *);
int dm_dev_free(dm_dev_t *);
int dm_dev_insert(dm_dev_t *);
dm_dev_t* dm_dev_lookup(const char *, const char *, int);
prop_array_t dm_dev_prop_list(void);
dm_dev_t* dm_dev_rem_dev(dm_dev_t *);
dm_dev_t* dm_dev_rem(const char *, const char *, int);
void dm_dev_unbusy(dm_dev_t *);

/* dm_pdev.c */
int dm_pdev_init(void);
int dm_pdev_uninit(void);
int dm_pdev_decr(dm_pdev_t *);
dm_pdev_t* dm_pdev_insert(const char *);
off_t dm_pdev_correct_dump_offset(dm_pdev_t *, off_t);

/* dm builtin magic */
void dm_builtin_init(void *);
void dm_builtin_uninit(void *);

extern int dm_debug_level;
MALLOC_DECLARE(M_DM);

#define aprint_debug(format, ...)	\
    do { if (dm_debug_level) kprintf(format, ## __VA_ARGS__); } while(0)
#define aprint_normal	kprintf

#define DM_TARGET_MODULE(name, evh)				\
    static moduledata_t name##_mod = {				\
	    #name,						\
	    evh,						\
	    NULL						\
    };								\
    DECLARE_MODULE(name, name##_mod, SI_SUB_DM_TARGETS,		\
		   SI_ORDER_ANY);				\
    MODULE_DEPEND(name, dm, 1, 1, 1)

#define DM_TARGET_BUILTIN(name, evh)				\
    SYSINIT(name##module, SI_SUB_DM_TARGETS, SI_ORDER_ANY,	\
	dm_builtin_init, evh);					\
    SYSUNINIT(name##module, SI_SUB_DM_TARGETS, SI_ORDER_ANY,	\
	dm_builtin_uninit, evh)

#endif /*_KERNEL*/

#endif /*_DM_DEV_H_*/