strdup() requires <string.h>
[strongswan.git] / src / pluto / defs.h
1 /* misc. universal things
2 * Copyright (C) 1997 Angelos D. Keromytis.
3 * Copyright (C) 1998-2001 D. Hugh Redelmeier.
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 *
15 * RCSID $Id$
16 */
17
18 #ifndef _DEFS_H
19 #define _DEFS_H
20
21 #include <string.h>
22 #include <sys/types.h>
23
24 #ifdef KLIPS
25 # define USED_BY_KLIPS /* ignore */
26 #else
27 # define USED_BY_KLIPS UNUSED
28 #endif
29
30 #ifdef DEBUG
31 # define USED_BY_DEBUG /* ignore */
32 #else
33 # define USED_BY_DEBUG UNUSED
34 #endif
35
36 /* type of serial number of a state object
37 * Needed in connections.h and state.h; here to simplify dependencies.
38 */
39 typedef unsigned long so_serial_t;
40 #define SOS_NOBODY 0 /* null serial number */
41 #define SOS_FIRST 1 /* first normal serial number */
42
43 /* memory allocation */
44
45 extern void *clone_bytes(const void *orig, size_t size);
46
47 #define clone_thing(orig) clone_bytes((const void *)&(orig), sizeof(orig))
48
49 #define clone_str(str) \
50 ((str) == NULL? NULL : strdup(str))
51
52 #define replace(p, q) { free(p); (p) = (q); }
53
54
55 /* chunk is a simple pointer-and-size abstraction */
56
57 struct chunk {
58 u_char *ptr;
59 size_t len;
60 };
61 typedef struct chunk chunk_t;
62
63 #define setchunk(ch, addr, size) { (ch).ptr = (addr); (ch).len = (size); }
64
65 #define strchunk(str) { str, sizeof(str) }
66
67 /* NOTE: freeanychunk NULLs .ptr */
68 #define freeanychunk(ch) { free((ch).ptr); (ch).ptr = NULL; }
69
70 #define clonetochunk(ch, addr, size) \
71 { (ch).ptr = clone_bytes((addr), (ch).len = (size)); }
72
73 #define clonereplacechunk(ch, addr, size) \
74 { free((ch).ptr); clonetochunk(ch, addr, size); }
75
76 #define chunkcpy(dst, chunk) \
77 { memcpy(dst, chunk.ptr, chunk.len); dst += chunk.len;}
78
79 #define same_chunk(a, b) \
80 ( (a).len == (b).len && memcmp((a).ptr, (b).ptr, (b).len) == 0 )
81
82 extern char* temporary_cyclic_buffer(void);
83 extern const char* concatenate_paths(const char *a, const char *b);
84
85 extern const chunk_t chunk_empty;
86
87 /* compare two chunks */
88 extern int cmp_chunk(chunk_t a, chunk_t b);
89
90 /* move a chunk to a memory position and free it after insertion */
91 extern void mv_chunk(u_char **pos, chunk_t content);
92
93 /* write the binary contents of a chunk_t to a file */
94 extern bool write_chunk(const char *filename, const char *label, chunk_t ch
95 ,mode_t mask, bool force);
96
97 /* display a date either in local or UTC time */
98 extern char* timetoa(const time_t *time, bool utc);
99
100 /* warns a predefined interval before expiry */
101 extern const char* check_expiry(time_t expiration_date,
102 int warning_interval, bool strict);
103
104 #define MAX_PROMPT_PASS_TRIALS 5
105 #define PROMPT_PASS_LEN 64
106
107 /* struct used to prompt for a secret passphrase
108 * from a console with file descriptor fd
109 */
110 typedef struct {
111 char secret[PROMPT_PASS_LEN+1];
112 bool prompt;
113 int fd;
114 } prompt_pass_t;
115
116 /* size of timetoa string buffer */
117 #define TIMETOA_BUF 30
118
119 /* filter eliminating the directory entries '.' and '..' */
120 typedef struct dirent dirent_t;
121 extern int file_select(const dirent_t *entry);
122
123 /* cleanly exit Pluto */
124
125 extern void exit_pluto(int /*status*/) NEVER_RETURNS;
126
127
128 /* zero all bytes */
129 #define zero(x) memset((x), '\0', sizeof(*(x)))
130
131 /* are all bytes 0? */
132 extern bool all_zero(const unsigned char *m, size_t len);
133
134 /* pad_up(n, m) is the amount to add to n to make it a multiple of m */
135 #define pad_up(n, m) (((m) - 1) - (((n) + (m) - 1) % (m)))
136
137 #endif /* _DEFS_H */