dist/ntp/include/recvbuff.h

   1 /*      $NetBSD: recvbuff.h,v 1.4 2007/06/24 16:55:12 kardel Exp $      */
   2
   3 #if !defined __recvbuff_h
   4 #define __recvbuff_h
   5
   6 #ifdef HAVE_CONFIG_H
   7 # include <config.h>
   8 #endif
   9
  10 #include "ntp.h"
  11 #include "ntp_fp.h"
  12 #include "ntp_types.h"
  13
  14 #include <isc/list.h>
  15 #include <isc/result.h>
  16
  17 /*
  18  * recvbuf memory management
  19  */
  20 #define RECV_INIT       10      /* 10 buffers initially */
  21 #define RECV_LOWAT      3       /* when we're down to three buffers get more */
  22 #define RECV_INC        5       /* get 5 more at a time */
  23 #define RECV_TOOMANY    40      /* this is way too many buffers */
  24
  25 #if defined HAVE_IO_COMPLETION_PORT
  26 # include "ntp_iocompletionport.h"
  27 #include "ntp_timer.h"
  28
  29 # define RECV_BLOCK_IO()        EnterCriticalSection(&RecvCritSection)
  30 # define RECV_UNBLOCK_IO()      LeaveCriticalSection(&RecvCritSection)
  31
  32 /*  Return the event which is set when items are added to the full list
  33  */
  34 extern HANDLE   get_recv_buff_event P((void));
  35 #else
  36 # define RECV_BLOCK_IO()
  37 # define RECV_UNBLOCK_IO()
  38 #endif
  39
  40
  41 /*
  42  * Format of a recvbuf.  These are used by the asynchronous receive
  43  * routine to store incoming packets and related information.
  44  */
  45
  46 /*
  47  *  the maximum length NTP packet contains the NTP header, one Autokey
  48  *  request, one Autokey response and the MAC. Assuming certificates don't
  49  *  get too big, the maximum packet length is set arbitrarily at 1000.
  50  */
  51 #define RX_BUFF_SIZE    1000            /* hail Mary */
  52
  53
  54 typedef struct recvbuf recvbuf_t;
  55
  56 struct recvbuf {
  57         ISC_LINK(recvbuf_t)     link;
  58         union {
  59                 struct sockaddr_storage X_recv_srcadr;
  60                 caddr_t X_recv_srcclock;
  61                 struct peer *X_recv_peer;
  62         } X_from_where;
  63 #define recv_srcadr     X_from_where.X_recv_srcadr
  64 #define recv_srcclock   X_from_where.X_recv_srcclock
  65 #define recv_peer       X_from_where.X_recv_peer
  66 #if defined HAVE_IO_COMPLETION_PORT
  67         WSABUF          wsabuff;
  68 #else
  69         struct sockaddr_storage srcadr; /* where packet came from */
  70 #endif
  71         int src_addr_len;               /* source address length */
  72         struct interface *dstadr;       /* interface datagram arrived thru */
  73         SOCKET  fd;                     /* fd on which it was received */
  74         int msg_flags;                  /* Flags received about the packet */
  75         l_fp recv_time;                 /* time of arrival */
  76         void (*receiver) P((struct recvbuf *)); /* routine to receive buffer */
  77         int recv_length;                /* number of octets received */
  78         union {
  79                 struct pkt X_recv_pkt;
  80                 u_char X_recv_buffer[RX_BUFF_SIZE];
  81         } recv_space;
  82         int used;
  83 #define recv_pkt        recv_space.X_recv_pkt
  84 #define recv_buffer     recv_space.X_recv_buffer
  85 };
  86
  87 extern  void    init_recvbuff   P((int));
  88
  89 /* freerecvbuf - make a single recvbuf available for reuse
  90  */
  91 extern  void    freerecvbuf P((struct recvbuf *));
  92
  93 /*  Get a free buffer (typically used so an async
  94  *  read can directly place data into the buffer
  95  *
  96  *  The buffer is removed from the free list. Make sure
  97  *  you put it back with freerecvbuf() or
  98  */
  99 extern  struct recvbuf *get_free_recv_buffer P((void)); /* signal safe - no malloc */
 100 extern  struct recvbuf *get_free_recv_buffer_alloc P((void)); /* signal unsafe - may malloc */
 101
 102 /*   Add a buffer to the full list
 103  */
 104 extern  void    add_full_recv_buffer     P((struct recvbuf *));
 105
 106 /*extern        void    process_recv_buffers     P((void)); */
 107
 108 /* number of recvbufs on freelist */
 109 extern u_long free_recvbuffs P((void));
 110 extern u_long full_recvbuffs P((void));
 111 extern u_long total_recvbuffs P((void));
 112 extern u_long lowater_additions P((void));
 113
 114 /*  Returns the next buffer in the full list.
 115  *
 116  */
 117 extern  struct recvbuf *get_full_recv_buffer P((void));
 118
 119 /*
 120  * Checks to see if there are buffers to process
 121  */
 122 extern isc_boolean_t has_full_recv_buffer P((void));
 123
 124 #endif /* defined __recvbuff_h */
 125