• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

nickg / nvc / 9863370937

09 Jul 2024 07:58PM UTC coverage: 91.571% (-0.007%) from 91.578%
9863370937

push

github

nickg
Allow function interface declarations to be pure or impure

Fixes #917

28 of 28 new or added lines in 3 files covered. (100.0%)

39 existing lines in 2 files now uncovered.

56951 of 62193 relevant lines covered (91.57%)

668412.97 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

75.21
/src/server.c
1
//
2
//  Copyright (C) 2023  Nick Gasson
3
//
4
//  This program is free software: you can redistribute it and/or modify
5
//  it under the terms of the GNU General Public License as published by
6
//  the Free Software Foundation, either version 3 of the License, or
7
//  (at your option) any later version.
8
//
9
//  This program is distributed in the hope that it will be useful,
10
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
11
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
//  GNU General Public License for more details.
13
//
14
//  You should have received a copy of the GNU General Public License
15
//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
16
//
17

18
#include "util.h"
19
#include "hash.h"
20
#include "ident.h"
21
#include "jit/jit.h"
22
#include "option.h"
23
#include "phase.h"
24
#include "rt/shell.h"
25
#include "server.h"
26
#include "sha1.h"
27
#include "thread.h"
28

29
#include <assert.h>
30
#include <errno.h>
31
#include <string.h>
32
#include <stdlib.h>
33
#include <sys/types.h>
34
#include <sys/stat.h>
35
#include <sys/fcntl.h>
36
#include <unistd.h>
37
#include <fcntl.h>
38
#include <time.h>
39

40
#ifdef __MINGW32__
41
#define WIN32_LEAN_AND_MEAN
42
#include <winsock2.h>
43
#else
44
#include <sys/select.h>
45
#include <sys/socket.h>
46
#include <netinet/in.h>
47
#endif
48

49
#define WS_UPGRADE_VALUE     "websocket"
50
#define WS_WEBSOCKET_VERSION "13"
51
#define WS_GUID              "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
52
#define WS_GUID_LEN          36
53
#define WS_KEY_LEN           24
54
#define WS_KEY_GUID_LEN      (WS_KEY_LEN + WS_GUID_LEN)
55

56
#define HTTP_SWITCHING_PROTOCOLS   101
57
#define HTTP_OK                    200
58
#define HTTP_BAD_REQUEST           400
59
#define HTTP_NOT_FOUND             404
60
#define HTTP_METHOD_NOT_ALLOWED    405
61
#define HTTP_UPGRADE_REQUIRED      426
62
#define HTTP_INTERNAL_SERVER_ERROR 500
63

64
#define WS_OPCODE_TEXT_FRAME   0x1
65
#define WS_OPCODE_BINARY_FRAME 0x2
66
#define WS_OPCODE_CLOSE_FRAME  0x8
67
#define WS_OPCODE_PING_FRAME   0x9
68
#define WS_OPCODE_PONG_FRAME   0xa
69

70
#define MAX_HTTP_REQUEST 1024
71

72
#ifndef __MINGW32__
73
#define closesocket close
74
#endif
75

76
typedef struct _web_socket {
77
   int           sock;
78
   bool          mask;
79
   bool          closing;
80
   ws_handler_t  handler;
81
   size_t        tx_size;
82
   size_t        tx_wptr;
83
   size_t        tx_rptr;
84
   uint8_t      *tx_buf;
85
   size_t        rx_size;
86
   size_t        rx_wptr;
87
   size_t        rx_rptr;
88
   uint8_t      *rx_buf;
89
} web_socket_t;
90

91
typedef struct _packet_buf {
92
   char  *buf;
93
   size_t alloc;
94
   size_t wptr;
95
   size_t rptr;
96
} packet_buf_t;
97

98
typedef struct {
99
   tcl_shell_t  *shell;
100
   bool          shutdown;
101
   bool          banner;
102
   web_socket_t *websocket;
103
   int           sock;
104
   tree_t        top;
105
   packet_buf_t *packetbuf;
106
   const char   *init_cmd;
107
} web_server_t;
108

109
////////////////////////////////////////////////////////////////////////////////
110
// WebSocket wrapper
111

112
web_socket_t *ws_new(int sock, const ws_handler_t *handler, bool mask)
14✔
113
{
114
   web_socket_t *ws = xcalloc(sizeof(web_socket_t));
14✔
115
   ws->sock    = sock;
14✔
116
   ws->mask    = mask;
14✔
117
   ws->handler = *handler;
14✔
118

119
   return ws;
14✔
120
}
121

122
void ws_free(web_socket_t *ws)
14✔
123
{
124
   free(ws->tx_buf);
14✔
125
   free(ws->rx_buf);
14✔
126
   free(ws);
14✔
127
}
14✔
128

129
static void ws_queue_buf(web_socket_t *ws, const void *data, size_t size)
651✔
130
{
131
   if (ws->tx_wptr + size > ws->tx_size) {
651✔
132
      ws->tx_size = MAX(ws->tx_size + size, 1024);
555✔
133
      ws->tx_buf = xrealloc(ws->tx_buf, ws->tx_size);
555✔
134
   }
135

136
   memcpy(ws->tx_buf + ws->tx_wptr, data, size);
651✔
137
   ws->tx_wptr += size;
651✔
138
}
651✔
139

140
static void ws_send(web_socket_t *ws, int opcode, const void *data, size_t size)
38✔
141
{
142
   const uint8_t size0 = (size < 126 ? size : (size <= UINT16_MAX ? 126 : 127));
38✔
143

144
   const uint8_t header[2] = {
38✔
145
      0x80 | opcode,
38✔
146
      (ws->mask ? 0x80 : 0x00) | (size0 & 0x7f),
38✔
147
   };
148
   ws_queue_buf(ws, header, sizeof(header));
38✔
149

150
   if (size0 == 126) {
38✔
151
      const uint8_t extlength[2] = { PACK_BE16(size) };
2✔
152
      ws_queue_buf(ws, extlength, sizeof(extlength));
2✔
153
   }
154
   else if (size0 == 127) {
36✔
155
      const uint8_t extlength[8] = { PACK_BE64(size) };
2✔
156
      ws_queue_buf(ws, extlength, sizeof(extlength));
2✔
157
   }
158

159
   if (ws->mask) {
38✔
160
      const int key = rand();
16✔
161
      const uint8_t masks[4] = { PACK_BE32(key) };
16✔
162
      ws_queue_buf(ws, masks, sizeof(masks));
16✔
163

164
      char xord[128];
16✔
165
      for (size_t i = 0; i < size; i += sizeof(xord)) {
593✔
166
         const size_t chunksz = MIN(sizeof(xord), size - i);
577✔
167
         for (int j = 0; j < chunksz; j++)
72,674✔
168
            xord[j] = ((const uint8_t *)data)[i + j] ^ masks[(i + j) % 4];
72,097✔
169

170
         ws_queue_buf(ws, xord, chunksz);
577✔
171
      }
172
   }
173
   else if (size > 0)
22✔
174
      ws_queue_buf(ws, data, size);
16✔
175
}
38✔
176

177
void ws_send_binary(web_socket_t *ws, const void *data, size_t size)
13✔
178
{
179
   ws_send(ws, WS_OPCODE_BINARY_FRAME, data, size);
13✔
180
}
13✔
181

182
void ws_send_packet(web_socket_t *ws, packet_buf_t *pb)
8✔
183
{
184
   ws_send_binary(ws, pb->buf, pb->wptr);
8✔
185
}
8✔
186

187
void ws_send_text(web_socket_t *ws, const char *text)
13✔
188
{
189
   ws_send(ws, WS_OPCODE_TEXT_FRAME, text, strlen(text));
13✔
190
}
13✔
191

192
void ws_send_close(web_socket_t *ws)
6✔
193
{
194
   ws_send(ws, WS_OPCODE_CLOSE_FRAME, NULL, 0);
6✔
195
}
6✔
196

197
void ws_send_ping(web_socket_t *ws, const void *data, size_t size)
3✔
198
{
199
   ws_send(ws, WS_OPCODE_PING_FRAME, data, size);
3✔
200
}
3✔
201

202
void ws_flush(web_socket_t *ws)
33✔
203
{
204
   while (ws->tx_wptr != ws->tx_rptr) {
66✔
205
      const size_t chunksz = ws->tx_wptr - ws->tx_rptr;
33✔
206
      const ssize_t nbytes =
33✔
207
         send(ws->sock, (char *)ws->tx_buf + ws->tx_rptr, chunksz, 0);
33✔
208

209
      if (nbytes == 0)
33✔
210
         break;
211
      else if (nbytes < 0) {
33✔
212
         ws->closing = true;
×
213
         break;
×
214
      }
215

216
      ws->tx_rptr += nbytes;
33✔
217
   }
218

219
   if (ws->tx_wptr == ws->tx_rptr)
33✔
220
      ws->tx_rptr = ws->tx_wptr = 0;
33✔
221
}
33✔
222

223
void ws_poll(web_socket_t *ws)
39✔
224
{
225
 read_more:
226
   if (ws->rx_size - ws->rx_wptr < 1024)
175✔
227
      ws->rx_buf = xrealloc(ws->rx_buf, (ws->rx_size += 1024));
150✔
228

229
   const ssize_t nbytes = recv(ws->sock, (char *)ws->rx_buf + ws->rx_wptr,
350✔
230
                               ws->rx_size - ws->rx_wptr - 1, 0);
175✔
231
   if (nbytes == -1 && errno == EAGAIN)
175✔
232
      return;
233
   else if (nbytes <= 0) {
175✔
234
      ws->closing = true;
6✔
235
      return;
6✔
236
   }
237

238
   ws->rx_wptr += nbytes;
169✔
239
   assert(ws->rx_wptr <= ws->rx_size);
169✔
240
   assert(ws->rx_rptr < ws->rx_wptr);
169✔
241

242
   do {
174✔
243
      const size_t rbytes = ws->rx_wptr - ws->rx_rptr;
174✔
244

245
      if (rbytes < 2)
174✔
246
         goto read_more;   // Not enough for WebSocket header
×
247

248
      uint8_t *frame = ws->rx_buf + ws->rx_rptr;
174✔
249

250
      // Frame format
251
      //
252
      //   0    1     2     3     4 5 6 7  8     9 A B C D E F
253
      //   FIN  RSV1  RSV2  RSV3  Opcode   Mask  Payload length
254
      //   Extended payload length (optional)
255
      //   Masking key (optional)
256
      //   Payload data
257

258
      const bool fin = frame[0] & 0x80;
174✔
259
      const int opcode = frame[0] & 0xf;
174✔
260
      const bool mask = frame[1] & 0x80;
174✔
261
      const int size0 = frame[1] & 0x7f;
174✔
262

263
      size_t headersz = 2 + (mask ? 4 : 0);
174✔
264
      if (size0 == 126)
174✔
265
         headersz += 2;
4✔
266
      else if (size0 == 127)
170✔
267
         headersz += 8;
136✔
268

269
      if (rbytes < headersz)
174✔
270
         goto read_more;   // Not enough for extended header
×
271

272
      int flength = size0;
174✔
273
      if (size0 == 127)
174✔
274
         flength = UNPACK_BE64(frame + 2);
136✔
275
      else if (size0 == 126)
38✔
276
         flength = UNPACK_BE16(frame + 2);
4✔
277

278
      if (rbytes < flength + headersz)
174✔
279
         goto read_more;   // Not enough for full frame
136✔
280

281
      assert(fin);
38✔
282
      (void)fin;
38✔
283

284
      if (mask) {
38✔
285
         for (int i = 0; i < flength; i++)
72,113✔
286
            frame[headersz + i] ^= frame[headersz - 4 + (i % 4)];
72,097✔
287
      }
288

289
      void *payload = frame + headersz;
38✔
290

291
      switch (opcode) {
38✔
292
      case WS_OPCODE_TEXT_FRAME:
13✔
293
         {
294
            char *text = payload;
13✔
295
            assert(text + flength < (char *)ws->rx_buf + ws->rx_size);
13✔
296
            text[flength] = '\0';
13✔
297

298
            if (ws->handler.text_frame != NULL)
13✔
299
               (*ws->handler.text_frame)(ws, text, ws->handler.context);
13✔
300
         }
301
         break;
302

303
      case WS_OPCODE_BINARY_FRAME:
13✔
304
         if (ws->handler.binary_frame != NULL)
13✔
305
            (*ws->handler.binary_frame)(ws, payload, flength,
13✔
306
                                        ws->handler.context);
307
         break;
308

309
      case WS_OPCODE_CLOSE_FRAME:
6✔
310
         ws->closing = true;
6✔
311
         break;
6✔
312

313
      case WS_OPCODE_PING_FRAME:
3✔
314
         ws_send(ws, WS_OPCODE_PONG_FRAME, payload, flength);
3✔
315
         break;
3✔
316

317
      case WS_OPCODE_PONG_FRAME:
3✔
318
         if (ws->handler.pong_frame != NULL)
3✔
319
            (*ws->handler.pong_frame)(ws, payload, flength,
3✔
320
                                      ws->handler.context);
321
         break;
322

323
      default:
×
324
         DEBUG_ONLY(fatal_trace("unhandled WebSocket opcode %02x", opcode));
×
325
         break;
38✔
326
      }
327

328
      ws->rx_rptr += flength + headersz;
38✔
329
   } while (ws->rx_rptr < ws->rx_wptr);
38✔
330

331
   ws->rx_rptr = ws->rx_wptr = 0;
33✔
332
}
333

334
bool ws_closing(web_socket_t *ws)
6✔
335
{
336
   return ws->closing;
6✔
337
}
338

339
////////////////////////////////////////////////////////////////////////////////
340
// Packet buffers
341

342
static packet_buf_t *pb_new(void)
5✔
343
{
344
   packet_buf_t *pb = xcalloc(sizeof(packet_buf_t));
5✔
345
   pb->alloc = 128;
5✔
346
   pb->buf = xmalloc(pb->alloc);
5✔
347

348
   return pb;
5✔
349
}
350

351
static void pb_free(packet_buf_t *pb)
5✔
352
{
353
   free(pb->buf);
5✔
354
   free(pb);
5✔
355
}
5✔
356

357
static void pb_grow(packet_buf_t *pb, size_t need)
22✔
358
{
359
   if (pb->wptr + need > pb->alloc) {
22✔
360
      pb->alloc = MAX(pb->wptr + need, pb->alloc * 2);
×
361
      pb->buf = xrealloc(pb->buf, pb->alloc);
×
362
   }
363
}
22✔
364

365
static void pb_pack_u8(packet_buf_t *pb, uint8_t value)
8✔
366
{
367
   pb_grow(pb, 1);
8✔
368
   pb->buf[pb->wptr++] = value;
8✔
369
}
8✔
370

371
static void pb_pack_u16(packet_buf_t *pb, uint16_t value)
6✔
372
{
373
   pb_grow(pb, 2);
6✔
374
   pb->buf[pb->wptr++] = value >> 8;
6✔
375
   pb->buf[pb->wptr++] = value & 0xff;
6✔
376
}
6✔
377

378
static void pb_pack_u32(packet_buf_t *pb, uint32_t value)
×
379
{
380
   pb_grow(pb, 4);
×
381
   pb->buf[pb->wptr++] = (value >> 24) & 0xff;
×
382
   pb->buf[pb->wptr++] = (value >> 16) & 0xff;
×
383
   pb->buf[pb->wptr++] = (value >> 8) & 0xff;
×
384
   pb->buf[pb->wptr++] = value & 0xff;
×
385
}
×
386

387
static void pb_pack_u64(packet_buf_t *pb, uint64_t value)
2✔
388
{
389
   pb_grow(pb, 8);
2✔
390
   pb->buf[pb->wptr++] = (value >> 56) & 0xff;
2✔
391
   pb->buf[pb->wptr++] = (value >> 48) & 0xff;
2✔
392
   pb->buf[pb->wptr++] = (value >> 40) & 0xff;
2✔
393
   pb->buf[pb->wptr++] = (value >> 32) & 0xff;
2✔
394
   pb->buf[pb->wptr++] = (value >> 24) & 0xff;
2✔
395
   pb->buf[pb->wptr++] = (value >> 16) & 0xff;
2✔
396
   pb->buf[pb->wptr++] = (value >> 8) & 0xff;
2✔
397
   pb->buf[pb->wptr++] = value & 0xff;
2✔
398
}
2✔
399

400
static void pb_pack_bytes(packet_buf_t *pb, const void *data, size_t len)
6✔
401
{
402
   pb_grow(pb, len);
6✔
403
   memcpy(pb->buf + pb->wptr, data, len);
6✔
404
   pb->wptr += len;
6✔
405
}
6✔
406

407
static void pb_pack_str(packet_buf_t *pb, const char *str)
3✔
408
{
409
   const size_t len = strlen(str);
3✔
410
   assert(len < UINT16_MAX);
3✔
411

412
   pb_pack_u16(pb, len);
3✔
413
   pb_pack_bytes(pb, str, len);
3✔
414
}
3✔
415

416
static void pb_pack_ident(packet_buf_t *pb, ident_t ident)
3✔
417
{
418
   const size_t len = ident_len(ident);
3✔
419
   assert(len < UINT16_MAX);
3✔
420

421
   pb_pack_u16(pb, len);
3✔
422
   pb_pack_bytes(pb, istr(ident), len);
3✔
423
}
3✔
424

425
////////////////////////////////////////////////////////////////////////////////
426
// Web server
427

428
typedef enum {
429
   LOG_DEBUG,
430
   LOG_INFO,
431
   LOG_WARN,
432
   LOG_ERROR
433
} log_level_t;
434

435
__attribute__((format(printf, 2, 3)))
436
static void server_log(log_level_t level, const char *fmt, ...)
17✔
437
{
438
   if (opt_get_int(OPT_UNIT_TEST))
17✔
439
      return;
17✔
440
   else if (DEBUG_ONLY(false &&) level < LOG_INFO)
×
441
      return;
442

443
   va_list ap;
×
444
   va_start(ap, fmt);
×
445

446
   switch (level) {
×
447
   case LOG_DEBUG: color_printf("$#8$D: "); break;
×
448
   case LOG_INFO: printf("I: "); break;
×
449
   case LOG_WARN: color_printf("$yellow$W: "); break;
×
450
   case LOG_ERROR: color_printf("$red$E: "); break;
×
451
   }
452

453
   vprintf(fmt, ap);
×
454
   color_printf("$$\n");
×
455
   fflush(stdout);
×
456

457
   va_end(ap);
×
458
}
459

460
static void send_fully(int fd, const void *data, size_t len)
7✔
461
{
462
   while (len > 0) {
14✔
463
      ssize_t nbytes = send(fd, data, len, 0);
7✔
464
      if (nbytes <= 0) {
7✔
465
         server_log(LOG_ERROR, "send: %s", strerror(errno));
×
466
         return;
×
467
      }
468

469
      data += nbytes;
7✔
470
      len -= nbytes;
7✔
471
   }
472
}
473

474
static void send_http_headers(int fd, int status, const char *type, size_t len,
7✔
475
                              const char *headers)
476
{
477
   LOCAL_TEXT_BUF date = tb_new();
14✔
478
   tb_strftime(date, "G%a, %d %b %Y %H:%M:%S %Z", time(NULL));
7✔
479

480
   char buf[512];
7✔
481
   const int nbytes = checked_sprintf(buf, sizeof(buf),
7✔
482
                                      "HTTP/1.1 %d\r\n"
483
                                      "Date: %s\r\n"
484
                                      "Content-Type: %s; charset=UTF-8\r\n"
485
                                      "Content-Length: %zu\r\n"
486
                                      "%s\r\n",
487
                                      status, tb_get(date), type, len, headers);
488

489
   send_fully(fd, buf, nbytes);
7✔
490
}
7✔
491

492
static void send_page(int fd, int status, const char *page)
×
493
{
494
   const size_t len = strlen(page);
×
495
   send_http_headers(fd, status, "text/html", len, "");
×
496
   send_fully(fd, page, len);
×
497
}
×
498

499
#ifdef ENABLE_GUI
500
static void send_file(int fd, const char *file, const char *mime)
×
501
{
502
   FILE *f = fopen(file, "rb");
×
503
   if (f == NULL) {
×
504
      send_page(fd, HTTP_NOT_FOUND, "File not found");
×
505
      return;
×
506
   }
507

508
   file_info_t info;
×
509
   if (!get_handle_info(fileno(f), &info)) {
×
510
      send_page(fd, HTTP_INTERNAL_SERVER_ERROR, "Cannot stat file");
×
511
      goto out_close;
×
512
   }
513

514
   send_http_headers(fd, HTTP_OK, mime, info.size, "");
×
515

516
   char buf[1024];
×
517
   for (ssize_t remain = info.size, nbytes; remain > 0; remain -= nbytes) {
×
518
      memset(buf, '\0', sizeof(buf));
×
519

520
      if ((nbytes = fread(buf, 1, MIN(remain, sizeof(buf)), f)) == 0) {
×
521
         server_log(LOG_ERROR, "fread: %s: %s", file, strerror(errno));
×
522
         goto out_close;
×
523
      }
524

525
      send_fully(fd, buf, nbytes);
×
526
   }
527

528
 out_close:
×
529
   fclose(f);
×
530
}
531
#endif
532

533
static void handle_text_frame(web_socket_t *ws, const char *text, void *context)
8✔
534
{
535
   web_server_t *server = context;
8✔
536

537
   const char *result = NULL;
8✔
538
   if (shell_eval(server->shell, text, &result) && *result != '\0')
8✔
539
      ws_send_text(ws, result);
5✔
540
}
8✔
541

542
static void handle_binary_frame(web_socket_t *ws, const void *data,
5✔
543
                                size_t length, void *context)
544
{
545
   web_server_t *server = context;
5✔
546

547
   if (length == 0) {
5✔
548
      server_log(LOG_WARN, "ignoring zero-length binary frame");
×
549
      return;
×
550
   }
551

552
   const c2s_opcode_t op = *(const uint8_t *)data;
5✔
553
   switch (op) {
5✔
554
   case C2S_SHUTDOWN:
5✔
555
      server->shutdown = true;
5✔
556
      break;
5✔
557
   default:
×
558
      server_log(LOG_ERROR, "unhandled client to server opcode %02x", op);
×
559
      break;
×
560
   }
561
}
562

563
static void kill_connection(web_server_t *server)
7✔
564
{
565
   diag_set_consumer(NULL, NULL);
7✔
566

567
   closesocket(server->websocket->sock);
7✔
568

569
   ws_free(server->websocket);
7✔
570
   server->websocket = NULL;
7✔
571
}
7✔
572

573
static void tunnel_diag(diag_t *d, void *context)
×
574
{
575
   web_server_t *server = context;
×
576

577
   if (server->websocket != NULL) {
×
578
      ws_send_text(server->websocket, diag_get_text(d));
×
579
   }
580
   else
581
      server_log(LOG_INFO, "%s", diag_get_text(d));
×
582
}
×
583

584
static packet_buf_t *fresh_packet_buffer(web_server_t *server)
8✔
585
{
586
   server->packetbuf->wptr = 0;
8✔
587
   return server->packetbuf;
8✔
588
}
589

590
static void add_wave_handler(ident_t path, const char *enc, void *user)
1✔
591
{
592
   web_server_t *server = user;
1✔
593

594
   packet_buf_t *pb = fresh_packet_buffer(server);
1✔
595
   pb_pack_u8(pb, S2C_ADD_WAVE);
1✔
596
   pb_pack_ident(pb, path);
1✔
597
   pb_pack_str(pb, enc);
1✔
598
   ws_send_packet(server->websocket, pb);
1✔
599
}
1✔
600

601
static void signal_update_handler(ident_t path, uint64_t now, rt_signal_t *s,
1✔
602
                                  const char *enc, void *user)
603
{
604
   web_server_t *server = user;
1✔
605

606
   packet_buf_t *pb = fresh_packet_buffer(server);
1✔
607
   pb_pack_u8(pb, S2C_SIGNAL_UPDATE);
1✔
608
   pb_pack_ident(pb, path);
1✔
609
   pb_pack_str(pb, enc);
1✔
610
   ws_send_packet(server->websocket, pb);
1✔
611
}
1✔
612

613
static void start_sim_handler(ident_t top, void *user)
1✔
614
{
615
   web_server_t *server = user;
1✔
616

617
   packet_buf_t *pb = fresh_packet_buffer(server);
1✔
618
   pb_pack_u8(pb, S2C_START_SIM);
1✔
619
   pb_pack_ident(pb, top);
1✔
620
   ws_send_packet(server->websocket, pb);
1✔
621
}
1✔
622

623
static void restart_sim_handler(void *user)
1✔
624
{
625
   web_server_t *server = user;
1✔
626

627
   packet_buf_t *pb = fresh_packet_buffer(server);
1✔
628
   pb_pack_u8(pb, S2C_RESTART_SIM);
1✔
629
   ws_send_packet(server->websocket, pb);
1✔
630
}
1✔
631

632
static void quit_sim_handler(void *user)
1✔
633
{
634
   web_server_t *server = user;
1✔
635

636
   packet_buf_t *pb = fresh_packet_buffer(server);
1✔
637
   pb_pack_u8(pb, S2C_QUIT_SIM);
1✔
638
   ws_send_packet(server->websocket, pb);
1✔
639
}
1✔
640

641
static void next_time_step_handler(uint64_t now, void *user)
2✔
642
{
643
   web_server_t *server = user;
2✔
644

645
   packet_buf_t *pb = fresh_packet_buffer(server);
2✔
646
   pb_pack_u8(pb, S2C_NEXT_TIME_STEP);
2✔
647
   pb_pack_u64(pb, now);
2✔
648
   ws_send_packet(server->websocket, pb);
2✔
649
}
2✔
650

651
static void open_websocket(web_server_t *server, int fd)
7✔
652
{
653
   if (server->websocket != NULL) {
7✔
654
      ws_send_close(server->websocket);
1✔
655
      ws_flush(server->websocket);
1✔
656
      kill_connection(server);
1✔
657
   }
658

659
   const ws_handler_t handler = {
7✔
660
      .text_frame   = handle_text_frame,
661
      .binary_frame = handle_binary_frame,
662
      .context      = server
663
   };
664

665
   server->websocket = ws_new(fd, &handler, false);
7✔
666

667
   diag_set_consumer(tunnel_diag, server);
7✔
668

669
   if (server->banner)
7✔
670
      shell_print_banner(server->shell);
×
671

672
   if (server->top != NULL)
7✔
673
      shell_reset(server->shell, server->top);
1✔
674

675
   if (server->init_cmd != NULL) {
7✔
676
      packet_buf_t *pb = fresh_packet_buffer(server);
1✔
677
      pb_pack_u8(pb, S2C_INIT_CMD);
1✔
678
      pb_pack_str(pb, server->init_cmd);
1✔
679
      ws_send_packet(server->websocket, pb);
1✔
680
   }
681
}
7✔
682

683
static void base64_encode(const void *in, size_t len, text_buf_t *tb)
7✔
684
{
685
   static const char map[] =
7✔
686
      "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
687

688
   const unsigned char *data = in;
7✔
689

690
   for (size_t i = 0; i < len; i++) {
56✔
691
      int c0 = (data[i] >> 2) & 0x3F;
49✔
692
      tb_append(tb, map[c0]);
49✔
693
      c0 = (data[i] << 4) & 0x3F;
49✔
694
      if (++i < len)
49✔
695
         c0 |= (data[i] >> 4) & 0x0F;
49✔
696
      tb_append(tb, map[c0]);
49✔
697

698
      if (i < len) {
49✔
699
         int c1 = (data[i] << 2) & 0x3F;
49✔
700
         if (++i < len)
49✔
701
            c1 |= (data[i] >> 6) & 0x03;
42✔
702
         tb_append(tb, map[c1]);
49✔
703
      }
704
      else {
705
         ++i;
×
706
         tb_append(tb, '=');
×
707
      }
708

709
      if (i < len) {
49✔
710
         int c2 = data[i] & 0x3F;
42✔
711
         tb_append(tb, map[c2]);
42✔
712
      }
713
      else
714
         tb_append(tb, '=');
7✔
715
   }
716
}
7✔
717

718
static bool get_websocket_accept_value(const char *key, text_buf_t *tb)
7✔
719
{
720
   if (key == NULL || strlen(key) != WS_KEY_LEN)
7✔
721
      return false;
722

723
   char *str LOCAL = xmalloc(WS_KEY_LEN + WS_GUID_LEN + 1);
7✔
724
   strncpy(str, key, (WS_KEY_LEN + 1));
7✔
725
   strncpy(str + WS_KEY_LEN, WS_GUID, WS_GUID_LEN + 1);
7✔
726

727
   SHA1_CTX ctx;
7✔
728
   SHA1Init(&ctx);
7✔
729
   SHA1Update(&ctx, (unsigned char *)str, WS_KEY_GUID_LEN);
7✔
730

731
   unsigned char hash[SHA1_LEN];
7✔
732
   SHA1Final(hash, &ctx);
7✔
733

734
   base64_encode(hash, SHA1_LEN, tb);
7✔
735
   return true;
7✔
736
}
737

738
static void websocket_upgrade(web_server_t *server, int fd, const char *method,
7✔
739
                              const char *version, shash_t *headers)
740
{
741
   LOCAL_TEXT_BUF tb = tb_new();
7✔
742

743
   if (strcmp(method, "GET") != 0 || strcmp(version, "HTTP/1.1") != 0) {
7✔
744
      send_page(fd, HTTP_BAD_REQUEST, "Bad request");
×
745
      goto out_close;
×
746
   }
747

748
   const char *ws_version_header = shash_get(headers, "sec-websocket-version");
7✔
749

750
   if (ws_version_header == NULL
7✔
751
       || strcasecmp(ws_version_header, WS_WEBSOCKET_VERSION) != 0) {
7✔
752

753
      static const char page[] = "Upgrade required";
×
754
      static const char header[] =
×
755
         "Sec-WebSocket-Version:" WS_WEBSOCKET_VERSION;
756

757
      send_http_headers(fd, HTTP_UPGRADE_REQUIRED, "text/html",
×
758
                        sizeof(page), header);
759
      send_fully(fd, page, sizeof(page));
×
760

761
      goto out_close;
×
762
   }
763

764
   const char *ws_key_header = shash_get(headers, "sec-websocket-key");
7✔
765

766
   if (ws_key_header == NULL || strlen(ws_key_header) != WS_KEY_LEN) {
7✔
767
      send_page(fd, HTTP_BAD_REQUEST, "Bad request");
×
768
      goto out_close;
×
769
   }
770

771
   tb_cat(tb, "Connection: upgrade\r\n"
7✔
772
          "Upgrade: websocket\r\n"
773
          "Sec-WebSocket-Accept: ");
774

775
   if (!get_websocket_accept_value(ws_key_header, tb))
7✔
776
      goto out_close;
×
777

778
   tb_cat(tb, "\r\n");
7✔
779

780
   send_http_headers(fd, HTTP_SWITCHING_PROTOCOLS, "text/html", 0, tb_get(tb));
7✔
781

782
   open_websocket(server, fd);
7✔
783

784
   return;   // Socket left open
7✔
785

786
 out_close:
×
787
   closesocket(fd);
×
788
}
789

790
static bool is_websocket_request(shash_t *headers)
7✔
791
{
792
   const char *upg_header = shash_get(headers, "upgrade");
7✔
793
   const char *con_header = shash_get(headers, "connection");
7✔
794

795
   return (upg_header != NULL && con_header != NULL)
7✔
796
          && (strcasecmp(upg_header, WS_UPGRADE_VALUE) == 0)
7✔
797
          && (strcasestr(con_header, "Upgrade") != NULL);
14✔
798
}
799

800
#ifdef ENABLE_GUI
801
static void serve_gui_static_files(int fd, const char *url)
×
802
{
803
   LOCAL_TEXT_BUF tb = tb_new();
×
804
   get_data_dir(tb);
×
805
   tb_cat(tb, "/gui");
×
806

807
   if (strcmp(url, "/") == 0) {
×
808
      tb_cat(tb, "/index.html");
×
809
      send_file(fd, tb_get(tb), "text/html");
×
810
      return;
×
811
   }
812

813
   const char *mime = "application/octet-stream";
×
814
   const char *dot = strrchr(url, '.');
×
815
   if (dot != NULL) {
×
816
      static const char *mime_map[][2] = {
817
         { ".js",  "text/javascript" },
818
         { ".css", "text/css" },
819
         { ".map", "application/json" },
820
      };
821

822
      for (int i = 0; i < ARRAY_LEN(mime_map); i++) {
×
823
         if (strcmp(dot, mime_map[i][0]) == 0) {
×
824
            mime = mime_map[i][1];
×
825
            break;
×
826
         }
827
      }
828
   }
829

830
   tb_cat(tb, url);
×
831
   send_file(fd, tb_get(tb), mime);
×
832
}
833
#endif
834

835
static void handle_http_request(web_server_t *server, int fd,
7✔
836
                                const char *method, const char *url,
837
                                const char *version, shash_t *headers)
838
{
839
   server_log(LOG_DEBUG, "%s %s", method, url);
7✔
840

841
   if (is_websocket_request(headers)) {
7✔
842
      websocket_upgrade(server, fd, method, version, headers);
7✔
843
      return;    // Socket left open
7✔
844
   }
845
   else if (strcmp(method, "GET") != 0) {
×
846
      send_page(fd, HTTP_METHOD_NOT_ALLOWED, "Method not allowed");
×
847
      goto out_close;
×
848
   }
849

850
#ifdef ENABLE_GUI
851
   serve_gui_static_files(fd, url);
×
852
#else
853
   send_page(fd, HTTP_NOT_FOUND, "Not found");
854
#endif
855

856
 out_close:
×
857
   closesocket(fd);
×
858
}
859

860
static void handle_new_connection(web_server_t *server)
7✔
861
{
862
   int fd = accept(server->sock, NULL, NULL);
7✔
863
   if (fd < 0) {
7✔
864
      server_log(LOG_ERROR, "accept: %s", last_os_error());
×
865
      return;
7✔
866
   }
867

868
#ifdef __MINGW32__
869
   if (ioctlsocket(fd, FIONBIO, &(unsigned long){1})) {
870
      server_log(LOG_ERROR, "ioctlsocket: %s", last_os_error());
871
      goto out_close;
872
   }
873
#else
874
   const int flags = fcntl(fd, F_GETFL, 0);
7✔
875
   if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) < 0) {
7✔
876
      server_log(LOG_ERROR, "fcntl: %s", last_os_error());
×
877
      goto out_close;
×
878
   }
879
#endif
880

881
   char buf[MAX_HTTP_REQUEST + 1];
7✔
882
   size_t reqlen = 0;
7✔
883
   do {
7✔
884
      ssize_t n = recv(fd, buf + reqlen, MAX_HTTP_REQUEST - reqlen, 0);
7✔
885

886
#ifdef __MINGW32__
887
      const bool would_block =
888
         (n == SOCKET_ERROR && WSAGetLastError() == WSAEWOULDBLOCK);
889
#else
890
      const bool would_block = (n == -1 && errno == EWOULDBLOCK);
7✔
891
#endif
892

893
      if (would_block) {
7✔
UNCOV
894
         fd_set rfd;
×
UNCOV
895
         FD_ZERO(&rfd);
×
UNCOV
896
         FD_SET(fd, &rfd);
×
897

UNCOV
898
         struct timeval tv = {
×
899
            .tv_sec = 1,
900
            .tv_usec = 0
901
         };
902

UNCOV
903
         if (select(fd + 1, &rfd, NULL, NULL, &tv) == -1) {
×
904
            server_log(LOG_ERROR, "select: %s", last_os_error());
×
905
            goto out_close;
×
906
         }
907

UNCOV
908
         if (FD_ISSET(fd, &rfd))
×
UNCOV
909
            continue;
×
910

911
         server_log(LOG_ERROR, "timeout waiting for HTTP request");
×
912
         goto out_close;
×
913
      }
914
      else if (n <= 0) {
7✔
915
         server_log(LOG_ERROR, "recv: %s", last_os_error());
×
916
         goto out_close;
×
917
      }
918

919
      reqlen += n;
7✔
920
      assert(reqlen <= MAX_HTTP_REQUEST);
7✔
921

922
      if (reqlen == MAX_HTTP_REQUEST) {
7✔
923
         server_log(LOG_ERROR, "HTTP request too big");
×
924
         goto out_close;
×
925
      }
926

927
      buf[reqlen] = '\0';
7✔
928
   } while (strstr(buf, "\r\n\r\n") == NULL);
7✔
929

930
   const char *method = "GET";
7✔
931
   const char *url = "/";
7✔
932
   const char *version = "";
7✔
933

934
   char *saveptr, *saveptr2;
7✔
935
   char *line = strtok_r(buf, "\r\n", &saveptr);
7✔
936
   if (line == NULL) {
7✔
937
      server_log(LOG_ERROR, "malformed HTTP request");
×
938
      goto out_close;
×
939
   }
940

941
   method = strtok_r(line, " ", &saveptr2);
7✔
942
   if (method == NULL)
7✔
943
      goto malformed;
×
944

945
   url = strtok_r(NULL, " ", &saveptr2);
7✔
946
   if (url == NULL)
7✔
947
      goto malformed;
×
948

949
   version = strtok_r(NULL, " ", &saveptr2);
7✔
950
   if (version == NULL)
7✔
951
      goto malformed;
×
952

953
   shash_t *headers = shash_new(64);
7✔
954

955
   while ((line = strtok_r(NULL, "\r\n", &saveptr)) && line[0] != '\0') {
70✔
956
      char *colon = strchr(line, ':');
56✔
957
      if (colon != NULL) {
56✔
958
         *colon = '\0';
56✔
959

960
         char *value = colon + 1;
56✔
961
         while (*value == ' ')
112✔
962
            value++;
56✔
963

964
         for (char *p = line; *p; p++)
623✔
965
            *p = tolower_iso88591(*p);
567✔
966

967
         shash_put(headers, line, value);
56✔
968
      }
969
   }
970

971
   handle_http_request(server, fd, method, url, version, headers);
7✔
972
   shash_free(headers);
7✔
973
   return;
7✔
974

975
 malformed:
×
976
   server_log(LOG_ERROR, "malformed HTTP request");
×
977

978
 out_close:
×
979
   closesocket(fd);
×
980
}
981

982
static void tunnel_output(const char *buf, size_t nchars, void *user)
×
983
{
984
   web_server_t *server = user;
×
985
   ws_send(server->websocket, WS_OPCODE_TEXT_FRAME, buf, nchars);
×
986
}
×
987

988
static void tunnel_backchannel(const char *buf, size_t nchars, void *user)
×
989
{
990
   web_server_t *server = user;
×
991

992
   packet_buf_t *pb = fresh_packet_buffer(server);
×
993
   pb_pack_u8(pb, S2C_BACKCHANNEL);
×
994
   pb_pack_u32(pb, nchars);
×
995
   pb_pack_bytes(pb, buf, nchars);
×
996
   ws_send_packet(server->websocket, pb);
×
997
}
×
998

999
static int open_server_socket(void)
5✔
1000
{
1001
#ifdef __MINGW32__
1002
   WSADATA wsaData;
1003
   if (WSAStartup(MAKEWORD(2, 2), &wsaData))
1004
      fatal_errno("WSAStartup failed");
1005
#endif
1006

1007
   int sock = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
5✔
1008
   if (sock < 0)
5✔
1009
      fatal_errno("socket");
×
1010

1011
   if (setsockopt(sock, SOL_SOCKET, SO_REUSEADDR,
5✔
1012
                  (char *)&(int){1}, sizeof(int)) < 0)
5✔
1013
      fatal_errno("setsockopt");
×
1014

1015
   const uint16_t port = opt_get_int(OPT_SERVER_PORT);
5✔
1016

1017
   struct sockaddr_in addr;
5✔
1018
   addr.sin_family = AF_INET;
5✔
1019
   addr.sin_port = htons(port);
5✔
1020
   addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
5✔
1021

1022
   if (bind(sock, (struct sockaddr *)&addr, sizeof(addr)) < 0)
5✔
1023
      fatal_errno("bind");
×
1024

1025
   if (listen(sock, SOMAXCONN) < 0)
5✔
1026
      fatal_errno("listen");
×
1027

1028
   server_log(LOG_INFO, "listening on 127.0.0.1:%u", port);
5✔
1029

1030
   return sock;
5✔
1031
}
1032

1033
void start_server(jit_factory_t make_jit, unit_registry_t *registry, tree_t top,
5✔
1034
                  server_ready_fn_t cb, void *arg, const char *init_cmd)
1035
{
1036
   web_server_t *server = xcalloc(sizeof(web_server_t));
5✔
1037
   server->shell     = shell_new(make_jit, registry);
5✔
1038
   server->top       = top;
5✔
1039
   server->packetbuf = pb_new();
5✔
1040
   server->init_cmd  = init_cmd;
5✔
1041
   server->banner    = !opt_get_int(OPT_UNIT_TEST);
5✔
1042

1043
   shell_handler_t handler = {
5✔
1044
      .add_wave = add_wave_handler,
1045
      .signal_update = signal_update_handler,
1046
      .stderr_write = tunnel_output,
1047
      .stdout_write = tunnel_output,
1048
      .backchannel_write = tunnel_backchannel,
1049
      .start_sim = start_sim_handler,
1050
      .restart_sim = restart_sim_handler,
1051
      .quit_sim = quit_sim_handler,
1052
      .next_time_step = next_time_step_handler,
1053
      .context = server
1054
   };
1055
   shell_set_handler(server->shell, &handler);
5✔
1056

1057
   server->sock = open_server_socket();
5✔
1058

1059
   if (cb != NULL)
5✔
1060
      (*cb)(arg);
5✔
1061

1062
   for (;;) {
44✔
1063
      fd_set rfd, wfd, efd;
49✔
1064
      FD_ZERO(&rfd);
882✔
1065
      FD_ZERO(&wfd);
833✔
1066
      FD_ZERO(&efd);
833✔
1067

1068
      int max_fd = -1;
49✔
1069

1070
      if (server->sock != -1) {
49✔
1071
         FD_SET(server->sock, &rfd);
34✔
1072
         max_fd = MAX(max_fd, server->sock);
34✔
1073
      }
1074

1075
      if (server->websocket != NULL) {
49✔
1076
         FD_SET(server->websocket->sock, &rfd);
38✔
1077

1078
         if (server->websocket->tx_wptr != server->websocket->tx_rptr)
38✔
1079
            FD_SET(server->websocket->sock, &wfd);
16✔
1080

1081
         max_fd = MAX(max_fd, server->websocket->sock);
38✔
1082
      }
1083

1084
      if (max_fd == -1)
49✔
1085
         break;
1086

1087
      struct timeval tv = {
44✔
1088
         .tv_sec = 1,
1089
         .tv_usec = 0
1090
      };
1091

1092
      if (select(max_fd + 1, &rfd, &wfd, &efd, &tv) == -1)
44✔
1093
         fatal_errno("select");
×
1094

1095
      if (server->sock != -1 && FD_ISSET(server->sock, &rfd))
44✔
1096
         handle_new_connection(server);
7✔
1097

1098
      if (server->websocket != NULL) {
44✔
1099
         if (FD_ISSET(server->websocket->sock, &rfd))
44✔
1100
            ws_poll(server->websocket);
22✔
1101

1102
         if (FD_ISSET(server->websocket->sock, &wfd))
44✔
1103
            ws_flush(server->websocket);
16✔
1104

1105
         if (server->websocket->closing)
44✔
1106
            kill_connection(server);
6✔
1107
      }
1108

1109
      if (server->shutdown && server->sock != -1) {
44✔
1110
         server_log(LOG_INFO, "stopping server");
5✔
1111

1112
         closesocket(server->sock);
5✔
1113
         server->sock = -1;
5✔
1114

1115
         if (server->websocket != NULL)
5✔
1116
            ws_send_close(server->websocket);
5✔
1117
      }
1118
   }
1119

1120
   assert(server->sock == -1);
5✔
1121

1122
   pb_free(server->packetbuf);
5✔
1123
   free(server);
5✔
1124
}
5✔
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc