Sync usage with man page.
[netbsd-mini2440.git] / external / gpl2 / lvm2 / dist / lib / activate / activate.h
blob9b49e88c20e21f32199cfe1953c2aeb0a1074576
1 /* $NetBSD$ */
3 /*
4 * Copyright (C) 2001-2004 Sistina Software, Inc. All rights reserved.
5 * Copyright (C) 2004-2007 Red Hat, Inc. All rights reserved.
7 * This file is part of LVM2.
9 * This copyrighted material is made available to anyone wishing to use,
10 * modify, copy, or redistribute it subject to the terms and conditions
11 * of the GNU Lesser General Public License v.2.1.
13 * You should have received a copy of the GNU Lesser General Public License
14 * along with this program; if not, write to the Free Software Foundation,
15 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 #ifndef LVM_ACTIVATE_H
19 #define LVM_ACTIVATE_H
21 #include "metadata-exported.h"
23 struct lvinfo {
24 int exists;
25 int suspended;
26 unsigned int open_count;
27 int major;
28 int minor;
29 int read_only;
30 int live_table;
31 int inactive_table;
32 uint32_t read_ahead;
35 /* target attribute flags */
36 #define MIRROR_LOG_CLUSTERED 0x00000001U
38 void set_activation(int activation);
39 int activation(void);
41 int driver_version(char *version, size_t size);
42 int library_version(char *version, size_t size);
43 int lvm1_present(struct cmd_context *cmd);
45 int module_present(struct cmd_context *cmd, const char *target_name);
46 int target_present(struct cmd_context *cmd, const char *target_name,
47 int use_modprobe);
48 int target_version(const char *target_name, uint32_t *maj,
49 uint32_t *min, uint32_t *patchlevel);
50 int list_segment_modules(struct dm_pool *mem, const struct lv_segment *seg,
51 struct dm_list *modules);
52 int list_lv_modules(struct dm_pool *mem, const struct logical_volume *lv,
53 struct dm_list *modules);
55 void activation_release(void);
56 void activation_exit(void);
58 int lv_suspend(struct cmd_context *cmd, const char *lvid_s);
59 int lv_suspend_if_active(struct cmd_context *cmd, const char *lvid_s);
60 int lv_resume(struct cmd_context *cmd, const char *lvid_s);
61 int lv_resume_if_active(struct cmd_context *cmd, const char *lvid_s);
62 int lv_activate(struct cmd_context *cmd, const char *lvid_s, int exclusive);
63 int lv_activate_with_filter(struct cmd_context *cmd, const char *lvid_s,
64 int exclusive);
65 int lv_deactivate(struct cmd_context *cmd, const char *lvid_s);
67 int lv_mknodes(struct cmd_context *cmd, const struct logical_volume *lv);
70 * Returns 1 if info structure has been populated, else 0.
72 int lv_info(struct cmd_context *cmd, const struct logical_volume *lv, struct lvinfo *info,
73 int with_open_count, int with_read_ahead);
74 int lv_info_by_lvid(struct cmd_context *cmd, const char *lvid_s,
75 struct lvinfo *info, int with_open_count, int with_read_ahead);
78 * Returns 1 if activate_lv has been set: 1 = activate; 0 = don't.
80 int lv_activation_filter(struct cmd_context *cmd, const char *lvid_s,
81 int *activate_lv);
84 * Returns 1 if percent has been set, else 0.
86 int lv_snapshot_percent(const struct logical_volume *lv, float *percent,
87 percent_range_t *percent_range);
88 int lv_mirror_percent(struct cmd_context *cmd, struct logical_volume *lv,
89 int wait, float *percent, percent_range_t *percent_range,
90 uint32_t *event_nr);
93 * Return number of LVs in the VG that are active.
95 int lvs_in_vg_activated(struct volume_group *vg);
96 int lvs_in_vg_activated_by_uuid_only(struct volume_group *vg);
97 int lvs_in_vg_opened(const struct volume_group *vg);
99 int lv_is_active(struct logical_volume *lv);
101 int monitor_dev_for_events(struct cmd_context *cmd,
102 struct logical_volume *lv, int do_reg);
105 * Returns 1 if PV has a dependency tree that uses anything in VG.
107 int pv_uses_vg(struct physical_volume *pv,
108 struct volume_group *vg);
111 * Returns 1 if mapped device is not suspended.
113 int device_is_usable(dev_t dev);
115 #endif