source: mainline/uspace/srv/hid/remcons/remcons.c@ e1c6d5df

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since e1c6d5df was 5d94b16c, checked in by Jiri Svoboda <jiri@…>, 13 years ago

Factor out server side of console IPC protocol.
  • Property mode set to 100644
File size: 10.1 KB
Line 
1/*
2 * Copyright (c) 2012 Vojtech Horky
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 remcons
30 * @{
31 */
32/** @file
33 */
34
35#include <async.h>
36#include <errno.h>
37#include <io/con_srv.h>
38#include <stdio.h>
39#include <stdlib.h>
40#include <str_error.h>
41#include <loc.h>
42#include <event.h>
43#include <io/keycode.h>
44#include <align.h>
45#include <fibril_synch.h>
46#include <task.h>
47#include <net/in.h>
48#include <net/inet.h>
49#include <net/socket.h>
50#include <io/console.h>
51#include <inttypes.h>
52#include "telnet.h"
53#include "user.h"
54
55#define APP_GETTERM "/app/getterm"
56#define APP_SHELL "/app/bdsh"
57
58/** Telnet commands to force character mode
59 * (redundant to be on the safe side).
60 * See
61 * http://stackoverflow.com/questions/273261/force-telnet-user-into-character-mode
62 * for discussion.
63 */
64static const telnet_cmd_t telnet_force_character_mode_command[] = {
65 TELNET_IAC, TELNET_WILL, TELNET_ECHO,
66 TELNET_IAC, TELNET_WILL, TELNET_SUPPRESS_GO_AHEAD,
67 TELNET_IAC, TELNET_WONT, TELNET_LINEMODE
68};
69
70static const size_t telnet_force_character_mode_command_count =
71 sizeof(telnet_force_character_mode_command) / sizeof(telnet_cmd_t);
72
73static int remcons_open(con_srvs_t *, con_srv_t *);
74static int remcons_close(con_srv_t *);
75static int remcons_write(con_srv_t *, void *, size_t);
76static void remcons_sync(con_srv_t *);
77static void remcons_clear(con_srv_t *);
78static void remcons_set_pos(con_srv_t *, sysarg_t col, sysarg_t row);
79static int remcons_get_pos(con_srv_t *, sysarg_t *, sysarg_t *);
80static int remcons_get_size(con_srv_t *, sysarg_t *, sysarg_t *);
81static int remcons_get_color_cap(con_srv_t *, console_caps_t *);
82static int remcons_get_event(con_srv_t *, kbd_event_t *);
83
84static con_ops_t con_ops = {
85 .open = remcons_open,
86 .close = remcons_close,
87 .read = NULL,
88 .write = remcons_write,
89 .sync = remcons_sync,
90 .clear = remcons_clear,
91 .set_pos = remcons_set_pos,
92 .get_pos = remcons_get_pos,
93 .get_size = remcons_get_size,
94 .get_color_cap = remcons_get_color_cap,
95 .set_style = NULL,
96 .set_color = NULL,
97 .set_rgb_color = NULL,
98 .set_cursor_visibility = NULL,
99 .get_event = remcons_get_event
100};
101
102static telnet_user_t *srv_to_user(con_srv_t *srv)
103{
104 return srv->srvs->sarg;
105}
106
107static int remcons_open(con_srvs_t *srvs, con_srv_t *srv)
108{
109 telnet_user_t *user = srv_to_user(srv);
110
111 telnet_user_log(user, "New client connected (%p).", srv);
112
113 /* Force character mode. */
114 send(user->socket, (void *)telnet_force_character_mode_command,
115 telnet_force_character_mode_command_count, 0);
116
117 return EOK;
118}
119
120static int remcons_close(con_srv_t *srv)
121{
122 telnet_user_t *user = srv_to_user(srv);
123
124 telnet_user_notify_client_disconnected(user);
125 telnet_user_log(user, "Client disconnected (%p).", srv);
126
127 return EOK;
128}
129
130static int remcons_write(con_srv_t *srv, void *data, size_t size)
131{
132 telnet_user_t *user = srv_to_user(srv);
133 int rc;
134
135 rc = telnet_user_send_data(user, data, size);
136 if (rc != EOK)
137 return rc;
138
139 return size;
140}
141
142static void remcons_sync(con_srv_t *srv)
143{
144 (void) srv;
145}
146
147static void remcons_clear(con_srv_t *srv)
148{
149 (void) srv;
150}
151
152static void remcons_set_pos(con_srv_t *srv, sysarg_t col, sysarg_t row)
153{
154 telnet_user_t *user = srv_to_user(srv);
155
156 telnet_user_update_cursor_x(user, col);
157}
158
159static int remcons_get_pos(con_srv_t *srv, sysarg_t *col, sysarg_t *row)
160{
161 telnet_user_t *user = srv_to_user(srv);
162
163 *col = user->cursor_x;
164 *row = 0;
165
166 return EOK;
167}
168
169static int remcons_get_size(con_srv_t *srv, sysarg_t *cols, sysarg_t *rows)
170{
171 (void) srv;
172
173 *cols = 100;
174 *rows = 1;
175
176 return EOK;
177}
178
179static int remcons_get_color_cap(con_srv_t *srv, console_caps_t *ccaps)
180{
181 (void) srv;
182 *ccaps = CONSOLE_CAP_NONE;
183
184 return EOK;
185}
186
187static int remcons_get_event(con_srv_t *srv, kbd_event_t *event)
188{
189 telnet_user_t *user = srv_to_user(srv);
190 int rc;
191
192 rc = telnet_user_get_next_keyboard_event(user, event);
193 if (rc != EOK) {
194 /* XXX What? */
195 memset(event, 0, sizeof(*event));
196 return EOK;
197 }
198
199 return EOK;
200}
201
202/** Callback when client connects to a telnet terminal. */
203static void client_connection(ipc_callid_t iid, ipc_call_t *icall, void *arg)
204{
205 /* Find the user. */
206 telnet_user_t *user = telnet_user_get_for_client_connection(IPC_GET_ARG1(*icall));
207 if (user == NULL) {
208 async_answer_0(iid, ENOENT);
209 return;
210 }
211
212 /* Handle messages. */
213 con_conn(iid, icall, &user->srvs);
214}
215
216/** Fibril for spawning the task running after user connects.
217 *
218 * @param arg Corresponding @c telnet_user_t structure.
219 */
220static int spawn_task_fibril(void *arg)
221{
222 telnet_user_t *user = arg;
223 int rc;
224
225 char term[LOC_NAME_MAXLEN];
226 snprintf(term, LOC_NAME_MAXLEN, "%s/%s", "/loc", user->service_name);
227
228 task_id_t task;
229 rc = task_spawnl(&task, APP_GETTERM, APP_GETTERM, "-w", term, APP_SHELL, NULL);
230 if (rc != EOK) {
231 telnet_user_error(user, "Spawning `%s -w %s %s' failed: %s.",
232 APP_GETTERM, term, APP_SHELL, str_error(rc));
233 fibril_mutex_lock(&user->guard);
234 user->task_finished = true;
235 user->srvs.aborted = true;
236 fibril_condvar_signal(&user->refcount_cv);
237 fibril_mutex_unlock(&user->guard);
238 return EOK;
239 }
240
241 fibril_mutex_lock(&user->guard);
242 user->task_id = task;
243 fibril_mutex_unlock(&user->guard);
244
245 task_exit_t task_exit;
246 int task_retval;
247 task_wait(task, &task_exit, &task_retval);
248 telnet_user_log(user, "%s terminated %s, exit code %d.", APP_GETTERM,
249 task_exit == TASK_EXIT_NORMAL ? "normally" : "unexpectedly",
250 task_retval);
251
252 /* Announce destruction. */
253 fibril_mutex_lock(&user->guard);
254 user->task_finished = true;
255 user->srvs.aborted = true;
256 fibril_condvar_signal(&user->refcount_cv);
257 fibril_mutex_unlock(&user->guard);
258
259 return EOK;
260}
261
262/** Tell whether given user can be destroyed (has no active clients).
263 *
264 * @param user The telnet user in question.
265 */
266static bool user_can_be_destroyed_no_lock(telnet_user_t *user)
267{
268 return user->task_finished && user->socket_closed &&
269 (user->locsrv_connection_count == 0);
270}
271
272/** Fibril for each accepted socket.
273 *
274 * @param arg Corresponding @c telnet_user_t structure.
275 */
276static int network_user_fibril(void *arg)
277{
278 telnet_user_t *user = arg;
279
280 int rc = loc_service_register(user->service_name, &user->service_id);
281 if (rc != EOK) {
282 telnet_user_error(user, "Unable to register %s with loc: %s.",
283 user->service_name, str_error(rc));
284 return EOK;
285 }
286
287 telnet_user_log(user, "Service %s registerd with id %" PRIun ".",
288 user->service_name, user->service_id);
289
290 fid_t spawn_fibril = fibril_create(spawn_task_fibril, user);
291 assert(spawn_fibril);
292 fibril_add_ready(spawn_fibril);
293
294 /* Wait for all clients to exit. */
295 fibril_mutex_lock(&user->guard);
296 while (!user_can_be_destroyed_no_lock(user)) {
297 if (user->task_finished) {
298 closesocket(user->socket);
299 user->socket_closed = true;
300 user->srvs.aborted = true;
301 continue;
302 } else if (user->socket_closed) {
303 if (user->task_id != 0) {
304 task_kill(user->task_id);
305 }
306 }
307 fibril_condvar_wait_timeout(&user->refcount_cv, &user->guard, 1000);
308 }
309 fibril_mutex_unlock(&user->guard);
310
311 rc = loc_service_unregister(user->service_id);
312 if (rc != EOK) {
313 telnet_user_error(user,
314 "Unable to unregister %s from loc: %s (ignored).",
315 user->service_name, str_error(rc));
316 }
317
318 telnet_user_log(user, "Destroying...");
319 telnet_user_destroy(user);
320
321 return EOK;
322}
323
324int main(int argc, char *argv[])
325{
326 int port = 2223;
327
328 async_set_client_connection(client_connection);
329 int rc = loc_server_register(NAME);
330 if (rc != EOK) {
331 fprintf(stderr, "%s: Unable to register server\n", NAME);
332 return rc;
333 }
334
335 struct sockaddr_in addr;
336
337 addr.sin_family = AF_INET;
338 addr.sin_port = htons(port);
339
340 rc = inet_pton(AF_INET, "127.0.0.1", (void *)
341 &addr.sin_addr.s_addr);
342 if (rc != EOK) {
343 fprintf(stderr, "Error parsing network address: %s.\n",
344 str_error(rc));
345 return 2;
346 }
347
348 int listen_sd = socket(PF_INET, SOCK_STREAM, 0);
349 if (listen_sd < 0) {
350 fprintf(stderr, "Error creating listening socket: %s.\n",
351 str_error(listen_sd));
352 return 3;
353 }
354
355 rc = bind(listen_sd, (struct sockaddr *) &addr, sizeof(addr));
356 if (rc != EOK) {
357 fprintf(stderr, "Error binding socket: %s.\n",
358 str_error(rc));
359 return 4;
360 }
361
362 rc = listen(listen_sd, BACKLOG_SIZE);
363 if (rc != EOK) {
364 fprintf(stderr, "listen() failed: %s.\n", str_error(rc));
365 return 5;
366 }
367
368 printf("%s: HelenOS Remote console service\n", NAME);
369 task_retval(0);
370
371 while (true) {
372 struct sockaddr_in raddr;
373 socklen_t raddr_len = sizeof(raddr);
374 int conn_sd = accept(listen_sd, (struct sockaddr *) &raddr,
375 &raddr_len);
376
377 if (conn_sd < 0) {
378 fprintf(stderr, "accept() failed: %s.\n",
379 str_error(rc));
380 continue;
381 }
382
383 telnet_user_t *user = telnet_user_create(conn_sd);
384 assert(user);
385
386 con_srvs_init(&user->srvs);
387 user->srvs.ops = &con_ops;
388 user->srvs.sarg = user;
389 user->srvs.abort_timeout = 1000;
390
391 telnet_user_add(user);
392
393 fid_t fid = fibril_create(network_user_fibril, user);
394 assert(fid);
395 fibril_add_ready(fid);
396 }
397
398 return 0;
399}
400
401/** @}
402 */
Note: See TracBrowser for help on using the repository browser.