git.sur5r.net Git - bacula/bacula/blob - bacula/src/lib/protos.h

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2010 Free Software Foundation Europe e.V.
   5
   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
  11    in the file LICENSE.
  12
  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.
  17
  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
  21    02110-1301, USA.
  22
  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.
  27 */
  28 /*
  29  * Prototypes for lib directory of Bacula
  30  *
  31  */
  32
  33 #ifndef __LIBPROTOS_H
  34 #define __LIBPROTOS_H
  35
  36 class JCR;
  37
  38 /* attr.c */
  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);
  44
  45 /* base64.c */
  46 void      base64_init            (void);
  47 int       to_base64              (intmax_t value, char *where);
  48 int       from_base64            (intmax_t *value, char *where);
  49 int       bin_to_base64          (char *buf, int buflen, char *bin, int binlen,
  50                                   int compatible);
  51
  52 /* bsys.c */
  53 char     *bstrncpy               (char *dest, const char *src, int maxlen);
  54 char     *bstrncpy               (char *dest, POOL_MEM &src, int maxlen);
  55 char     *bstrncat               (char *dest, const char *src, int maxlen);
  56 char     *bstrncat               (char *dest, POOL_MEM &src, int maxlen);
  57 bool      bstrcmp                (const char *s1, const char *s2);
  58 int       cstrlen                (const char *str);
  59 void     *b_malloc               (const char *file, int line, size_t size);
  60 #ifndef bmalloc
  61 void     *bmalloc                (size_t size);
  62 #endif
  63 void      bfree                  (void *buf);
  64 void     *brealloc               (void *buf, size_t size);
  65 void     *bcalloc                (size_t size1, size_t size2);
  66 int       bsnprintf              (char *str, int32_t size, const char *format, ...);
  67 int       bvsnprintf             (char *str, int32_t size, const char *format, va_list ap);
  68 int       pool_sprintf           (char *pool_buf, const char *fmt, ...);
  69 void      create_pid_file        (char *dir, const char *progname, int port);
  70 int       delete_pid_file        (char *dir, const char *progname, int port);
  71 void      drop                   (char *uid, char *gid, bool keep_readall_caps);
  72 int       bmicrosleep            (int32_t sec, int32_t usec);
  73 char     *bfgets                 (char *s, int size, FILE *fd);
  74 void      make_unique_filename   (POOLMEM **name, int Id, char *what);
  75 #ifndef HAVE_STRTOLL
  76 long long int strtoll            (const char *ptr, char **endptr, int base);
  77 #endif
  78 void      read_state_file(char *dir, const char *progname, int port);
  79 int       b_strerror(int errnum, char *buf, size_t bufsiz);
  80 char     *escape_filename(const char *file_path);
  81 int       Zdeflate(char *in, int in_len, char *out, int &out_len);
  82 int       Zinflate(char *in, int in_len, char *out, int &out_len);
  83 void      stack_trace();
  84
  85 /* bnet.c */
  86 int32_t    bnet_recv             (BSOCK *bsock);
  87 bool       bnet_send             (BSOCK *bsock);
  88 bool       bnet_fsend            (BSOCK *bs, const char *fmt, ...);
  89 bool       bnet_set_buffer_size  (BSOCK *bs, uint32_t size, int rw);
  90 bool       bnet_sig              (BSOCK *bs, int sig);
  91 bool       bnet_tls_server       (TLS_CONTEXT *ctx, BSOCK *bsock,
  92                                   alist *verify_list);
  93 bool       bnet_tls_client       (TLS_CONTEXT *ctx, BSOCK *bsock,
  94                                   alist *verify_list);
  95 BSOCK *    bnet_connect          (JCR *jcr, int retry_interval,
  96                utime_t max_retry_time, utime_t heart_beat,
  97                const char *name, char *host, char *service,
  98                int port, int verbose);
  99 void       bnet_close            (BSOCK *bsock);
 100 BSOCK *    init_bsock            (JCR *jcr, int sockfd, const char *who, const char *ip,
 101                                   int port, struct sockaddr *client_addr);
 102 #ifdef HAVE_WIN32
 103 #ifndef socklen_t
 104 #define socklen_t int
 105 #endif
 106 #endif
 107 int        bnet_get_peer           (BSOCK *bs, char *buf, socklen_t buflen);
 108 BSOCK *    dup_bsock             (BSOCK *bsock);
 109 void       term_bsock            (BSOCK *bsock);
 110 const char *bnet_strerror         (BSOCK *bsock);
 111 const char *bnet_sig_to_ascii     (BSOCK *bsock);
 112 int        bnet_wait_data        (BSOCK *bsock, int sec);
 113 int        bnet_wait_data_intr   (BSOCK *bsock, int sec);
 114 bool       is_bnet_stop          (BSOCK *bsock);
 115 int        is_bnet_error         (BSOCK *bsock);
 116 void       bnet_suppress_error_messages(BSOCK *bsock, bool flag);
 117 dlist *bnet_host2ipaddrs(const char *host, int family, const char **errstr);
 118 int        bnet_set_blocking     (BSOCK *sock);
 119 int        bnet_set_nonblocking  (BSOCK *sock);
 120 void       bnet_restore_blocking (BSOCK *sock, int flags);
 121
 122 /* bget_msg.c */
 123 int      bget_msg(BSOCK *sock);
 124
 125 /* bpipe.c */
 126 BPIPE *          open_bpipe(char *prog, int wait, const char *mode);
 127 int              close_wpipe(BPIPE *bpipe);
 128 int              close_bpipe(BPIPE *bpipe);
 129
 130 /* cram-md5.c */
 131 bool cram_md5_respond(BSOCK *bs, const char *password, int *tls_remote_need, int *compatible);
 132 bool cram_md5_challenge(BSOCK *bs, const char *password, int tls_local_need, int compatible);
 133 void hmac_md5(uint8_t* text, int text_len, uint8_t* key, int key_len, uint8_t *hmac);
 134
 135 /* crc32.c */
 136
 137 uint32_t bcrc32(uint8_t *buf, int len);
 138
 139 /* crypto.c */
 140 int                init_crypto                 (void);
 141 int                cleanup_crypto              (void);
 142 DIGEST *           crypto_digest_new           (JCR *jcr, crypto_digest_t type);
 143 bool               crypto_digest_update        (DIGEST *digest, const uint8_t *data, uint32_t length);
 144 bool               crypto_digest_finalize      (DIGEST *digest, uint8_t *dest, uint32_t *length);
 145 void               crypto_digest_free          (DIGEST *digest);
 146 SIGNATURE *        crypto_sign_new             (JCR *jcr);
 147 crypto_error_t     crypto_sign_get_digest      (SIGNATURE *sig, X509_KEYPAIR *keypair,
 148                                                 crypto_digest_t &algorithm, DIGEST **digest);
 149 crypto_error_t     crypto_sign_verify          (SIGNATURE *sig, X509_KEYPAIR *keypair, DIGEST *digest);
 150 int                crypto_sign_add_signer      (SIGNATURE *sig, DIGEST *digest, X509_KEYPAIR *keypair);
 151 int                crypto_sign_encode          (SIGNATURE *sig, uint8_t *dest, uint32_t *length);
 152 SIGNATURE *        crypto_sign_decode          (JCR *jcr, const uint8_t *sigData, uint32_t length);
 153 void               crypto_sign_free            (SIGNATURE *sig);
 154 CRYPTO_SESSION *   crypto_session_new          (crypto_cipher_t cipher, alist *pubkeys);
 155 void               crypto_session_free         (CRYPTO_SESSION *cs);
 156 bool               crypto_session_encode       (CRYPTO_SESSION *cs, uint8_t *dest, uint32_t *length);
 157 crypto_error_t     crypto_session_decode       (const uint8_t *data, uint32_t length, alist *keypairs, CRYPTO_SESSION **session);
 158 CRYPTO_SESSION *   crypto_session_decode       (const uint8_t *data, uint32_t length);
 159 CIPHER_CONTEXT *   crypto_cipher_new           (CRYPTO_SESSION *cs, bool encrypt, uint32_t *blocksize);
 160 bool               crypto_cipher_update        (CIPHER_CONTEXT *cipher_ctx, const uint8_t *data, uint32_t length, const uint8_t *dest, uint32_t *written);
 161 bool               crypto_cipher_finalize      (CIPHER_CONTEXT *cipher_ctx, uint8_t *dest, uint32_t *written);
 162 void               crypto_cipher_free          (CIPHER_CONTEXT *cipher_ctx);
 163 X509_KEYPAIR *     crypto_keypair_new          (void);
 164 X509_KEYPAIR *     crypto_keypair_dup          (X509_KEYPAIR *keypair);
 165 int                crypto_keypair_load_cert    (X509_KEYPAIR *keypair, const char *file);
 166 bool               crypto_keypair_has_key      (const char *file);
 167 int                crypto_keypair_load_key     (X509_KEYPAIR *keypair, const char *file, CRYPTO_PEM_PASSWD_CB *pem_callback, const void *pem_userdata);
 168 void               crypto_keypair_free         (X509_KEYPAIR *keypair);
 169 int                crypto_default_pem_callback (char *buf, int size, const void *userdata);
 170 const char *       crypto_digest_name          (DIGEST *digest);
 171 crypto_digest_t    crypto_digest_stream_type   (int stream);
 172 const char *       crypto_strerror             (crypto_error_t error);
 173
 174 /* daemon.c */
 175 void     daemon_start            ();
 176
 177 /* edit.c */
 178 uint64_t         str_to_uint64(char *str);
 179 int64_t          str_to_int64(char *str);
 180 #define str_to_int32(str) ((int32_t)str_to_int64(str))
 181 char *           edit_uint64_with_commas   (uint64_t val, char *buf);
 182 char *           edit_uint64_with_suffix   (uint64_t val, char *buf);
 183 char *           add_commas              (char *val, char *buf);
 184 char *           edit_uint64             (uint64_t val, char *buf);
 185 char *           edit_int64              (int64_t val, char *buf);
 186 char *           edit_int64_with_commas  (int64_t val, char *buf);
 187 bool             duration_to_utime       (char *str, utime_t *value);
 188 bool             size_to_uint64(char *str, int str_len, uint64_t *rtn_value);
 189 bool             speed_to_uint64(char *str, int str_len, uint64_t *rtn_value);
 190 char             *edit_utime             (utime_t val, char *buf, int buf_len);
 191 bool             is_a_number             (const char *num);
 192 bool             is_a_number_list        (const char *n);
 193 bool             is_an_integer           (const char *n);
 194 bool             is_name_valid           (const char *name, POOLMEM **msg);
 195
 196 /* jcr.c (most definitions are in src/jcr.h) */
 197 void     init_last_jobs_list();
 198 void     term_last_jobs_list();
 199 void     lock_last_jobs_list();
 200 void     unlock_last_jobs_list();
 201 bool     read_last_jobs_list(int fd, uint64_t addr);
 202 uint64_t write_last_jobs_list(int fd, uint64_t addr);
 203 void     write_state_file(char *dir, const char *progname, int port);
 204 void     job_end_push(JCR *jcr, void job_end_cb(JCR *jcr,void *), void *ctx);
 205 void     lock_jobs();
 206 void     unlock_jobs();
 207 JCR     *jcr_walk_start();
 208 JCR     *jcr_walk_next(JCR *prev_jcr);
 209 void     jcr_walk_end(JCR *jcr);
 210 int      job_count();
 211 JCR     *get_jcr_from_tsd();
 212 void     set_jcr_in_tsd(JCR *jcr);
 213 void     remove_jcr_from_tsd(JCR *jcr);
 214 uint32_t get_jobid_from_tsd();
 215 uint32_t get_jobid_from_tid(pthread_t tid);
 216
 217
 218 /* lex.c */
 219 LEX *     lex_close_file         (LEX *lf);
 220 LEX *     lex_open_file          (LEX *lf, const char *fname, LEX_ERROR_HANDLER *scan_error);
 221 int       lex_get_char           (LEX *lf);
 222 void      lex_unget_char         (LEX *lf);
 223 const char *  lex_tok_to_str     (int token);
 224 int       lex_get_token          (LEX *lf, int expect);
 225 void      lex_set_default_error_handler (LEX *lf);
 226 int       lex_set_error_handler_error_type (LEX *lf, int err_type);
 227
 228 /* message.c */
 229 void       my_name_is            (int argc, char *argv[], const char *name);
 230 void       init_msg              (JCR *jcr, MSGS *msg);
 231 void       term_msg              (void);
 232 void       close_msg             (JCR *jcr);
 233 void       add_msg_dest          (MSGS *msg, int dest, int type, char *where, char *dest_code);
 234 void       rem_msg_dest          (MSGS *msg, int dest, int type, char *where);
 235 void       Jmsg                  (JCR *jcr, int type, utime_t mtime, const char *fmt, ...);
 236 void       dispatch_message      (JCR *jcr, int type, utime_t mtime, char *buf);
 237 void       init_console_msg      (const char *wd);
 238 void       free_msgs_res         (MSGS *msgs);
 239 void       dequeue_messages      (JCR *jcr);
 240 void       set_trace             (int trace_flag);
 241 bool       get_trace             (void);
 242 void       set_hangup            (int hangup_value);
 243 int        get_hangup            (void);
 244 void       set_db_type           (const char *name);
 245 void       register_message_callback(void msg_callback(int type, char *msg));
 246
 247 /* bnet_server.c */
 248 void       bnet_thread_server(dlist *addr, int max_clients, workq_t *client_wq,
 249                    void *handle_client_request(void *bsock));
 250 void       bnet_stop_thread_server(pthread_t tid);
 251 void             bnet_server             (int port, void handle_client_request(BSOCK *bsock));
 252 int              net_connect             (int port);
 253 BSOCK *          bnet_bind               (int port);
 254 BSOCK *          bnet_accept             (BSOCK *bsock, char *who);
 255
 256 /* pythonlib.c */
 257 typedef int (EVENT_HANDLER)(JCR *jcr, const char *event);
 258 //EVENT_HANDLER *generate_daemon_event;
 259 int generate_daemon_event(JCR *jcr, const char *event);
 260
 261 /* signal.c */
 262 void             init_signals             (void terminate(int sig));
 263 void             init_stack_dump          (void);
 264
 265 /* scan.c */
 266 void             strip_leading_space     (char *str);
 267 void             strip_trailing_junk     (char *str);
 268 void             strip_trailing_newline  (char *str);
 269
 270 void             strip_trailing_slashes  (char *dir);
 271 bool             skip_spaces             (char **msg);
 272 bool             skip_nonspaces          (char **msg);
 273 int              fstrsch                 (const char *a, const char *b);
 274 char            *next_arg(char **s);
 275 int              parse_args(POOLMEM *cmd, POOLMEM **args, int *argc,
 276                         char **argk, char **argv, int max_args);
 277 int              parse_args_only(POOLMEM *cmd, POOLMEM **args, int *argc,
 278                         char **argk, char **argv, int max_args);
 279 void            split_path_and_filename(const char *fname, POOLMEM **path,
 280                         int *pnl, POOLMEM **file, int *fnl);
 281 int             bsscanf(const char *buf, const char *fmt, ...);
 282
 283
 284 /* tls.c */
 285 TLS_CONTEXT      *new_tls_context        (const char *ca_certfile,
 286                                           const char *ca_certdir,
 287                                           const char *certfile,
 288                                           const char *keyfile,
 289                                           CRYPTO_PEM_PASSWD_CB *pem_callback,
 290                                           const void *pem_userdata,
 291                                           const char *dhfile,
 292                                           bool verify_peer);
 293 void             free_tls_context        (TLS_CONTEXT *ctx);
 294 #ifdef HAVE_TLS
 295 bool             tls_postconnect_verify_host(JCR *jcr, TLS_CONNECTION *tls,
 296                                                const char *host);
 297 bool             tls_postconnect_verify_cn(JCR *jcr, TLS_CONNECTION *tls,
 298                                                alist *verify_list);
 299 TLS_CONNECTION   *new_tls_connection     (TLS_CONTEXT *ctx, int fd);
 300 bool             tls_bsock_accept        (BSOCK *bsock);
 301 int              tls_bsock_writen        (BSOCK *bsock, char *ptr, int32_t nbytes);
 302 int              tls_bsock_readn         (BSOCK *bsock, char *ptr, int32_t nbytes);
 303 #endif /* HAVE_TLS */
 304 bool             tls_bsock_connect       (BSOCK *bsock);
 305 void             tls_bsock_shutdown      (BSOCK *bsock);
 306 void             free_tls_connection     (TLS_CONNECTION *tls);
 307 bool             get_tls_require         (TLS_CONTEXT *ctx);
 308 bool             get_tls_enable          (TLS_CONTEXT *ctx);
 309
 310
 311 /* util.c */
 312
 313 extern "C" {
 314 typedef char *(*job_code_callback_t)(JCR *, const char *);
 315 }
 316
 317 bool             is_buf_zero             (char *buf, int len);
 318 void             lcase                   (char *str);
 319 void             bash_spaces             (char *str);
 320 void             bash_spaces             (POOL_MEM &pm);
 321 void             unbash_spaces           (char *str);
 322 void             unbash_spaces           (POOL_MEM &pm);
 323 char *           encode_time             (utime_t time, char *buf);
 324 char *           encode_mode             (mode_t mode, char *buf);
 325 int              do_shell_expansion      (char *name, int name_len);
 326 void             jobstatus_to_ascii      (int JobStatus, char *msg, int maxlen);
 327 void             jobstatus_to_ascii_gui  (int JobStatus, char *msg, int maxlen);
 328 int              run_program             (char *prog, int wait, POOLMEM *&results);
 329 int              run_program_full_output (char *prog, int wait, POOLMEM *&results);
 330 char *           action_on_purge_to_string(int aop, POOL_MEM &ret);
 331 const char *     job_type_to_str         (int type);
 332 const char *     job_status_to_str       (int stat);
 333 const char *     job_level_to_str        (int level);
 334 const char *     volume_status_to_str    (const char *status);
 335 void             make_session_key        (char *key, char *seed, int mode);
 336 void             encode_session_key      (char *encode, char *session, char *key, int maxlen);
 337 void             decode_session_key      (char *decode, char *session, char *key, int maxlen);
 338 POOLMEM *        edit_job_codes          (JCR *jcr, char *omsg, char *imsg, const char *to, job_code_callback_t job_code_callback = NULL);
 339 void             set_working_directory   (char *wd);
 340 const char *     last_path_separator     (const char *str);
 341
 342
 343 /* watchdog.c */
 344 int start_watchdog(void);
 345 int stop_watchdog(void);
 346 watchdog_t *new_watchdog(void);
 347 bool register_watchdog(watchdog_t *wd);
 348 bool unregister_watchdog(watchdog_t *wd);
 349 bool is_watchdog();
 350
 351 /* timers.c */
 352 btimer_t *start_child_timer(JCR *jcr, pid_t pid, uint32_t wait);
 353 void stop_child_timer(btimer_t *wid);
 354 btimer_t *start_thread_timer(JCR *jcr, pthread_t tid, uint32_t wait);
 355 void stop_thread_timer(btimer_t *wid);
 356 btimer_t *start_bsock_timer(BSOCK *bs, uint32_t wait);
 357 void stop_bsock_timer(btimer_t *wid);
 358
 359 #endif /* __LIBPROTOS_H */