Home | History | Annotate | Line # | Download | only in libdm
dm.h revision 1.1.2.2
      1  1.1.2.2  bouyer /*
      2  1.1.2.2  bouyer  * Copyright (c) 2010 The NetBSD Foundation, Inc.
      3  1.1.2.2  bouyer  * All rights reserved.
      4  1.1.2.2  bouyer  *
      5  1.1.2.2  bouyer  * This code is derived from software contributed to The NetBSD Foundation
      6  1.1.2.2  bouyer  * by Adam Hamsik.
      7  1.1.2.2  bouyer  *
      8  1.1.2.2  bouyer  * Redistribution and use in source and binary forms, with or without
      9  1.1.2.2  bouyer  * modification, are permitted provided that the following conditions
     10  1.1.2.2  bouyer  * are met:
     11  1.1.2.2  bouyer  * 1. Redistributions of source code must retain the above copyright
     12  1.1.2.2  bouyer  *    notice, this list of conditions and the following disclaimer.
     13  1.1.2.2  bouyer  * 2. Redistributions in binary form must reproduce the above copyright
     14  1.1.2.2  bouyer  *    notice, this list of conditions and the following disclaimer in the
     15  1.1.2.2  bouyer  *    documentation and/or other materials provided with the distribution.
     16  1.1.2.2  bouyer  *
     17  1.1.2.2  bouyer  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     18  1.1.2.2  bouyer  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     19  1.1.2.2  bouyer  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     20  1.1.2.2  bouyer  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     21  1.1.2.2  bouyer  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     22  1.1.2.2  bouyer  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     23  1.1.2.2  bouyer  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     24  1.1.2.2  bouyer  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     25  1.1.2.2  bouyer  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     26  1.1.2.2  bouyer  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     27  1.1.2.2  bouyer  * POSSIBILITY OF SUCH DAMAGE.
     28  1.1.2.2  bouyer  */
     29  1.1.2.2  bouyer 
     30  1.1.2.2  bouyer 
     31  1.1.2.2  bouyer #ifndef _LIB_DM_H_
     32  1.1.2.2  bouyer #define _LIB_DM_H_
     33  1.1.2.2  bouyer 
     34  1.1.2.2  bouyer __BEGIN_DECLS
     35  1.1.2.2  bouyer 
     36  1.1.2.2  bouyer #define DM_DEVICE_PATH "/dev/mapper/control"
     37  1.1.2.2  bouyer 
     38  1.1.2.2  bouyer #define IOCTL_TYPE_IN  0x1
     39  1.1.2.2  bouyer #define IOCTL_TYPE_OUT 0x2
     40  1.1.2.2  bouyer 
     41  1.1.2.2  bouyer struct libdm_task;
     42  1.1.2.2  bouyer struct libdm_cmd;
     43  1.1.2.2  bouyer struct libdm_target;
     44  1.1.2.2  bouyer struct libdm_table;
     45  1.1.2.2  bouyer struct libdm_dev;
     46  1.1.2.2  bouyer struct libdm_iter;
     47  1.1.2.2  bouyer 
     48  1.1.2.2  bouyer typedef struct libdm_task* libdm_task_t;
     49  1.1.2.2  bouyer typedef struct libdm_cmd* libdm_cmd_t;
     50  1.1.2.2  bouyer typedef struct libdm_target* libdm_target_t;
     51  1.1.2.2  bouyer typedef struct libdm_table* libdm_table_t;
     52  1.1.2.2  bouyer typedef struct libdm_dev* libdm_dev_t;
     53  1.1.2.2  bouyer typedef struct libdm_iter* libdm_iter_t;
     54  1.1.2.2  bouyer 
     55  1.1.2.2  bouyer struct cmd_version {
     56  1.1.2.2  bouyer 	const char *cmd;
     57  1.1.2.2  bouyer 	uint32_t version[3];
     58  1.1.2.2  bouyer };
     59  1.1.2.2  bouyer 
     60  1.1.2.2  bouyer void libdm_iter_destroy(libdm_iter_t);
     61  1.1.2.2  bouyer 
     62  1.1.2.2  bouyer libdm_task_t libdm_task_create(const char *);
     63  1.1.2.2  bouyer void libdm_task_destroy(libdm_task_t);
     64  1.1.2.2  bouyer 
     65  1.1.2.2  bouyer char *libdm_task_get_command(libdm_task_t);
     66  1.1.2.2  bouyer int32_t libdm_task_get_cmd_version(libdm_task_t, uint32_t *, size_t);
     67  1.1.2.2  bouyer 
     68  1.1.2.2  bouyer int libdm_task_set_name(const char *, libdm_task_t);
     69  1.1.2.2  bouyer char *libdm_task_get_name(libdm_task_t);
     70  1.1.2.2  bouyer 
     71  1.1.2.2  bouyer int libdm_task_set_uuid(const char *, libdm_task_t);
     72  1.1.2.2  bouyer char *libdm_task_get_uuid(libdm_task_t);
     73  1.1.2.2  bouyer 
     74  1.1.2.2  bouyer int libdm_task_set_minor(uint32_t, libdm_task_t);
     75  1.1.2.2  bouyer uint32_t libdm_task_get_minor(libdm_task_t);
     76  1.1.2.2  bouyer 
     77  1.1.2.2  bouyer uint32_t libdm_task_get_flags(libdm_task_t);
     78  1.1.2.2  bouyer void libdm_task_set_flags(libdm_task_t, uint32_t);
     79  1.1.2.2  bouyer 
     80  1.1.2.2  bouyer void libdm_task_set_suspend_flag(libdm_task_t);
     81  1.1.2.2  bouyer void libdm_task_del_suspend_flag(libdm_task_t);
     82  1.1.2.2  bouyer 
     83  1.1.2.2  bouyer void libdm_task_set_status_flag(libdm_task_t);
     84  1.1.2.2  bouyer void libdm_task_del_status_flag(libdm_task_t);
     85  1.1.2.2  bouyer 
     86  1.1.2.2  bouyer void libdm_task_set_exists_flag(libdm_task_t);
     87  1.1.2.2  bouyer void libdm_task_del_exists_flag(libdm_task_t);
     88  1.1.2.2  bouyer 
     89  1.1.2.2  bouyer void libdm_task_set_nocount_flag(libdm_task_t);
     90  1.1.2.2  bouyer void libdm_task_del_nocount_flag(libdm_task_t);
     91  1.1.2.2  bouyer 
     92  1.1.2.2  bouyer uint32_t libdm_task_get_target_num(libdm_task_t);
     93  1.1.2.2  bouyer int32_t libdm_task_get_open_num(libdm_task_t);
     94  1.1.2.2  bouyer uint32_t libdm_task_get_event_num(libdm_task_t);
     95  1.1.2.2  bouyer 
     96  1.1.2.2  bouyer int libdm_task_set_cmd(libdm_cmd_t, libdm_task_t);
     97  1.1.2.2  bouyer libdm_cmd_t libdm_task_get_cmd(libdm_task_t);
     98  1.1.2.2  bouyer 
     99  1.1.2.2  bouyer /* cmd_data dictionary entry manipulating functions */
    100  1.1.2.2  bouyer libdm_cmd_t libdm_cmd_create(void);
    101  1.1.2.2  bouyer void libdm_cmd_destroy(libdm_cmd_t);
    102  1.1.2.2  bouyer libdm_iter_t libdm_cmd_iter_create(libdm_cmd_t);
    103  1.1.2.2  bouyer 
    104  1.1.2.2  bouyer int libdm_cmd_set_table(libdm_table_t, libdm_cmd_t);
    105  1.1.2.2  bouyer 
    106  1.1.2.2  bouyer /* cmd is array of table dictionaries */
    107  1.1.2.2  bouyer libdm_table_t libdm_cmd_get_table(libdm_iter_t);
    108  1.1.2.2  bouyer 
    109  1.1.2.2  bouyer /* cmd is array of dev dictionaries */
    110  1.1.2.2  bouyer libdm_dev_t libdm_cmd_get_dev(libdm_iter_t);
    111  1.1.2.2  bouyer 
    112  1.1.2.2  bouyer /* cmd is array of target dictonaries */
    113  1.1.2.2  bouyer libdm_target_t libdm_cmd_get_target(libdm_iter_t);
    114  1.1.2.2  bouyer /* cmd is array of dev_t's */
    115  1.1.2.2  bouyer uint64_t libdm_cmd_get_deps(libdm_iter_t);
    116  1.1.2.2  bouyer 
    117  1.1.2.2  bouyer /* Table functions. */
    118  1.1.2.2  bouyer libdm_table_t libdm_table_create(void);
    119  1.1.2.2  bouyer void libdm_table_destroy(libdm_table_t);
    120  1.1.2.2  bouyer 
    121  1.1.2.2  bouyer int libdm_table_set_start(uint64_t, libdm_table_t);
    122  1.1.2.2  bouyer uint64_t libdm_table_get_start(libdm_table_t);
    123  1.1.2.2  bouyer 
    124  1.1.2.2  bouyer int libdm_table_set_length(uint64_t, libdm_table_t);
    125  1.1.2.2  bouyer uint64_t libdm_table_get_length(libdm_table_t);
    126  1.1.2.2  bouyer 
    127  1.1.2.2  bouyer int libdm_table_set_target(const char *, libdm_table_t);
    128  1.1.2.2  bouyer char * libdm_table_get_target(libdm_table_t);
    129  1.1.2.2  bouyer 
    130  1.1.2.2  bouyer int libdm_table_set_params(const char *, libdm_table_t);
    131  1.1.2.2  bouyer char * libdm_table_get_params(libdm_table_t);
    132  1.1.2.2  bouyer 
    133  1.1.2.2  bouyer int32_t libdm_table_get_status(libdm_table_t);
    134  1.1.2.2  bouyer 
    135  1.1.2.2  bouyer /* Target manipulating functions. */
    136  1.1.2.2  bouyer void libdm_target_destroy(libdm_target_t);
    137  1.1.2.2  bouyer 
    138  1.1.2.2  bouyer char * libdm_target_get_name(libdm_target_t);
    139  1.1.2.2  bouyer int32_t libdm_target_get_version(libdm_target_t, uint32_t *, size_t);
    140  1.1.2.2  bouyer 
    141  1.1.2.2  bouyer /* Dev manipulating functions. */
    142  1.1.2.2  bouyer void libdm_dev_destroy(libdm_dev_t);
    143  1.1.2.2  bouyer 
    144  1.1.2.2  bouyer char * libdm_dev_get_name(libdm_dev_t);
    145  1.1.2.2  bouyer uint32_t libdm_dev_get_minor(libdm_dev_t);
    146  1.1.2.2  bouyer 
    147  1.1.2.2  bouyer int libdm_dev_set_newname(const char *, libdm_cmd_t);
    148  1.1.2.2  bouyer 
    149  1.1.2.2  bouyer /* task run routine */
    150  1.1.2.2  bouyer int libdm_task_run(libdm_task_t);
    151  1.1.2.2  bouyer 
    152  1.1.2.2  bouyer __END_DECLS
    153  1.1.2.2  bouyer 
    154  1.1.2.2  bouyer #endif /* _LIB_DM_H_ */
    155