* Allow different data offset setting for detached header.
[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 "nls.h"
14 #include "utils_crypt.h"
15 #include "utils_loop.h"
16 #include "utils_dm.h"
17
18 #define SECTOR_SHIFT            9
19 #define SECTOR_SIZE             (1 << SECTOR_SHIFT)
20 #define DEFAULT_DISK_ALIGNMENT  1048576 /* 1MiB */
21 #define DEFAULT_MEM_ALIGNMENT   4096
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(a, b) ({ __typeof__(a) __at_least = (a); (__at_least >= (b))?__at_least:(b); })
31
32 struct crypt_device;
33
34 struct volume_key {
35         size_t keylength;
36         char key[];
37 };
38
39 struct volume_key *crypt_alloc_volume_key(unsigned keylength, const char *key);
40 struct volume_key *crypt_generate_volume_key(struct crypt_device *cd, unsigned keylength);
41 void crypt_free_volume_key(struct volume_key *vk);
42
43 int crypt_confirm(struct crypt_device *cd, const char *msg);
44
45 void set_error_va(const char *fmt, va_list va);
46 void set_error(const char *fmt, ...);
47 const char *get_error(void);
48
49 char *crypt_lookup_dev(const char *dev_id);
50 int crypt_sysfs_check_crypt_segment(const char *device, uint64_t offset, uint64_t size);
51
52 int sector_size_for_device(const char *device);
53 int device_read_ahead(const char *dev, uint32_t *read_ahead);
54 ssize_t write_blockwise(int fd, void *buf, size_t count);
55 ssize_t read_blockwise(int fd, void *_buf, size_t count);
56 ssize_t write_lseek_blockwise(int fd, char *buf, size_t count, off_t offset);
57 int device_ready(struct crypt_device *cd, const char *device, int mode);
58 int device_size(const char *device, uint64_t *size);
59
60 enum devcheck { DEV_OK = 0, DEV_EXCL = 1, DEV_SHARED = 2 };
61 int device_check_and_adjust(struct crypt_device *cd,
62                             const char *device,
63                             enum devcheck device_check,
64                             uint64_t *size,
65                             uint64_t *offset,
66                             uint32_t *flags);
67 int wipe_device_header(const char *device, int sectors);
68
69 void logger(struct crypt_device *cd, int class, const char *file, int line, const char *format, ...);
70 #define log_dbg(x...) logger(NULL, CRYPT_LOG_DEBUG, __FILE__, __LINE__, x)
71 #define log_std(c, x...) logger(c, CRYPT_LOG_NORMAL, __FILE__, __LINE__, x)
72 #define log_verbose(c, x...) logger(c, CRYPT_LOG_VERBOSE, __FILE__, __LINE__, x)
73 #define log_err(c, x...) do { \
74         logger(c, CRYPT_LOG_ERROR, __FILE__, __LINE__, x); \
75         set_error(x); } while(0)
76
77 int crypt_get_debug_level(void);
78 void debug_processes_using_device(const char *name);
79
80 int crypt_memlock_inc(struct crypt_device *ctx);
81 int crypt_memlock_dec(struct crypt_device *ctx);
82
83 void get_topology_alignment(const char *device,
84                             unsigned long *required_alignment, /* bytes */
85                             unsigned long *alignment_offset,   /* bytes */
86                             unsigned long default_alignment);
87
88 enum { CRYPT_RND_NORMAL = 0, CRYPT_RND_KEY = 1 };
89 int crypt_random_init(struct crypt_device *ctx);
90 int crypt_random_get(struct crypt_device *ctx, char *buf, size_t len, int quality);
91 void crypt_random_exit(void);
92 int crypt_random_default_key_rng(void);
93
94 int crypt_plain_hash(struct crypt_device *ctx,
95                      const char *hash_name,
96                      char *key, size_t key_size,
97                      const char *passphrase, size_t passphrase_size);
98 int PLAIN_activate(struct crypt_device *cd,
99                      const char *name,
100                      struct volume_key *vk,
101                      uint64_t size,
102                      uint32_t flags);
103
104 #endif /* INTERNAL_H */