source: mainline/uspace/srv/devman/main.c@ f480d7e

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

Do not trust driver to remove all functions.
  • Property mode set to 100644
File size: 32.1 KB
Line 
1/*
2 * Copyright (c) 2010 Lenka Trochtova
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/**
30 * @defgroup devman Device manager.
31 * @brief HelenOS device manager.
32 * @{
33 */
34
35/** @file
36 */
37
38#include <inttypes.h>
39#include <assert.h>
40#include <ipc/services.h>
41#include <ns.h>
42#include <async.h>
43#include <stdio.h>
44#include <errno.h>
45#include <str_error.h>
46#include <bool.h>
47#include <fibril_synch.h>
48#include <stdlib.h>
49#include <str.h>
50#include <dirent.h>
51#include <fcntl.h>
52#include <sys/stat.h>
53#include <ctype.h>
54#include <io/log.h>
55#include <ipc/devman.h>
56#include <ipc/driver.h>
57#include <thread.h>
58#include <loc.h>
59
60#include "devman.h"
61
62#define DRIVER_DEFAULT_STORE "/drv"
63
64static driver_list_t drivers_list;
65static dev_tree_t device_tree;
66
67static int init_running_drv(void *drv);
68
69/** Register running driver. */
70static driver_t *devman_driver_register(ipc_callid_t callid, ipc_call_t *call)
71{
72 driver_t *driver = NULL;
73 char *drv_name = NULL;
74
75 log_msg(LVL_DEBUG, "devman_driver_register");
76
77 /* Get driver name. */
78 int rc = async_data_write_accept((void **) &drv_name, true, 0, 0, 0, 0);
79 if (rc != EOK) {
80 async_answer_0(callid, rc);
81 return NULL;
82 }
83
84 log_msg(LVL_DEBUG, "The `%s' driver is trying to register.",
85 drv_name);
86
87 /* Find driver structure. */
88 driver = find_driver(&drivers_list, drv_name);
89 if (driver == NULL) {
90 log_msg(LVL_ERROR, "No driver named `%s' was found.", drv_name);
91 free(drv_name);
92 drv_name = NULL;
93 async_answer_0(callid, ENOENT);
94 return NULL;
95 }
96
97 free(drv_name);
98 drv_name = NULL;
99
100 fibril_mutex_lock(&driver->driver_mutex);
101
102 if (driver->sess) {
103 /* We already have a connection to the driver. */
104 log_msg(LVL_ERROR, "Driver '%s' already started.\n",
105 driver->name);
106 fibril_mutex_unlock(&driver->driver_mutex);
107 async_answer_0(callid, EEXISTS);
108 return NULL;
109 }
110
111 switch (driver->state) {
112 case DRIVER_NOT_STARTED:
113 /* Somebody started the driver manually. */
114 log_msg(LVL_NOTE, "Driver '%s' started manually.\n",
115 driver->name);
116 driver->state = DRIVER_STARTING;
117 break;
118 case DRIVER_STARTING:
119 /* The expected case */
120 break;
121 case DRIVER_RUNNING:
122 /* Should not happen since we do not have a connected session */
123 assert(false);
124 }
125
126 /* Create connection to the driver. */
127 log_msg(LVL_DEBUG, "Creating connection to the `%s' driver.",
128 driver->name);
129 driver->sess = async_callback_receive(EXCHANGE_PARALLEL);
130 if (!driver->sess) {
131 fibril_mutex_unlock(&driver->driver_mutex);
132 async_answer_0(callid, ENOTSUP);
133 return NULL;
134 }
135 /* FIXME: Work around problem with callback sessions */
136 async_sess_args_set(driver->sess, DRIVER_DEVMAN, 0, 0);
137
138 log_msg(LVL_NOTE,
139 "The `%s' driver was successfully registered as running.",
140 driver->name);
141
142 /*
143 * Initialize the driver as running (e.g. pass assigned devices to it)
144 * in a separate fibril; the separate fibril is used to enable the
145 * driver to use devman service during the driver's initialization.
146 */
147 fid_t fid = fibril_create(init_running_drv, driver);
148 if (fid == 0) {
149 log_msg(LVL_ERROR, "Failed to create initialization fibril " \
150 "for driver `%s'.", driver->name);
151 fibril_mutex_unlock(&driver->driver_mutex);
152 async_answer_0(callid, ENOMEM);
153 return NULL;
154 }
155
156 fibril_add_ready(fid);
157 fibril_mutex_unlock(&driver->driver_mutex);
158
159 async_answer_0(callid, EOK);
160 return driver;
161}
162
163/** Receive device match ID from the device's parent driver and add it to the
164 * list of devices match ids.
165 *
166 * @param match_ids The list of the device's match ids.
167 * @return Zero on success, negative error code otherwise.
168 */
169static int devman_receive_match_id(match_id_list_t *match_ids)
170{
171 match_id_t *match_id = create_match_id();
172 ipc_callid_t callid;
173 ipc_call_t call;
174 int rc = 0;
175
176 callid = async_get_call(&call);
177 if (DEVMAN_ADD_MATCH_ID != IPC_GET_IMETHOD(call)) {
178 log_msg(LVL_ERROR,
179 "Invalid protocol when trying to receive match id.");
180 async_answer_0(callid, EINVAL);
181 delete_match_id(match_id);
182 return EINVAL;
183 }
184
185 if (match_id == NULL) {
186 log_msg(LVL_ERROR, "Failed to allocate match id.");
187 async_answer_0(callid, ENOMEM);
188 return ENOMEM;
189 }
190
191 async_answer_0(callid, EOK);
192
193 match_id->score = IPC_GET_ARG1(call);
194
195 char *match_id_str;
196 rc = async_data_write_accept((void **) &match_id_str, true, 0, 0, 0, 0);
197 match_id->id = match_id_str;
198 if (rc != EOK) {
199 delete_match_id(match_id);
200 log_msg(LVL_ERROR, "Failed to receive match id string: %s.",
201 str_error(rc));
202 return rc;
203 }
204
205 list_append(&match_id->link, &match_ids->ids);
206
207 log_msg(LVL_DEBUG, "Received match id `%s', score %d.",
208 match_id->id, match_id->score);
209 return rc;
210}
211
212/** Receive device match IDs from the device's parent driver and add them to the
213 * list of devices match ids.
214 *
215 * @param match_count The number of device's match ids to be received.
216 * @param match_ids The list of the device's match ids.
217 * @return Zero on success, negative error code otherwise.
218 */
219static int devman_receive_match_ids(sysarg_t match_count,
220 match_id_list_t *match_ids)
221{
222 int ret = EOK;
223 size_t i;
224
225 for (i = 0; i < match_count; i++) {
226 if (EOK != (ret = devman_receive_match_id(match_ids)))
227 return ret;
228 }
229 return ret;
230}
231
232static int assign_driver_fibril(void *arg)
233{
234 dev_node_t *dev_node = (dev_node_t *) arg;
235 assign_driver(dev_node, &drivers_list, &device_tree);
236
237 /* Delete one reference we got from the caller. */
238 dev_del_ref(dev_node);
239 return EOK;
240}
241
242static int online_function(fun_node_t *fun)
243{
244 dev_node_t *dev;
245
246 fibril_rwlock_write_lock(&device_tree.rwlock);
247
248 if (fun->state == FUN_ON_LINE) {
249 fibril_rwlock_write_unlock(&device_tree.rwlock);
250 log_msg(LVL_WARN, "Function %s is already on line.",
251 fun->pathname);
252 return EOK;
253 }
254
255 if (fun->ftype == fun_inner) {
256 dev = create_dev_node();
257 if (dev == NULL) {
258 fibril_rwlock_write_unlock(&device_tree.rwlock);
259 return ENOMEM;
260 }
261
262 insert_dev_node(&device_tree, dev, fun);
263 dev_add_ref(dev);
264 }
265
266 log_msg(LVL_DEBUG, "devman_add_function(fun=\"%s\")", fun->pathname);
267
268 if (fun->ftype == fun_inner) {
269 dev = fun->child;
270 assert(dev != NULL);
271
272 /* Give one reference over to assign_driver_fibril(). */
273 dev_add_ref(dev);
274 /*
275 * Try to find a suitable driver and assign it to the device. We do
276 * not want to block the current fibril that is used for processing
277 * incoming calls: we will launch a separate fibril to handle the
278 * driver assigning. That is because assign_driver can actually include
279 * task spawning which could take some time.
280 */
281 fid_t assign_fibril = fibril_create(assign_driver_fibril, dev);
282 if (assign_fibril == 0) {
283 log_msg(LVL_ERROR, "Failed to create fibril for "
284 "assigning driver.");
285 /* XXX Cleanup */
286 fibril_rwlock_write_unlock(&device_tree.rwlock);
287 return ENOMEM;
288 }
289 fibril_add_ready(assign_fibril);
290 } else {
291 loc_register_tree_function(fun, &device_tree);
292 }
293
294 fibril_rwlock_write_unlock(&device_tree.rwlock);
295
296 return EOK;
297}
298
299static int offline_function(fun_node_t *fun)
300{
301 int rc;
302
303 fibril_rwlock_write_lock(&device_tree.rwlock);
304
305 if (fun->state == FUN_OFF_LINE) {
306 fibril_rwlock_write_unlock(&device_tree.rwlock);
307 log_msg(LVL_WARN, "Function %s is already off line.",
308 fun->pathname);
309 return EOK;
310 }
311
312 if (fun->ftype == fun_inner) {
313 log_msg(LVL_DEBUG, "Offlining inner function %s.",
314 fun->pathname);
315
316 if (fun->child != NULL) {
317 dev_node_t *dev = fun->child;
318
319 dev_add_ref(dev);
320 fibril_rwlock_write_unlock(&device_tree.rwlock);
321
322 rc = driver_dev_remove(&device_tree, dev);
323 if (rc != EOK) {
324 dev_del_ref(dev);
325 return ENOTSUP;
326 }
327
328 /* Verify that driver removed all functions */
329 fibril_rwlock_read_lock(&device_tree.rwlock);
330 if (!list_empty(&dev->functions)) {
331 fibril_rwlock_read_unlock(&device_tree.rwlock);
332 return EIO;
333 }
334 fibril_rwlock_read_unlock(&device_tree.rwlock);
335
336 detach_driver(&device_tree, dev);
337
338 fibril_rwlock_write_lock(&device_tree.rwlock);
339 remove_dev_node(&device_tree, dev);
340
341 /* Delete ref created when node was inserted */
342 dev_del_ref(dev);
343 /* Delete ref created by dev_add_ref(dev) above */
344 dev_del_ref(dev);
345 }
346 } else {
347 /* Unregister from location service */
348 rc = loc_service_unregister(fun->service_id);
349 if (rc != EOK) {
350 fibril_rwlock_write_unlock(&device_tree.rwlock);
351 log_msg(LVL_ERROR, "Failed unregistering tree service.");
352 return EIO;
353 }
354
355 fun->service_id = 0;
356 }
357
358 fun->state = FUN_OFF_LINE;
359 fibril_rwlock_write_unlock(&device_tree.rwlock);
360
361 return EOK;
362}
363
364/** Handle function registration.
365 *
366 * Child devices are registered by their parent's device driver.
367 */
368static void devman_add_function(ipc_callid_t callid, ipc_call_t *call)
369{
370 fun_type_t ftype = (fun_type_t) IPC_GET_ARG1(*call);
371 devman_handle_t dev_handle = IPC_GET_ARG2(*call);
372 sysarg_t match_count = IPC_GET_ARG3(*call);
373 dev_tree_t *tree = &device_tree;
374
375 dev_node_t *pdev = find_dev_node(&device_tree, dev_handle);
376 if (pdev == NULL) {
377 async_answer_0(callid, ENOENT);
378 return;
379 }
380
381 if (ftype != fun_inner && ftype != fun_exposed) {
382 /* Unknown function type */
383 log_msg(LVL_ERROR,
384 "Unknown function type %d provided by driver.",
385 (int) ftype);
386
387 dev_del_ref(pdev);
388 async_answer_0(callid, EINVAL);
389 return;
390 }
391
392 char *fun_name = NULL;
393 int rc = async_data_write_accept((void **)&fun_name, true, 0, 0, 0, 0);
394 if (rc != EOK) {
395 dev_del_ref(pdev);
396 async_answer_0(callid, rc);
397 return;
398 }
399
400 fibril_rwlock_write_lock(&tree->rwlock);
401
402 /* Check device state */
403 if (pdev->state == DEVICE_REMOVED) {
404 fibril_rwlock_write_unlock(&tree->rwlock);
405 dev_del_ref(pdev);
406 async_answer_0(callid, ENOENT);
407 return;
408 }
409
410 /* Check that function with same name is not there already. */
411 if (find_fun_node_in_device(tree, pdev, fun_name) != NULL) {
412 fibril_rwlock_write_unlock(&tree->rwlock);
413 dev_del_ref(pdev);
414 async_answer_0(callid, EEXISTS);
415 printf(NAME ": Warning, driver tried to register `%s' twice.\n",
416 fun_name);
417 free(fun_name);
418 return;
419 }
420
421 fun_node_t *fun = create_fun_node();
422 fun_add_ref(fun);
423 fun->ftype = ftype;
424
425 if (!insert_fun_node(&device_tree, fun, fun_name, pdev)) {
426 fibril_rwlock_write_unlock(&tree->rwlock);
427 dev_del_ref(pdev);
428 delete_fun_node(fun);
429 async_answer_0(callid, ENOMEM);
430 return;
431 }
432
433 fibril_rwlock_write_unlock(&tree->rwlock);
434 dev_del_ref(pdev);
435
436 devman_receive_match_ids(match_count, &fun->match_ids);
437
438 rc = online_function(fun);
439 if (rc != EOK) {
440 /* XXX clean up */
441 async_answer_0(callid, rc);
442 return;
443 }
444
445 /* Return device handle to parent's driver. */
446 async_answer_1(callid, EOK, fun->handle);
447}
448
449static void devman_add_function_to_cat(ipc_callid_t callid, ipc_call_t *call)
450{
451 devman_handle_t handle = IPC_GET_ARG1(*call);
452 category_id_t cat_id;
453 int rc;
454
455 /* Get category name. */
456 char *cat_name;
457 rc = async_data_write_accept((void **) &cat_name, true,
458 0, 0, 0, 0);
459 if (rc != EOK) {
460 async_answer_0(callid, rc);
461 return;
462 }
463
464 fun_node_t *fun = find_fun_node(&device_tree, handle);
465 if (fun == NULL) {
466 async_answer_0(callid, ENOENT);
467 return;
468 }
469
470 fibril_rwlock_read_lock(&device_tree.rwlock);
471
472 /* Check function state */
473 if (fun->state == FUN_REMOVED) {
474 fibril_rwlock_read_unlock(&device_tree.rwlock);
475 async_answer_0(callid, ENOENT);
476 return;
477 }
478
479 rc = loc_category_get_id(cat_name, &cat_id, IPC_FLAG_BLOCKING);
480 if (rc == EOK) {
481 loc_service_add_to_cat(fun->service_id, cat_id);
482 } else {
483 log_msg(LVL_ERROR, "Failed adding function `%s' to category "
484 "`%s'.", fun->pathname, cat_name);
485 }
486
487 log_msg(LVL_NOTE, "Function `%s' added to category `%s'.",
488 fun->pathname, cat_name);
489
490 fibril_rwlock_read_unlock(&device_tree.rwlock);
491 fun_del_ref(fun);
492
493 async_answer_0(callid, EOK);
494}
495
496/** Online function by driver request.
497 *
498 */
499static void devman_drv_fun_online(ipc_callid_t iid, ipc_call_t *icall,
500 driver_t *drv)
501{
502 fun_node_t *fun;
503 int rc;
504
505 printf("devman_drv_fun_online()\n");
506 fun = find_fun_node(&device_tree, IPC_GET_ARG1(*icall));
507 if (fun == NULL) {
508 async_answer_0(iid, ENOENT);
509 return;
510 }
511
512 fibril_rwlock_read_lock(&device_tree.rwlock);
513 if (fun->dev == NULL || fun->dev->drv != drv) {
514 fibril_rwlock_read_unlock(&device_tree.rwlock);
515 fun_del_ref(fun);
516 async_answer_0(iid, ENOENT);
517 return;
518 }
519 fibril_rwlock_read_unlock(&device_tree.rwlock);
520
521 rc = online_function(fun);
522 if (rc != EOK) {
523 printf("devman_drv_fun_online() online_fun->ERROR\n");
524 fun_del_ref(fun);
525 async_answer_0(iid, (sysarg_t) rc);
526 return;
527 }
528
529 fun_del_ref(fun);
530 printf("devman_drv_fun_online() online_fun->OK\n");
531
532 async_answer_0(iid, (sysarg_t) EOK);
533}
534
535
536/** Offline function by driver request.
537 *
538 */
539static void devman_drv_fun_offline(ipc_callid_t iid, ipc_call_t *icall,
540 driver_t *drv)
541{
542 fun_node_t *fun;
543 int rc;
544
545 fun = find_fun_node(&device_tree, IPC_GET_ARG1(*icall));
546 if (fun == NULL) {
547 async_answer_0(iid, ENOENT);
548 return;
549 }
550
551 fibril_rwlock_write_lock(&device_tree.rwlock);
552 if (fun->dev == NULL || fun->dev->drv != drv) {
553 fun_del_ref(fun);
554 async_answer_0(iid, ENOENT);
555 return;
556 }
557 fibril_rwlock_write_unlock(&device_tree.rwlock);
558
559 rc = offline_function(fun);
560 if (rc != EOK) {
561 fun_del_ref(fun);
562 async_answer_0(iid, (sysarg_t) rc);
563 return;
564 }
565
566 fun_del_ref(fun);
567 async_answer_0(iid, (sysarg_t) EOK);
568}
569
570/** Remove function. */
571static void devman_remove_function(ipc_callid_t callid, ipc_call_t *call)
572{
573 devman_handle_t fun_handle = IPC_GET_ARG1(*call);
574 dev_tree_t *tree = &device_tree;
575 int rc;
576
577
578 fun_node_t *fun = find_fun_node(&device_tree, fun_handle);
579 if (fun == NULL) {
580 async_answer_0(callid, ENOENT);
581 return;
582 }
583
584 fibril_rwlock_write_lock(&tree->rwlock);
585
586 log_msg(LVL_DEBUG, "devman_remove_function(fun='%s')", fun->pathname);
587
588 /* Check function state */
589 if (fun->state == FUN_REMOVED) {
590 fibril_rwlock_write_unlock(&tree->rwlock);
591 async_answer_0(callid, ENOENT);
592 return;
593 }
594
595 if (fun->ftype == fun_inner) {
596 /* Handle possible descendants */
597 /* TODO - This is a surprise removal */
598 if (fun->child != NULL) {
599 log_msg(LVL_WARN, "devman_remove_function(): not handling "
600 "descendants\n");
601 }
602 } else {
603 if (fun->service_id != 0) {
604 /* Unregister from location service */
605 rc = loc_service_unregister(fun->service_id);
606 if (rc != EOK) {
607 log_msg(LVL_ERROR, "Failed unregistering tree "
608 "service.");
609 fibril_rwlock_write_unlock(&tree->rwlock);
610 fun_del_ref(fun);
611 async_answer_0(callid, EIO);
612 return;
613 }
614 }
615 }
616
617 remove_fun_node(&device_tree, fun);
618 fibril_rwlock_write_unlock(&tree->rwlock);
619
620 /* Delete ref added when inserting function into tree */
621 fun_del_ref(fun);
622 /* Delete ref added above when looking up function */
623 fun_del_ref(fun);
624
625 log_msg(LVL_DEBUG, "devman_remove_function() succeeded.");
626 async_answer_0(callid, EOK);
627}
628
629/** Initialize driver which has registered itself as running and ready.
630 *
631 * The initialization is done in a separate fibril to avoid deadlocks (if the
632 * driver needed to be served by devman during the driver's initialization).
633 */
634static int init_running_drv(void *drv)
635{
636 driver_t *driver = (driver_t *) drv;
637
638 initialize_running_driver(driver, &device_tree);
639 log_msg(LVL_DEBUG, "The `%s` driver was successfully initialized.",
640 driver->name);
641 return 0;
642}
643
644/** Function for handling connections from a driver to the device manager. */
645static void devman_connection_driver(ipc_callid_t iid, ipc_call_t *icall)
646{
647 client_t *client;
648 driver_t *driver;
649
650 /* Accept the connection. */
651 async_answer_0(iid, EOK);
652
653 client = async_get_client_data();
654 if (client == NULL) {
655 log_msg(LVL_ERROR, "Failed to allocate client data.");
656 return;
657 }
658
659 while (true) {
660 ipc_call_t call;
661 ipc_callid_t callid = async_get_call(&call);
662
663 if (!IPC_GET_IMETHOD(call))
664 break;
665
666 if (IPC_GET_IMETHOD(call) != DEVMAN_DRIVER_REGISTER) {
667 fibril_mutex_lock(&client->mutex);
668 driver = client->driver;
669 fibril_mutex_unlock(&client->mutex);
670 if (driver == NULL) {
671 /* First call must be to DEVMAN_DRIVER_REGISTER */
672 async_answer_0(callid, ENOTSUP);
673 continue;
674 }
675 }
676
677 switch (IPC_GET_IMETHOD(call)) {
678 case DEVMAN_DRIVER_REGISTER:
679 fibril_mutex_lock(&client->mutex);
680 if (client->driver != NULL) {
681 fibril_mutex_unlock(&client->mutex);
682 async_answer_0(callid, EINVAL);
683 continue;
684 }
685 client->driver = devman_driver_register(callid, &call);
686 fibril_mutex_unlock(&client->mutex);
687 break;
688 case DEVMAN_ADD_FUNCTION:
689 devman_add_function(callid, &call);
690 break;
691 case DEVMAN_ADD_DEVICE_TO_CATEGORY:
692 devman_add_function_to_cat(callid, &call);
693 break;
694 case DEVMAN_DRV_FUN_ONLINE:
695 devman_drv_fun_online(callid, &call, driver);
696 break;
697 case DEVMAN_DRV_FUN_OFFLINE:
698 devman_drv_fun_offline(callid, &call, driver);
699 break;
700 case DEVMAN_REMOVE_FUNCTION:
701 devman_remove_function(callid, &call);
702 break;
703 default:
704 async_answer_0(callid, EINVAL);
705 break;
706 }
707 }
708}
709
710/** Find handle for the device instance identified by the device's path in the
711 * device tree. */
712static void devman_function_get_handle(ipc_callid_t iid, ipc_call_t *icall)
713{
714 char *pathname;
715 devman_handle_t handle;
716
717 int rc = async_data_write_accept((void **) &pathname, true, 0, 0, 0, 0);
718 if (rc != EOK) {
719 async_answer_0(iid, rc);
720 return;
721 }
722
723 fun_node_t *fun = find_fun_node_by_path(&device_tree, pathname);
724
725 free(pathname);
726
727 if (fun == NULL) {
728 async_answer_0(iid, ENOENT);
729 return;
730 }
731
732 fibril_rwlock_read_lock(&device_tree.rwlock);
733
734 /* Check function state */
735 if (fun->state == FUN_REMOVED) {
736 fibril_rwlock_read_unlock(&device_tree.rwlock);
737 async_answer_0(iid, ENOENT);
738 return;
739 }
740 handle = fun->handle;
741
742 fibril_rwlock_read_unlock(&device_tree.rwlock);
743
744 /* Delete reference created above by find_fun_node_by_path() */
745 fun_del_ref(fun);
746
747 async_answer_1(iid, EOK, handle);
748}
749
750/** Get device name. */
751static void devman_fun_get_name(ipc_callid_t iid, ipc_call_t *icall)
752{
753 devman_handle_t handle = IPC_GET_ARG1(*icall);
754
755 fun_node_t *fun = find_fun_node(&device_tree, handle);
756 if (fun == NULL) {
757 async_answer_0(iid, ENOMEM);
758 return;
759 }
760
761 ipc_callid_t data_callid;
762 size_t data_len;
763 if (!async_data_read_receive(&data_callid, &data_len)) {
764 async_answer_0(iid, EINVAL);
765 fun_del_ref(fun);
766 return;
767 }
768
769 void *buffer = malloc(data_len);
770 if (buffer == NULL) {
771 async_answer_0(data_callid, ENOMEM);
772 async_answer_0(iid, ENOMEM);
773 fun_del_ref(fun);
774 return;
775 }
776
777 fibril_rwlock_read_lock(&device_tree.rwlock);
778
779 /* Check function state */
780 if (fun->state == FUN_REMOVED) {
781 fibril_rwlock_read_unlock(&device_tree.rwlock);
782 free(buffer);
783
784 async_answer_0(data_callid, ENOENT);
785 async_answer_0(iid, ENOENT);
786 fun_del_ref(fun);
787 return;
788 }
789
790 size_t sent_length = str_size(fun->name);
791 if (sent_length > data_len) {
792 sent_length = data_len;
793 }
794
795 async_data_read_finalize(data_callid, fun->name, sent_length);
796 async_answer_0(iid, EOK);
797
798 fibril_rwlock_read_unlock(&device_tree.rwlock);
799 fun_del_ref(fun);
800 free(buffer);
801}
802
803
804/** Get device path. */
805static void devman_fun_get_path(ipc_callid_t iid, ipc_call_t *icall)
806{
807 devman_handle_t handle = IPC_GET_ARG1(*icall);
808
809 fun_node_t *fun = find_fun_node(&device_tree, handle);
810 if (fun == NULL) {
811 async_answer_0(iid, ENOMEM);
812 return;
813 }
814
815 ipc_callid_t data_callid;
816 size_t data_len;
817 if (!async_data_read_receive(&data_callid, &data_len)) {
818 async_answer_0(iid, EINVAL);
819 fun_del_ref(fun);
820 return;
821 }
822
823 void *buffer = malloc(data_len);
824 if (buffer == NULL) {
825 async_answer_0(data_callid, ENOMEM);
826 async_answer_0(iid, ENOMEM);
827 fun_del_ref(fun);
828 return;
829 }
830
831 fibril_rwlock_read_lock(&device_tree.rwlock);
832
833 /* Check function state */
834 if (fun->state == FUN_REMOVED) {
835 fibril_rwlock_read_unlock(&device_tree.rwlock);
836 free(buffer);
837
838 async_answer_0(data_callid, ENOENT);
839 async_answer_0(iid, ENOENT);
840 fun_del_ref(fun);
841 return;
842 }
843
844 size_t sent_length = str_size(fun->pathname);
845 if (sent_length > data_len) {
846 sent_length = data_len;
847 }
848
849 async_data_read_finalize(data_callid, fun->pathname, sent_length);
850 async_answer_0(iid, EOK);
851
852 fibril_rwlock_read_unlock(&device_tree.rwlock);
853 fun_del_ref(fun);
854 free(buffer);
855}
856
857static void devman_dev_get_functions(ipc_callid_t iid, ipc_call_t *icall)
858{
859 ipc_callid_t callid;
860 size_t size;
861 size_t act_size;
862 int rc;
863
864 if (!async_data_read_receive(&callid, &size)) {
865 async_answer_0(callid, EREFUSED);
866 async_answer_0(iid, EREFUSED);
867 return;
868 }
869
870 fibril_rwlock_read_lock(&device_tree.rwlock);
871
872 dev_node_t *dev = find_dev_node_no_lock(&device_tree,
873 IPC_GET_ARG1(*icall));
874 if (dev == NULL || dev->state == DEVICE_REMOVED) {
875 fibril_rwlock_read_unlock(&device_tree.rwlock);
876 async_answer_0(callid, ENOENT);
877 async_answer_0(iid, ENOENT);
878 return;
879 }
880
881 devman_handle_t *hdl_buf = (devman_handle_t *) malloc(size);
882 if (hdl_buf == NULL) {
883 fibril_rwlock_read_unlock(&device_tree.rwlock);
884 async_answer_0(callid, ENOMEM);
885 async_answer_0(iid, ENOMEM);
886 return;
887 }
888
889 rc = dev_get_functions(&device_tree, dev, hdl_buf, size, &act_size);
890 if (rc != EOK) {
891 fibril_rwlock_read_unlock(&device_tree.rwlock);
892 async_answer_0(callid, rc);
893 async_answer_0(iid, rc);
894 return;
895 }
896
897 fibril_rwlock_read_unlock(&device_tree.rwlock);
898
899 sysarg_t retval = async_data_read_finalize(callid, hdl_buf, size);
900 free(hdl_buf);
901
902 async_answer_1(iid, retval, act_size);
903}
904
905
906/** Get handle for child device of a function. */
907static void devman_fun_get_child(ipc_callid_t iid, ipc_call_t *icall)
908{
909 fun_node_t *fun;
910
911 fibril_rwlock_read_lock(&device_tree.rwlock);
912
913 fun = find_fun_node_no_lock(&device_tree, IPC_GET_ARG1(*icall));
914 if (fun == NULL || fun->state == FUN_REMOVED) {
915 fibril_rwlock_read_unlock(&device_tree.rwlock);
916 async_answer_0(iid, ENOENT);
917 return;
918 }
919
920 if (fun->child == NULL) {
921 fibril_rwlock_read_unlock(&device_tree.rwlock);
922 async_answer_0(iid, ENOENT);
923 return;
924 }
925
926 async_answer_1(iid, EOK, fun->child->handle);
927
928 fibril_rwlock_read_unlock(&device_tree.rwlock);
929}
930
931/** Online function.
932 *
933 * Send a request to online a function to the responsible driver.
934 * The driver may offline other functions if necessary (i.e. if the state
935 * of this function is linked to state of another function somehow).
936 */
937static void devman_fun_online(ipc_callid_t iid, ipc_call_t *icall)
938{
939 fun_node_t *fun;
940 int rc;
941
942 fun = find_fun_node(&device_tree, IPC_GET_ARG1(*icall));
943 if (fun == NULL) {
944 async_answer_0(iid, ENOENT);
945 return;
946 }
947
948 rc = driver_fun_online(&device_tree, fun);
949 fun_del_ref(fun);
950
951 async_answer_0(iid, (sysarg_t) rc);
952}
953
954/** Offline function.
955 *
956 * Send a request to offline a function to the responsible driver. As
957 * a result the subtree rooted at that function should be cleanly
958 * detatched. The driver may offline other functions if necessary
959 * (i.e. if the state of this function is linked to state of another
960 * function somehow).
961 */
962static void devman_fun_offline(ipc_callid_t iid, ipc_call_t *icall)
963{
964 fun_node_t *fun;
965 int rc;
966
967 fun = find_fun_node(&device_tree, IPC_GET_ARG1(*icall));
968 if (fun == NULL) {
969 async_answer_0(iid, ENOENT);
970 return;
971 }
972
973 rc = driver_fun_offline(&device_tree, fun);
974 fun_del_ref(fun);
975
976 async_answer_0(iid, (sysarg_t) rc);
977}
978
979/** Find handle for the function instance identified by its service ID. */
980static void devman_fun_sid_to_handle(ipc_callid_t iid, ipc_call_t *icall)
981{
982 fun_node_t *fun;
983
984 fun = find_loc_tree_function(&device_tree, IPC_GET_ARG1(*icall));
985
986 if (fun == NULL) {
987 async_answer_0(iid, ENOENT);
988 return;
989 }
990
991 fibril_rwlock_read_lock(&device_tree.rwlock);
992
993 /* Check function state */
994 if (fun->state == FUN_REMOVED) {
995 fibril_rwlock_read_unlock(&device_tree.rwlock);
996 async_answer_0(iid, ENOENT);
997 return;
998 }
999
1000 async_answer_1(iid, EOK, fun->handle);
1001 fibril_rwlock_read_unlock(&device_tree.rwlock);
1002 fun_del_ref(fun);
1003}
1004
1005/** Function for handling connections from a client to the device manager. */
1006static void devman_connection_client(ipc_callid_t iid, ipc_call_t *icall)
1007{
1008 /* Accept connection. */
1009 async_answer_0(iid, EOK);
1010
1011 while (true) {
1012 ipc_call_t call;
1013 ipc_callid_t callid = async_get_call(&call);
1014
1015 if (!IPC_GET_IMETHOD(call))
1016 break;
1017
1018 switch (IPC_GET_IMETHOD(call)) {
1019 case DEVMAN_DEVICE_GET_HANDLE:
1020 devman_function_get_handle(callid, &call);
1021 break;
1022 case DEVMAN_DEV_GET_FUNCTIONS:
1023 devman_dev_get_functions(callid, &call);
1024 break;
1025 case DEVMAN_FUN_GET_CHILD:
1026 devman_fun_get_child(callid, &call);
1027 break;
1028 case DEVMAN_FUN_GET_NAME:
1029 devman_fun_get_name(callid, &call);
1030 break;
1031 case DEVMAN_FUN_GET_PATH:
1032 devman_fun_get_path(callid, &call);
1033 break;
1034 case DEVMAN_FUN_ONLINE:
1035 devman_fun_online(callid, &call);
1036 break;
1037 case DEVMAN_FUN_OFFLINE:
1038 devman_fun_offline(callid, &call);
1039 break;
1040 case DEVMAN_FUN_SID_TO_HANDLE:
1041 devman_fun_sid_to_handle(callid, &call);
1042 break;
1043 default:
1044 async_answer_0(callid, ENOENT);
1045 }
1046 }
1047}
1048
1049static void devman_forward(ipc_callid_t iid, ipc_call_t *icall,
1050 bool drv_to_parent)
1051{
1052 devman_handle_t handle = IPC_GET_ARG2(*icall);
1053 devman_handle_t fwd_h;
1054 fun_node_t *fun = NULL;
1055 dev_node_t *dev = NULL;
1056
1057 fun = find_fun_node(&device_tree, handle);
1058 if (fun == NULL)
1059 dev = find_dev_node(&device_tree, handle);
1060 else {
1061 fibril_rwlock_read_lock(&device_tree.rwlock);
1062 dev = fun->dev;
1063 if (dev != NULL)
1064 dev_add_ref(dev);
1065 fibril_rwlock_read_unlock(&device_tree.rwlock);
1066 }
1067
1068 /*
1069 * For a valid function to connect to we need a device. The root
1070 * function, for example, has no device and cannot be connected to.
1071 * This means @c dev needs to be valid regardless whether we are
1072 * connecting to a device or to a function.
1073 */
1074 if (dev == NULL) {
1075 log_msg(LVL_ERROR, "IPC forwarding failed - no device or "
1076 "function with handle %" PRIun " was found.", handle);
1077 async_answer_0(iid, ENOENT);
1078 goto cleanup;
1079 }
1080
1081 if (fun == NULL && !drv_to_parent) {
1082 log_msg(LVL_ERROR, NAME ": devman_forward error - cannot "
1083 "connect to handle %" PRIun ", refers to a device.",
1084 handle);
1085 async_answer_0(iid, ENOENT);
1086 goto cleanup;
1087 }
1088
1089 driver_t *driver = NULL;
1090
1091 fibril_rwlock_read_lock(&device_tree.rwlock);
1092
1093 if (drv_to_parent) {
1094 /* Connect to parent function of a device (or device function). */
1095 if (dev->pfun->dev != NULL)
1096 driver = dev->pfun->dev->drv;
1097 fwd_h = dev->pfun->handle;
1098 } else if (dev->state == DEVICE_USABLE) {
1099 /* Connect to the specified function */
1100 driver = dev->drv;
1101 assert(driver != NULL);
1102
1103 fwd_h = handle;
1104 }
1105
1106 fibril_rwlock_read_unlock(&device_tree.rwlock);
1107
1108 if (driver == NULL) {
1109 log_msg(LVL_ERROR, "IPC forwarding refused - " \
1110 "the device %" PRIun " is not in usable state.", handle);
1111 async_answer_0(iid, ENOENT);
1112 goto cleanup;
1113 }
1114
1115 int method;
1116 if (drv_to_parent)
1117 method = DRIVER_DRIVER;
1118 else
1119 method = DRIVER_CLIENT;
1120
1121 if (!driver->sess) {
1122 log_msg(LVL_ERROR,
1123 "Could not forward to driver `%s'.", driver->name);
1124 async_answer_0(iid, EINVAL);
1125 goto cleanup;
1126 }
1127
1128 if (fun != NULL) {
1129 log_msg(LVL_DEBUG,
1130 "Forwarding request for `%s' function to driver `%s'.",
1131 fun->pathname, driver->name);
1132 } else {
1133 log_msg(LVL_DEBUG,
1134 "Forwarding request for `%s' device to driver `%s'.",
1135 dev->pfun->pathname, driver->name);
1136 }
1137
1138 async_exch_t *exch = async_exchange_begin(driver->sess);
1139 async_forward_fast(iid, exch, method, fwd_h, 0, IPC_FF_NONE);
1140 async_exchange_end(exch);
1141
1142cleanup:
1143 if (dev != NULL)
1144 dev_del_ref(dev);
1145 if (fun != NULL)
1146 fun_del_ref(fun);
1147}
1148
1149/** Function for handling connections from a client forwarded by the location
1150 * service to the device manager. */
1151static void devman_connection_loc(ipc_callid_t iid, ipc_call_t *icall)
1152{
1153 service_id_t service_id = IPC_GET_ARG2(*icall);
1154 fun_node_t *fun;
1155 dev_node_t *dev;
1156 devman_handle_t handle;
1157 driver_t *driver;
1158
1159 fun = find_loc_tree_function(&device_tree, service_id);
1160
1161 fibril_rwlock_read_lock(&device_tree.rwlock);
1162
1163 if (fun == NULL || fun->dev == NULL || fun->dev->drv == NULL) {
1164 log_msg(LVL_WARN, "devman_connection_loc(): function "
1165 "not found.\n");
1166 fibril_rwlock_read_unlock(&device_tree.rwlock);
1167 async_answer_0(iid, ENOENT);
1168 return;
1169 }
1170
1171 dev = fun->dev;
1172 driver = dev->drv;
1173 handle = fun->handle;
1174
1175 fibril_rwlock_read_unlock(&device_tree.rwlock);
1176
1177 async_exch_t *exch = async_exchange_begin(driver->sess);
1178 async_forward_fast(iid, exch, DRIVER_CLIENT, handle, 0,
1179 IPC_FF_NONE);
1180 async_exchange_end(exch);
1181
1182 log_msg(LVL_DEBUG,
1183 "Forwarding loc service request for `%s' function to driver `%s'.",
1184 fun->pathname, driver->name);
1185
1186 fun_del_ref(fun);
1187}
1188
1189/** Function for handling connections to device manager. */
1190static void devman_connection(ipc_callid_t iid, ipc_call_t *icall, void *arg)
1191{
1192 /* Select port. */
1193 switch ((sysarg_t) (IPC_GET_ARG1(*icall))) {
1194 case DEVMAN_DRIVER:
1195 devman_connection_driver(iid, icall);
1196 break;
1197 case DEVMAN_CLIENT:
1198 devman_connection_client(iid, icall);
1199 break;
1200 case DEVMAN_CONNECT_TO_DEVICE:
1201 /* Connect client to selected device. */
1202 devman_forward(iid, icall, false);
1203 break;
1204 case DEVMAN_CONNECT_FROM_LOC:
1205 /* Someone connected through loc node. */
1206 devman_connection_loc(iid, icall);
1207 break;
1208 case DEVMAN_CONNECT_TO_PARENTS_DEVICE:
1209 /* Connect client to selected device. */
1210 devman_forward(iid, icall, true);
1211 break;
1212 default:
1213 /* No such interface */
1214 async_answer_0(iid, ENOENT);
1215 }
1216}
1217
1218static void *devman_client_data_create(void)
1219{
1220 client_t *client;
1221
1222 client = calloc(1, sizeof(client_t));
1223 if (client == NULL)
1224 return NULL;
1225
1226 fibril_mutex_initialize(&client->mutex);
1227 return client;
1228}
1229
1230static void devman_client_data_destroy(void *data)
1231{
1232 free(data);
1233}
1234
1235/** Initialize device manager internal structures. */
1236static bool devman_init(void)
1237{
1238 log_msg(LVL_DEBUG, "devman_init - looking for available drivers.");
1239
1240 /* Initialize list of available drivers. */
1241 init_driver_list(&drivers_list);
1242 if (lookup_available_drivers(&drivers_list,
1243 DRIVER_DEFAULT_STORE) == 0) {
1244 log_msg(LVL_FATAL, "No drivers found.");
1245 return false;
1246 }
1247
1248 log_msg(LVL_DEBUG, "devman_init - list of drivers has been initialized.");
1249
1250 /* Create root device node. */
1251 if (!init_device_tree(&device_tree, &drivers_list)) {
1252 log_msg(LVL_FATAL, "Failed to initialize device tree.");
1253 return false;
1254 }
1255
1256 /*
1257 * !!! devman_connection ... as the device manager is not a real loc
1258 * driver (it uses a completely different ipc protocol than an ordinary
1259 * loc driver) forwarding a connection from client to the devman by
1260 * location service would not work.
1261 */
1262 loc_server_register(NAME, devman_connection);
1263
1264 return true;
1265}
1266
1267int main(int argc, char *argv[])
1268{
1269 printf(NAME ": HelenOS Device Manager\n");
1270
1271 if (log_init(NAME, LVL_WARN) != EOK) {
1272 printf(NAME ": Error initializing logging subsystem.\n");
1273 return -1;
1274 }
1275
1276 if (!devman_init()) {
1277 log_msg(LVL_ERROR, "Error while initializing service.");
1278 return -1;
1279 }
1280
1281 /* Set handlers for incoming connections. */
1282 async_set_client_data_constructor(devman_client_data_create);
1283 async_set_client_data_destructor(devman_client_data_destroy);
1284 async_set_client_connection(devman_connection);
1285
1286 /* Register device manager at naming service. */
1287 if (service_register(SERVICE_DEVMAN) != EOK) {
1288 log_msg(LVL_ERROR, "Failed registering as a service.");
1289 return -1;
1290 }
1291
1292 printf(NAME ": Accepting connections.\n");
1293 task_retval(0);
1294 async_manager();
1295
1296 /* Never reached. */
1297 return 0;
1298}
1299
1300/** @}
1301 */
Note: See TracBrowser for help on using the repository browser.