blkid.h revision 7292355283b90f1da3a86713b9f85074da22bb84 
1/*
2 * blkid.h - Interface for libblkid, a library to identify block devices
3 *
4 * Copyright (C) 2001 Andreas Dilger
5 * Copyright (C) 2003 Theodore Ts'o
6 *
7 * %Begin-Header%
8 * This file may be redistributed under the terms of the
9 * GNU Lesser General Public License.
10 * %End-Header%
11 */
12
13#ifndef _BLKID_BLKID_H
14#define _BLKID_BLKID_H
15
16#include <sys/types.h>
17#include <blkid/blkid_types.h>
18
19#ifdef __cplusplus
20extern "C" {
21#endif
22
23#define BLKID_VERSION	"1.0.0"
24#define BLKID_DATE	"12-Feb-2003"
25
26typedef struct blkid_struct_dev *blkid_dev;
27typedef struct blkid_struct_cache *blkid_cache;
28typedef __s64 blkid_loff_t;
29
30typedef struct blkid_struct_tag_iterate *blkid_tag_iterate;
31typedef struct blkid_struct_dev_iterate *blkid_dev_iterate;
32
33/*
34 * Flags for blkid_get_dev
35 *
36 * BLKID_DEV_CREATE	Create an empty device structure if not found
37 * 			in the cache.
38 * BLKID_DEV_VERIFY	Make sure the device structure corresponds
39 * 			with reality.
40 * BLKID_DEV_FIND	Just look up a device entry, and return NULL
41 * 			if it is not found.
42 * BLKID_DEV_NORMAL	Get a valid device structure, either from the
43 * 			cache or by probing the device.
44 */
45#define BLKID_DEV_FIND		0x0000
46#define BLKID_DEV_CREATE	0x0001
47#define BLKID_DEV_VERIFY	0x0002
48#define BLKID_DEV_NORMAL	(BLKID_DEV_CREATE | BLKID_DEV_VERIFY)
49
50/* cache.c */
51extern void blkid_put_cache(blkid_cache cache);
52extern int blkid_get_cache(blkid_cache *cache, const char *filename);
53extern void blkid_gc_cache(blkid_cache cache);
54
55/* dev.c */
56extern const char *blkid_dev_devname(blkid_dev dev);
57
58extern blkid_dev_iterate blkid_dev_iterate_begin(blkid_cache cache);
59extern int blkid_dev_set_search(blkid_dev_iterate iter,
60				char *search_type, char *search_value);
61extern int blkid_dev_next(blkid_dev_iterate iterate, blkid_dev *dev);
62extern void blkid_dev_iterate_end(blkid_dev_iterate iterate);
63
64/* devno.c */
65extern char *blkid_devno_to_devname(dev_t devno);
66
67/* devname.c */
68extern int blkid_probe_all(blkid_cache cache);
69extern int blkid_probe_all_new(blkid_cache cache);
70extern blkid_dev blkid_get_dev(blkid_cache cache, const char *devname,
71			       int flags);
72
73/* getsize.c */
74extern blkid_loff_t blkid_get_dev_size(int fd);
75
76/* probe.c */
77int blkid_known_fstype(const char *fstype);
78extern blkid_dev blkid_verify(blkid_cache cache, blkid_dev dev);
79
80/* read.c */
81
82/* resolve.c */
83extern char *blkid_get_tag_value(blkid_cache cache, const char *tagname,
84				       const char *devname);
85extern char *blkid_get_devname(blkid_cache cache, const char *token,
86			       const char *value);
87
88/* tag.c */
89extern blkid_tag_iterate blkid_tag_iterate_begin(blkid_dev dev);
90extern int blkid_tag_next(blkid_tag_iterate iterate,
91			      const char **type, const char **value);
92extern void blkid_tag_iterate_end(blkid_tag_iterate iterate);
93extern int blkid_dev_has_tag(blkid_dev dev, const char *type,
94			     const char *value);
95extern blkid_dev blkid_find_dev_with_tag(blkid_cache cache,
96					 const char *type,
97					 const char *value);
98extern int blkid_parse_tag_string(const char *token, char **ret_type,
99				  char **ret_val);
100
101/* version.c */
102extern int blkid_parse_version_string(const char *ver_string);
103extern int blkid_get_library_version(const char **ver_string,
104				     const char **date_string);
105
106#ifdef __cplusplus
107}
108#endif
109
110#endif /* _BLKID_BLKID_H */
111