summaryrefslogtreecommitdiff
path: root/pflocal/connq.c
blob: 3011f634fcf9e1628e6ec34e0e3d169b41406b82 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/* Listen queue functions

   Copyright (C) 1995 Free Software Foundation, Inc.

   Written by Miles Bader <miles@gnu.ai.mit.edu>

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License as
   published by the Free Software Foundation; either version 2, or (at
   your option) any later version.

   This program is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */

#include <socket.h>

#include "pflocal.h"

/* A queue for queueing incoming connections.  */
struct connq
{
  /* True if all connection requests should be treated as non-blocking.  */
  int noqueue;

  /* The connection request queue.  */
  unsigned length;
  unsigned head, tail;
  struct connq_request *queue;

  /* Threads that have done an accept on this queue wait on this condition.  */
  struct condition listeners;
  unsigned num_listeners;
  struct mutex lock;
}

/* ---------------------------------------------------------------- */

/* A data block allocated by a thread waiting on a connq, which is used to
   get information from and to the thread.  */
struct connq_request
{
  /* The socket that's waiting to connect.  */
  struct sock *sock;

  /* What the waiting thread blocks on.  */
  struct condition signal;
  struct mutex lock;

  /* Set to true when this request has been dealt with, to guard against
     spurious conditions being signaled.  */
  int completed;

  /* After the waiting thread is unblocked, this is the result, either 0 if
     SOCK has been connected, or an error.  */
  error_t err;
};

static inline void
connq_request_init (struct sock *sock, struct connq_request *req)
{
  req->err = 0;
  req->sock = sock;
  req->completed = 0;
  condition_init (&req->signal);
  mutex_init (&req->lock);
}

/* ---------------------------------------------------------------- */

/* Create a new listening queue, returning it in CQ.  The resulting queue
   will be of zero length, that is it won't allow connections unless someone
   is already listening (change this with connq_set_length).  */
error_t
connq_create (struct connq **cq)
{
  struct connq *new = malloc (sizeof (struct connq));

  if (!new)
    return ENOMEM;

  new->noqueue = 1;		/* By default, don't queue requests.  */
  new->length = 0;
  new->head = new->tail = 0;
  new->queue = NULL;
  new->num_listeners = 0;

  mutex_init (&new->lock);
  condition_init (&new->listeners);

  *cq = new;
  return 0;
}

/* ---------------------------------------------------------------- */

/* Wait for a connection attempt to be made on CQ, and return the connecting
   socket in SOCK, and a request tag in REQ.  connq_request_complete must be
   call on REQ to allow the requesting thread to continue.  If NOBLOCK is
   true, then return EWOULDBLOCK immediately when there are no immediate
   connections available.  */
error_t 
connq_listen (struct connq *cq, int noblock,
		struct sock **sock, struct connq_request **req)
{
  error_t err = 0;

  mutex_lock (&cq->lock);

  if (noblock && cq->head == cq->tail)
    return EWOULDBLOCK;

  cq->num_listeners++;

  while (cq->head == cq->tail)
    condition_wait (&cq->listeners, &cq->lock);

  /* Dequeue the next request.  */
  *req = cq->queue[cq->tail];
  cq->tail = (cq->tail + 1 == cq->length ? 0 : cq->tail + 1);

  mutex_lock (&(*req)->lock);

  cq->num_listeners--;

  mutex_unlock (&cq->lock);

  *sock = (*req)->sock;
  return 0;    
}

/* Return the error code ERR to the thread that made the listen request REQ,
   returned from a previous connq_listen.  */
void
connq_request_complete (struct connq_request *req, error_t err)
{
  req->err = err;
  req->complete = 1;
  condition_signal (&req->signal, &req->lock);
}

/* Try to connect SOCK with the socket listening on CQ.  If NOBLOCK is true,
   then return EWOULDBLOCK immediately when there are no immediate
   connections available. */
error_t
connq_connect (struct connq *cq, int noblock, struct sock *sock)
{
  error_t err = 0;
  struct connq_request req;
  unsigned next;

  mutex_lock (&cq->lock);

  if ((noblock || cq->noqueue) && cq->num_listeners == 0)
    return EWOULDBLOCK;

  next = (cq->head + 1 == cq->length ? 0 : cq->head + 1);
  if (next == cq->tail)
    err = ECONNREFUSED;
  else
    {
      cq->queue[cq->head] = &req;
      cq->head = next;
    }
    
  /* Hold REQ.LOCK before we signal the condition so that we're sure to be
     woken up.  */
  mutex_lock (&req.lock);
  condition_signal (&cq->listeners, &cq->lock);

  while (!req.completed)
    condition_wait (&req.signal, &req.lock);

  return req.err;
}

/* Set CQ's queue length to LENGTH.  Any sockets already waiting for a
   connections that are past the new length will fail with ECONNREFUSED.  */
error_t 
connq_set_length (struct connq *cq, int length)
{
  int excess;

  mutex_lock (&cq->lock);

  cq->noqueue = 0;		/* Turn on queueing.  */

  /* Force any excess requests to fail.  */
  excess = cq->length - length;
  while (excess-- > 0)
    {
      assert (cq->head != cq->tail);
      cq->head = (cq->head == 0 ? cq->length - 1 : cq->head - 1);
      connq_request_complete (cq->queue[cq->head], ECONNREFUSED);
    }

  /* ... */
}