source: mainline/uspace/srv/devman/main.c@ 85a4350

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 85a4350 was 50ad3f3, checked in by Martin Decky <martin@…>, 13 years ago

trivial changes (error code reporting, messages)
  • Property mode set to 100644
File size: 33.5 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 /*
276 * Try to find a suitable driver and assign it to the device. We do
277 * not want to block the current fibril that is used for processing
278 * incoming calls: we will launch a separate fibril to handle the
279 * driver assigning. That is because assign_driver can actually include
280 * task spawning which could take some time.
281 */
282 fid_t assign_fibril = fibril_create(assign_driver_fibril, dev);
283 if (assign_fibril == 0) {
284 log_msg(LVL_ERROR, "Failed to create fibril for "
285 "assigning driver.");
286 /* XXX Cleanup */
287 fibril_rwlock_write_unlock(&device_tree.rwlock);
288 return ENOMEM;
289 }
290 fibril_add_ready(assign_fibril);
291 } else
292 loc_register_tree_function(fun, &device_tree);
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 device_state_t dev_state;
319
320 dev_add_ref(dev);
321 dev_state = dev->state;
322
323 fibril_rwlock_write_unlock(&device_tree.rwlock);
324
325 /* If device is owned by driver, ask driver to give it up. */
326 if (dev_state == DEVICE_USABLE) {
327 rc = driver_dev_remove(&device_tree, dev);
328 if (rc != EOK) {
329 dev_del_ref(dev);
330 return ENOTSUP;
331 }
332 }
333
334 /* Verify that driver removed all functions */
335 fibril_rwlock_read_lock(&device_tree.rwlock);
336 if (!list_empty(&dev->functions)) {
337 fibril_rwlock_read_unlock(&device_tree.rwlock);
338 dev_del_ref(dev);
339 return EIO;
340 }
341
342 driver_t *driver = dev->drv;
343 fibril_rwlock_read_unlock(&device_tree.rwlock);
344
345 if (driver)
346 detach_driver(&device_tree, dev);
347
348 fibril_rwlock_write_lock(&device_tree.rwlock);
349 remove_dev_node(&device_tree, dev);
350
351 /* Delete ref created when node was inserted */
352 dev_del_ref(dev);
353 /* Delete ref created by dev_add_ref(dev) above */
354 dev_del_ref(dev);
355 }
356 } else {
357 /* Unregister from location service */
358 rc = loc_service_unregister(fun->service_id);
359 if (rc != EOK) {
360 fibril_rwlock_write_unlock(&device_tree.rwlock);
361 log_msg(LVL_ERROR, "Failed unregistering tree service.");
362 return EIO;
363 }
364
365 fun->service_id = 0;
366 }
367
368 fun->state = FUN_OFF_LINE;
369 fibril_rwlock_write_unlock(&device_tree.rwlock);
370
371 return EOK;
372}
373
374/** Handle function registration.
375 *
376 * Child devices are registered by their parent's device driver.
377 */
378static void devman_add_function(ipc_callid_t callid, ipc_call_t *call)
379{
380 fun_type_t ftype = (fun_type_t) IPC_GET_ARG1(*call);
381 devman_handle_t dev_handle = IPC_GET_ARG2(*call);
382 sysarg_t match_count = IPC_GET_ARG3(*call);
383 dev_tree_t *tree = &device_tree;
384
385 dev_node_t *pdev = find_dev_node(&device_tree, dev_handle);
386 if (pdev == NULL) {
387 async_answer_0(callid, ENOENT);
388 return;
389 }
390
391 if (ftype != fun_inner && ftype != fun_exposed) {
392 /* Unknown function type */
393 log_msg(LVL_ERROR,
394 "Unknown function type %d provided by driver.",
395 (int) ftype);
396
397 dev_del_ref(pdev);
398 async_answer_0(callid, EINVAL);
399 return;
400 }
401
402 char *fun_name = NULL;
403 int rc = async_data_write_accept((void **)&fun_name, true, 0, 0, 0, 0);
404 if (rc != EOK) {
405 dev_del_ref(pdev);
406 async_answer_0(callid, rc);
407 return;
408 }
409
410 fibril_rwlock_write_lock(&tree->rwlock);
411
412 /* Check device state */
413 if (pdev->state == DEVICE_REMOVED) {
414 fibril_rwlock_write_unlock(&tree->rwlock);
415 dev_del_ref(pdev);
416 async_answer_0(callid, ENOENT);
417 return;
418 }
419
420 /* Check that function with same name is not there already. */
421 if (find_fun_node_in_device(tree, pdev, fun_name) != NULL) {
422 fibril_rwlock_write_unlock(&tree->rwlock);
423 dev_del_ref(pdev);
424 async_answer_0(callid, EEXISTS);
425 printf(NAME ": Warning, driver tried to register `%s' twice.\n",
426 fun_name);
427 free(fun_name);
428 return;
429 }
430
431 fun_node_t *fun = create_fun_node();
432 fun_add_ref(fun);
433 fun->ftype = ftype;
434
435 if (!insert_fun_node(&device_tree, fun, fun_name, pdev)) {
436 fibril_rwlock_write_unlock(&tree->rwlock);
437 dev_del_ref(pdev);
438 delete_fun_node(fun);
439 async_answer_0(callid, ENOMEM);
440 return;
441 }
442
443 fibril_rwlock_write_unlock(&tree->rwlock);
444 dev_del_ref(pdev);
445
446 devman_receive_match_ids(match_count, &fun->match_ids);
447
448 rc = online_function(fun);
449 if (rc != EOK) {
450 /* XXX clean up */
451 async_answer_0(callid, rc);
452 return;
453 }
454
455 /* Return device handle to parent's driver. */
456 async_answer_1(callid, EOK, fun->handle);
457}
458
459static void devman_add_function_to_cat(ipc_callid_t callid, ipc_call_t *call)
460{
461 devman_handle_t handle = IPC_GET_ARG1(*call);
462 category_id_t cat_id;
463 int rc;
464
465 /* Get category name. */
466 char *cat_name;
467 rc = async_data_write_accept((void **) &cat_name, true,
468 0, 0, 0, 0);
469 if (rc != EOK) {
470 async_answer_0(callid, rc);
471 return;
472 }
473
474 fun_node_t *fun = find_fun_node(&device_tree, handle);
475 if (fun == NULL) {
476 async_answer_0(callid, ENOENT);
477 return;
478 }
479
480 fibril_rwlock_read_lock(&device_tree.rwlock);
481
482 /* Check function state */
483 if (fun->state == FUN_REMOVED) {
484 fibril_rwlock_read_unlock(&device_tree.rwlock);
485 async_answer_0(callid, ENOENT);
486 return;
487 }
488
489 rc = loc_category_get_id(cat_name, &cat_id, IPC_FLAG_BLOCKING);
490 if (rc == EOK) {
491 loc_service_add_to_cat(fun->service_id, cat_id);
492 log_msg(LVL_NOTE, "Function `%s' added to category `%s'.",
493 fun->pathname, cat_name);
494 } else {
495 log_msg(LVL_ERROR, "Failed adding function `%s' to category "
496 "`%s'.", fun->pathname, cat_name);
497 }
498
499 fibril_rwlock_read_unlock(&device_tree.rwlock);
500 fun_del_ref(fun);
501
502 async_answer_0(callid, rc);
503}
504
505/** Online function by driver request.
506 *
507 */
508static void devman_drv_fun_online(ipc_callid_t iid, ipc_call_t *icall,
509 driver_t *drv)
510{
511 fun_node_t *fun;
512 int rc;
513
514 log_msg(LVL_DEBUG, "devman_drv_fun_online()");
515
516 fun = find_fun_node(&device_tree, IPC_GET_ARG1(*icall));
517 if (fun == NULL) {
518 async_answer_0(iid, ENOENT);
519 return;
520 }
521
522 fibril_rwlock_read_lock(&device_tree.rwlock);
523 if (fun->dev == NULL || fun->dev->drv != drv) {
524 fibril_rwlock_read_unlock(&device_tree.rwlock);
525 fun_del_ref(fun);
526 async_answer_0(iid, ENOENT);
527 return;
528 }
529 fibril_rwlock_read_unlock(&device_tree.rwlock);
530
531 rc = online_function(fun);
532 if (rc != EOK) {
533 fun_del_ref(fun);
534 async_answer_0(iid, (sysarg_t) rc);
535 return;
536 }
537
538 fun_del_ref(fun);
539
540 async_answer_0(iid, (sysarg_t) EOK);
541}
542
543
544/** Offline function by driver request.
545 *
546 */
547static void devman_drv_fun_offline(ipc_callid_t iid, ipc_call_t *icall,
548 driver_t *drv)
549{
550 fun_node_t *fun;
551 int rc;
552
553 fun = find_fun_node(&device_tree, IPC_GET_ARG1(*icall));
554 if (fun == NULL) {
555 async_answer_0(iid, ENOENT);
556 return;
557 }
558
559 fibril_rwlock_write_lock(&device_tree.rwlock);
560 if (fun->dev == NULL || fun->dev->drv != drv) {
561 fun_del_ref(fun);
562 async_answer_0(iid, ENOENT);
563 return;
564 }
565 fibril_rwlock_write_unlock(&device_tree.rwlock);
566
567 rc = offline_function(fun);
568 if (rc != EOK) {
569 fun_del_ref(fun);
570 async_answer_0(iid, (sysarg_t) rc);
571 return;
572 }
573
574 fun_del_ref(fun);
575 async_answer_0(iid, (sysarg_t) EOK);
576}
577
578/** Remove function. */
579static void devman_remove_function(ipc_callid_t callid, ipc_call_t *call)
580{
581 devman_handle_t fun_handle = IPC_GET_ARG1(*call);
582 dev_tree_t *tree = &device_tree;
583 int rc;
584
585 fun_node_t *fun = find_fun_node(&device_tree, fun_handle);
586 if (fun == NULL) {
587 async_answer_0(callid, ENOENT);
588 return;
589 }
590
591 fibril_rwlock_write_lock(&tree->rwlock);
592
593 log_msg(LVL_DEBUG, "devman_remove_function(fun='%s')", fun->pathname);
594
595 /* Check function state */
596 if (fun->state == FUN_REMOVED) {
597 fibril_rwlock_write_unlock(&tree->rwlock);
598 async_answer_0(callid, ENOENT);
599 return;
600 }
601
602 if (fun->ftype == fun_inner) {
603 /* This is a surprise removal. Handle possible descendants */
604 if (fun->child != NULL) {
605 dev_node_t *dev = fun->child;
606 device_state_t dev_state;
607 int gone_rc;
608
609 dev_add_ref(dev);
610 dev_state = dev->state;
611
612 fibril_rwlock_write_unlock(&device_tree.rwlock);
613
614 /* If device is owned by driver, inform driver it is gone. */
615 if (dev_state == DEVICE_USABLE)
616 gone_rc = driver_dev_gone(&device_tree, dev);
617 else
618 gone_rc = EOK;
619
620 fibril_rwlock_read_lock(&device_tree.rwlock);
621
622 /* Verify that driver succeeded and removed all functions */
623 if (gone_rc != EOK || !list_empty(&dev->functions)) {
624 log_msg(LVL_ERROR, "Driver did not remove "
625 "functions for device that is gone. "
626 "Device node is now defunct.");
627
628 /*
629 * Not much we can do but mark the device
630 * node as having invalid state. This
631 * is a driver bug.
632 */
633 dev->state = DEVICE_INVALID;
634 fibril_rwlock_read_unlock(&device_tree.rwlock);
635 dev_del_ref(dev);
636 if (gone_rc == EOK)
637 gone_rc = ENOTSUP;
638 async_answer_0(callid, gone_rc);
639 return;
640 }
641
642 driver_t *driver = dev->drv;
643 fibril_rwlock_read_unlock(&device_tree.rwlock);
644
645 if (driver)
646 detach_driver(&device_tree, dev);
647
648 fibril_rwlock_write_lock(&device_tree.rwlock);
649 remove_dev_node(&device_tree, dev);
650
651 /* Delete ref created when node was inserted */
652 dev_del_ref(dev);
653 /* Delete ref created by dev_add_ref(dev) above */
654 dev_del_ref(dev);
655 }
656 } else {
657 if (fun->service_id != 0) {
658 /* Unregister from location service */
659 rc = loc_service_unregister(fun->service_id);
660 if (rc != EOK) {
661 log_msg(LVL_ERROR, "Failed unregistering tree "
662 "service.");
663 fibril_rwlock_write_unlock(&tree->rwlock);
664 fun_del_ref(fun);
665 async_answer_0(callid, EIO);
666 return;
667 }
668 }
669 }
670
671 remove_fun_node(&device_tree, fun);
672 fibril_rwlock_write_unlock(&tree->rwlock);
673
674 /* Delete ref added when inserting function into tree */
675 fun_del_ref(fun);
676 /* Delete ref added above when looking up function */
677 fun_del_ref(fun);
678
679 log_msg(LVL_DEBUG, "devman_remove_function() succeeded.");
680 async_answer_0(callid, EOK);
681}
682
683/** Initialize driver which has registered itself as running and ready.
684 *
685 * The initialization is done in a separate fibril to avoid deadlocks (if the
686 * driver needed to be served by devman during the driver's initialization).
687 */
688static int init_running_drv(void *drv)
689{
690 driver_t *driver = (driver_t *) drv;
691
692 initialize_running_driver(driver, &device_tree);
693 log_msg(LVL_DEBUG, "The `%s` driver was successfully initialized.",
694 driver->name);
695 return 0;
696}
697
698/** Function for handling connections from a driver to the device manager. */
699static void devman_connection_driver(ipc_callid_t iid, ipc_call_t *icall)
700{
701 client_t *client;
702 driver_t *driver;
703
704 /* Accept the connection. */
705 async_answer_0(iid, EOK);
706
707 client = async_get_client_data();
708 if (client == NULL) {
709 log_msg(LVL_ERROR, "Failed to allocate client data.");
710 return;
711 }
712
713 while (true) {
714 ipc_call_t call;
715 ipc_callid_t callid = async_get_call(&call);
716
717 if (!IPC_GET_IMETHOD(call))
718 break;
719
720 if (IPC_GET_IMETHOD(call) != DEVMAN_DRIVER_REGISTER) {
721 fibril_mutex_lock(&client->mutex);
722 driver = client->driver;
723 fibril_mutex_unlock(&client->mutex);
724 if (driver == NULL) {
725 /* First call must be to DEVMAN_DRIVER_REGISTER */
726 async_answer_0(callid, ENOTSUP);
727 continue;
728 }
729 }
730
731 switch (IPC_GET_IMETHOD(call)) {
732 case DEVMAN_DRIVER_REGISTER:
733 fibril_mutex_lock(&client->mutex);
734 if (client->driver != NULL) {
735 fibril_mutex_unlock(&client->mutex);
736 async_answer_0(callid, EINVAL);
737 continue;
738 }
739 client->driver = devman_driver_register(callid, &call);
740 fibril_mutex_unlock(&client->mutex);
741 break;
742 case DEVMAN_ADD_FUNCTION:
743 devman_add_function(callid, &call);
744 break;
745 case DEVMAN_ADD_DEVICE_TO_CATEGORY:
746 devman_add_function_to_cat(callid, &call);
747 break;
748 case DEVMAN_DRV_FUN_ONLINE:
749 devman_drv_fun_online(callid, &call, driver);
750 break;
751 case DEVMAN_DRV_FUN_OFFLINE:
752 devman_drv_fun_offline(callid, &call, driver);
753 break;
754 case DEVMAN_REMOVE_FUNCTION:
755 devman_remove_function(callid, &call);
756 break;
757 default:
758 async_answer_0(callid, EINVAL);
759 break;
760 }
761 }
762}
763
764/** Find handle for the device instance identified by the device's path in the
765 * device tree. */
766static void devman_function_get_handle(ipc_callid_t iid, ipc_call_t *icall)
767{
768 char *pathname;
769 devman_handle_t handle;
770
771 int rc = async_data_write_accept((void **) &pathname, true, 0, 0, 0, 0);
772 if (rc != EOK) {
773 async_answer_0(iid, rc);
774 return;
775 }
776
777 fun_node_t *fun = find_fun_node_by_path(&device_tree, pathname);
778
779 free(pathname);
780
781 if (fun == NULL) {
782 async_answer_0(iid, ENOENT);
783 return;
784 }
785
786 fibril_rwlock_read_lock(&device_tree.rwlock);
787
788 /* Check function state */
789 if (fun->state == FUN_REMOVED) {
790 fibril_rwlock_read_unlock(&device_tree.rwlock);
791 async_answer_0(iid, ENOENT);
792 return;
793 }
794 handle = fun->handle;
795
796 fibril_rwlock_read_unlock(&device_tree.rwlock);
797
798 /* Delete reference created above by find_fun_node_by_path() */
799 fun_del_ref(fun);
800
801 async_answer_1(iid, EOK, handle);
802}
803
804/** Get device name. */
805static void devman_fun_get_name(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->name);
845 if (sent_length > data_len) {
846 sent_length = data_len;
847 }
848
849 async_data_read_finalize(data_callid, fun->name, 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
857
858/** Get device path. */
859static void devman_fun_get_path(ipc_callid_t iid, ipc_call_t *icall)
860{
861 devman_handle_t handle = IPC_GET_ARG1(*icall);
862
863 fun_node_t *fun = find_fun_node(&device_tree, handle);
864 if (fun == NULL) {
865 async_answer_0(iid, ENOMEM);
866 return;
867 }
868
869 ipc_callid_t data_callid;
870 size_t data_len;
871 if (!async_data_read_receive(&data_callid, &data_len)) {
872 async_answer_0(iid, EINVAL);
873 fun_del_ref(fun);
874 return;
875 }
876
877 void *buffer = malloc(data_len);
878 if (buffer == NULL) {
879 async_answer_0(data_callid, ENOMEM);
880 async_answer_0(iid, ENOMEM);
881 fun_del_ref(fun);
882 return;
883 }
884
885 fibril_rwlock_read_lock(&device_tree.rwlock);
886
887 /* Check function state */
888 if (fun->state == FUN_REMOVED) {
889 fibril_rwlock_read_unlock(&device_tree.rwlock);
890 free(buffer);
891
892 async_answer_0(data_callid, ENOENT);
893 async_answer_0(iid, ENOENT);
894 fun_del_ref(fun);
895 return;
896 }
897
898 size_t sent_length = str_size(fun->pathname);
899 if (sent_length > data_len) {
900 sent_length = data_len;
901 }
902
903 async_data_read_finalize(data_callid, fun->pathname, sent_length);
904 async_answer_0(iid, EOK);
905
906 fibril_rwlock_read_unlock(&device_tree.rwlock);
907 fun_del_ref(fun);
908 free(buffer);
909}
910
911static void devman_dev_get_functions(ipc_callid_t iid, ipc_call_t *icall)
912{
913 ipc_callid_t callid;
914 size_t size;
915 size_t act_size;
916 int rc;
917
918 if (!async_data_read_receive(&callid, &size)) {
919 async_answer_0(callid, EREFUSED);
920 async_answer_0(iid, EREFUSED);
921 return;
922 }
923
924 fibril_rwlock_read_lock(&device_tree.rwlock);
925
926 dev_node_t *dev = find_dev_node_no_lock(&device_tree,
927 IPC_GET_ARG1(*icall));
928 if (dev == NULL || dev->state == DEVICE_REMOVED) {
929 fibril_rwlock_read_unlock(&device_tree.rwlock);
930 async_answer_0(callid, ENOENT);
931 async_answer_0(iid, ENOENT);
932 return;
933 }
934
935 devman_handle_t *hdl_buf = (devman_handle_t *) malloc(size);
936 if (hdl_buf == NULL) {
937 fibril_rwlock_read_unlock(&device_tree.rwlock);
938 async_answer_0(callid, ENOMEM);
939 async_answer_0(iid, ENOMEM);
940 return;
941 }
942
943 rc = dev_get_functions(&device_tree, dev, hdl_buf, size, &act_size);
944 if (rc != EOK) {
945 fibril_rwlock_read_unlock(&device_tree.rwlock);
946 async_answer_0(callid, rc);
947 async_answer_0(iid, rc);
948 return;
949 }
950
951 fibril_rwlock_read_unlock(&device_tree.rwlock);
952
953 sysarg_t retval = async_data_read_finalize(callid, hdl_buf, size);
954 free(hdl_buf);
955
956 async_answer_1(iid, retval, act_size);
957}
958
959
960/** Get handle for child device of a function. */
961static void devman_fun_get_child(ipc_callid_t iid, ipc_call_t *icall)
962{
963 fun_node_t *fun;
964
965 fibril_rwlock_read_lock(&device_tree.rwlock);
966
967 fun = find_fun_node_no_lock(&device_tree, IPC_GET_ARG1(*icall));
968 if (fun == NULL || fun->state == FUN_REMOVED) {
969 fibril_rwlock_read_unlock(&device_tree.rwlock);
970 async_answer_0(iid, ENOENT);
971 return;
972 }
973
974 if (fun->child == NULL) {
975 fibril_rwlock_read_unlock(&device_tree.rwlock);
976 async_answer_0(iid, ENOENT);
977 return;
978 }
979
980 async_answer_1(iid, EOK, fun->child->handle);
981
982 fibril_rwlock_read_unlock(&device_tree.rwlock);
983}
984
985/** Online function.
986 *
987 * Send a request to online a function to the responsible driver.
988 * The driver may offline other functions if necessary (i.e. if the state
989 * of this function is linked to state of another function somehow).
990 */
991static void devman_fun_online(ipc_callid_t iid, ipc_call_t *icall)
992{
993 fun_node_t *fun;
994 int rc;
995
996 fun = find_fun_node(&device_tree, IPC_GET_ARG1(*icall));
997 if (fun == NULL) {
998 async_answer_0(iid, ENOENT);
999 return;
1000 }
1001
1002 rc = driver_fun_online(&device_tree, fun);
1003 fun_del_ref(fun);
1004
1005 async_answer_0(iid, (sysarg_t) rc);
1006}
1007
1008/** Offline function.
1009 *
1010 * Send a request to offline a function to the responsible driver. As
1011 * a result the subtree rooted at that function should be cleanly
1012 * detatched. The driver may offline other functions if necessary
1013 * (i.e. if the state of this function is linked to state of another
1014 * function somehow).
1015 */
1016static void devman_fun_offline(ipc_callid_t iid, ipc_call_t *icall)
1017{
1018 fun_node_t *fun;
1019 int rc;
1020
1021 fun = find_fun_node(&device_tree, IPC_GET_ARG1(*icall));
1022 if (fun == NULL) {
1023 async_answer_0(iid, ENOENT);
1024 return;
1025 }
1026
1027 rc = driver_fun_offline(&device_tree, fun);
1028 fun_del_ref(fun);
1029
1030 async_answer_0(iid, (sysarg_t) rc);
1031}
1032
1033/** Find handle for the function instance identified by its service ID. */
1034static void devman_fun_sid_to_handle(ipc_callid_t iid, ipc_call_t *icall)
1035{
1036 fun_node_t *fun;
1037
1038 fun = find_loc_tree_function(&device_tree, IPC_GET_ARG1(*icall));
1039
1040 if (fun == NULL) {
1041 async_answer_0(iid, ENOENT);
1042 return;
1043 }
1044
1045 fibril_rwlock_read_lock(&device_tree.rwlock);
1046
1047 /* Check function state */
1048 if (fun->state == FUN_REMOVED) {
1049 fibril_rwlock_read_unlock(&device_tree.rwlock);
1050 async_answer_0(iid, ENOENT);
1051 return;
1052 }
1053
1054 async_answer_1(iid, EOK, fun->handle);
1055 fibril_rwlock_read_unlock(&device_tree.rwlock);
1056 fun_del_ref(fun);
1057}
1058
1059/** Function for handling connections from a client to the device manager. */
1060static void devman_connection_client(ipc_callid_t iid, ipc_call_t *icall)
1061{
1062 /* Accept connection. */
1063 async_answer_0(iid, EOK);
1064
1065 while (true) {
1066 ipc_call_t call;
1067 ipc_callid_t callid = async_get_call(&call);
1068
1069 if (!IPC_GET_IMETHOD(call))
1070 break;
1071
1072 switch (IPC_GET_IMETHOD(call)) {
1073 case DEVMAN_DEVICE_GET_HANDLE:
1074 devman_function_get_handle(callid, &call);
1075 break;
1076 case DEVMAN_DEV_GET_FUNCTIONS:
1077 devman_dev_get_functions(callid, &call);
1078 break;
1079 case DEVMAN_FUN_GET_CHILD:
1080 devman_fun_get_child(callid, &call);
1081 break;
1082 case DEVMAN_FUN_GET_NAME:
1083 devman_fun_get_name(callid, &call);
1084 break;
1085 case DEVMAN_FUN_GET_PATH:
1086 devman_fun_get_path(callid, &call);
1087 break;
1088 case DEVMAN_FUN_ONLINE:
1089 devman_fun_online(callid, &call);
1090 break;
1091 case DEVMAN_FUN_OFFLINE:
1092 devman_fun_offline(callid, &call);
1093 break;
1094 case DEVMAN_FUN_SID_TO_HANDLE:
1095 devman_fun_sid_to_handle(callid, &call);
1096 break;
1097 default:
1098 async_answer_0(callid, ENOENT);
1099 }
1100 }
1101}
1102
1103static void devman_forward(ipc_callid_t iid, ipc_call_t *icall,
1104 bool drv_to_parent)
1105{
1106 devman_handle_t handle = IPC_GET_ARG2(*icall);
1107 devman_handle_t fwd_h;
1108 fun_node_t *fun = NULL;
1109 dev_node_t *dev = NULL;
1110
1111 fun = find_fun_node(&device_tree, handle);
1112 if (fun == NULL)
1113 dev = find_dev_node(&device_tree, handle);
1114 else {
1115 fibril_rwlock_read_lock(&device_tree.rwlock);
1116 dev = fun->dev;
1117 if (dev != NULL)
1118 dev_add_ref(dev);
1119 fibril_rwlock_read_unlock(&device_tree.rwlock);
1120 }
1121
1122 /*
1123 * For a valid function to connect to we need a device. The root
1124 * function, for example, has no device and cannot be connected to.
1125 * This means @c dev needs to be valid regardless whether we are
1126 * connecting to a device or to a function.
1127 */
1128 if (dev == NULL) {
1129 log_msg(LVL_ERROR, "IPC forwarding failed - no device or "
1130 "function with handle %" PRIun " was found.", handle);
1131 async_answer_0(iid, ENOENT);
1132 goto cleanup;
1133 }
1134
1135 if (fun == NULL && !drv_to_parent) {
1136 log_msg(LVL_ERROR, NAME ": devman_forward error - cannot "
1137 "connect to handle %" PRIun ", refers to a device.",
1138 handle);
1139 async_answer_0(iid, ENOENT);
1140 goto cleanup;
1141 }
1142
1143 driver_t *driver = NULL;
1144
1145 fibril_rwlock_read_lock(&device_tree.rwlock);
1146
1147 if (drv_to_parent) {
1148 /* Connect to parent function of a device (or device function). */
1149 if (dev->pfun->dev != NULL)
1150 driver = dev->pfun->dev->drv;
1151
1152 fwd_h = dev->pfun->handle;
1153 } else if (dev->state == DEVICE_USABLE) {
1154 /* Connect to the specified function */
1155 driver = dev->drv;
1156 assert(driver != NULL);
1157
1158 fwd_h = handle;
1159 }
1160
1161 fibril_rwlock_read_unlock(&device_tree.rwlock);
1162
1163 if (driver == NULL) {
1164 log_msg(LVL_ERROR, "IPC forwarding refused - " \
1165 "the device %" PRIun " is not in usable state.", handle);
1166 async_answer_0(iid, ENOENT);
1167 goto cleanup;
1168 }
1169
1170 int method;
1171 if (drv_to_parent)
1172 method = DRIVER_DRIVER;
1173 else
1174 method = DRIVER_CLIENT;
1175
1176 if (!driver->sess) {
1177 log_msg(LVL_ERROR,
1178 "Could not forward to driver `%s'.", driver->name);
1179 async_answer_0(iid, EINVAL);
1180 goto cleanup;
1181 }
1182
1183 if (fun != NULL) {
1184 log_msg(LVL_DEBUG,
1185 "Forwarding request for `%s' function to driver `%s'.",
1186 fun->pathname, driver->name);
1187 } else {
1188 log_msg(LVL_DEBUG,
1189 "Forwarding request for `%s' device to driver `%s'.",
1190 dev->pfun->pathname, driver->name);
1191 }
1192
1193 async_exch_t *exch = async_exchange_begin(driver->sess);
1194 async_forward_fast(iid, exch, method, fwd_h, 0, IPC_FF_NONE);
1195 async_exchange_end(exch);
1196
1197cleanup:
1198 if (dev != NULL)
1199 dev_del_ref(dev);
1200
1201 if (fun != NULL)
1202 fun_del_ref(fun);
1203}
1204
1205/** Function for handling connections from a client forwarded by the location
1206 * service to the device manager. */
1207static void devman_connection_loc(ipc_callid_t iid, ipc_call_t *icall)
1208{
1209 service_id_t service_id = IPC_GET_ARG2(*icall);
1210 fun_node_t *fun;
1211 dev_node_t *dev;
1212 devman_handle_t handle;
1213 driver_t *driver;
1214
1215 fun = find_loc_tree_function(&device_tree, service_id);
1216
1217 fibril_rwlock_read_lock(&device_tree.rwlock);
1218
1219 if (fun == NULL || fun->dev == NULL || fun->dev->drv == NULL) {
1220 log_msg(LVL_WARN, "devman_connection_loc(): function "
1221 "not found.\n");
1222 fibril_rwlock_read_unlock(&device_tree.rwlock);
1223 async_answer_0(iid, ENOENT);
1224 return;
1225 }
1226
1227 dev = fun->dev;
1228 driver = dev->drv;
1229 handle = fun->handle;
1230
1231 fibril_rwlock_read_unlock(&device_tree.rwlock);
1232
1233 async_exch_t *exch = async_exchange_begin(driver->sess);
1234 async_forward_fast(iid, exch, DRIVER_CLIENT, handle, 0,
1235 IPC_FF_NONE);
1236 async_exchange_end(exch);
1237
1238 log_msg(LVL_DEBUG,
1239 "Forwarding loc service request for `%s' function to driver `%s'.",
1240 fun->pathname, driver->name);
1241
1242 fun_del_ref(fun);
1243}
1244
1245/** Function for handling connections to device manager. */
1246static void devman_connection(ipc_callid_t iid, ipc_call_t *icall, void *arg)
1247{
1248 /* Select port. */
1249 switch ((sysarg_t) (IPC_GET_ARG1(*icall))) {
1250 case DEVMAN_DRIVER:
1251 devman_connection_driver(iid, icall);
1252 break;
1253 case DEVMAN_CLIENT:
1254 devman_connection_client(iid, icall);
1255 break;
1256 case DEVMAN_CONNECT_TO_DEVICE:
1257 /* Connect client to selected device. */
1258 devman_forward(iid, icall, false);
1259 break;
1260 case DEVMAN_CONNECT_FROM_LOC:
1261 /* Someone connected through loc node. */
1262 devman_connection_loc(iid, icall);
1263 break;
1264 case DEVMAN_CONNECT_TO_PARENTS_DEVICE:
1265 /* Connect client to selected device. */
1266 devman_forward(iid, icall, true);
1267 break;
1268 default:
1269 /* No such interface */
1270 async_answer_0(iid, ENOENT);
1271 }
1272}
1273
1274static void *devman_client_data_create(void)
1275{
1276 client_t *client;
1277
1278 client = calloc(1, sizeof(client_t));
1279 if (client == NULL)
1280 return NULL;
1281
1282 fibril_mutex_initialize(&client->mutex);
1283 return client;
1284}
1285
1286static void devman_client_data_destroy(void *data)
1287{
1288 free(data);
1289}
1290
1291/** Initialize device manager internal structures. */
1292static bool devman_init(void)
1293{
1294 log_msg(LVL_DEBUG, "devman_init - looking for available drivers.");
1295
1296 /* Initialize list of available drivers. */
1297 init_driver_list(&drivers_list);
1298 if (lookup_available_drivers(&drivers_list,
1299 DRIVER_DEFAULT_STORE) == 0) {
1300 log_msg(LVL_FATAL, "No drivers found.");
1301 return false;
1302 }
1303
1304 log_msg(LVL_DEBUG, "devman_init - list of drivers has been initialized.");
1305
1306 /* Create root device node. */
1307 if (!init_device_tree(&device_tree, &drivers_list)) {
1308 log_msg(LVL_FATAL, "Failed to initialize device tree.");
1309 return false;
1310 }
1311
1312 /*
1313 * Caution: As the device manager is not a real loc
1314 * driver (it uses a completely different IPC protocol
1315 * than an ordinary loc driver), forwarding a connection
1316 * from client to the devman by location service will
1317 * not work.
1318 */
1319 loc_server_register(NAME);
1320
1321 return true;
1322}
1323
1324int main(int argc, char *argv[])
1325{
1326 printf("%s: HelenOS Device Manager\n", NAME);
1327
1328 int rc = log_init(NAME, LVL_WARN);
1329 if (rc != EOK) {
1330 printf("%s: Error initializing logging subsystem.\n", NAME);
1331 return rc;
1332 }
1333
1334 /* Set handlers for incoming connections. */
1335 async_set_client_data_constructor(devman_client_data_create);
1336 async_set_client_data_destructor(devman_client_data_destroy);
1337 async_set_client_connection(devman_connection);
1338
1339 if (!devman_init()) {
1340 log_msg(LVL_ERROR, "Error while initializing service.");
1341 return -1;
1342 }
1343
1344 /* Register device manager at naming service. */
1345 rc = service_register(SERVICE_DEVMAN);
1346 if (rc != EOK) {
1347 log_msg(LVL_ERROR, "Failed registering as a service.");
1348 return rc;
1349 }
1350
1351 printf("%s: Accepting connections.\n", NAME);
1352 task_retval(0);
1353 async_manager();
1354
1355 /* Never reached. */
1356 return 0;
1357}
1358
1359/** @}
1360 */
Note: See TracBrowser for help on using the repository browser.