2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2010 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version three of the GNU Affero General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU Affero General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
29 * Prototypes for lib directory of Bacula
39 ATTR *new_attr(JCR *jcr);
40 void free_attr(ATTR *attr);
41 int unpack_attributes_record(JCR *jcr, int32_t stream, char *rec, int32_t reclen, ATTR *attr);
42 void build_attr_output_fnames(JCR *jcr, ATTR *attr);
43 void print_ls_output(JCR *jcr, ATTR *attr);
46 void base64_init (void);
47 int to_base64 (int64_t value, char *where);
48 int from_base64 (int64_t *value, char *where);
49 int bin_to_base64 (char *buf, int buflen, char *bin, int binlen,
51 int base64_to_bin(char *dest, int destlen, char *src, int srclen);
54 char *bstrncpy (char *dest, const char *src, int maxlen);
55 char *bstrncpy (char *dest, POOL_MEM &src, int maxlen);
56 char *bstrncat (char *dest, const char *src, int maxlen);
57 char *bstrncat (char *dest, POOL_MEM &src, int maxlen);
58 bool bstrcmp (const char *s1, const char *s2);
59 int cstrlen (const char *str);
60 void *b_malloc (const char *file, int line, size_t size);
62 void *bmalloc (size_t size);
64 void bfree (void *buf);
65 void *brealloc (void *buf, size_t size);
66 void *bcalloc (size_t size1, size_t size2);
67 int bsnprintf (char *str, int32_t size, const char *format, ...);
68 int bvsnprintf (char *str, int32_t size, const char *format, va_list ap);
69 int pool_sprintf (char *pool_buf, const char *fmt, ...);
70 void create_pid_file (char *dir, const char *progname, int port);
71 int delete_pid_file (char *dir, const char *progname, int port);
72 void drop (char *uid, char *gid, bool keep_readall_caps);
73 int bmicrosleep (int32_t sec, int32_t usec);
74 char *bfgets (char *s, int size, FILE *fd);
75 void make_unique_filename (POOLMEM **name, int Id, char *what);
77 long long int strtoll (const char *ptr, char **endptr, int base);
79 void read_state_file(char *dir, const char *progname, int port);
80 int b_strerror(int errnum, char *buf, size_t bufsiz);
81 char *escape_filename(const char *file_path);
82 int Zdeflate(char *in, int in_len, char *out, int &out_len);
83 int Zinflate(char *in, int in_len, char *out, int &out_len);
87 int32_t bnet_recv (BSOCK *bsock);
88 bool bnet_send (BSOCK *bsock);
89 bool bnet_fsend (BSOCK *bs, const char *fmt, ...);
90 bool bnet_set_buffer_size (BSOCK *bs, uint32_t size, int rw);
91 bool bnet_sig (BSOCK *bs, int sig);
92 bool bnet_tls_server (TLS_CONTEXT *ctx, BSOCK *bsock,
94 bool bnet_tls_client (TLS_CONTEXT *ctx, BSOCK *bsock,
96 BSOCK * bnet_connect (JCR *jcr, int retry_interval,
97 utime_t max_retry_time, utime_t heart_beat,
98 const char *name, char *host, char *service,
99 int port, int verbose);
100 void bnet_close (BSOCK *bsock);
101 BSOCK * init_bsock (JCR *jcr, int sockfd, const char *who, const char *ip,
102 int port, struct sockaddr *client_addr);
105 #define socklen_t int
108 int bnet_get_peer (BSOCK *bs, char *buf, socklen_t buflen);
109 BSOCK * dup_bsock (BSOCK *bsock);
110 void term_bsock (BSOCK *bsock);
111 const char *bnet_strerror (BSOCK *bsock);
112 const char *bnet_sig_to_ascii (BSOCK *bsock);
113 int bnet_wait_data (BSOCK *bsock, int sec);
114 int bnet_wait_data_intr (BSOCK *bsock, int sec);
115 bool is_bnet_stop (BSOCK *bsock);
116 int is_bnet_error (BSOCK *bsock);
117 void bnet_suppress_error_messages(BSOCK *bsock, bool flag);
118 dlist *bnet_host2ipaddrs(const char *host, int family, const char **errstr);
119 int bnet_set_blocking (BSOCK *sock);
120 int bnet_set_nonblocking (BSOCK *sock);
121 void bnet_restore_blocking (BSOCK *sock, int flags);
124 int bget_msg(BSOCK *sock);
127 BPIPE * open_bpipe(char *prog, int wait, const char *mode);
128 int close_wpipe(BPIPE *bpipe);
129 int close_bpipe(BPIPE *bpipe);
132 bool cram_md5_respond(BSOCK *bs, const char *password, int *tls_remote_need, int *compatible);
133 bool cram_md5_challenge(BSOCK *bs, const char *password, int tls_local_need, int compatible);
134 void hmac_md5(uint8_t* text, int text_len, uint8_t* key, int key_len, uint8_t *hmac);
138 uint32_t bcrc32(uint8_t *buf, int len);
141 int init_crypto (void);
142 int cleanup_crypto (void);
143 DIGEST * crypto_digest_new (JCR *jcr, crypto_digest_t type);
144 bool crypto_digest_update (DIGEST *digest, const uint8_t *data, uint32_t length);
145 bool crypto_digest_finalize (DIGEST *digest, uint8_t *dest, uint32_t *length);
146 void crypto_digest_free (DIGEST *digest);
147 SIGNATURE * crypto_sign_new (JCR *jcr);
148 crypto_error_t crypto_sign_get_digest (SIGNATURE *sig, X509_KEYPAIR *keypair,
149 crypto_digest_t &algorithm, DIGEST **digest);
150 crypto_error_t crypto_sign_verify (SIGNATURE *sig, X509_KEYPAIR *keypair, DIGEST *digest);
151 int crypto_sign_add_signer (SIGNATURE *sig, DIGEST *digest, X509_KEYPAIR *keypair);
152 int crypto_sign_encode (SIGNATURE *sig, uint8_t *dest, uint32_t *length);
153 SIGNATURE * crypto_sign_decode (JCR *jcr, const uint8_t *sigData, uint32_t length);
154 void crypto_sign_free (SIGNATURE *sig);
155 CRYPTO_SESSION * crypto_session_new (crypto_cipher_t cipher, alist *pubkeys);
156 void crypto_session_free (CRYPTO_SESSION *cs);
157 bool crypto_session_encode (CRYPTO_SESSION *cs, uint8_t *dest, uint32_t *length);
158 crypto_error_t crypto_session_decode (const uint8_t *data, uint32_t length, alist *keypairs, CRYPTO_SESSION **session);
159 CRYPTO_SESSION * crypto_session_decode (const uint8_t *data, uint32_t length);
160 CIPHER_CONTEXT * crypto_cipher_new (CRYPTO_SESSION *cs, bool encrypt, uint32_t *blocksize);
161 bool crypto_cipher_update (CIPHER_CONTEXT *cipher_ctx, const uint8_t *data, uint32_t length, const uint8_t *dest, uint32_t *written);
162 bool crypto_cipher_finalize (CIPHER_CONTEXT *cipher_ctx, uint8_t *dest, uint32_t *written);
163 void crypto_cipher_free (CIPHER_CONTEXT *cipher_ctx);
164 X509_KEYPAIR * crypto_keypair_new (void);
165 X509_KEYPAIR * crypto_keypair_dup (X509_KEYPAIR *keypair);
166 int crypto_keypair_load_cert (X509_KEYPAIR *keypair, const char *file);
167 bool crypto_keypair_has_key (const char *file);
168 int crypto_keypair_load_key (X509_KEYPAIR *keypair, const char *file, CRYPTO_PEM_PASSWD_CB *pem_callback, const void *pem_userdata);
169 void crypto_keypair_free (X509_KEYPAIR *keypair);
170 int crypto_default_pem_callback (char *buf, int size, const void *userdata);
171 const char * crypto_digest_name (DIGEST *digest);
172 crypto_digest_t crypto_digest_stream_type (int stream);
173 const char * crypto_strerror (crypto_error_t error);
176 void daemon_start ();
179 uint64_t str_to_uint64(char *str);
180 int64_t str_to_int64(char *str);
181 #define str_to_int32(str) ((int32_t)str_to_int64(str))
182 char * edit_uint64_with_commas (uint64_t val, char *buf);
183 char * edit_uint64_with_suffix (uint64_t val, char *buf);
184 char * add_commas (char *val, char *buf);
185 char * edit_uint64 (uint64_t val, char *buf);
186 char * edit_int64 (int64_t val, char *buf);
187 char * edit_int64_with_commas (int64_t val, char *buf);
188 bool duration_to_utime (char *str, utime_t *value);
189 bool size_to_uint64(char *str, int str_len, uint64_t *rtn_value);
190 bool speed_to_uint64(char *str, int str_len, uint64_t *rtn_value);
191 char *edit_utime (utime_t val, char *buf, int buf_len);
192 bool is_a_number (const char *num);
193 bool is_a_number_list (const char *n);
194 bool is_an_integer (const char *n);
195 bool is_name_valid (const char *name, POOLMEM **msg);
197 /* jcr.c (most definitions are in src/jcr.h) */
198 void init_last_jobs_list();
199 void term_last_jobs_list();
200 void lock_last_jobs_list();
201 void unlock_last_jobs_list();
202 bool read_last_jobs_list(int fd, uint64_t addr);
203 uint64_t write_last_jobs_list(int fd, uint64_t addr);
204 void write_state_file(char *dir, const char *progname, int port);
205 void job_end_push(JCR *jcr, void job_end_cb(JCR *jcr,void *), void *ctx);
208 JCR *jcr_walk_start();
209 JCR *jcr_walk_next(JCR *prev_jcr);
210 void jcr_walk_end(JCR *jcr);
212 JCR *get_jcr_from_tsd();
213 void set_jcr_in_tsd(JCR *jcr);
214 void remove_jcr_from_tsd(JCR *jcr);
215 uint32_t get_jobid_from_tsd();
216 uint32_t get_jobid_from_tid(pthread_t tid);
220 LEX * lex_close_file (LEX *lf);
221 LEX * lex_open_file (LEX *lf, const char *fname, LEX_ERROR_HANDLER *scan_error);
222 int lex_get_char (LEX *lf);
223 void lex_unget_char (LEX *lf);
224 const char * lex_tok_to_str (int token);
225 int lex_get_token (LEX *lf, int expect);
226 void lex_set_default_error_handler (LEX *lf);
227 int lex_set_error_handler_error_type (LEX *lf, int err_type);
230 void my_name_is (int argc, char *argv[], const char *name);
231 void init_msg (JCR *jcr, MSGS *msg);
232 void term_msg (void);
233 void close_msg (JCR *jcr);
234 void add_msg_dest (MSGS *msg, int dest, int type, char *where, char *dest_code);
235 void rem_msg_dest (MSGS *msg, int dest, int type, char *where);
236 void Jmsg (JCR *jcr, int type, utime_t mtime, const char *fmt, ...);
237 void dispatch_message (JCR *jcr, int type, utime_t mtime, char *buf);
238 void init_console_msg (const char *wd);
239 void free_msgs_res (MSGS *msgs);
240 void dequeue_messages (JCR *jcr);
241 void set_trace (int trace_flag);
242 bool get_trace (void);
243 void set_hangup (int hangup_value);
244 int get_hangup (void);
245 void set_db_type (const char *name);
246 void register_message_callback(void msg_callback(int type, char *msg));
249 void bnet_thread_server(dlist *addr, int max_clients, workq_t *client_wq,
250 void *handle_client_request(void *bsock));
251 void bnet_stop_thread_server(pthread_t tid);
252 void bnet_server (int port, void handle_client_request(BSOCK *bsock));
253 int net_connect (int port);
254 BSOCK * bnet_bind (int port);
255 BSOCK * bnet_accept (BSOCK *bsock, char *who);
258 typedef int (EVENT_HANDLER)(JCR *jcr, const char *event);
259 //EVENT_HANDLER *generate_daemon_event;
260 int generate_daemon_event(JCR *jcr, const char *event);
263 void init_signals (void terminate(int sig));
264 void init_stack_dump (void);
267 void strip_leading_space (char *str);
268 void strip_trailing_junk (char *str);
269 void strip_trailing_newline (char *str);
271 void strip_trailing_slashes (char *dir);
272 bool skip_spaces (char **msg);
273 bool skip_nonspaces (char **msg);
274 int fstrsch (const char *a, const char *b);
275 char *next_arg(char **s);
276 int parse_args(POOLMEM *cmd, POOLMEM **args, int *argc,
277 char **argk, char **argv, int max_args);
278 int parse_args_only(POOLMEM *cmd, POOLMEM **args, int *argc,
279 char **argk, char **argv, int max_args);
280 void split_path_and_filename(const char *fname, POOLMEM **path,
281 int *pnl, POOLMEM **file, int *fnl);
282 int bsscanf(const char *buf, const char *fmt, ...);
286 TLS_CONTEXT *new_tls_context (const char *ca_certfile,
287 const char *ca_certdir,
288 const char *certfile,
290 CRYPTO_PEM_PASSWD_CB *pem_callback,
291 const void *pem_userdata,
294 void free_tls_context (TLS_CONTEXT *ctx);
296 bool tls_postconnect_verify_host(JCR *jcr, TLS_CONNECTION *tls,
298 bool tls_postconnect_verify_cn(JCR *jcr, TLS_CONNECTION *tls,
300 TLS_CONNECTION *new_tls_connection (TLS_CONTEXT *ctx, int fd);
301 bool tls_bsock_accept (BSOCK *bsock);
302 int tls_bsock_writen (BSOCK *bsock, char *ptr, int32_t nbytes);
303 int tls_bsock_readn (BSOCK *bsock, char *ptr, int32_t nbytes);
304 #endif /* HAVE_TLS */
305 bool tls_bsock_connect (BSOCK *bsock);
306 void tls_bsock_shutdown (BSOCK *bsock);
307 void free_tls_connection (TLS_CONNECTION *tls);
308 bool get_tls_require (TLS_CONTEXT *ctx);
309 bool get_tls_enable (TLS_CONTEXT *ctx);
315 typedef char *(*job_code_callback_t)(JCR *, const char *);
318 bool is_buf_zero (char *buf, int len);
319 void lcase (char *str);
320 void bash_spaces (char *str);
321 void bash_spaces (POOL_MEM &pm);
322 void unbash_spaces (char *str);
323 void unbash_spaces (POOL_MEM &pm);
324 char * encode_time (utime_t time, char *buf);
325 char * encode_mode (mode_t mode, char *buf);
326 int do_shell_expansion (char *name, int name_len);
327 void jobstatus_to_ascii (int JobStatus, char *msg, int maxlen);
328 void jobstatus_to_ascii_gui (int JobStatus, char *msg, int maxlen);
329 int run_program (char *prog, int wait, POOLMEM *&results);
330 int run_program_full_output (char *prog, int wait, POOLMEM *&results);
331 char * action_on_purge_to_string(int aop, POOL_MEM &ret);
332 const char * job_type_to_str (int type);
333 const char * job_status_to_str (int stat);
334 const char * job_level_to_str (int level);
335 const char * volume_status_to_str (const char *status);
336 void make_session_key (char *key, char *seed, int mode);
337 void encode_session_key (char *encode, char *session, char *key, int maxlen);
338 void decode_session_key (char *decode, char *session, char *key, int maxlen);
339 POOLMEM * edit_job_codes (JCR *jcr, char *omsg, char *imsg, const char *to, job_code_callback_t job_code_callback = NULL);
340 void set_working_directory (char *wd);
341 const char * last_path_separator (const char *str);
345 int start_watchdog(void);
346 int stop_watchdog(void);
347 watchdog_t *new_watchdog(void);
348 bool register_watchdog(watchdog_t *wd);
349 bool unregister_watchdog(watchdog_t *wd);
353 btimer_t *start_child_timer(JCR *jcr, pid_t pid, uint32_t wait);
354 void stop_child_timer(btimer_t *wid);
355 btimer_t *start_thread_timer(JCR *jcr, pthread_t tid, uint32_t wait);
356 void stop_thread_timer(btimer_t *wid);
357 btimer_t *start_bsock_timer(BSOCK *bs, uint32_t wait);
358 void stop_bsock_timer(btimer_t *wid);
360 #endif /* __LIBPROTOS_H */