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

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2007 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 two of the GNU 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 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 John Walker.
  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  * Bacula Sock Class definition
  30  *   Note, the old non-class code is in bnet.c, and the
  31  *   new class code associated with this file is in bsock.c
  32  *
  33  * Kern Sibbald, May MM
  34  *
  35  * Zero msglen from other end indicates soft eof (usually
  36  *   end of some binary data stream, but not end of conversation).
  37  *
  38  * Negative msglen, is special "signal" (no data follows).
  39  *   See below for SIGNAL codes.
  40  *
  41  *   Version $Id$
  42  */
  43
  44 #ifndef __BSOCK_H_
  45 #define __BSOCK_H_
  46
  47 struct btimer_t;                      /* forward reference */
  48 class BSOCK;
  49 btimer_t *start_bsock_timer(BSOCK *bs, uint32_t wait);
  50 void stop_bsock_timer(btimer_t *wid);
  51
  52
  53 class BSOCK {
  54 private:
  55    BSOCK *m_next;                     /* next BSOCK if duped */
  56    JCR *m_jcr;                        /* jcr or NULL for error msgs */
  57    char *m_who;                       /* Name of daemon to which we are talking */
  58    char *m_host;                      /* Host name/IP */
  59    int m_port;                        /* desired port */
  60    btimer_t *m_tid;                   /* timer id */
  61    volatile bool m_timed_out: 1;      /* timed out in read/write */
  62    volatile bool m_terminated: 1;     /* set when BNET_TERMINATE arrives */
  63    bool m_duped: 1;                   /* set if duped BSOCK */
  64    bool m_spool: 1;                   /* set for spooling */
  65
  66    void fin_init(JCR * jcr, int sockfd, const char *who, const char *host, int port,
  67                struct sockaddr *lclient_addr);
  68    bool open(JCR *jcr, const char *name, char *host, char *service,
  69                int port, utime_t heart_beat, int *fatal);
  70
  71 public:
  72    uint64_t read_seqno;               /* read sequence number */
  73    uint32_t in_msg_no;                /* input message number */
  74    uint32_t out_msg_no;               /* output message number */
  75    int m_fd;                          /* socket file descriptor */
  76    TLS_CONNECTION *tls;               /* associated tls connection */
  77    int32_t msglen;                    /* message length */
  78    int b_errno;                       /* bsock errno */
  79    int m_blocking;                    /* blocking state (0 = nonblocking, 1 = blocking) */
  80    volatile int errors;               /* incremented for each error on socket */
  81    volatile bool m_suppress_error_msgs: 1; /* set to suppress error messages */
  82    volatile time_t timer_start;       /* time started read/write */
  83    volatile time_t timeout;           /* timeout BSOCK after this interval */
  84    POOLMEM *msg;                      /* message pool buffer */
  85    POOLMEM *errmsg;                   /* edited error message */
  86    RES *res;                          /* Resource to which we are connected */
  87    FILE *m_spool_fd;                  /* spooling file */
  88    struct sockaddr client_addr;       /* client's IP address */
  89    struct sockaddr_in peer_addr;      /* peer's IP address */
  90
  91    /* methods -- in bsock.c */
  92    void init();
  93    void free_bsock();
  94    bool connect(JCR * jcr, int retry_interval, utime_t max_retry_time,
  95                 utime_t heart_beat, const char *name, char *host,
  96                 char *service, int port, int verbose);
  97    int32_t recv();
  98    bool send();
  99    bool fsend(const char*, ...);
 100    bool signal(int signal);
 101    void close();                      /* close connection and destroy packet */
 102    void destroy();                    /* destroy socket packet */
 103    const char *bstrerror();           /* last error on socket */
 104    int get_peer(char *buf, socklen_t buflen);
 105    bool despool(void update_attr_spool_size(ssize_t size), ssize_t tsize);
 106    bool set_buffer_size(uint32_t size, int rw);
 107    int set_nonblocking();
 108    int set_blocking();
 109    void restore_blocking(int flags);
 110    int wait_data(int sec);
 111    int wait_data_intr(int sec);
 112    bool authenticate_director(const char *name, const char *password,
 113                   TLS_CONTEXT *tls_ctx, char *msg, int msglen);
 114
 115    /* Inline functions */
 116    void set_jcr(JCR *jcr) { m_jcr = jcr; };
 117    void set_who(char *who) { m_who = who; };
 118    void set_host(char *host) { m_host = host; };
 119    void set_port(int port) { m_port = port; };
 120    char *who() { return m_who; };
 121    char *host() { return m_host; };
 122    int port() { return m_port; };
 123    JCR *jcr() { return m_jcr; };
 124    JCR *get_jcr() { return m_jcr; };
 125    bool is_spooling() { return m_spool; };
 126    bool is_duped() { return m_duped; };
 127    bool is_terminated() { return m_terminated; };
 128    bool is_timed_out() { return m_timed_out; };
 129    bool is_stop() { return errors || is_terminated(); }
 130    bool is_error() { errno = b_errno; return errors; }
 131    void set_spooling() { m_spool = true; };
 132    void clear_spooling() { m_spool = false; };
 133    void set_duped() { m_duped = true; };
 134    void set_timed_out() { m_timed_out = true; };
 135    void clear_timed_out() { m_timed_out = false; };
 136    void set_terminated() { m_terminated = true; };
 137    void start_timer(int sec) { m_tid = start_bsock_timer(this, sec); };
 138    void stop_timer() { stop_bsock_timer(m_tid); };
 139 };
 140
 141 /*
 142  *  Signal definitions for use in bnet_sig()
 143  *  Note! These must be negative.  There are signals that are generated
 144  *   by the bsock software not by the OS ...
 145  */
 146 enum {
 147    BNET_EOD            = -1,          /* End of data stream, new data may follow */
 148    BNET_EOD_POLL       = -2,          /* End of data and poll all in one */
 149    BNET_STATUS         = -3,          /* Send full status */
 150    BNET_TERMINATE      = -4,          /* Conversation terminated, doing close() */
 151    BNET_POLL           = -5,          /* Poll request, I'm hanging on a read */
 152    BNET_HEARTBEAT      = -6,          /* Heartbeat Response requested */
 153    BNET_HB_RESPONSE    = -7,          /* Only response permited to HB */
 154    BNET_PROMPT         = -8,          /* Prompt for subcommand */
 155    BNET_BTIME          = -9,          /* Send UTC btime */
 156    BNET_BREAK          = -10,         /* Stop current command -- ctl-c */
 157    BNET_START_SELECT   = -11,         /* Start of a selection list */
 158    BNET_END_SELECT     = -12,         /* End of a select list */
 159    BNET_INVALID_CMD    = -13,         /* Invalid command sent */
 160    BNET_CMD_FAILED     = -14,         /* Command failed */
 161    BNET_CMD_OK         = -15,         /* Command succeeded */
 162    BNET_CMD_BEGIN      = -16,         /* Start command execution */
 163    BNET_MSGS_PENDING   = -17,         /* Messages pending */
 164    BNET_MAIN_PROMPT    = -18,         /* Server ready and waiting */
 165    BNET_SELECT_INPUT   = -19,         /* Return selection input */
 166    BNET_WARNING_MSG    = -20,         /* Warning message */
 167    BNET_ERROR_MSG      = -21,         /* Error message -- command failed */
 168    BNET_INFO_MSG       = -22,         /* Info message -- status line */
 169    BNET_RUN_CMD        = -23,         /* Run command follows */
 170    BNET_YESNO          = -24,         /* Request yes no response */
 171    BNET_START_RTREE    = -25,         /* Start restore tree mode */
 172    BNET_END_RTREE      = -26          /* End restore tree mode */
 173 };
 174
 175 #define BNET_SETBUF_READ  1           /* Arg for bnet_set_buffer_size */
 176 #define BNET_SETBUF_WRITE 2           /* Arg for bnet_set_buffer_size */
 177
 178 /*
 179  * Return status from bnet_recv()
 180  * Note, the HARDEOF and ERROR refer to comm status/problems
 181  *  rather than the BNET_xxx above, which are software signals.
 182  */
 183 enum {
 184    BNET_SIGNAL         = -1,
 185    BNET_HARDEOF        = -2,
 186    BNET_ERROR          = -3
 187 };
 188
 189 /*
 190  * TLS enabling values. Value is important for comparison, ie:
 191  * if (tls_remote_need < BNET_TLS_REQUIRED) { ... }
 192  */
 193 enum {
 194    BNET_TLS_NONE        = 0,          /* cannot do TLS */
 195    BNET_TLS_OK          = 1,          /* can do, but not required on my end */
 196    BNET_TLS_REQUIRED    = 2           /* TLS is required */
 197 };
 198
 199 int32_t read_nbytes(BSOCK * bsock, char *ptr, int32_t nbytes);
 200 int32_t write_nbytes(BSOCK * bsock, char *ptr, int32_t nbytes);
 201
 202 BSOCK *new_bsock();
 203
 204 #endif /* __BSOCK_H_ */