blob: 81f3098c1b530bf357537784df5c813a06cacb95 [file] [log] [blame]
Theodore Ts'oe12f2ae2003-01-23 16:45:16 -05001/*
2 * blkid.h - Interface for libblkid, a library to identify block devices
3 *
4 * Copyright (C) 2001 Andreas Dilger
Theodore Ts'o7a603aa2003-01-26 01:54:39 -05005 * Copyright (C) 2003 Theodore Ts'o
Theodore Ts'oe12f2ae2003-01-23 16:45:16 -05006 *
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
Theodore Ts'oed1b33e2003-03-01 19:29:01 -050016#include <sys/types.h>
Theodore Ts'o50b380b2003-02-12 23:51:21 -050017#include <blkid/blkid_types.h>
18
Theodore Ts'oe12f2ae2003-01-23 16:45:16 -050019#ifdef __cplusplus
20extern "C" {
21#endif
22
Theodore Ts'o50b380b2003-02-12 23:51:21 -050023#define BLKID_VERSION "1.0.0"
24#define BLKID_DATE "12-Feb-2003"
Theodore Ts'oe12f2ae2003-01-23 16:45:16 -050025
Theodore Ts'o7a603aa2003-01-26 01:54:39 -050026typedef struct blkid_struct_dev *blkid_dev;
Theodore Ts'o7a603aa2003-01-26 01:54:39 -050027typedef struct blkid_struct_cache *blkid_cache;
Theodore Ts'o50b380b2003-02-12 23:51:21 -050028typedef __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/*
Theodore Ts'o98999c32003-02-16 00:47:07 -050034 * Flags for blkid_get_dev
Theodore Ts'o50b380b2003-02-12 23:51:21 -050035 *
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)
Theodore Ts'oe12f2ae2003-01-23 16:45:16 -050049
Theodore Ts'o7a603aa2003-01-26 01:54:39 -050050/* cache.c */
Theodore Ts'o50b380b2003-02-12 23:51:21 -050051extern void blkid_put_cache(blkid_cache cache);
Theodore Ts'o79dd2342003-02-22 17:15:20 -050052extern int blkid_get_cache(blkid_cache *cache, const char *filename);
Theodore Ts'o72923552007-05-18 00:02:35 -040053extern void blkid_gc_cache(blkid_cache cache);
Theodore Ts'oe12f2ae2003-01-23 16:45:16 -050054
Theodore Ts'o7a603aa2003-01-26 01:54:39 -050055/* dev.c */
Theodore Ts'o98999c32003-02-16 00:47:07 -050056extern const char *blkid_dev_devname(blkid_dev dev);
Theodore Ts'oe12f2ae2003-01-23 16:45:16 -050057
Theodore Ts'o7a603aa2003-01-26 01:54:39 -050058extern blkid_dev_iterate blkid_dev_iterate_begin(blkid_cache cache);
Theodore Ts'oc37543d2005-05-07 13:32:47 -040059extern int blkid_dev_set_search(blkid_dev_iterate iter,
60 char *search_type, char *search_value);
Theodore Ts'o7a603aa2003-01-26 01:54:39 -050061extern int blkid_dev_next(blkid_dev_iterate iterate, blkid_dev *dev);
62extern void blkid_dev_iterate_end(blkid_dev_iterate iterate);
Theodore Ts'oe12f2ae2003-01-23 16:45:16 -050063
Theodore Ts'o50b380b2003-02-12 23:51:21 -050064/* devno.c */
65extern char *blkid_devno_to_devname(dev_t devno);
66
Theodore Ts'o7a603aa2003-01-26 01:54:39 -050067/* devname.c */
Theodore Ts'o50b380b2003-02-12 23:51:21 -050068extern int blkid_probe_all(blkid_cache cache);
Theodore Ts'oed6acfa2005-05-07 17:06:27 -040069extern int blkid_probe_all_new(blkid_cache cache);
Theodore Ts'o98999c32003-02-16 00:47:07 -050070extern blkid_dev blkid_get_dev(blkid_cache cache, const char *devname,
71 int flags);
Theodore Ts'o50b380b2003-02-12 23:51:21 -050072
73/* getsize.c */
74extern blkid_loff_t blkid_get_dev_size(int fd);
Theodore Ts'oe12f2ae2003-01-23 16:45:16 -050075
Theodore Ts'o78e2edf2003-07-21 19:42:19 -040076/* probe.c */
77int blkid_known_fstype(const char *fstype);
Theodore Ts'o18d12962005-01-27 19:51:47 -050078extern blkid_dev blkid_verify(blkid_cache cache, blkid_dev dev);
Theodore Ts'o78e2edf2003-07-21 19:42:19 -040079
Theodore Ts'o7a603aa2003-01-26 01:54:39 -050080/* read.c */
Theodore Ts'oe12f2ae2003-01-23 16:45:16 -050081
Theodore Ts'o7a603aa2003-01-26 01:54:39 -050082/* resolve.c */
Theodore Ts'o1549a442003-02-27 19:33:36 -050083extern char *blkid_get_tag_value(blkid_cache cache, const char *tagname,
Theodore Ts'oe12f2ae2003-01-23 16:45:16 -050084 const char *devname);
Theodore Ts'o98999c32003-02-16 00:47:07 -050085extern char *blkid_get_devname(blkid_cache cache, const char *token,
86 const char *value);
Theodore Ts'oe12f2ae2003-01-23 16:45:16 -050087
Theodore Ts'o7a603aa2003-01-26 01:54:39 -050088/* tag.c */
Theodore Ts'o7a603aa2003-01-26 01:54:39 -050089extern 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);
Theodore Ts'oefc6f622008-08-27 23:07:54 -040093extern int blkid_dev_has_tag(blkid_dev dev, const char *type,
Theodore Ts'oc37543d2005-05-07 13:32:47 -040094 const char *value);
Theodore Ts'o7a603aa2003-01-26 01:54:39 -050095extern 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
Theodore Ts'o32923fa2005-01-26 13:16:06 -0500101/* 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
Theodore Ts'oe12f2ae2003-01-23 16:45:16 -0500106#ifdef __cplusplus
107}
108#endif
109
110#endif /* _BLKID_BLKID_H */