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 plus additions
  11    that are listed 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
  45 class BSOCK {
  46 private:
  47    BSOCK *m_next;                     /* next BSOCK if duped */
  48    JCR *m_jcr;                        /* jcr or NULL for error msgs */
  49    char *m_who;                       /* Name of daemon to which we are talking */
  50    char *m_host;                      /* Host name/IP */
  51    int m_port;                        /* desired port */
  52
  53    void init(JCR * jcr, int sockfd, const char *who, const char *host, int port,
  54                struct sockaddr *lclient_addr);
  55    bool open(JCR *jcr, const char *name, char *host, char *service,
  56                int port, utime_t heart_beat, int *fatal);
  57
  58 public:
  59    uint64_t read_seqno;               /* read sequence number */
  60    uint32_t in_msg_no;                /* input message number */
  61    uint32_t out_msg_no;               /* output message number */
  62    int m_fd;                          /* socket file descriptor */
  63    TLS_CONNECTION *tls;               /* associated tls connection */
  64    int32_t msglen;                    /* message length */
  65    int b_errno;                       /* bsock errno */
  66    int m_blocking;                    /* blocking state (0 = nonblocking, 1 = blocking) */
  67    volatile int errors;               /* incremented for each error on socket */
  68    volatile bool m_suppress_error_msgs: 1; /* set to suppress error messages */
  69    volatile bool m_timed_out: 1;      /* timed out in read/write */
  70    volatile bool m_terminated: 1;     /* set when BNET_TERMINATE arrives */
  71    bool m_duped: 1;                   /* set if duped BSOCK */
  72    bool m_spool: 1;                   /* set for spooling */
  73    volatile time_t timer_start;       /* time started read/write */
  74    volatile time_t timeout;           /* timeout BSOCK after this interval */
  75    POOLMEM *msg;                      /* message pool buffer */
  76    POOLMEM *errmsg;                   /* edited error message */
  77    RES *res;                          /* Resource to which we are connected */
  78    FILE *m_spool_fd;                  /* spooling file */
  79    struct sockaddr client_addr;       /* client's IP address */
  80    struct sockaddr_in peer_addr;      /* peer's IP address */
  81
  82    /* methods -- in bsock.c */
  83    BSOCK();
  84    ~BSOCK();
  85    bool connect(JCR * jcr, int retry_interval, utime_t max_retry_time,
  86                 utime_t heart_beat, const char *name, char *host,
  87                 char *service, int port, int verbose);
  88    int32_t recv();
  89    bool send();
  90    bool fsend(const char*, ...);
  91    bool signal(int signal);
  92    void close();                      /* close connection and destroy packet */
  93    void destroy();                    /* destroy socket packet */
  94    const char *bstrerror();           /* last error on socket */
  95    int get_peer(char *buf, socklen_t buflen);
  96    bool despool(void update_attr_spool_size(ssize_t size), ssize_t tsize);
  97    bool set_buffer_size(uint32_t size, int rw);
  98    int set_nonblocking();
  99    int set_blocking();
 100    void restore_blocking(int flags);
 101
 102    /* Inline functions */
 103    void set_jcr(JCR *jcr) { m_jcr = jcr; };
 104    void set_who(char *who) { m_who = who; };
 105    void set_host(char *host) { m_host = host; };
 106    void set_port(int port) { m_port = port; };
 107    char *who() { return m_who; };
 108    char *host() { return m_host; };
 109    int port() { return m_port; };
 110    JCR *jcr() { return m_jcr; };
 111    JCR *get_jcr() { return m_jcr; };
 112    bool is_terminated() { return m_terminated; };
 113    bool is_timed_out() { return m_timed_out; };
 114    void set_terminated() { m_terminated = true; };
 115 };
 116
 117 /*
 118  *  Signal definitions for use in bnet_sig()
 119  *  Note! These must be negative.  There are signals that are generated
 120  *   by the bsock software not by the OS ...
 121  */
 122 enum {
 123    BNET_EOD            = -1,          /* End of data stream, new data may follow */
 124    BNET_EOD_POLL       = -2,          /* End of data and poll all in one */
 125    BNET_STATUS         = -3,          /* Send full status */
 126    BNET_TERMINATE      = -4,          /* Conversation terminated, doing close() */
 127    BNET_POLL           = -5,          /* Poll request, I'm hanging on a read */
 128    BNET_HEARTBEAT      = -6,          /* Heartbeat Response requested */
 129    BNET_HB_RESPONSE    = -7,          /* Only response permited to HB */
 130    BNET_PROMPT         = -8,          /* Prompt for subcommand */
 131    BNET_BTIME          = -9,          /* Send UTC btime */
 132    BNET_BREAK          = -10,         /* Stop current command -- ctl-c */
 133    BNET_START_SELECT   = -11,         /* Start of a selection list */
 134    BNET_END_SELECT     = -12,         /* End of a select list */
 135    BNET_INVALID_CMD    = -13,         /* Invalid command sent */
 136    BNET_CMD_FAILED     = -14,         /* Command failed */
 137    BNET_CMD_OK         = -15,         /* Command succeeded */
 138    BNET_CMD_BEGIN      = -16,         /* Start command execution */
 139    BNET_MSGS_PENDING   = -17,         /* Messages pending */
 140    BNET_MAIN_PROMPT    = -18,         /* Server ready and waiting */
 141    BNET_SELECT_INPUT   = -19,         /* Return selection input */
 142    BNET_WARNING_MSG    = -20,         /* Warning message */
 143    BNET_ERROR_MSG      = -21,         /* Error message -- command failed */
 144    BNET_INFO_MSG       = -22,         /* Info message -- status line */
 145    BNET_RUN_CMD        = -23          /* Run command follows */
 146 };
 147
 148 #define BNET_SETBUF_READ  1           /* Arg for bnet_set_buffer_size */
 149 #define BNET_SETBUF_WRITE 2           /* Arg for bnet_set_buffer_size */
 150
 151 /*
 152  * Return status from bnet_recv()
 153  * Note, the HARDEOF and ERROR refer to comm status/problems
 154  *  rather than the BNET_xxx above, which are software signals.
 155  */
 156 enum {
 157    BNET_SIGNAL         = -1,
 158    BNET_HARDEOF        = -2,
 159    BNET_ERROR          = -3
 160 };
 161
 162 /*
 163  * TLS enabling values. Value is important for comparison, ie:
 164  * if (tls_remote_need < BNET_TLS_REQUIRED) { ... }
 165  */
 166 enum {
 167    BNET_TLS_NONE        = 0,          /* cannot do TLS */
 168    BNET_TLS_OK          = 1,          /* can do, but not required on my end */
 169    BNET_TLS_REQUIRED    = 2           /* TLS is required */
 170 };
 171
 172 int32_t read_nbytes(BSOCK * bsock, char *ptr, int32_t nbytes);
 173 int32_t write_nbytes(BSOCK * bsock, char *ptr, int32_t nbytes);