2 * Prototypes for lib directory of Bacula
7 Copyright (C) 2000-2005 Kern Sibbald
9 This program is free software; you can redistribute it and/or
10 modify it under the terms of the GNU General Public License as
11 published by the Free Software Foundation; either version 2 of
12 the License, or (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
19 You should have received a copy of the GNU General Public
20 License along with this program; if not, write to the Free
21 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 void free_attr(ATTR *attr);
31 int unpack_attributes_record(JCR *jcr, int32_t stream, char *rec, ATTR *attr);
32 void build_attr_output_fnames(JCR *jcr, ATTR *attr);
33 void print_ls_output(JCR *jcr, ATTR *attr);
36 void base64_init (void);
37 int to_base64 (intmax_t value, char *where);
38 int from_base64 (intmax_t *value, char *where);
39 int bin_to_base64 (char *buf, char *bin, int len);
42 char *bstrncpy (char *dest, const char *src, int maxlen);
43 char *bstrncpy (char *dest, POOL_MEM &src, int maxlen);
44 char *bstrncat (char *dest, const char *src, int maxlen);
45 char *bstrncat (char *dest, POOL_MEM &src, int maxlen);
46 void *b_malloc (const char *file, int line, size_t size);
48 void *bmalloc (size_t size);
50 void *brealloc (void *buf, size_t size);
51 void *bcalloc (size_t size1, size_t size2);
52 int bsnprintf (char *str, int32_t size, const char *format, ...);
53 int bvsnprintf (char *str, int32_t size, const char *format, va_list ap);
54 int pool_sprintf (char *pool_buf, const char *fmt, ...);
55 void create_pid_file (char *dir, const char *progname, int port);
56 int delete_pid_file (char *dir, const char *progname, int port);
57 void drop (char *uid, char *gid);
58 int bmicrosleep (time_t sec, long usec);
59 char *bfgets (char *s, int size, FILE *fd);
60 void make_unique_filename (POOLMEM **name, int Id, char *what);
62 long long int strtoll (const char *ptr, char **endptr, int base);
64 void read_state_file(char *dir, const char *progname, int port);
65 int bstrerror(int errnum, char *buf, size_t bufsiz);
68 int32_t bnet_recv (BSOCK *bsock);
69 bool bnet_send (BSOCK *bsock);
70 bool bnet_fsend (BSOCK *bs, const char *fmt, ...);
71 bool bnet_set_buffer_size (BSOCK *bs, uint32_t size, int rw);
72 bool bnet_sig (BSOCK *bs, int sig);
74 int bnet_tls_server (TLS_CONTEXT *ctx, BSOCK *bsock,
76 int bnet_tls_client (TLS_CONTEXT *ctx, BSOCK *bsock);
78 BSOCK * bnet_connect (JCR *jcr, int retry_interval,
79 int max_retry_time, const char *name, char *host, char *service,
80 int port, int verbose);
81 void bnet_close (BSOCK *bsock);
82 BSOCK * init_bsock (JCR *jcr, int sockfd, const char *who, const char *ip,
83 int port, struct sockaddr *client_addr);
84 BSOCK * dup_bsock (BSOCK *bsock);
85 void term_bsock (BSOCK *bsock);
86 const char *bnet_strerror (BSOCK *bsock);
87 const char *bnet_sig_to_ascii (BSOCK *bsock);
88 int bnet_wait_data (BSOCK *bsock, int sec);
89 int bnet_wait_data_intr (BSOCK *bsock, int sec);
90 int bnet_despool_to_bsock (BSOCK *bsock, void update(ssize_t size), ssize_t size);
91 bool is_bnet_stop (BSOCK *bsock);
92 int is_bnet_error (BSOCK *bsock);
93 void bnet_suppress_error_messages(BSOCK *bsock, bool flag);
94 dlist *bnet_host2ipaddrs(const char *host, int family, const char **errstr);
95 int bnet_set_blocking (BSOCK *sock);
96 int bnet_set_nonblocking (BSOCK *sock);
97 void bnet_restore_blocking (BSOCK *sock, int flags);
100 int bget_msg(BSOCK *sock);
103 BPIPE * open_bpipe(char *prog, int wait, const char *mode);
104 int close_wpipe(BPIPE *bpipe);
105 int close_bpipe(BPIPE *bpipe);
108 int cram_md5_get_auth(BSOCK *bs, char *password, int *tls_remote_need);
109 int cram_md5_auth(BSOCK *bs, char *password, int tls_local_need);
110 void hmac_md5(uint8_t* text, int text_len, uint8_t* key,
111 int key_len, uint8_t *hmac);
115 uint32_t bcrc32(uint8_t *buf, int len);
118 void daemon_start ();
121 uint64_t str_to_uint64(char *str);
122 int64_t str_to_int64(char *str);
123 char * edit_uint64_with_commas (uint64_t val, char *buf);
124 char * add_commas (char *val, char *buf);
125 char * edit_uint64 (uint64_t val, char *buf);
126 char * edit_int64 (int64_t val, char *buf);
127 int duration_to_utime (char *str, utime_t *value);
128 int size_to_uint64(char *str, int str_len, uint64_t *rtn_value);
129 char *edit_utime (utime_t val, char *buf, int buf_len);
130 bool is_a_number (const char *num);
131 bool is_an_integer (const char *n);
132 bool is_name_valid (char *name, POOLMEM **msg);
134 /* jcr.c (most definitions are in src/jcr.h) */
135 void init_last_jobs_list();
136 void term_last_jobs_list();
137 void lock_last_jobs_list();
138 void unlock_last_jobs_list();
139 void read_last_jobs_list(int fd, uint64_t addr);
140 uint64_t write_last_jobs_list(int fd, uint64_t addr);
141 void write_state_file(char *dir, const char *progname, int port);
142 void job_end_push(JCR *jcr, void job_end_cb(JCR *jcr,void *), void *ctx);
146 LEX * lex_close_file (LEX *lf);
147 LEX * lex_open_file (LEX *lf, const char *fname, LEX_ERROR_HANDLER *scan_error);
148 int lex_get_char (LEX *lf);
149 void lex_unget_char (LEX *lf);
150 const char * lex_tok_to_str (int token);
151 int lex_get_token (LEX *lf, int expect);
154 void my_name_is (int argc, char *argv[], const char *name);
155 void init_msg (JCR *jcr, MSGS *msg);
156 void term_msg (void);
157 void close_msg (JCR *jcr);
158 void add_msg_dest (MSGS *msg, int dest, int type, char *where, char *dest_code);
159 void rem_msg_dest (MSGS *msg, int dest, int type, char *where);
160 void Jmsg (JCR *jcr, int type, time_t mtime, const char *fmt, ...);
161 void dispatch_message (JCR *jcr, int type, time_t mtime, char *buf);
162 void init_console_msg (const char *wd);
163 void free_msgs_res (MSGS *msgs);
164 void dequeue_messages (JCR *jcr);
165 void set_trace (int trace_flag);
166 void set_exit_on_error (int value);
169 void bnet_thread_server(dlist *addr, int max_clients, workq_t *client_wq,
170 void *handle_client_request(void *bsock));
171 void bnet_stop_thread_server(pthread_t tid);
172 void bnet_server (int port, void handle_client_request(BSOCK *bsock));
173 int net_connect (int port);
174 BSOCK * bnet_bind (int port);
175 BSOCK * bnet_accept (BSOCK *bsock, char *who);
178 char *getuser(uid_t uid);
179 void free_getuser_cache();
180 char *getgroup (gid_t gid);
181 void free_getgroup_cache();
184 typedef int (EVENT_HANDLER)(JCR *jcr, const char *event);
185 void init_python_interpreter(const char *progname, const char *scripts,
187 void term_python_interpreter();
188 //extern EVENT_HANDLER *generate_daemon_event;
189 int generate_daemon_event(JCR *jcr, const char *event);
192 void init_signals (void terminate(int sig));
193 void init_stack_dump (void);
196 void strip_trailing_junk (char *str);
197 void strip_trailing_slashes (char *dir);
198 bool skip_spaces (char **msg);
199 bool skip_nonspaces (char **msg);
200 int fstrsch (const char *a, const char *b);
201 char *next_arg(char **s);
202 int parse_args(POOLMEM *cmd, POOLMEM **args, int *argc,
203 char **argk, char **argv, int max_args);
204 void split_path_and_filename(const char *fname, POOLMEM **path,
205 int *pnl, POOLMEM **file, int *fnl);
206 int bsscanf(const char *buf, const char *fmt, ...);
212 int cleanup_tls (void);
213 TLS_CONTEXT *new_tls_context (const char *ca_certfile,
214 const char *ca_certdir,
215 const char *certfile,
217 TLS_PEM_PASSWD_CB *pem_callback,
218 const void *pem_userdata,
221 void free_tls_context (TLS_CONTEXT *ctx);
222 bool tls_postconnect_verify_host (TLS_CONNECTION *tls,
224 bool tls_postconnect_verify_cn (TLS_CONNECTION *tls,
226 TLS_CONNECTION *new_tls_connection (TLS_CONTEXT *ctx, int fd);
227 void free_tls_connection (TLS_CONNECTION *tls);
228 bool tls_bsock_connect (BSOCK *bsock);
229 bool tls_bsock_accept (BSOCK *bsock);
230 void tls_bsock_shutdown (BSOCK *bsock);
231 int tls_bsock_writen (BSOCK *bsock, char *ptr, int32_t nbytes);
232 int tls_bsock_readn (BSOCK *bsock, char *ptr, int32_t nbytes);
233 #endif /* HAVE_TLS */
237 int is_buf_zero (char *buf, int len);
238 void lcase (char *str);
239 void bash_spaces (char *str);
240 void bash_spaces (POOL_MEM &pm);
241 void unbash_spaces (char *str);
242 void unbash_spaces (POOL_MEM &pm);
243 char * encode_time (time_t time, char *buf);
244 char * encode_mode (mode_t mode, char *buf);
245 int do_shell_expansion (char *name, int name_len);
246 void jobstatus_to_ascii (int JobStatus, char *msg, int maxlen);
247 int run_program (char *prog, int wait, POOLMEM *results);
248 int run_program_full_output (char *prog, int wait, POOLMEM *results);
249 const char * job_type_to_str (int type);
250 const char * job_status_to_str (int stat);
251 const char * job_level_to_str (int level);
252 void make_session_key (char *key, char *seed, int mode);
253 POOLMEM *edit_job_codes(JCR *jcr, char *omsg, char *imsg, const char *to);
254 void set_working_directory(char *wd);
258 int start_watchdog(void);
259 int stop_watchdog(void);
260 watchdog_t *new_watchdog(void);
261 bool register_watchdog(watchdog_t *wd);
262 bool unregister_watchdog(watchdog_t *wd);
265 btimer_t *start_child_timer(pid_t pid, uint32_t wait);
266 void stop_child_timer(btimer_t *wid);
267 btimer_t *start_thread_timer(pthread_t tid, uint32_t wait);
268 void stop_thread_timer(btimer_t *wid);
269 btimer_t *start_bsock_timer(BSOCK *bs, uint32_t wait);
270 void stop_bsock_timer(btimer_t *wid);