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