* Move device utils code and provide context parameter (for log).
[platform/upstream/cryptsetup.git] / lib / internal.h
1 #ifndef INTERNAL_H
2 #define INTERNAL_H
3
4 #ifdef HAVE_CONFIG_H
5 #       include "config.h"
6 #endif
7
8 #include <stdint.h>
9 #include <stdarg.h>
10 #include <unistd.h>
11 #include <inttypes.h>
12
13 #include <libintl.h>
14 #include <locale.h>
15 #define _(String) gettext((String))
16
17 #define SECTOR_SHIFT            9
18 #define SECTOR_SIZE             (1 << SECTOR_SHIFT)
19 #define DEFAULT_ALIGNMENT       4096
20
21 #define MAX_TTY_PASSWORD_LEN    512
22
23 /* private struct crypt_options flags */
24
25 #define CRYPT_FLAG_FREE_DEVICE  (1 << 24)
26 #define CRYPT_FLAG_FREE_CIPHER  (1 << 25)
27
28 #define CRYPT_FLAG_PRIVATE_MASK ((unsigned int)-1 << 24)
29
30 #define at_least_one(a) ({ __typeof__(a) __at_least_one=(a); (__at_least_one)?__at_least_one:1; })
31
32 struct hash_type {
33         char            *name;
34         void            *private;
35         int             (*fn)(void *data, int size, char *key,
36                               int sizep, const char *passphrase);
37 };
38
39 struct hash_backend {
40         const char              *name;
41         struct hash_type *      (*get_hashes)(void);
42         void                    (*free_hashes)(struct hash_type *hashes);
43 };
44
45 struct device_infos {
46         uint64_t        size;
47         int             readonly;
48 };
49
50 struct crypt_device;
51
52 void set_error_va(const char *fmt, va_list va);
53 void set_error(const char *fmt, ...);
54 const char *get_error(void);
55 void *safe_alloc(size_t size);
56 void safe_free(void *data);
57 void *safe_realloc(void *data, size_t size);
58 char *safe_strdup(const char *s);
59 void set_debug_level(int level);
60
61 struct hash_backend *get_hash_backend(const char *name);
62 void put_hash_backend(struct hash_backend *backend);
63 int hash(const char *backend_name, const char *hash_name,
64          char *result, size_t size,
65          const char *passphrase, size_t sizep);
66
67 void hexprint(char *d, int n);
68
69 /* Device mapper backend */
70 const char *dm_get_dir(void);
71 int dm_init(struct crypt_device *context, int check_kernel);
72 void dm_exit(void);
73 int dm_remove_device(const char *name, int force, uint64_t size);
74 int dm_status_device(const char *name);
75 int dm_query_device(const char *name,
76                     char **device,
77                     uint64_t *size,
78                     uint64_t *skip,
79                     uint64_t *offset,
80                     char **cipher,
81                     int *key_size,
82                     char **key,
83                     int *read_only);
84 int dm_create_device(const char *name, const char *device, const char *cipher, const char *uuid,
85                      uint64_t size, uint64_t skip, uint64_t offset,
86                      size_t key_size, const char *key,
87                      int read_only, int reload);
88
89 int sector_size_for_device(const char *device);
90 ssize_t write_blockwise(int fd, const void *buf, size_t count);
91 ssize_t read_blockwise(int fd, void *_buf, size_t count);
92 ssize_t write_lseek_blockwise(int fd, const char *buf, size_t count, off_t offset);
93 int device_ready(struct crypt_device *cd, const char *device, int mode);
94 int get_device_infos(const char *device, struct device_infos *infos, struct crypt_device *cd);
95 int wipe_device_header(const char *device, int sectors);
96
97 void get_key(char *prompt, char **key, unsigned int *passLen, int key_size,
98              const char *key_file, int timeout, int how2verify,
99              struct crypt_device *cd);
100
101 int parse_into_name_and_mode(const char *nameAndMode, char *name, char *mode);
102
103 void set_default_log(void (*log)(int class, char *msg));
104 void logger(struct crypt_device *cd, int class, const char *file, int line, const char *format, ...);
105 #define log_dbg(x...) logger(NULL, CRYPT_LOG_DEBUG, __FILE__, __LINE__, x)
106 #define log_std(c, x...) logger(c, CRYPT_LOG_NORMAL, __FILE__, __LINE__, x)
107 #define log_err(c, x...) do { \
108         logger(c, CRYPT_LOG_ERROR, __FILE__, __LINE__, x); \
109         set_error(x); } while(0)
110
111 int memlock_inc(struct crypt_device *ctx);
112 int memlock_dec(struct crypt_device *ctx);
113
114 #endif /* INTERNAL_H */