lib/socket.h

   1 /*
   2  *      BIRD Socket Interface
   3  *
   4  *      (c) 1998--2004 Martin Mares <mj@ucw.cz>
   5  *
   6  *      Can be freely distributed and used under the terms of the GNU GPL.
   7  */
   8
   9 #ifndef _BIRD_SOCKET_H_
  10 #define _BIRD_SOCKET_H_
  11
  12 #include "lib/resource.h"
  13
  14 typedef struct birdsock {
  15   resource r;
  16   pool *pool;                           /* Pool where incoming connections should be allocated (for SK_xxx_PASSIVE) */
  17   int type;                             /* Socket type */
  18   void *data;                           /* User data */
  19   ip_addr saddr, daddr;                 /* IPA_NONE = unspecified */
  20   unsigned sport, dport;                /* 0 = unspecified (for IP: protocol type) */
  21   int tos;                              /* TOS and priority, -1 = default */
  22   int ttl;                              /* Time To Live, -1 = default */
  23   u32 flags;
  24   struct iface *iface;                  /* Interface; specify this for broad/multicast sockets */
  25
  26   byte *rbuf, *rpos;                    /* NULL=allocate automatically */
  27   unsigned rbsize;
  28   int (*rx_hook)(struct birdsock *, int size); /* NULL=receiving turned off, returns 1 to clear rx buffer */
  29
  30   byte *tbuf, *tpos;                    /* NULL=allocate automatically */
  31   byte *ttx;                            /* Internal */
  32   unsigned tbsize;
  33   void (*tx_hook)(struct birdsock *);
  34
  35   void (*err_hook)(struct birdsock *, int); /* errno or zero if EOF */
  36
  37   ip_addr faddr;                        /* For packet protocols: source of current packet */
  38   unsigned fport;
  39
  40   int fd;                               /* System-dependent data */
  41   node n;
  42   void *rbuf_alloc, *tbuf_alloc;
  43   char *password;                               /* Password for MD5 authentication */
  44 } sock;
  45
  46 sock *sk_new(pool *);                   /* Allocate new socket */
  47 int sk_open(sock *);                    /* Open socket */
  48 int sk_send(sock *, unsigned len);      /* Send data, <0=err, >0=ok, 0=sleep */
  49 int sk_send_to(sock *, unsigned len, ip_addr to, unsigned port); /* sk_send to given destination */
  50 void sk_reallocate(sock *);             /* Free and allocate tbuf & rbuf */
  51 void sk_dump_all(void);
  52 int sk_set_ttl(sock *s, int ttl);       /* Set TTL for given socket */
  53
  54 /* Add or remove security associations for given passive socket */
  55 int sk_set_md5_auth(sock *s, ip_addr a, char *passwd);
  56 int sk_rx_ready(sock *s);
  57
  58 /* Prepare UDP or IP socket to multicasting. s->iface and s->ttl must be set */
  59 int sk_setup_multicast(sock *s);
  60 int sk_join_group(sock *s, ip_addr maddr);
  61 int sk_leave_group(sock *s, ip_addr maddr);
  62
  63 #ifdef IPV6
  64 int sk_set_ipv6_checksum(sock *s, int offset);
  65 #endif
  66
  67 static inline int
  68 sk_send_buffer_empty(sock *sk)
  69 {
  70         return sk->tbuf == sk->tpos;
  71 }
  72
  73
  74 /* Socket flags */
  75
  76 #define SKF_V6ONLY      1       /* Use  IPV6_V6ONLY socket option */
  77
  78
  79 /*
  80  *      Socket types                 SA SP DA DP IF  TTL SendTo (?=may, -=must not, *=must)
  81  */
  82
  83 #define SK_TCP_PASSIVE  0          /* ?  *  -  -  -  ?   -      */
  84 #define SK_TCP_ACTIVE   1          /* ?  ?  *  *  -  ?   -      */
  85 #define SK_TCP          2
  86 #define SK_UDP          3          /* ?  ?  ?  ?  ?  ?   ?      */
  87 #define SK_IP           5          /* ?  -  ?  *  ?  ?   ?      */
  88 #define SK_MAGIC        7          /* Internal use by sysdep code */
  89 #define SK_UNIX_PASSIVE 8
  90 #define SK_UNIX         9
  91
  92 /*
  93  *  For SK_UDP or SK_IP sockets setting DA/DP allows to use sk_send(),
  94  *  otherwise sk_send_to() must be used.
  95  *
  96  *  For SK_IP sockets setting DP specifies protocol number, which is used
  97  *  for both receiving and sending.
  98  *
  99  *  For multicast on SK_UDP or SK_IP sockets set IF and TTL,
 100  *  call sk_setup_multicast() to enable multicast on that socket,
 101  *  and then use sk_join_group() and sk_leave_group() to manage
 102  *  a set of received multicast groups.
 103  */
 104
 105 #endif