blob: 222f215cc6675779542282868bae945ee740b08e [file] [log] [blame]
Jeremy Kerrd831f962016-01-29 17:18:01 +08001/**
2 * Console server process for OpenBMC
3 *
Jeremy Kerr9326d772016-03-17 17:15:02 +08004 * Copyright © 2016 IBM Corporation
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
Jeremy Kerrd831f962016-01-29 17:18:01 +080017 */
18
Jeremy Kerr329a35f2016-03-10 15:36:01 +080019#include <assert.h>
Jeremy Kerr769cee12016-03-15 17:53:56 +080020#include <errno.h>
21#include <signal.h>
Jeremy Kerrd831f962016-01-29 17:18:01 +080022#include <stdint.h>
23#include <stdbool.h>
24#include <stdlib.h>
25#include <stdio.h>
26#include <fcntl.h>
27#include <unistd.h>
28#include <err.h>
Jeremy Kerrd831f962016-01-29 17:18:01 +080029#include <string.h>
30#include <getopt.h>
Zev Weiss7dc08ba2023-09-12 20:49:14 -070031#include <glob.h>
Jeremy Kerr17217842016-01-29 18:44:21 +080032#include <limits.h>
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -080033#include <time.h>
Jeremy Kerr54e95692016-03-24 17:07:56 +080034#include <termios.h>
Jeremy Kerrd831f962016-01-29 17:18:01 +080035
36#include <sys/types.h>
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -080037#include <sys/time.h>
Ninad Palsuleb14ca192023-03-31 09:49:00 -050038#include <sys/socket.h>
Joel Stanley87e344c2016-09-01 00:00:51 +093039#include <poll.h>
Jeremy Kerrd831f962016-01-29 17:18:01 +080040
Alexander Hansena6b29102024-07-10 15:33:37 +020041#include "console-mux.h"
42
Jeremy Kerr1a0e03b2016-03-08 17:57:11 +080043#include "console-server.h"
Alexander Hansen1e04f442024-06-12 16:35:58 +020044#include "config.h"
Jeremy Kerrd831f962016-01-29 17:18:01 +080045
Andrew Jeffery30ea6382023-05-03 16:56:10 +093046#define DEV_PTS_PATH "/dev/pts"
47
Medicine Yeh7f2bfb92024-03-10 23:19:41 -070048/* default size of the shared backlog ringbuffer */
49const size_t default_buffer_size = 128ul * 1024ul;
Jeremy Kerrf733c852017-02-07 18:40:10 +080050
Jeremy Kerr769cee12016-03-15 17:53:56 +080051/* state shared with the signal handler */
Andrew Jeffery553cb662024-07-09 15:14:56 +093052static volatile sig_atomic_t sigint;
Jeremy Kerr329a35f2016-03-10 15:36:01 +080053
Jeremy Kerrd831f962016-01-29 17:18:01 +080054static void usage(const char *progname)
55{
56 fprintf(stderr,
Andrew Jefferya72711a2023-04-18 18:19:41 +093057 "usage: %s [options] <DEVICE>\n"
58 "\n"
59 "Options:\n"
Andrew Jeffery954be0f2023-05-03 21:01:59 +093060 " --config <FILE>\tUse FILE for configuration\n"
61 " --console-id <NAME>\tUse NAME in the UNIX domain socket address\n"
Andrew Jefferya72711a2023-04-18 18:19:41 +093062 "",
Jeremy Kerrd831f962016-01-29 17:18:01 +080063 progname);
64}
65
Alexander Hansen2325d5d2024-06-07 16:54:20 +020066static bool console_server_pollfd_reclaimable(struct pollfd *p)
67{
68 return p->fd == -1 && p->events == 0 && p->revents == ~0;
69}
70
71static ssize_t
72console_server_find_released_pollfd(struct console_server *server)
73{
74 for (size_t i = 0; i < server->capacity_pollfds; i++) {
75 struct pollfd *p = &server->pollfds[i];
76 if (console_server_pollfd_reclaimable(p)) {
77 return (ssize_t)i;
78 }
79 }
80 return -1;
81}
82
83// returns the index of that pollfd in server->pollfds
84// we cannot return a pointer because 'realloc' may move server->pollfds
85ssize_t console_server_request_pollfd(struct console_server *server, int fd,
86 short int events)
87{
88 ssize_t index;
89 struct pollfd *pollfd;
90
91 index = console_server_find_released_pollfd(server);
92
93 if (index < 0) {
94 const size_t newcap = server->capacity_pollfds + 1;
95
96 struct pollfd *newarr = reallocarray(server->pollfds, newcap,
97 sizeof(struct pollfd));
98 if (newarr == NULL) {
99 return -1;
100 }
101 server->pollfds = newarr;
102
103 index = (ssize_t)server->capacity_pollfds;
104
105 server->capacity_pollfds = newcap;
106 }
107
108 pollfd = &server->pollfds[index];
109 pollfd->fd = fd;
110 pollfd->events = events;
111 pollfd->revents = 0;
112
113 return index;
114}
115
116int console_server_release_pollfd(struct console_server *server,
117 size_t pollfd_index)
118{
119 if (pollfd_index >= server->capacity_pollfds) {
120 return -1;
121 }
122
123 struct pollfd *pfd = &server->pollfds[pollfd_index];
124
125 // mark pollfd as reclaimable
126
127 // ignore this file descriptor when calling 'poll'
128 // https://www.man7.org/linux/man-pages/man2/poll.2.html
129 pfd->fd = -1;
130 pfd->events = 0;
131 pfd->revents = ~0;
132
133 return 0;
134}
135
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200136/* populates server->tty.dev and server->tty.sysfs_devnode, using the tty kernel name */
137static int tty_find_device(struct console_server *server)
Jeremy Kerr17217842016-01-29 18:44:21 +0800138{
Andrew Jefferyd3cb9c22023-05-03 17:13:50 +0930139 char *tty_class_device_link = NULL;
140 char *tty_path_input_real = NULL;
141 char *tty_device_tty_dir = NULL;
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930142 char *tty_vuart_lpc_addr = NULL;
Andrew Jefferyd3cb9c22023-05-03 17:13:50 +0930143 char *tty_device_reldir = NULL;
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930144 char *tty_sysfs_devnode = NULL;
Andrew Jefferyd3cb9c22023-05-03 17:13:50 +0930145 char *tty_kname_real = NULL;
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930146 char *tty_path_input = NULL;
Jeremy Kerr17217842016-01-29 18:44:21 +0800147 int rc;
148
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200149 server->tty.type = TTY_DEVICE_UNDEFINED;
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930150
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200151 assert(server->tty.kname);
152 if (!strlen(server->tty.kname)) {
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930153 warnx("TTY kname must not be empty");
154 rc = -1;
155 goto out_free;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930156 }
Jeremy Kerr17217842016-01-29 18:44:21 +0800157
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200158 if (server->tty.kname[0] == '/') {
159 tty_path_input = strdup(server->tty.kname);
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930160 if (!tty_path_input) {
161 rc = -1;
162 goto out_free;
163 }
164 } else {
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200165 rc = asprintf(&tty_path_input, "/dev/%s", server->tty.kname);
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930166 if (rc < 0) {
167 goto out_free;
168 }
169 }
170
171 /* udev may rename the tty name with a symbol link, try to resolve */
Yi Li45ad7672016-10-18 23:21:19 +0800172 tty_path_input_real = realpath(tty_path_input, NULL);
173 if (!tty_path_input_real) {
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930174 warn("Can't find realpath for %s", tty_path_input);
Andrew Jeffery15792aa2023-04-18 16:47:33 +0930175 rc = -1;
Yi Li45ad7672016-10-18 23:21:19 +0800176 goto out_free;
177 }
178
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930179 /*
180 * Allow hooking obmc-console-server up to PTYs for testing
181 *
182 * https://amboar.github.io/notes/2023/05/02/testing-obmc-console-with-socat.html
183 */
184 if (!strncmp(DEV_PTS_PATH, tty_path_input_real, strlen(DEV_PTS_PATH))) {
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200185 server->tty.type = TTY_DEVICE_PTY;
186 server->tty.dev = strdup(server->tty.kname);
187 rc = server->tty.dev ? 0 : -1;
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930188 goto out_free;
189 }
190
Yi Li45ad7672016-10-18 23:21:19 +0800191 tty_kname_real = basename(tty_path_input_real);
192 if (!tty_kname_real) {
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200193 warn("Can't find real name for %s", server->tty.kname);
Andrew Jeffery15792aa2023-04-18 16:47:33 +0930194 rc = -1;
Yi Li45ad7672016-10-18 23:21:19 +0800195 goto out_free;
196 }
197
Andrew Jefferya72711a2023-04-18 18:19:41 +0930198 rc = asprintf(&tty_class_device_link, "/sys/class/tty/%s",
199 tty_kname_real);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930200 if (rc < 0) {
Yi Li45ad7672016-10-18 23:21:19 +0800201 goto out_free;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930202 }
Yi Li45ad7672016-10-18 23:21:19 +0800203
Jeremy Kerr17217842016-01-29 18:44:21 +0800204 tty_device_tty_dir = realpath(tty_class_device_link, NULL);
Yi Li45ad7672016-10-18 23:21:19 +0800205 if (!tty_device_tty_dir) {
206 warn("Can't query sysfs for device %s", tty_kname_real);
Andrew Jeffery15792aa2023-04-18 16:47:33 +0930207 rc = -1;
Jeremy Kerr17217842016-01-29 18:44:21 +0800208 goto out_free;
209 }
210
Jeremy Kerrf3153342025-09-10 11:40:02 +0800211 rc = asprintf(&server->tty.dev, "/dev/%s", tty_kname_real);
212 if (rc < 0) {
213 goto out_free;
214 }
215
216 // Default to non-VUART
217 server->tty.type = TTY_DEVICE_UART;
218
Jeremy Kerr17217842016-01-29 18:44:21 +0800219 rc = asprintf(&tty_device_reldir, "%s/../../", tty_device_tty_dir);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930220 if (rc < 0) {
Jeremy Kerr17217842016-01-29 18:44:21 +0800221 goto out_free;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930222 }
Jeremy Kerr17217842016-01-29 18:44:21 +0800223
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930224 tty_sysfs_devnode = realpath(tty_device_reldir, NULL);
Jeremy Kerref07b772025-09-10 11:48:48 +0800225 /* not really an error, but it'd be unusual if we cannot resolve
226 * two parent dirs...
227 */
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930228 if (!tty_sysfs_devnode) {
Yi Li45ad7672016-10-18 23:21:19 +0800229 warn("Can't find parent device for %s", tty_kname_real);
Jeremy Kerref07b772025-09-10 11:48:48 +0800230 rc = 0;
231 goto out_free;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930232 }
Jeremy Kerr17217842016-01-29 18:44:21 +0800233
Oskar Senft955d1402023-09-27 22:43:22 -0400234 /* Arbitrarily pick an attribute to differentiate UART vs VUART */
Jeremy Kerref07b772025-09-10 11:48:48 +0800235 rc = asprintf(&tty_vuart_lpc_addr, "%s/lpc_address", tty_sysfs_devnode);
236 if (rc < 0) {
237 goto out_free;
238 }
Oskar Senft955d1402023-09-27 22:43:22 -0400239
Jeremy Kerref07b772025-09-10 11:48:48 +0800240 rc = access(tty_vuart_lpc_addr, F_OK);
241 if (!rc) {
242 server->tty.type = TTY_DEVICE_VUART;
243 server->tty.vuart.sysfs_devnode = strdup(tty_sysfs_devnode);
Oskar Senft955d1402023-09-27 22:43:22 -0400244 }
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930245
Jeremy Kerr17217842016-01-29 18:44:21 +0800246 rc = 0;
247
248out_free:
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930249 free(tty_vuart_lpc_addr);
Jeremy Kerr17217842016-01-29 18:44:21 +0800250 free(tty_class_device_link);
Andrew Jeffery982090d2024-07-09 17:31:27 +0930251 free(tty_sysfs_devnode);
Jeremy Kerr17217842016-01-29 18:44:21 +0800252 free(tty_device_tty_dir);
253 free(tty_device_reldir);
Yi Li45ad7672016-10-18 23:21:19 +0800254 free(tty_path_input);
255 free(tty_path_input_real);
Jeremy Kerr17217842016-01-29 18:44:21 +0800256 return rc;
257}
258
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200259static int tty_set_sysfs_attr(struct console_server *server, const char *name,
Andrew Jefferya72711a2023-04-18 18:19:41 +0930260 int value)
Jeremy Kerr957818b2016-03-08 14:35:15 +0800261{
262 char *path;
263 FILE *fp;
264 int rc;
265
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200266 assert(server->tty.type == TTY_DEVICE_VUART);
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930267
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200268 if (!server->tty.vuart.sysfs_devnode) {
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930269 return -1;
270 }
271
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200272 rc = asprintf(&path, "%s/%s", server->tty.vuart.sysfs_devnode, name);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930273 if (rc < 0) {
Jeremy Kerr957818b2016-03-08 14:35:15 +0800274 return -1;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930275 }
Jeremy Kerr957818b2016-03-08 14:35:15 +0800276
277 fp = fopen(path, "w");
278 if (!fp) {
Andrew Jefferya72711a2023-04-18 18:19:41 +0930279 warn("Can't access attribute %s on device %s", name,
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200280 server->tty.kname);
Jeremy Kerr957818b2016-03-08 14:35:15 +0800281 rc = -1;
282 goto out_free;
283 }
284 setvbuf(fp, NULL, _IONBF, 0);
285
286 rc = fprintf(fp, "0x%x", value);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930287 if (rc < 0) {
Andrew Jefferya72711a2023-04-18 18:19:41 +0930288 warn("Error writing to %s attribute of device %s", name,
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200289 server->tty.kname);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930290 }
Jeremy Kerr957818b2016-03-08 14:35:15 +0800291 fclose(fp);
292
Jeremy Kerr957818b2016-03-08 14:35:15 +0800293out_free:
294 free(path);
295 return rc;
296}
297
Jeremy Kerrd831f962016-01-29 17:18:01 +0800298/**
Benjamin Fairc7fbcd42018-06-04 14:39:01 -0700299 * Set termios attributes on the console tty.
Jeremy Kerr54e95692016-03-24 17:07:56 +0800300 */
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200301void tty_init_termios(struct console_server *server)
Jeremy Kerr54e95692016-03-24 17:07:56 +0800302{
303 struct termios termios;
304 int rc;
305
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200306 rc = tcgetattr(server->tty.fd, &termios);
Jeremy Kerr54e95692016-03-24 17:07:56 +0800307 if (rc) {
308 warn("Can't read tty termios");
309 return;
310 }
311
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200312 if (server->tty.type == TTY_DEVICE_UART && server->tty.uart.baud) {
313 if (cfsetspeed(&termios, server->tty.uart.baud) < 0) {
314 warn("Couldn't set speeds for %s", server->tty.kname);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930315 }
Benjamin Fairc7fbcd42018-06-04 14:39:01 -0700316 }
317
318 /* Set console to raw mode: we don't want any processing to occur on
319 * the underlying terminal input/output.
320 */
Jeremy Kerr54e95692016-03-24 17:07:56 +0800321 cfmakeraw(&termios);
Benjamin Fairc7fbcd42018-06-04 14:39:01 -0700322
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200323 rc = tcsetattr(server->tty.fd, TCSANOW, &termios);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930324 if (rc) {
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200325 warn("Can't set terminal options for %s", server->tty.kname);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930326 }
Jeremy Kerr54e95692016-03-24 17:07:56 +0800327}
328
329/**
Jeremy Kerrd831f962016-01-29 17:18:01 +0800330 * Open and initialise the serial device
331 */
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200332static void tty_init_vuart_io(struct console_server *server)
Jeremy Kerrd831f962016-01-29 17:18:01 +0800333{
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200334 assert(server->tty.type == TTY_DEVICE_VUART);
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930335
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200336 if (server->tty.vuart.sirq) {
337 tty_set_sysfs_attr(server, "sirq", server->tty.vuart.sirq);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930338 }
Jeremy Kerr957818b2016-03-08 14:35:15 +0800339
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200340 if (server->tty.vuart.lpc_addr) {
341 tty_set_sysfs_attr(server, "lpc_address",
342 server->tty.vuart.lpc_addr);
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930343 }
344}
345
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200346static int tty_init_io(struct console_server *server)
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930347{
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200348 server->tty.fd = open(server->tty.dev, O_RDWR);
349 if (server->tty.fd <= 0) {
350 warn("Can't open tty %s", server->tty.dev);
Jeremy Kerrd831f962016-01-29 17:18:01 +0800351 return -1;
352 }
353
354 /* Disable character delay. We may want to later enable this when
355 * we detect larger amounts of data
356 */
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200357 fcntl(server->tty.fd, F_SETFL, FNDELAY);
Jeremy Kerrd831f962016-01-29 17:18:01 +0800358
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200359 tty_init_termios(server);
Jeremy Kerr54e95692016-03-24 17:07:56 +0800360
Alexander Hansen2325d5d2024-06-07 16:54:20 +0200361 ssize_t index =
362 console_server_request_pollfd(server, server->tty.fd, POLLIN);
363
364 if (index < 0) {
365 return -1;
366 }
367
368 server->tty_pollfd_index = (size_t)index;
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800369
Jeremy Kerrd831f962016-01-29 17:18:01 +0800370 return 0;
371}
372
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200373static int tty_init_vuart(struct console_server *server, struct config *config)
Jeremy Kerrd66195c2016-03-16 17:24:51 +0800374{
Andrew Jefferyfd883a82023-04-18 22:18:25 +0930375 unsigned long parsed;
Jeremy Kerrd66195c2016-03-16 17:24:51 +0800376 const char *val;
377 char *endp;
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930378
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200379 assert(server->tty.type == TTY_DEVICE_VUART);
Jeremy Kerrd66195c2016-03-16 17:24:51 +0800380
Jeremy Kerrd66195c2016-03-16 17:24:51 +0800381 val = config_get_value(config, "lpc-address");
382 if (val) {
Andrew Jefferyfd883a82023-04-18 22:18:25 +0930383 errno = 0;
384 parsed = strtoul(val, &endp, 0);
385 if (parsed == ULONG_MAX && errno == ERANGE) {
386 warn("Cannot interpret 'lpc-address' value as an unsigned long: '%s'",
387 val);
388 return -1;
389 }
390
391 if (parsed > UINT16_MAX) {
392 warn("Invalid LPC address '%s'", val);
393 return -1;
394 }
395
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200396 server->tty.vuart.lpc_addr = (uint16_t)parsed;
Jeremy Kerrd66195c2016-03-16 17:24:51 +0800397 if (endp == optarg) {
398 warn("Invalid LPC address: '%s'", val);
399 return -1;
400 }
401 }
402
403 val = config_get_value(config, "sirq");
404 if (val) {
Andrew Jefferyfd883a82023-04-18 22:18:25 +0930405 errno = 0;
406 parsed = strtoul(val, &endp, 0);
407 if (parsed == ULONG_MAX && errno == ERANGE) {
408 warn("Cannot interpret 'sirq' value as an unsigned long: '%s'",
409 val);
410 }
411
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930412 if (parsed > 16) {
Andrew Jefferyfd883a82023-04-18 22:18:25 +0930413 warn("Invalid LPC SERIRQ: '%s'", val);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930414 }
Andrew Jefferyfd883a82023-04-18 22:18:25 +0930415
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200416 server->tty.vuart.sirq = (int)parsed;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930417 if (endp == optarg) {
Jeremy Kerrd66195c2016-03-16 17:24:51 +0800418 warn("Invalid sirq: '%s'", val);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930419 }
Jeremy Kerrd66195c2016-03-16 17:24:51 +0800420 }
421
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930422 return 0;
423}
424
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200425static int tty_init(struct console_server *server, struct config *config,
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930426 const char *tty_arg)
427{
428 const char *val;
429 int rc;
Benjamin Fairc7fbcd42018-06-04 14:39:01 -0700430
Andrew Jefferyd769eec2023-05-03 20:00:09 +0930431 if (tty_arg) {
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200432 server->tty.kname = tty_arg;
Andrew Jefferyd769eec2023-05-03 20:00:09 +0930433 } else if ((val = config_get_value(config, "upstream-tty"))) {
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200434 server->tty.kname = val;
Andrew Jefferyd769eec2023-05-03 20:00:09 +0930435 } else {
Jeremy Kerrd66195c2016-03-16 17:24:51 +0800436 warnx("Error: No TTY device specified");
437 return -1;
438 }
439
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200440 rc = tty_find_device(server);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930441 if (rc) {
Jeremy Kerrd66195c2016-03-16 17:24:51 +0800442 return rc;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930443 }
Jeremy Kerrd66195c2016-03-16 17:24:51 +0800444
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200445 switch (server->tty.type) {
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930446 case TTY_DEVICE_VUART:
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200447 rc = tty_init_vuart(server, config);
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930448 if (rc) {
449 return rc;
450 }
451
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200452 tty_init_vuart_io(server);
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930453 break;
454 case TTY_DEVICE_UART:
455 val = config_get_value(config, "baud");
456 if (val) {
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200457 if (config_parse_baud(&server->tty.uart.baud, val)) {
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930458 warnx("Invalid baud rate: '%s'", val);
459 }
460 }
461 break;
462 case TTY_DEVICE_PTY:
463 break;
464 case TTY_DEVICE_UNDEFINED:
465 default:
466 warnx("Cannot configure unrecognised TTY device");
467 return -1;
468 }
469
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200470 return tty_init_io(server);
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930471}
472
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200473static void tty_fini(struct console_server *server)
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930474{
Alexander Hansen2325d5d2024-06-07 16:54:20 +0200475 if (server->tty_pollfd_index < server->capacity_pollfds) {
476 console_server_release_pollfd(server, server->tty_pollfd_index);
477 server->tty_pollfd_index = SIZE_MAX;
478 }
479
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200480 if (server->tty.type == TTY_DEVICE_VUART) {
481 free(server->tty.vuart.sysfs_devnode);
Andrew Jeffery30ea6382023-05-03 16:56:10 +0930482 }
Alexander Hansen2325d5d2024-06-07 16:54:20 +0200483
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200484 free(server->tty.dev);
Jeremy Kerrd66195c2016-03-16 17:24:51 +0800485}
486
Zev Weiss7dc08ba2023-09-12 20:49:14 -0700487static int write_to_path(const char *path, const char *data)
488{
489 int rc = 0;
490 FILE *f = fopen(path, "w");
491 if (!f) {
492 return -1;
493 }
494
495 if (fprintf(f, "%s", data) < 0) {
496 rc = -1;
497 }
498
499 if (fclose(f)) {
500 rc = -1;
501 }
502
503 return rc;
504}
505
506#define ASPEED_UART_ROUTING_PATTERN \
507 "/sys/bus/platform/drivers/aspeed-uart-routing/*.uart-routing"
508
509static void uart_routing_init(struct config *config)
510{
511 const char *muxcfg;
512 const char *p;
513 size_t buflen;
514 char *sink;
515 char *source;
516 char *muxdir;
517 char *path;
518 glob_t globbuf;
519
520 muxcfg = config_get_value(config, "aspeed-uart-routing");
521 if (!muxcfg) {
522 return;
523 }
524
525 /* Find the driver's sysfs directory */
526 if (glob(ASPEED_UART_ROUTING_PATTERN, GLOB_ERR | GLOB_NOSORT, NULL,
527 &globbuf) != 0) {
528 warn("Couldn't find uart-routing driver directory, cannot apply config");
529 return;
530 }
531 if (globbuf.gl_pathc != 1) {
532 warnx("Found %zd uart-routing driver directories, cannot apply config",
533 globbuf.gl_pathc);
534 goto out_free_glob;
535 }
536 muxdir = globbuf.gl_pathv[0];
537
538 /*
539 * Rather than faff about tracking a bunch of separate buffer sizes,
540 * just use one (worst-case) size for all of them -- +2 for a trailing
541 * NUL and a '/' separator to construct the sysfs file path.
542 */
543 buflen = strlen(muxdir) + strlen(muxcfg) + 2;
544
545 sink = malloc(buflen);
546 source = malloc(buflen);
547 path = malloc(buflen);
548 if (!path || !sink || !source) {
549 warnx("Out of memory applying uart routing config");
550 goto out_free_bufs;
551 }
552
553 p = muxcfg;
554 while (*p) {
555 ssize_t bytes_scanned;
556
557 if (sscanf(p, " %[^:/ \t]:%[^: \t] %zn", sink, source,
558 &bytes_scanned) != 2) {
559 warnx("Invalid syntax in aspeed uart config: '%s' not applied",
560 p);
561 break;
562 }
563 p += bytes_scanned;
564
565 /*
566 * Check that the sink name looks reasonable before proceeding
567 * (there are other writable files in the same directory that
568 * we shouldn't be touching, such as 'driver_override' and
569 * 'uevent').
570 */
571 if (strncmp(sink, "io", strlen("io")) != 0 &&
572 strncmp(sink, "uart", strlen("uart")) != 0) {
573 warnx("Skipping invalid uart routing name '%s' (must be ioN or uartN)",
574 sink);
575 continue;
576 }
577
578 snprintf(path, buflen, "%s/%s", muxdir, sink);
579 if (write_to_path(path, source)) {
580 warn("Failed to apply uart-routing config '%s:%s'",
581 sink, source);
582 }
583 }
584
585out_free_bufs:
586 free(path);
587 free(source);
588 free(sink);
589out_free_glob:
590 globfree(&globbuf);
591}
592
Jeremy Kerr1a0e03b2016-03-08 17:57:11 +0800593int console_data_out(struct console *console, const uint8_t *data, size_t len)
Jeremy Kerrd831f962016-01-29 17:18:01 +0800594{
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +0200595 return write_buf_to_fd(console->server->tty.fd, data, len);
Jeremy Kerrd831f962016-01-29 17:18:01 +0800596}
597
Ninad Palsule5ba20b52023-05-12 14:03:15 -0500598/* Prepare a socket name */
Andrew Jeffery954be0f2023-05-03 21:01:59 +0930599static int set_socket_info(struct console *console, struct config *config,
600 const char *console_id)
Ninad Palsuleb14ca192023-03-31 09:49:00 -0500601{
602 ssize_t len;
603
Ninad Palsule5ba20b52023-05-12 14:03:15 -0500604 /* Get console id */
605 console->console_id = config_resolve_console_id(config, console_id);
Andrew Jeffery954be0f2023-05-03 21:01:59 +0930606
Ninad Palsuleb14ca192023-03-31 09:49:00 -0500607 /* Get the socket name/path */
Ninad Palsule5ba20b52023-05-12 14:03:15 -0500608 len = console_socket_path(console->socket_name, console->console_id);
Ninad Palsuleb14ca192023-03-31 09:49:00 -0500609 if (len < 0) {
610 warn("Failed to set socket path: %s", strerror(errno));
611 return EXIT_FAILURE;
612 }
613
614 /* Socket name is not a null terminated string hence save the length */
615 console->socket_name_len = len;
616
617 return 0;
618}
619
Jeremy Kerrd47963e2016-03-16 17:29:55 +0800620static void handlers_init(struct console *console, struct config *config)
Jeremy Kerrd831f962016-01-29 17:18:01 +0800621{
Andrew Jefferyb70f8712023-04-19 12:53:34 +0930622 /* NOLINTBEGIN(bugprone-reserved-identifier,cert-dcl37-c,cert-dcl51-cpp) */
Andrew Jefferyadedc332024-07-10 10:48:13 +0930623 extern const struct handler_type *const __start_handlers[];
624 extern const struct handler_type *const __stop_handlers[];
Andrew Jefferyb70f8712023-04-19 12:53:34 +0930625 /* NOLINTEND(bugprone-reserved-identifier,cert-dcl37-c,cert-dcl51-cpp) */
Jeremy Kerre2826c72024-07-05 10:54:21 +0800626 size_t n_types;
627 int j = 0;
628 size_t i;
Jeremy Kerrd831f962016-01-29 17:18:01 +0800629
Andrew Jefferyadedc332024-07-10 10:48:13 +0930630 n_types = __stop_handlers - __start_handlers;
Jeremy Kerre2826c72024-07-05 10:54:21 +0800631 console->handlers = calloc(n_types, sizeof(struct handler *));
632 if (!console->handlers) {
633 err(EXIT_FAILURE, "malloc(handlers)");
634 }
Jeremy Kerrd831f962016-01-29 17:18:01 +0800635
Andrew Jeffery079fc512024-07-09 16:51:56 +0930636 printf("%zu handler type%s\n", n_types, n_types == 1 ? "" : "s");
Jeremy Kerrd831f962016-01-29 17:18:01 +0800637
Jeremy Kerre2826c72024-07-05 10:54:21 +0800638 for (i = 0; i < n_types; i++) {
Andrew Jefferyadedc332024-07-10 10:48:13 +0930639 const struct handler_type *type = __start_handlers[i];
Jeremy Kerre2826c72024-07-05 10:54:21 +0800640 struct handler *handler;
Jeremy Kerr1a0e03b2016-03-08 17:57:11 +0800641
Jeremy Kerre2826c72024-07-05 10:54:21 +0800642 /* Should be picked up at build time by
643 * console_handler_register, but check anyway
644 */
645 if (!type->init || !type->fini) {
646 errx(EXIT_FAILURE,
647 "invalid handler type %s: no init() / fini()",
648 type->name);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930649 }
Jeremy Kerr021b91f2016-04-28 11:51:52 +0800650
Jeremy Kerre2826c72024-07-05 10:54:21 +0800651 handler = type->init(type, console, config);
Jeremy Kerr021b91f2016-04-28 11:51:52 +0800652
Jeremy Kerre2826c72024-07-05 10:54:21 +0800653 printf(" console '%s': handler %s [%sactive]\n",
654 console->console_id, type->name, handler ? "" : "in");
655
656 if (handler) {
657 handler->type = type;
658 console->handlers[j++] = handler;
659 }
Jeremy Kerrd831f962016-01-29 17:18:01 +0800660 }
Jeremy Kerre2826c72024-07-05 10:54:21 +0800661
662 console->n_handlers = j;
Jeremy Kerrd831f962016-01-29 17:18:01 +0800663}
664
Jeremy Kerr1a0e03b2016-03-08 17:57:11 +0800665static void handlers_fini(struct console *console)
Jeremy Kerrd831f962016-01-29 17:18:01 +0800666{
Jeremy Kerr1a0e03b2016-03-08 17:57:11 +0800667 struct handler *handler;
668 int i;
669
670 for (i = 0; i < console->n_handlers; i++) {
671 handler = console->handlers[i];
Jeremy Kerre2826c72024-07-05 10:54:21 +0800672 handler->type->fini(handler);
Jeremy Kerr1a0e03b2016-03-08 17:57:11 +0800673 }
Jeremy Kerre2826c72024-07-05 10:54:21 +0800674
675 free(console->handlers);
676 console->handlers = NULL;
677 console->n_handlers = 0;
Jeremy Kerrd831f962016-01-29 17:18:01 +0800678}
679
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800680static int get_current_time(struct timeval *tv)
681{
682 struct timespec t;
683 int rc;
684
685 /*
686 * We use clock_gettime(CLOCK_MONOTONIC) so we're immune to
687 * local time changes. However, a struct timeval is more
688 * convenient for calculations, so convert to that.
689 */
690 rc = clock_gettime(CLOCK_MONOTONIC, &t);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930691 if (rc) {
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800692 return rc;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930693 }
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800694
695 tv->tv_sec = t.tv_sec;
696 tv->tv_usec = t.tv_nsec / 1000;
697
698 return 0;
699}
700
Andrew Jefferya72711a2023-04-18 18:19:41 +0930701struct ringbuffer_consumer *
702console_ringbuffer_consumer_register(struct console *console,
703 ringbuffer_poll_fn_t poll_fn, void *data)
Jeremy Kerrd831f962016-01-29 17:18:01 +0800704{
Jeremy Kerrf733c852017-02-07 18:40:10 +0800705 return ringbuffer_consumer_register(console->rb, poll_fn, data);
Jeremy Kerrd831f962016-01-29 17:18:01 +0800706}
707
Jeremy Kerr55c97122017-02-07 17:06:46 +0800708struct poller *console_poller_register(struct console *console,
Andrew Jefferya72711a2023-04-18 18:19:41 +0930709 struct handler *handler,
710 poller_event_fn_t poller_fn,
711 poller_timeout_fn_t timeout_fn, int fd,
712 int events, void *data)
Jeremy Kerrd831f962016-01-29 17:18:01 +0800713{
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800714 struct poller *poller;
Andrew Jeffery5c359cc2023-04-18 22:50:07 +0930715 long n;
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800716
Alexander Hansen2325d5d2024-06-07 16:54:20 +0200717 const ssize_t index = console_server_request_pollfd(
718 console->server, fd, (short)(events & 0x7fff));
719 if (index < 0) {
720 fprintf(stderr, "Error requesting pollfd\n");
721 return NULL;
722 }
723
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800724 poller = malloc(sizeof(*poller));
Alexander Hansen2325d5d2024-06-07 16:54:20 +0200725 // TODO: check for error case of malloc here and release previously requested pollfd
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800726 poller->remove = false;
727 poller->handler = handler;
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800728 poller->event_fn = poller_fn;
729 poller->timeout_fn = timeout_fn;
Andrew Jeffery9cc84592024-07-09 15:44:30 +0930730 timerclear(&poller->timeout);
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800731 poller->data = data;
Alexander Hansen2325d5d2024-06-07 16:54:20 +0200732 poller->pollfd_index = index;
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800733
734 /* add one to our pollers array */
735 n = console->n_pollers++;
Andrew Jeffery91b52172023-04-19 12:42:14 +0930736 /*
737 * We're managing an array of pointers to aggregates, so don't warn about sizeof() on a
738 * pointer type.
739 */
740 /* NOLINTBEGIN(bugprone-sizeof-expression) */
741 console->pollers = reallocarray(console->pollers, console->n_pollers,
742 sizeof(*console->pollers));
Alexander Hansen2325d5d2024-06-07 16:54:20 +0200743 // TODO: check for the error case of reallocarray and release previously requested pollfd
Andrew Jeffery91b52172023-04-19 12:42:14 +0930744 /* NOLINTEND(bugprone-sizeof-expression) */
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800745
746 console->pollers[n] = poller;
747
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800748 return poller;
749}
750
Andrew Jefferya72711a2023-04-18 18:19:41 +0930751void console_poller_unregister(struct console *console, struct poller *poller)
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800752{
753 int i;
754
755 /* find the entry in our pollers array */
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930756 for (i = 0; i < console->n_pollers; i++) {
757 if (console->pollers[i] == poller) {
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800758 break;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930759 }
760 }
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800761
762 assert(i < console->n_pollers);
763
764 console->n_pollers--;
765
Andrew Jeffery91b52172023-04-19 12:42:14 +0930766 /*
767 * Remove the item from the pollers array...
768 *
769 * We're managing an array of pointers to aggregates, so don't warn about sizeof() on a
770 * pointer type.
771 */
772 /* NOLINTBEGIN(bugprone-sizeof-expression) */
Andrew Jefferya72711a2023-04-18 18:19:41 +0930773 memmove(&console->pollers[i], &console->pollers[i + 1],
774 sizeof(*console->pollers) * (console->n_pollers - i));
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800775
Andrew Jeffery7851a392024-07-09 16:30:22 +0930776 if (console->n_pollers == 0) {
777 free(console->pollers);
778 console->pollers = NULL;
779 } else {
780 console->pollers = reallocarray(console->pollers,
781 console->n_pollers,
782 sizeof(*console->pollers));
783 }
Andrew Jeffery91b52172023-04-19 12:42:14 +0930784 /* NOLINTEND(bugprone-sizeof-expression) */
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800785
Alexander Hansen2325d5d2024-06-07 16:54:20 +0200786 console_server_release_pollfd(console->server, poller->pollfd_index);
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800787
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800788 free(poller);
789}
790
Jeremy Kerr6b1fed22017-02-07 21:40:38 +0800791void console_poller_set_events(struct console *console, struct poller *poller,
Andrew Jefferya72711a2023-04-18 18:19:41 +0930792 int events)
Jeremy Kerr6b1fed22017-02-07 21:40:38 +0800793{
Alexander Hansen2325d5d2024-06-07 16:54:20 +0200794 console->server->pollfds[poller->pollfd_index].events =
795 (short)(events & 0x7fff);
Jeremy Kerr6b1fed22017-02-07 21:40:38 +0800796}
797
Andrew Jefferyfd048322023-04-18 12:02:01 +0930798void console_poller_set_timeout(struct console *console __attribute__((unused)),
Andrew Jefferya72711a2023-04-18 18:19:41 +0930799 struct poller *poller, const struct timeval *tv)
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800800{
801 struct timeval now;
802 int rc;
803
804 rc = get_current_time(&now);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930805 if (rc) {
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800806 return;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930807 }
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800808
809 timeradd(&now, tv, &poller->timeout);
810}
811
Andrew Jeffery5c359cc2023-04-18 22:50:07 +0930812static long get_poll_timeout(struct console *console, struct timeval *cur_time)
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800813{
Andrew Jefferyb70f8712023-04-19 12:53:34 +0930814 struct timeval *earliest;
815 struct timeval interval;
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800816 struct poller *poller;
817 int i;
818
819 earliest = NULL;
820
821 for (i = 0; i < console->n_pollers; i++) {
822 poller = console->pollers[i];
823
824 if (poller->timeout_fn && timerisset(&poller->timeout) &&
825 (!earliest ||
Andrew Jefferya72711a2023-04-18 18:19:41 +0930826 (earliest && timercmp(&poller->timeout, earliest, <)))) {
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800827 // poller is buffering data and needs the poll
828 // function to timeout.
829 earliest = &poller->timeout;
830 }
831 }
832
833 if (earliest) {
834 if (timercmp(earliest, cur_time, >)) {
835 /* recalculate the timeout period, time period has
836 * not elapsed */
837 timersub(earliest, cur_time, &interval);
838 return ((interval.tv_sec * 1000) +
839 (interval.tv_usec / 1000));
Andrew Jeffery0b7b0472023-04-19 12:48:51 +0930840 } /* return from poll immediately */
841 return 0;
842
843 } /* poll indefinitely */
844 return -1;
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800845}
846
847static int call_pollers(struct console *console, struct timeval *cur_time)
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800848{
849 struct poller *poller;
850 struct pollfd *pollfd;
851 enum poller_ret prc;
Andrew Jefferyb70f8712023-04-19 12:53:34 +0930852 int i;
853 int rc;
Jeremy Kerrd831f962016-01-29 17:18:01 +0800854
Jeremy Kerr1a0e03b2016-03-08 17:57:11 +0800855 rc = 0;
856
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800857 /*
858 * Process poll events by iterating through the pollers and pollfds
859 * in-step, calling any pollers that we've found revents for.
860 */
861 for (i = 0; i < console->n_pollers; i++) {
862 poller = console->pollers[i];
Alexander Hansen2325d5d2024-06-07 16:54:20 +0200863 pollfd = &console->server->pollfds[poller->pollfd_index];
864 if (pollfd->fd < 0) {
865 // pollfd has already been released
866 continue;
867 }
868
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800869 prc = POLLER_OK;
Jeremy Kerr1a0e03b2016-03-08 17:57:11 +0800870
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800871 /* process pending events... */
872 if (pollfd->revents) {
873 prc = poller->event_fn(poller->handler, pollfd->revents,
Andrew Jefferya72711a2023-04-18 18:19:41 +0930874 poller->data);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930875 if (prc == POLLER_EXIT) {
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800876 rc = -1;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930877 } else if (prc == POLLER_REMOVE) {
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800878 poller->remove = true;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930879 }
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800880 }
Jeremy Kerr1a0e03b2016-03-08 17:57:11 +0800881
Johnathan Mantey1cecc5d2019-02-28 15:01:46 -0800882 if ((prc == POLLER_OK) && poller->timeout_fn &&
883 timerisset(&poller->timeout) &&
884 timercmp(&poller->timeout, cur_time, <=)) {
885 /* One of the ringbuffer consumers is buffering the
886 data stream. The amount of idle time the consumer
887 desired has expired. Process the buffered data for
888 transmission. */
889 timerclear(&poller->timeout);
890 prc = poller->timeout_fn(poller->handler, poller->data);
891 if (prc == POLLER_EXIT) {
892 rc = -1;
893 } else if (prc == POLLER_REMOVE) {
894 poller->remove = true;
895 }
896 }
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800897 }
898
899 /**
900 * Process deferred removals; restarting each time we unregister, as
901 * the array will have changed
902 */
903 for (;;) {
904 bool removed = false;
905
906 for (i = 0; i < console->n_pollers; i++) {
907 poller = console->pollers[i];
908 if (poller->remove) {
Jeremy Kerr55c97122017-02-07 17:06:46 +0800909 console_poller_unregister(console, poller);
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800910 removed = true;
911 break;
912 }
913 }
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930914 if (!removed) {
Jeremy Kerr329a35f2016-03-10 15:36:01 +0800915 break;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930916 }
Jeremy Kerr1a0e03b2016-03-08 17:57:11 +0800917 }
918
919 return rc;
920}
921
Jeremy Kerr769cee12016-03-15 17:53:56 +0800922static void sighandler(int signal)
923{
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930924 if (signal == SIGINT) {
Andrew Jeffery553cb662024-07-09 15:14:56 +0930925 sigint = 1;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +0930926 }
Jeremy Kerr769cee12016-03-15 17:53:56 +0800927}
928
Alexander Hansen312ecdc2024-07-10 15:33:37 +0200929static int run_console_per_console(struct console *console, size_t buf_size,
930 struct timeval *tv)
Jeremy Kerr1a0e03b2016-03-08 17:57:11 +0800931{
Alexander Hansen312ecdc2024-07-10 15:33:37 +0200932 int rc;
Jeremy Kerr769cee12016-03-15 17:53:56 +0800933
Alexander Hansen312ecdc2024-07-10 15:33:37 +0200934 if (console->rb->size < buf_size) {
Alexander Hansen69257402024-06-07 15:17:09 +0200935 fprintf(stderr, "Ringbuffer size should be greater than %zuB\n",
Alexander Hansen312ecdc2024-07-10 15:33:37 +0200936 buf_size);
Alexander Hansen69257402024-06-07 15:17:09 +0200937 return -1;
938 }
939
940 if (sigint) {
Alexander Hansen312ecdc2024-07-10 15:33:37 +0200941 warnx("Received interrupt, exiting\n");
Alexander Hansen69257402024-06-07 15:17:09 +0200942 return -1;
943 }
944
Alexander Hansen312ecdc2024-07-10 15:33:37 +0200945 /* ... and then the pollers */
946 rc = call_pollers(console, tv);
947 if (rc) {
948 return -1;
949 }
950
951 return 0;
952}
953
954static int run_console_iteration(struct console_server *server)
955{
956 struct timeval tv;
957 uint8_t buf[4096];
958 long timeout;
959 ssize_t rc;
960
Alexander Hansen69257402024-06-07 15:17:09 +0200961 rc = get_current_time(&tv);
962 if (rc) {
963 warn("Failed to read current time");
964 return -1;
965 }
966
Alexander Hansen312ecdc2024-07-10 15:33:37 +0200967 timeout = get_poll_timeout(server->active, &tv);
Alexander Hansen69257402024-06-07 15:17:09 +0200968
Alexander Hansen312ecdc2024-07-10 15:33:37 +0200969 rc = poll(server->pollfds, server->capacity_pollfds, (int)timeout);
970
971 if (sigint) {
972 warnx("Received interrupt, exiting\n");
973 return -1;
974 }
Alexander Hansen69257402024-06-07 15:17:09 +0200975
976 if (rc < 0) {
977 if (errno == EINTR) {
978 return 0;
979 }
980 warn("poll error");
981 return -1;
982 }
983
984 /* process internal fd first */
Alexander Hansen312ecdc2024-07-10 15:33:37 +0200985 if (server->pollfds[server->tty_pollfd_index].revents) {
986 rc = read(server->tty.fd, buf, sizeof(buf));
Alexander Hansen69257402024-06-07 15:17:09 +0200987 if (rc <= 0) {
988 warn("Error reading from tty device");
989 return -1;
990 }
Alexander Hansen312ecdc2024-07-10 15:33:37 +0200991
992 rc = ringbuffer_queue(server->active->rb, buf, rc);
Alexander Hansen69257402024-06-07 15:17:09 +0200993 if (rc) {
994 return -1;
995 }
996 }
997
Alexander Hansen312ecdc2024-07-10 15:33:37 +0200998 // process dbus
999 struct pollfd *dbus_pollfd =
1000 &(server->pollfds[server->dbus_pollfd_index]);
1001 if (dbus_pollfd->revents) {
1002 sd_bus_process(server->bus, NULL);
Alexander Hansen69257402024-06-07 15:17:09 +02001003 }
1004
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001005 for (size_t i = 0; i < server->n_consoles; i++) {
1006 struct console *console = server->consoles[i];
1007
1008 rc = run_console_per_console(console, sizeof(buf), &tv);
1009 if (rc != 0) {
1010 return -1;
1011 }
Alexander Hansen69257402024-06-07 15:17:09 +02001012 }
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001013
Alexander Hansen69257402024-06-07 15:17:09 +02001014 return 0;
1015}
1016
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001017int run_server(struct console_server *server)
Alexander Hansen69257402024-06-07 15:17:09 +02001018{
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001019 sighandler_t sighandler_save;
Alexander Hansen69257402024-06-07 15:17:09 +02001020 ssize_t rc = 0;
Jeremy Kerr769cee12016-03-15 17:53:56 +08001021
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001022 if (server->n_consoles == 0) {
1023 warnx("no console configured for this server");
1024 return -1;
1025 }
1026
1027 sighandler_save = signal(SIGINT, sighandler);
Jeremy Kerrd831f962016-01-29 17:18:01 +08001028 for (;;) {
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001029 rc = run_console_iteration(server);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +09301030 if (rc) {
Jeremy Kerr769cee12016-03-15 17:53:56 +08001031 break;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +09301032 }
Jeremy Kerrd831f962016-01-29 17:18:01 +08001033 }
Jeremy Kerr769cee12016-03-15 17:53:56 +08001034 signal(SIGINT, sighandler_save);
1035
1036 return rc ? -1 : 0;
Jeremy Kerrd831f962016-01-29 17:18:01 +08001037}
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001038
Jeremy Kerrd831f962016-01-29 17:18:01 +08001039static const struct option options[] = {
Andrew Jefferya72711a2023-04-18 18:19:41 +09301040 { "config", required_argument, 0, 'c' },
Andrew Jeffery954be0f2023-05-03 21:01:59 +09301041 { "console-id", required_argument, 0, 'i' },
Andrew Jefferya72711a2023-04-18 18:19:41 +09301042 { 0, 0, 0, 0 },
Jeremy Kerrd831f962016-01-29 17:18:01 +08001043};
1044
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001045static struct console *console_init(struct console_server *server,
1046 struct config *config,
1047 const char *console_id)
Jeremy Kerrd831f962016-01-29 17:18:01 +08001048{
Medicine Yeh7f2bfb92024-03-10 23:19:41 -07001049 size_t buffer_size = default_buffer_size;
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001050 const char *buffer_size_str = NULL;
1051 int rc;
1052
1053 struct console *console = calloc(1, sizeof(struct console));
1054 if (console == NULL) {
1055 return NULL;
1056 }
1057
1058 console->server = server;
1059 console->console_id = console_id;
1060
1061 buffer_size_str =
1062 config_get_section_value(config, console_id, "ringbuffer-size");
1063
1064 if (!buffer_size_str) {
1065 buffer_size_str = config_get_value(config, "ringbuffer-size");
1066 }
1067
1068 if (buffer_size_str) {
1069 rc = config_parse_bytesize(buffer_size_str, &buffer_size);
1070 if (rc) {
1071 warn("Invalid ringbuffer-size. Default to %zukB",
1072 buffer_size >> 10);
1073 }
1074 }
1075
1076 console->rb = ringbuffer_init(buffer_size);
1077 if (!console->rb) {
1078 goto cleanup_console;
1079 }
1080
Alexander Hansena6b29102024-07-10 15:33:37 +02001081 rc = console_mux_init(console, config);
1082 if (rc) {
1083 warnx("could not set mux gpios from config, exiting");
1084 goto cleanup_rb;
1085 }
1086
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001087 if (set_socket_info(console, config, console_id)) {
1088 warnx("set_socket_info failed");
1089 goto cleanup_rb;
1090 }
1091
1092 rc = dbus_init(console, config);
1093 if (rc != 0) {
1094 goto cleanup_rb;
1095 }
1096
1097 handlers_init(console, config);
1098
1099 return console;
1100
1101cleanup_rb:
1102 free(console->rb);
1103cleanup_console:
1104 free(console);
1105
1106 return NULL;
1107}
1108
1109static void console_fini(struct console *console)
1110{
1111 handlers_fini(console);
1112 ringbuffer_fini(console->rb);
1113 free(console->pollers);
1114 free(console);
1115}
1116
1117// 'opt_console_id' may be NULL
1118static int console_server_add_console(struct console_server *server,
1119 struct config *config,
1120 const char *opt_console_id)
1121{
1122 const char *console_id;
1123 struct console *console;
1124
1125 console_id = config_resolve_console_id(config, opt_console_id);
1126
1127 struct console **tmp = reallocarray(server->consoles,
1128 server->n_consoles + 1,
1129 sizeof(struct console *));
1130 if (tmp == NULL) {
1131 warnx("could not realloc server->consoles");
1132 return -1;
1133 }
1134 server->consoles = tmp;
1135
1136 console = console_init(server, config, console_id);
1137 if (console == NULL) {
1138 warnx("console_init failed");
1139 return -1;
1140 }
1141
1142 server->consoles[server->n_consoles++] = console;
1143
1144 return 0;
1145}
1146
1147// returns NULL on error
1148static struct console *
1149console_server_add_consoles(struct console_server *server,
1150 const char *arg_console_id)
1151{
1152 int rc;
1153
1154 const int nsections = config_count_sections(server->config);
1155 if (nsections < 0) {
1156 return NULL;
1157 }
1158
1159 if (nsections == 0) {
1160 const char *console_id = arg_console_id;
1161
1162 rc = console_server_add_console(server, server->config,
1163 console_id);
1164 if (rc != 0) {
1165 return NULL;
1166 }
1167 }
1168
1169 for (int i = 0; i < nsections; i++) {
1170 const char *console_id =
1171 config_get_section_name(server->config, i);
1172
1173 if (console_id == NULL) {
1174 warnx("no console id provided\n");
1175 return NULL;
1176 }
1177
1178 rc = console_server_add_console(server, server->config,
1179 console_id);
1180 if (rc != 0) {
1181 return NULL;
1182 }
1183 }
1184
1185 const char *initially_active =
1186 config_get_value(server->config, "active-console");
1187 if (!initially_active) {
1188 return server->consoles[0];
1189 }
1190
1191 printf("setting console-id '%s' as the initially active console\n",
1192 initially_active);
1193
1194 for (size_t i = 0; i < server->n_consoles; i++) {
1195 struct console *console = server->consoles[i];
1196
1197 if (strcmp(console->console_id, initially_active) == 0) {
1198 return console;
1199 }
1200 }
1201
1202 warnx("'active-console' '%s' not found among console ids\n",
1203 initially_active);
1204
1205 return NULL;
1206}
1207
1208int console_server_init(struct console_server *server,
1209 const char *config_filename,
1210 const char *config_tty_kname, const char *console_id)
1211{
1212 int rc;
1213 memset(server, 0, sizeof(struct console_server));
1214
1215 server->tty_pollfd_index = -1;
1216
1217 server->config = config_init(config_filename);
1218 if (server->config == NULL) {
1219 return -1;
1220 }
1221
Alexander Hansena6b29102024-07-10 15:33:37 +02001222 rc = console_server_mux_init(server);
1223 if (rc != 0) {
1224 return -1;
1225 }
1226
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001227 uart_routing_init(server->config);
1228
1229 rc = tty_init(server, server->config, config_tty_kname);
1230 if (rc != 0) {
1231 warnx("error during tty_init, exiting.\n");
1232 return -1;
1233 }
1234
1235 rc = dbus_server_init(server);
1236 if (rc != 0) {
1237 warnx("error during dbus init for console server");
1238 return -1;
1239 }
1240
Alexander Hansena6b29102024-07-10 15:33:37 +02001241 struct console *initial_active =
1242 console_server_add_consoles(server, console_id);
1243 if (initial_active == NULL) {
1244 return -1;
1245 }
1246
1247 rc = console_mux_activate(initial_active);
1248 if (rc != 0) {
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001249 return -1;
1250 }
1251
1252 return 0;
1253}
1254
1255void console_server_fini(struct console_server *server)
1256{
1257 for (size_t i = 0; i < server->n_consoles; i++) {
1258 console_fini(server->consoles[i]);
1259 }
1260
1261 free(server->consoles);
1262 dbus_server_fini(server);
1263 tty_fini(server);
1264 free(server->pollfds);
Alexander Hansena6b29102024-07-10 15:33:37 +02001265 console_server_mux_fini(server);
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001266 config_fini(server->config);
1267}
1268
1269int main(int argc, char **argv)
1270{
Jeremy Kerrd66195c2016-03-16 17:24:51 +08001271 const char *config_filename = NULL;
Vishwanatha Subbanna6221ce92016-07-20 05:35:45 -05001272 const char *config_tty_kname = NULL;
Andrew Jeffery954be0f2023-05-03 21:01:59 +09301273 const char *console_id = NULL;
Alexander Hansenc2b0d8c2024-06-07 14:35:44 +02001274 struct console_server server = { 0 };
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001275 int rc = 0;
Jeremy Kerrd831f962016-01-29 17:18:01 +08001276
Jeremy Kerrd831f962016-01-29 17:18:01 +08001277 for (;;) {
Andrew Jefferyb70f8712023-04-19 12:53:34 +09301278 int c;
1279 int idx;
Jeremy Kerrd831f962016-01-29 17:18:01 +08001280
Andrew Jeffery954be0f2023-05-03 21:01:59 +09301281 c = getopt_long(argc, argv, "c:i:", options, &idx);
Andrew Jeffery2834c5b2023-04-19 12:47:09 +09301282 if (c == -1) {
Jeremy Kerrd831f962016-01-29 17:18:01 +08001283 break;
Andrew Jeffery2834c5b2023-04-19 12:47:09 +09301284 }
Jeremy Kerrd831f962016-01-29 17:18:01 +08001285
1286 switch (c) {
Jeremy Kerrd66195c2016-03-16 17:24:51 +08001287 case 'c':
1288 config_filename = optarg;
Jeremy Kerrd831f962016-01-29 17:18:01 +08001289 break;
Andrew Jeffery954be0f2023-05-03 21:01:59 +09301290 case 'i':
1291 console_id = optarg;
1292 break;
Jeremy Kerrd831f962016-01-29 17:18:01 +08001293 case 'h':
1294 case '?':
1295 usage(argv[0]);
Jeremy Kerrd66195c2016-03-16 17:24:51 +08001296 return EXIT_SUCCESS;
Jeremy Kerrd831f962016-01-29 17:18:01 +08001297 }
1298 }
1299
Andrew Jeffery2834c5b2023-04-19 12:47:09 +09301300 if (optind < argc) {
Andrew Jeffery91dde142020-02-12 22:46:27 +10301301 config_tty_kname = argv[optind];
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001302 } else {
1303 errx(EXIT_FAILURE, "no tty device path has been provided\n");
Andrew Jeffery2834c5b2023-04-19 12:47:09 +09301304 }
Vishwanatha Subbanna6221ce92016-07-20 05:35:45 -05001305
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001306 rc = console_server_init(&server, config_filename, config_tty_kname,
1307 console_id);
1308
1309 if (rc == 0) {
1310 rc = run_server(&server);
Andrew Jeffery28a17612024-07-10 09:32:05 +09301311 }
Medicine Yeh7f2bfb92024-03-10 23:19:41 -07001312
Alexander Hansen312ecdc2024-07-10 15:33:37 +02001313 console_server_fini(&server);
Andrew Jeffery28a17612024-07-10 09:32:05 +09301314
Jeremy Kerrd831f962016-01-29 17:18:01 +08001315 return rc == 0 ? EXIT_SUCCESS : EXIT_FAILURE;
1316}