varnish-cache/bin/varnishtest/vtc_server.c
0
/*-
1
 * Copyright (c) 2008-2010 Varnish Software AS
2
 * All rights reserved.
3
 *
4
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
5
 *
6
 * SPDX-License-Identifier: BSD-2-Clause
7
 *
8
 * Redistribution and use in source and binary forms, with or without
9
 * modification, are permitted provided that the following conditions
10
 * are met:
11
 * 1. Redistributions of source code must retain the above copyright
12
 *    notice, this list of conditions and the following disclaimer.
13
 * 2. Redistributions in binary form must reproduce the above copyright
14
 *    notice, this list of conditions and the following disclaimer in the
15
 *    documentation and/or other materials provided with the distribution.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27
 * SUCH DAMAGE.
28
 */
29
30
#include "config.h"
31
32
#include <sys/socket.h>
33
#include <sys/types.h>
34
#include <sys/stat.h>
35
36
#include <stdio.h>
37
#include <stdlib.h>
38
#include <string.h>
39
#include <unistd.h>
40
41
#include "vsa.h"
42
#include "vtc.h"
43
44
#include "vtcp.h"
45
#include "vus.h"
46
47
struct server {
48
        unsigned                magic;
49
#define SERVER_MAGIC            0x55286619
50
        char                    *name;
51
        struct vtclog           *vl;
52
        VTAILQ_ENTRY(server)    list;
53
        struct vtc_sess         *vsp;
54
        char                    run;
55
56
        char                    *spec;
57
58
        int                     depth;
59
        int                     sock;
60
        int                     fd;
61
        unsigned                is_dispatch;
62
        char                    listen[256];
63
        char                    aaddr[VTCP_ADDRBUFSIZE];
64
        char                    aport[VTCP_PORTBUFSIZE];
65
66
        pthread_t               tp;
67
};
68
69
static pthread_mutex_t          server_mtx;
70
71
static VTAILQ_HEAD(, server)    servers =
72
    VTAILQ_HEAD_INITIALIZER(servers);
73
74
/**********************************************************************
75
 * Allocate and initialize a server
76
 */
77
78
static struct server *
79 2102
server_new(const char *name, struct vtclog *vl)
80
{
81
        struct server *s;
82
83 2102
        VTC_CHECK_NAME(vl, name, "Server", 's');
84 2102
        ALLOC_OBJ(s, SERVER_MAGIC);
85 2102
        AN(s);
86 2102
        REPLACE(s->name, name);
87 2102
        s->vl = vtc_logopen("%s", s->name);
88 2102
        AN(s->vl);
89 2102
        s->vsp = Sess_New(s->vl, name);
90 2102
        AN(s->vsp);
91
92 2102
        bprintf(s->listen, "%s", default_listen_addr);
93 2102
        s->depth = 10;
94 2102
        s->sock = -1;
95 2102
        s->fd = -1;
96 2102
        PTOK(pthread_mutex_lock(&server_mtx));
97 2102
        VTAILQ_INSERT_TAIL(&servers, s, list);
98 2102
        PTOK(pthread_mutex_unlock(&server_mtx));
99 2102
        return (s);
100
}
101
102
/**********************************************************************
103
 * Clean up a server
104
 */
105
106
static void
107 2102
server_delete(struct server *s)
108
{
109
110 2102
        CHECK_OBJ_NOTNULL(s, SERVER_MAGIC);
111 2102
        Sess_Destroy(&s->vsp);
112 2102
        macro_undef(s->vl, s->name, "addr");
113 2102
        macro_undef(s->vl, s->name, "port");
114 2102
        macro_undef(s->vl, s->name, "sock");
115 2102
        vtc_logclose(s->vl);
116 2102
        free(s->name);
117
        /* XXX: MEMLEAK (?) (VSS ??) */
118 2102
        FREE_OBJ(s);
119 2102
}
120
121
/**********************************************************************
122
 * Server listen
123
 */
124
125
struct helper {
126
        int             depth;
127
        const char      **errp;
128
};
129
130
/* cf. VTCP_listen_on() */
131
static int v_matchproto_(vus_resolved_f)
132 118
uds_listen(void *priv, const struct sockaddr_un *uds)
133
{
134
        int sock, e;
135 118
        struct helper *hp = priv;
136
137 118
        sock = VUS_bind(uds, hp->errp);
138 118
        if (sock >= 0)   {
139 118
                if (listen(sock, hp->depth) != 0) {
140 0
                        e = errno;
141 0
                        closefd(&sock);
142 0
                        errno = e;
143 0
                        if (hp->errp != NULL)
144 0
                                *hp->errp = "listen(2)";
145 0
                        return (-1);
146
                }
147 118
        }
148 118
        if (sock > 0) {
149 118
                *hp->errp = NULL;
150 118
                return (sock);
151
        }
152 0
        AN(*hp->errp);
153 0
        return (0);
154 118
}
155
156
static void
157 118
server_listen_uds(struct server *s, const char **errp)
158
{
159
        mode_t m;
160
        struct helper h;
161
162 118
        h.depth = s->depth;
163 118
        h.errp = errp;
164
165 118
        errno = 0;
166 118
        if (unlink(s->listen) != 0 && errno != ENOENT)
167 0
                vtc_fatal(s->vl, "Could not unlink %s before bind: %s",
168 0
                    s->listen, strerror(errno));
169
        /*
170
         * Temporarily set the umask to 0 to avoid issues with
171
         * permissions.
172
         */
173 118
        m = umask(0);
174 118
        s->sock = VUS_resolver(s->listen, uds_listen, &h, errp);
175 118
        (void)umask(m);
176 118
        if (*errp != NULL)
177 0
                return;
178 118
        assert(s->sock > 0);
179 118
        macro_def(s->vl, s->name, "addr", "0.0.0.0");
180 118
        macro_def(s->vl, s->name, "port", "0");
181 118
        macro_def(s->vl, s->name, "sock", "%s", s->listen);
182 118
}
183
184
static void
185 2042
server_listen_tcp(struct server *s, const char **errp)
186
{
187 2042
        char buf[vsa_suckaddr_len];
188
        const struct suckaddr *sua;
189
190 2042
        s->sock = VTCP_listen_on(s->listen, "0", s->depth, errp);
191 2042
        if (*errp != NULL)
192 0
                return;
193 2042
        assert(s->sock > 0);
194 2042
        sua = VSA_getsockname(s->sock, buf, sizeof buf);
195 2042
        AN(sua);
196 4084
        VTCP_name(sua, s->aaddr, sizeof s->aaddr,
197 2042
            s->aport, sizeof s->aport);
198
199
        /* Record the actual port, and reuse it on subsequent starts */
200 2042
        if (VSA_Get_Proto(sua) == AF_INET)
201 2034
                bprintf(s->listen, "%s:%s", s->aaddr, s->aport);
202
        else
203 8
                bprintf(s->listen, "[%s]:%s", s->aaddr, s->aport);
204
205 2042
        macro_def(s->vl, s->name, "addr", "%s", s->aaddr);
206 2042
        macro_def(s->vl, s->name, "port", "%s", s->aport);
207 2042
        macro_def(s->vl, s->name, "sock", "%s", s->listen);
208 2042
}
209
210
static void
211 2160
server_listen(struct server *s)
212
{
213
        const char *err;
214
215 2160
        CHECK_OBJ_NOTNULL(s, SERVER_MAGIC);
216
217 2160
        if (s->sock >= 0)
218 182
                VTCP_close(&s->sock);
219 2160
        if (VUS_is(s->listen))
220 118
                server_listen_uds(s, &err);
221
        else
222 2042
                server_listen_tcp(s, &err);
223 2160
        if (err != NULL)
224 0
                vtc_fatal(s->vl,
225
                    "Server listen address (%s) cannot be resolved: %s",
226 0
                    s->listen, err);
227 2160
}
228
229
/**********************************************************************
230
 * Server thread
231
 */
232
233
static int
234 2701
server_conn(void *priv, struct vtclog *vl)
235
{
236
        struct server *s;
237
        struct sockaddr_storage addr_s;
238
        struct sockaddr *addr;
239
        char abuf[VTCP_ADDRBUFSIZE];
240
        char pbuf[VTCP_PORTBUFSIZE];
241
        socklen_t l;
242
        int fd;
243
244 2701
        CAST_OBJ_NOTNULL(s, priv, SERVER_MAGIC);
245
246 2701
        addr = (void*)&addr_s;
247 2701
        l = sizeof addr_s;
248 2701
        fd = accept(s->sock, addr, &l);
249 2701
        if (fd < 0)
250 0
                vtc_fatal(vl, "Accept failed: %s", strerror(errno));
251 2701
        if (VUS_is(s->listen))
252 118
                vtc_log(vl, 3, "accepted fd %d 0.0.0.0 0", fd);
253
        else {
254 2583
                VTCP_hisname(fd, abuf, sizeof abuf, pbuf, sizeof pbuf);
255 2583
                vtc_log(vl, 3, "accepted fd %d %s %s", fd, abuf, pbuf);
256
        }
257 2701
        return (fd);
258
}
259
260
static void
261 2649
server_disc(void *priv, struct vtclog *vl, int *fdp)
262
{
263
        int j;
264
        struct server *s;
265
266 2649
        CAST_OBJ_NOTNULL(s, priv, SERVER_MAGIC);
267 2649
        vtc_log(vl, 3, "shutting fd %d", *fdp);
268 2649
        j = shutdown(*fdp, SHUT_WR);
269 2649
        if (!vtc_stop && !VTCP_Check(j))
270 0
                vtc_fatal(vl, "Shutdown failed: %s", strerror(errno));
271 2649
        VTCP_close(fdp);
272 2649
}
273
274
static void
275 2134
server_start_thread(struct server *s)
276
{
277
278 2134
        s->run = 1;
279 2134
        s->tp = Sess_Start_Thread(
280 2134
            s,
281 2134
            s->vsp,
282
            server_conn,
283
            server_disc,
284 2134
            s->listen,
285 2134
            &s->sock,
286 2134
            s->spec
287
        );
288 2134
}
289
290
/**********************************************************************
291
 * Start the server thread
292
 */
293
294
static void
295 2134
server_start(struct server *s)
296
{
297 2134
        CHECK_OBJ_NOTNULL(s, SERVER_MAGIC);
298 2134
        vtc_log(s->vl, 2, "Starting server");
299 2134
        server_listen(s);
300 2134
        vtc_log(s->vl, 1, "Listen on %s", s->listen);
301 2134
        server_start_thread(s);
302 2134
}
303
304
/**********************************************************************
305
 */
306
307
static void *
308 130
server_dispatch_wrk(void *priv)
309
{
310
        struct server *s;
311
        struct vtclog *vl;
312
        int j, fd;
313
314 130
        CAST_OBJ_NOTNULL(s, priv, SERVER_MAGIC);
315 130
        assert(s->sock < 0);
316
317 130
        vl = vtc_logopen("%s", s->name);
318 130
        pthread_cleanup_push(vtc_logclose, vl);
319
320 130
        fd = s->fd;
321
322 130
        vtc_log(vl, 3, "start with fd %d", fd);
323 130
        fd = sess_process(vl, s->vsp, s->spec, fd, &s->sock, s->listen);
324 130
        vtc_log(vl, 3, "shutting fd %d", fd);
325 130
        j = shutdown(fd, SHUT_WR);
326 130
        if (!VTCP_Check(j))
327 0
                vtc_fatal(vl, "Shutdown failed: %s", strerror(errno));
328 130
        VTCP_close(&s->fd);
329 130
        vtc_log(vl, 2, "Ending");
330 130
        pthread_cleanup_pop(0);
331 130
        vtc_logclose(vl);
332 130
        return (NULL);
333
}
334
335
static void *
336 26
server_dispatch_thread(void *priv)
337
{
338
        struct server *s, *s2;
339
        static int sn = 1;
340
        int fd;
341
        char snbuf[8];
342
        struct vtclog *vl;
343
        struct sockaddr_storage addr_s;
344
        struct sockaddr *addr;
345
        socklen_t l;
346
347 26
        CAST_OBJ_NOTNULL(s, priv, SERVER_MAGIC);
348 26
        assert(s->sock >= 0);
349
350 26
        vl = vtc_logopen("%s", s->name);
351 26
        pthread_cleanup_push(vtc_logclose, vl);
352
353 26
        vtc_log(vl, 2, "Dispatch started on %s", s->listen);
354
355 156
        while (!vtc_stop) {
356 130
                addr = (void*)&addr_s;
357 130
                l = sizeof addr_s;
358 130
                fd = accept(s->sock, addr, &l);
359 130
                if (fd < 0)
360 0
                        vtc_fatal(vl, "Accepted failed: %s", strerror(errno));
361 130
                bprintf(snbuf, "s%d", sn++);
362 130
                vtc_log(vl, 3, "dispatch fd %d -> %s", fd, snbuf);
363 130
                s2 = server_new(snbuf, vl);
364 130
                s2->is_dispatch = 1;
365 130
                s2->spec = s->spec;
366 130
                bstrcpy(s2->listen, s->listen);
367 130
                s2->fd = fd;
368 130
                s2->run = 1;
369 130
                PTOK(pthread_create(&s2->tp, NULL, server_dispatch_wrk, s2));
370
        }
371 26
        pthread_cleanup_pop(0);
372 26
        vtc_logclose(vl);
373 26
        NEEDLESS(return (NULL));
374
}
375
376
static void
377 26
server_dispatch(struct server *s)
378
{
379 26
        CHECK_OBJ_NOTNULL(s, SERVER_MAGIC);
380 26
        server_listen(s);
381 26
        vtc_log(s->vl, 2, "Starting dispatch server");
382 26
        s->run = 1;
383 26
        PTOK(pthread_create(&s->tp, NULL, server_dispatch_thread, s));
384 26
}
385
386
/**********************************************************************
387
 * Force stop the server thread
388
 */
389
390
static void
391 6
server_break(struct server *s)
392
{
393
        void *res;
394
395 6
        CHECK_OBJ_NOTNULL(s, SERVER_MAGIC);
396 6
        vtc_log(s->vl, 2, "Breaking for server");
397 6
        (void)pthread_cancel(s->tp);
398 6
        PTOK(pthread_join(s->tp, &res));
399 6
        VTCP_close(&s->sock);
400 6
        s->tp = 0;
401 6
        s->run = 0;
402 6
}
403
404
/**********************************************************************
405
 * Wait for server thread to stop
406
 */
407
408
static void
409 2284
server_wait(struct server *s)
410
{
411
        void *res;
412
413 2284
        CHECK_OBJ_NOTNULL(s, SERVER_MAGIC);
414 2284
        vtc_log(s->vl, 2, "Waiting for server (%d/%d)", s->sock, s->fd);
415 2284
        PTOK(pthread_join(s->tp, &res));
416 2284
        if (res != NULL && !vtc_stop)
417 0
                vtc_fatal(s->vl, "Server returned \"%p\"",
418 0
                    (char *)res);
419 2284
        s->tp = 0;
420 2284
        s->run = 0;
421 2284
}
422
423
/**********************************************************************
424
 * Generate VCL backend decls for our servers
425
 */
426
427
void
428 1732
cmd_server_gen_vcl(struct vsb *vsb)
429
{
430
        struct server *s;
431
432 1732
        PTOK(pthread_mutex_lock(&server_mtx));
433 3700
        VTAILQ_FOREACH(s, &servers, list) {
434 1968
                if (s->is_dispatch)
435 32
                        continue;
436
437 1936
                if (VUS_is(s->listen))
438 68
                        VSB_printf(vsb,
439
                           "backend %s { .path = \"%s\"; }\n",
440 34
                           s->name, s->listen);
441
                else
442 3804
                        VSB_printf(vsb,
443
                           "backend %s { .host = \"%s\"; .port = \"%s\"; }\n",
444 1902
                           s->name, s->aaddr, s->aport);
445 1936
        }
446 1732
        PTOK(pthread_mutex_unlock(&server_mtx));
447 1732
}
448
449
450
/**********************************************************************
451
 * Generate VCL backend decls for our servers
452
 */
453
454
void
455 2
cmd_server_gen_haproxy_conf(struct vsb *vsb)
456
{
457
        struct server *s;
458
459 2
        PTOK(pthread_mutex_lock(&server_mtx));
460 4
        VTAILQ_FOREACH(s, &servers, list) {
461 2
                if (! VUS_is(s->listen))
462 4
                        VSB_printf(vsb,
463
                           "\n    backend be%s\n"
464
                           "\tserver srv%s %s:%s\n",
465 2
                           s->name + 1, s->name + 1, s->aaddr, s->aport);
466
                else
467 0
                        INCOMPL();
468 2
        }
469 4
        VTAILQ_FOREACH(s, &servers, list) {
470 2
                if (! VUS_is(s->listen))
471 4
                        VSB_printf(vsb,
472
                           "\n    frontend http%s\n"
473
                           "\tuse_backend be%s\n"
474
                           "\tbind \"fd@${fe%s}\"\n",
475 2
                           s->name + 1, s->name + 1, s->name + 1);
476
                else
477 0
                        INCOMPL();
478 2
        }
479 2
        PTOK(pthread_mutex_unlock(&server_mtx));
480 2
}
481
482
483
/**********************************************************************
484
 * Server command dispatch
485
 */
486
487
void
488 4448
cmd_server(CMD_ARGS)
489
{
490
        struct server *s;
491
492 4448
        (void)priv;
493
494 4448
        if (av == NULL) {
495
                /* Reset and free */
496 4116
                while (1) {
497 4116
                        PTOK(pthread_mutex_lock(&server_mtx));
498 4116
                        s = VTAILQ_FIRST(&servers);
499 4116
                        CHECK_OBJ_ORNULL(s, SERVER_MAGIC);
500 4116
                        if (s != NULL)
501 2102
                                VTAILQ_REMOVE(&servers, s, list);
502 4116
                        PTOK(pthread_mutex_unlock(&server_mtx));
503 4116
                        if (s == NULL)
504 2014
                                break;
505 2102
                        if (s->run) {
506 1938
                                (void)pthread_cancel(s->tp);
507 1938
                                server_wait(s);
508 1938
                        }
509 2102
                        if (s->sock >= 0)
510 1972
                                VTCP_close(&s->sock);
511 2102
                        server_delete(s);
512
                }
513 2014
                return;
514
        }
515
516 2434
        AZ(strcmp(av[0], "server"));
517 2434
        av++;
518
519 2434
        PTOK(pthread_mutex_lock(&server_mtx));
520 3050
        VTAILQ_FOREACH(s, &servers, list)
521 1078
                if (!strcmp(s->name, av[0]))
522 462
                        break;
523 2434
        PTOK(pthread_mutex_unlock(&server_mtx));
524 2434
        if (s == NULL)
525 1972
                s = server_new(av[0], vl);
526 2434
        CHECK_OBJ_NOTNULL(s, SERVER_MAGIC);
527 2434
        av++;
528
529 7206
        for (; *av != NULL; av++) {
530 4772
                if (vtc_error)
531 0
                        break;
532 4772
                if (!strcmp(*av, "-wait")) {
533 212
                        if (!s->run)
534 0
                                vtc_fatal(s->vl, "Server not -started");
535 212
                        server_wait(s);
536 212
                        continue;
537
                }
538
539 4560
                if (!strcmp(*av, "-break")) {
540 6
                        server_break(s);
541 6
                        continue;
542
                }
543
544
                /*
545
                 * We do an implicit -wait if people muck about with a
546
                 * running server.
547
                 */
548 4554
                if (s->run)
549 134
                        server_wait(s);
550
551 4554
                AZ(s->run);
552
553 4554
                if (Sess_GetOpt(s->vsp, &av))
554 160
                        continue;
555
556 4394
                if (!strcmp(*av, "-listen")) {
557 118
                        if (s->sock >= 0)
558 0
                                VTCP_close(&s->sock);
559 118
                        bprintf(s->listen, "%s", av[1]);
560 118
                        av++;
561 118
                        continue;
562
                }
563 4276
                if (!strcmp(*av, "-start")) {
564 2134
                        server_start(s);
565 2134
                        continue;
566
                }
567 2142
                if (!strcmp(*av, "-dispatch")) {
568 26
                        if (strcmp(s->name, "s0"))
569 0
                                vtc_fatal(s->vl,
570
                                    "server -dispatch only works on s0");
571 26
                        server_dispatch(s);
572 26
                        continue;
573
                }
574 2116
                if (**av == '-')
575 0
                        vtc_fatal(s->vl, "Unknown server argument: %s", *av);
576 2116
                s->spec = *av;
577 2116
        }
578 4448
}
579
580
void
581 2014
init_server(void)
582
{
583 2014
        PTOK(pthread_mutex_init(&server_mtx, NULL));
584 2014
}