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

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