source: mainline/uspace/lib/c/generic/io/con_srv.c@ 552b69f

serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 552b69f was b48e680f, checked in by Jiri Svoboda <jiri@…>, 4 years ago

Allow console application to set the terminal window caption
  • Property mode set to 100644
File size: 11.3 KB
Line 
1/*
2 * Copyright (c) 2021 Jiri Svoboda
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup libc
30 * @{
31 */
32/**
33 * @file
34 * @brief Console protocol server stub
35 */
36#include <as.h>
37#include <errno.h>
38#include <io/cons_event.h>
39#include <ipc/console.h>
40#include <stdlib.h>
41#include <stddef.h>
42
43#include <io/con_srv.h>
44
45static errno_t console_ev_encode(cons_event_t *event, ipc_call_t *icall)
46{
47 ipc_set_arg1(icall, event->type);
48
49 switch (event->type) {
50 case CEV_KEY:
51 ipc_set_arg2(icall, event->ev.key.type);
52 ipc_set_arg3(icall, event->ev.key.key);
53 ipc_set_arg4(icall, event->ev.key.mods);
54 ipc_set_arg5(icall, event->ev.key.c);
55 break;
56 case CEV_POS:
57 ipc_set_arg2(icall, (event->ev.pos.pos_id << 16) | (event->ev.pos.type & 0xffff));
58 ipc_set_arg3(icall, event->ev.pos.btn_num);
59 ipc_set_arg4(icall, event->ev.pos.hpos);
60 ipc_set_arg5(icall, event->ev.pos.vpos);
61 break;
62 default:
63 return EIO;
64 }
65
66 return EOK;
67}
68
69static void con_read_srv(con_srv_t *srv, ipc_call_t *icall)
70{
71 void *buf;
72 size_t size;
73 errno_t rc;
74
75 ipc_call_t call;
76 if (!async_data_read_receive(&call, &size)) {
77 async_answer_0(icall, EINVAL);
78 return;
79 }
80
81 buf = malloc(size);
82 if (buf == NULL) {
83 async_answer_0(&call, ENOMEM);
84 async_answer_0(icall, ENOMEM);
85 return;
86 }
87
88 if (srv->srvs->ops->read == NULL) {
89 async_answer_0(&call, ENOTSUP);
90 async_answer_0(icall, ENOTSUP);
91 free(buf);
92 return;
93 }
94
95 size_t nread;
96 rc = srv->srvs->ops->read(srv, buf, size, &nread);
97 if (rc != EOK) {
98 async_answer_0(&call, rc);
99 async_answer_0(icall, rc);
100 free(buf);
101 return;
102 }
103
104 async_data_read_finalize(&call, buf, nread);
105 free(buf);
106
107 async_answer_1(icall, EOK, nread);
108}
109
110static void con_write_srv(con_srv_t *srv, ipc_call_t *icall)
111{
112 void *data;
113 size_t size;
114 errno_t rc;
115
116 rc = async_data_write_accept(&data, false, 0, 0, 0, &size);
117 if (rc != EOK) {
118 async_answer_0(icall, rc);
119 return;
120 }
121
122 if (srv->srvs->ops->write == NULL) {
123 async_answer_0(icall, ENOTSUP);
124 return;
125 }
126
127 size_t nwritten = 0;
128 rc = srv->srvs->ops->write(srv, data, size, &nwritten);
129 free(data);
130
131 async_answer_1(icall, rc, nwritten);
132}
133
134static void con_sync_srv(con_srv_t *srv, ipc_call_t *icall)
135{
136 if (srv->srvs->ops->sync == NULL) {
137 async_answer_0(icall, ENOTSUP);
138 return;
139 }
140
141 srv->srvs->ops->sync(srv);
142 async_answer_0(icall, EOK);
143}
144
145static void con_clear_srv(con_srv_t *srv, ipc_call_t *icall)
146{
147 if (srv->srvs->ops->clear == NULL) {
148 async_answer_0(icall, ENOTSUP);
149 return;
150 }
151
152 srv->srvs->ops->clear(srv);
153 async_answer_0(icall, EOK);
154}
155
156static void con_set_pos_srv(con_srv_t *srv, ipc_call_t *icall)
157{
158 sysarg_t col;
159 sysarg_t row;
160
161 col = ipc_get_arg1(icall);
162 row = ipc_get_arg2(icall);
163
164 if (srv->srvs->ops->set_pos == NULL) {
165 async_answer_0(icall, ENOTSUP);
166 return;
167 }
168
169 srv->srvs->ops->set_pos(srv, col, row);
170 async_answer_0(icall, EOK);
171}
172
173static void con_get_pos_srv(con_srv_t *srv, ipc_call_t *icall)
174{
175 errno_t rc;
176 sysarg_t col;
177 sysarg_t row;
178
179 if (srv->srvs->ops->get_pos == NULL) {
180 async_answer_0(icall, ENOTSUP);
181 return;
182 }
183
184 rc = srv->srvs->ops->get_pos(srv, &col, &row);
185 async_answer_2(icall, rc, col, row);
186}
187
188static void con_get_size_srv(con_srv_t *srv, ipc_call_t *icall)
189{
190 errno_t rc;
191 sysarg_t cols;
192 sysarg_t rows;
193
194 if (srv->srvs->ops->get_size == NULL) {
195 async_answer_0(icall, ENOTSUP);
196 return;
197 }
198
199 rc = srv->srvs->ops->get_size(srv, &cols, &rows);
200 async_answer_2(icall, rc, cols, rows);
201}
202
203static void con_get_color_cap_srv(con_srv_t *srv, ipc_call_t *icall)
204{
205 errno_t rc;
206 console_caps_t ccap;
207
208 if (srv->srvs->ops->get_color_cap == NULL) {
209 async_answer_0(icall, ENOTSUP);
210 return;
211 }
212
213 rc = srv->srvs->ops->get_color_cap(srv, &ccap);
214 async_answer_1(icall, rc, (sysarg_t)ccap);
215}
216
217static void con_set_style_srv(con_srv_t *srv, ipc_call_t *icall)
218{
219 console_style_t style;
220
221 style = ipc_get_arg1(icall);
222
223 if (srv->srvs->ops->set_style == NULL) {
224 async_answer_0(icall, ENOTSUP);
225 return;
226 }
227
228 srv->srvs->ops->set_style(srv, style);
229 async_answer_0(icall, EOK);
230}
231
232static void con_set_color_srv(con_srv_t *srv, ipc_call_t *icall)
233{
234 console_color_t bgcolor;
235 console_color_t fgcolor;
236 console_color_attr_t flags;
237
238 bgcolor = ipc_get_arg1(icall);
239 fgcolor = ipc_get_arg2(icall);
240 flags = ipc_get_arg3(icall);
241
242 if (srv->srvs->ops->set_color == NULL) {
243 async_answer_0(icall, ENOTSUP);
244 return;
245 }
246
247 srv->srvs->ops->set_color(srv, bgcolor, fgcolor, flags);
248 async_answer_0(icall, EOK);
249}
250
251static void con_set_rgb_color_srv(con_srv_t *srv, ipc_call_t *icall)
252{
253 pixel_t bgcolor;
254 pixel_t fgcolor;
255
256 bgcolor = ipc_get_arg1(icall);
257 fgcolor = ipc_get_arg2(icall);
258
259 if (srv->srvs->ops->set_rgb_color == NULL) {
260 async_answer_0(icall, ENOTSUP);
261 return;
262 }
263
264 srv->srvs->ops->set_rgb_color(srv, bgcolor, fgcolor);
265 async_answer_0(icall, EOK);
266}
267
268static void con_set_cursor_visibility_srv(con_srv_t *srv, ipc_call_t *icall)
269{
270 bool show;
271
272 show = ipc_get_arg1(icall);
273
274 if (srv->srvs->ops->set_cursor_visibility == NULL) {
275 async_answer_0(icall, ENOTSUP);
276 return;
277 }
278
279 srv->srvs->ops->set_cursor_visibility(srv, show);
280 async_answer_0(icall, EOK);
281}
282
283static void con_set_caption_srv(con_srv_t *srv, ipc_call_t *icall)
284{
285 char *caption;
286 errno_t rc;
287
288 rc = async_data_write_accept((void **) &caption, true, 0,
289 CON_CAPTION_MAXLEN, 0, NULL);
290 if (rc != EOK) {
291 async_answer_0(icall, rc);
292 return;
293 }
294
295 if (srv->srvs->ops->set_caption == NULL) {
296 async_answer_0(icall, ENOTSUP);
297 return;
298 }
299
300 srv->srvs->ops->set_caption(srv, caption);
301 free(caption);
302 async_answer_0(icall, EOK);
303}
304
305static void con_get_event_srv(con_srv_t *srv, ipc_call_t *icall)
306{
307 errno_t rc;
308 cons_event_t event;
309 ipc_call_t result;
310
311 if (srv->srvs->ops->get_event == NULL) {
312 async_answer_0(icall, ENOTSUP);
313 return;
314 }
315
316 rc = srv->srvs->ops->get_event(srv, &event);
317 if (rc != EOK) {
318 async_answer_0(icall, rc);
319 return;
320 }
321
322 rc = console_ev_encode(&event, &result);
323 if (rc != EOK) {
324 async_answer_0(icall, rc);
325 return;
326 }
327
328 async_answer_5(icall, rc, ipc_get_arg1(&result), ipc_get_arg2(&result),
329 ipc_get_arg3(&result), ipc_get_arg4(&result), ipc_get_arg5(&result));
330}
331
332/** Create shared buffer for efficient rendering */
333static void con_map_srv(con_srv_t *srv, ipc_call_t *icall)
334{
335 errno_t rc;
336 charfield_t *buf;
337 sysarg_t cols, rows;
338 ipc_call_t call;
339 size_t size;
340
341 if (srv->srvs->ops->map == NULL || srv->srvs->ops->unmap == NULL) {
342 async_answer_0(icall, ENOTSUP);
343 return;
344 }
345
346 cols = ipc_get_arg1(icall);
347 rows = ipc_get_arg2(icall);
348
349 if (!async_share_in_receive(&call, &size)) {
350 async_answer_0(icall, EINVAL);
351 return;
352 }
353
354 /* Check size */
355 if (size != PAGES2SIZE(SIZE2PAGES(cols * rows * sizeof(charfield_t)))) {
356 async_answer_0(&call, EINVAL);
357 async_answer_0(icall, EINVAL);
358 return;
359 }
360
361 rc = srv->srvs->ops->map(srv, cols, rows, &buf);
362 if (rc != EOK) {
363 async_answer_0(&call, rc);
364 async_answer_0(icall, rc);
365 return;
366 }
367
368 rc = async_share_in_finalize(&call, buf, AS_AREA_READ |
369 AS_AREA_WRITE | AS_AREA_CACHEABLE);
370 if (rc != EOK) {
371 srv->srvs->ops->unmap(srv);
372 async_answer_0(icall, EIO);
373 return;
374 }
375
376 async_answer_0(icall, EOK);
377}
378
379/** Delete shared buffer */
380static void con_unmap_srv(con_srv_t *srv, ipc_call_t *icall)
381{
382 if (srv->srvs->ops->unmap == NULL) {
383 async_answer_0(icall, ENOTSUP);
384 return;
385 }
386
387 srv->srvs->ops->unmap(srv);
388 async_answer_0(icall, EOK);
389}
390
391/** Update console area from shared buffer */
392static void con_update_srv(con_srv_t *srv, ipc_call_t *icall)
393{
394 sysarg_t c0, r0, c1, r1;
395
396 c0 = ipc_get_arg1(icall);
397 r0 = ipc_get_arg2(icall);
398 c1 = ipc_get_arg3(icall);
399 r1 = ipc_get_arg4(icall);
400
401 if (srv->srvs->ops->update == NULL) {
402 async_answer_0(icall, ENOTSUP);
403 return;
404 }
405
406 srv->srvs->ops->update(srv, c0, r0, c1, r1);
407 async_answer_0(icall, EOK);
408}
409
410static con_srv_t *con_srv_create(con_srvs_t *srvs)
411{
412 con_srv_t *srv;
413
414 srv = calloc(1, sizeof(*srv));
415 if (srv == NULL)
416 return NULL;
417
418 srv->srvs = srvs;
419 return srv;
420}
421
422void con_srvs_init(con_srvs_t *srvs)
423{
424 srvs->ops = NULL;
425 srvs->sarg = NULL;
426 srvs->abort_timeout = 0;
427 srvs->aborted = false;
428}
429
430errno_t con_conn(ipc_call_t *icall, con_srvs_t *srvs)
431{
432 con_srv_t *srv;
433 errno_t rc;
434
435 /* Accept the connection */
436 async_accept_0(icall);
437
438 srv = con_srv_create(srvs);
439 if (srv == NULL)
440 return ENOMEM;
441
442 srv->client_sess = NULL;
443
444 rc = srvs->ops->open(srvs, srv);
445 if (rc != EOK)
446 return rc;
447
448 while (true) {
449 ipc_call_t call;
450 bool received = false;
451
452 while (!received) {
453 /* XXX Need to be able to abort immediately */
454 received = async_get_call_timeout(&call,
455 srvs->abort_timeout);
456
457 if (srv->srvs->aborted) {
458 if (received)
459 async_answer_0(&call, EINTR);
460 break;
461 }
462 }
463
464 if (!received)
465 break;
466
467 sysarg_t method = ipc_get_imethod(&call);
468
469 if (!method) {
470 /* The other side has hung up */
471 async_answer_0(&call, EOK);
472 break;
473 }
474
475 switch (method) {
476 case VFS_OUT_READ:
477 con_read_srv(srv, &call);
478 break;
479 case VFS_OUT_WRITE:
480 con_write_srv(srv, &call);
481 break;
482 case VFS_OUT_SYNC:
483 con_sync_srv(srv, &call);
484 break;
485 case CONSOLE_CLEAR:
486 con_clear_srv(srv, &call);
487 break;
488 case CONSOLE_SET_POS:
489 con_set_pos_srv(srv, &call);
490 break;
491 case CONSOLE_GET_POS:
492 con_get_pos_srv(srv, &call);
493 break;
494 case CONSOLE_GET_SIZE:
495 con_get_size_srv(srv, &call);
496 break;
497 case CONSOLE_GET_COLOR_CAP:
498 con_get_color_cap_srv(srv, &call);
499 break;
500 case CONSOLE_SET_STYLE:
501 con_set_style_srv(srv, &call);
502 break;
503 case CONSOLE_SET_COLOR:
504 con_set_color_srv(srv, &call);
505 break;
506 case CONSOLE_SET_RGB_COLOR:
507 con_set_rgb_color_srv(srv, &call);
508 break;
509 case CONSOLE_SET_CURSOR_VISIBILITY:
510 con_set_cursor_visibility_srv(srv, &call);
511 break;
512 case CONSOLE_SET_CAPTION:
513 con_set_caption_srv(srv, &call);
514 break;
515 case CONSOLE_GET_EVENT:
516 con_get_event_srv(srv, &call);
517 break;
518 case CONSOLE_MAP:
519 con_map_srv(srv, &call);
520 break;
521 case CONSOLE_UNMAP:
522 con_unmap_srv(srv, &call);
523 break;
524 case CONSOLE_UPDATE:
525 con_update_srv(srv, &call);
526 break;
527 default:
528 async_answer_0(&call, ENOTSUP);
529 }
530 }
531
532 rc = srvs->ops->close(srv);
533 free(srv);
534
535 return rc;
536}
537
538/** @}
539 */
Note: See TracBrowser for help on using the repository browser.