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 <errno.h>
  13
  14 #include "lib/resource.h"
  15
  16 typedef struct birdsock {
  17   resource r;
  18   pool *pool;                           /* Pool where incoming connections should be allocated (for SK_xxx_PASSIVE) */
  19   int type;                             /* Socket type */
  20   void *data;                           /* User data */
  21   ip_addr saddr, daddr;                 /* IPA_NONE = unspecified */
  22   unsigned sport, dport;                /* 0 = unspecified (for IP: protocol type) */
  23   int tos;                              /* TOS and priority, -1 = default */
  24   int ttl;                              /* Time To Live, -1 = default */
  25   u32 flags;
  26   struct iface *iface;                  /* Interface; specify this for broad/multicast sockets */
  27
  28   byte *rbuf, *rpos;                    /* NULL=allocate automatically */
  29   unsigned rbsize;
  30   int (*rx_hook)(struct birdsock *, int size); /* NULL=receiving turned off, returns 1 to clear rx buffer */
  31
  32   byte *tbuf, *tpos;                    /* NULL=allocate automatically */
  33   byte *ttx;                            /* Internal */
  34   unsigned tbsize;
  35   void (*tx_hook)(struct birdsock *);
  36
  37   void (*err_hook)(struct birdsock *, int); /* errno or zero if EOF */
  38
  39   /* Information about received datagrams (UDP, RAW), valid in rx_hook */
  40   ip_addr faddr, laddr;                 /* src (From) and dst (Local) address of the datagram */
  41   unsigned fport;                       /* src port of the datagram */
  42   unsigned lifindex;                    /* local interface that received the datagram */
  43   /* laddr and lifindex are valid only if SKF_LADDR_RX flag is set to request it */
  44
  45   int fd;                               /* System-dependent data */
  46   node n;
  47   void *rbuf_alloc, *tbuf_alloc;
  48   char *password;                               /* Password for MD5 authentication */
  49 } sock;
  50
  51 sock *sk_new(pool *);                   /* Allocate new socket */
  52 int sk_open(sock *);                    /* Open socket */
  53 int sk_send(sock *, unsigned len);      /* Send data, <0=err, >0=ok, 0=sleep */
  54 int sk_send_to(sock *, unsigned len, ip_addr to, unsigned port); /* sk_send to given destination */
  55 void sk_reallocate(sock *);             /* Free and allocate tbuf & rbuf */
  56 void sk_dump_all(void);
  57 int sk_set_ttl(sock *s, int ttl);       /* Set transmit TTL for given socket */
  58 int sk_set_min_ttl(sock *s, int ttl);   /* Set minimal accepted TTL for given socket */
  59
  60 /* Add or remove security associations for given passive socket */
  61 int sk_set_md5_auth(sock *s, ip_addr a, struct iface *ifa, char *passwd);
  62 int sk_rx_ready(sock *s);
  63
  64 /* Prepare UDP or IP socket to multicasting. s->iface and s->ttl must be set */
  65 int sk_setup_multicast(sock *s);
  66 int sk_join_group(sock *s, ip_addr maddr);
  67 int sk_leave_group(sock *s, ip_addr maddr);
  68
  69 #ifdef IPV6
  70 int sk_set_ipv6_checksum(sock *s, int offset);
  71 int sk_set_icmp_filter(sock *s, int p1, int p2);
  72 #endif
  73
  74 int sk_set_broadcast(sock *s, int enable);
  75
  76 static inline int
  77 sk_send_buffer_empty(sock *sk)
  78 {
  79         return sk->tbuf == sk->tpos;
  80 }
  81
  82
  83 /* Socket flags */
  84
  85 #define SKF_V6ONLY      1       /* Use IPV6_V6ONLY socket option */
  86 #define SKF_LADDR_RX    2       /* Report local address for RX packets */
  87 #define SKF_LADDR_TX    4       /* Allow to specify local address for TX packets */
  88
  89
  90 /*
  91  *      Socket types                 SA SP DA DP IF  TTL SendTo (?=may, -=must not, *=must)
  92  */
  93
  94 #define SK_TCP_PASSIVE  0          /* ?  *  -  -  -  ?   -      */
  95 #define SK_TCP_ACTIVE   1          /* ?  ?  *  *  -  ?   -      */
  96 #define SK_TCP          2
  97 #define SK_UDP          3          /* ?  ?  ?  ?  ?  ?   ?      */
  98 #define SK_IP           5          /* ?  -  ?  *  ?  ?   ?      */
  99 #define SK_MAGIC        7          /* Internal use by sysdep code */
 100 #define SK_UNIX_PASSIVE 8
 101 #define SK_UNIX         9
 102
 103 /*
 104  *  For SK_UDP or SK_IP sockets setting DA/DP allows to use sk_send(),
 105  *  otherwise sk_send_to() must be used.
 106  *
 107  *  For SK_IP sockets setting DP specifies protocol number, which is used
 108  *  for both receiving and sending.
 109  *
 110  *  For multicast on SK_UDP or SK_IP sockets set IF and TTL,
 111  *  call sk_setup_multicast() to enable multicast on that socket,
 112  *  and then use sk_join_group() and sk_leave_group() to manage
 113  *  a set of received multicast groups.
 114  */
 115
 116 #endif