source: mainline/uspace/srv/devman/main.c@ 2e39656

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

In devctl print driver name for child of each function (and not the handle).
  • Property mode set to 100644
File size: 35.0 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/** Get function driver name. */
858static void devman_fun_get_driver_name(ipc_callid_t iid, ipc_call_t *icall)
859{
860 devman_handle_t handle = IPC_GET_ARG1(*icall);
861
862 fun_node_t *fun = find_fun_node(&device_tree, handle);
863 if (fun == NULL) {
864 async_answer_0(iid, ENOMEM);
865 return;
866 }
867
868 ipc_callid_t data_callid;
869 size_t data_len;
870 if (!async_data_read_receive(&data_callid, &data_len)) {
871 async_answer_0(iid, EINVAL);
872 fun_del_ref(fun);
873 return;
874 }
875
876 void *buffer = malloc(data_len);
877 if (buffer == NULL) {
878 async_answer_0(data_callid, ENOMEM);
879 async_answer_0(iid, ENOMEM);
880 fun_del_ref(fun);
881 return;
882 }
883
884 fibril_rwlock_read_lock(&device_tree.rwlock);
885
886 /* Check function state */
887 if (fun->state == FUN_REMOVED) {
888 fibril_rwlock_read_unlock(&device_tree.rwlock);
889 free(buffer);
890
891 async_answer_0(data_callid, ENOENT);
892 async_answer_0(iid, ENOENT);
893 fun_del_ref(fun);
894 return;
895 }
896
897 /* Check whether function has a driver */
898 if (fun->child == NULL || fun->child->drv == NULL) {
899 fibril_rwlock_read_unlock(&device_tree.rwlock);
900 free(buffer);
901
902 async_answer_0(data_callid, EINVAL);
903 async_answer_0(iid, EINVAL);
904 fun_del_ref(fun);
905 return;
906 }
907
908 size_t sent_length = str_size(fun->child->drv->name);
909 if (sent_length > data_len) {
910 sent_length = data_len;
911 }
912
913 async_data_read_finalize(data_callid, fun->child->drv->name,
914 sent_length);
915 async_answer_0(iid, EOK);
916
917 fibril_rwlock_read_unlock(&device_tree.rwlock);
918 fun_del_ref(fun);
919 free(buffer);
920}
921
922/** Get device path. */
923static void devman_fun_get_path(ipc_callid_t iid, ipc_call_t *icall)
924{
925 devman_handle_t handle = IPC_GET_ARG1(*icall);
926
927 fun_node_t *fun = find_fun_node(&device_tree, handle);
928 if (fun == NULL) {
929 async_answer_0(iid, ENOMEM);
930 return;
931 }
932
933 ipc_callid_t data_callid;
934 size_t data_len;
935 if (!async_data_read_receive(&data_callid, &data_len)) {
936 async_answer_0(iid, EINVAL);
937 fun_del_ref(fun);
938 return;
939 }
940
941 void *buffer = malloc(data_len);
942 if (buffer == NULL) {
943 async_answer_0(data_callid, ENOMEM);
944 async_answer_0(iid, ENOMEM);
945 fun_del_ref(fun);
946 return;
947 }
948
949 fibril_rwlock_read_lock(&device_tree.rwlock);
950
951 /* Check function state */
952 if (fun->state == FUN_REMOVED) {
953 fibril_rwlock_read_unlock(&device_tree.rwlock);
954 free(buffer);
955
956 async_answer_0(data_callid, ENOENT);
957 async_answer_0(iid, ENOENT);
958 fun_del_ref(fun);
959 return;
960 }
961
962 size_t sent_length = str_size(fun->pathname);
963 if (sent_length > data_len) {
964 sent_length = data_len;
965 }
966
967 async_data_read_finalize(data_callid, fun->pathname, sent_length);
968 async_answer_0(iid, EOK);
969
970 fibril_rwlock_read_unlock(&device_tree.rwlock);
971 fun_del_ref(fun);
972 free(buffer);
973}
974
975static void devman_dev_get_functions(ipc_callid_t iid, ipc_call_t *icall)
976{
977 ipc_callid_t callid;
978 size_t size;
979 size_t act_size;
980 int rc;
981
982 if (!async_data_read_receive(&callid, &size)) {
983 async_answer_0(callid, EREFUSED);
984 async_answer_0(iid, EREFUSED);
985 return;
986 }
987
988 fibril_rwlock_read_lock(&device_tree.rwlock);
989
990 dev_node_t *dev = find_dev_node_no_lock(&device_tree,
991 IPC_GET_ARG1(*icall));
992 if (dev == NULL || dev->state == DEVICE_REMOVED) {
993 fibril_rwlock_read_unlock(&device_tree.rwlock);
994 async_answer_0(callid, ENOENT);
995 async_answer_0(iid, ENOENT);
996 return;
997 }
998
999 devman_handle_t *hdl_buf = (devman_handle_t *) malloc(size);
1000 if (hdl_buf == NULL) {
1001 fibril_rwlock_read_unlock(&device_tree.rwlock);
1002 async_answer_0(callid, ENOMEM);
1003 async_answer_0(iid, ENOMEM);
1004 return;
1005 }
1006
1007 rc = dev_get_functions(&device_tree, dev, hdl_buf, size, &act_size);
1008 if (rc != EOK) {
1009 fibril_rwlock_read_unlock(&device_tree.rwlock);
1010 async_answer_0(callid, rc);
1011 async_answer_0(iid, rc);
1012 return;
1013 }
1014
1015 fibril_rwlock_read_unlock(&device_tree.rwlock);
1016
1017 sysarg_t retval = async_data_read_finalize(callid, hdl_buf, size);
1018 free(hdl_buf);
1019
1020 async_answer_1(iid, retval, act_size);
1021}
1022
1023
1024/** Get handle for child device of a function. */
1025static void devman_fun_get_child(ipc_callid_t iid, ipc_call_t *icall)
1026{
1027 fun_node_t *fun;
1028
1029 fibril_rwlock_read_lock(&device_tree.rwlock);
1030
1031 fun = find_fun_node_no_lock(&device_tree, IPC_GET_ARG1(*icall));
1032 if (fun == NULL || fun->state == FUN_REMOVED) {
1033 fibril_rwlock_read_unlock(&device_tree.rwlock);
1034 async_answer_0(iid, ENOENT);
1035 return;
1036 }
1037
1038 if (fun->child == NULL) {
1039 fibril_rwlock_read_unlock(&device_tree.rwlock);
1040 async_answer_0(iid, ENOENT);
1041 return;
1042 }
1043
1044 async_answer_1(iid, EOK, fun->child->handle);
1045
1046 fibril_rwlock_read_unlock(&device_tree.rwlock);
1047}
1048
1049/** Online function.
1050 *
1051 * Send a request to online a function to the responsible driver.
1052 * The driver may offline other functions if necessary (i.e. if the state
1053 * of this function is linked to state of another function somehow).
1054 */
1055static void devman_fun_online(ipc_callid_t iid, ipc_call_t *icall)
1056{
1057 fun_node_t *fun;
1058 int rc;
1059
1060 fun = find_fun_node(&device_tree, IPC_GET_ARG1(*icall));
1061 if (fun == NULL) {
1062 async_answer_0(iid, ENOENT);
1063 return;
1064 }
1065
1066 rc = driver_fun_online(&device_tree, fun);
1067 fun_del_ref(fun);
1068
1069 async_answer_0(iid, (sysarg_t) rc);
1070}
1071
1072/** Offline function.
1073 *
1074 * Send a request to offline a function to the responsible driver. As
1075 * a result the subtree rooted at that function should be cleanly
1076 * detatched. The driver may offline other functions if necessary
1077 * (i.e. if the state of this function is linked to state of another
1078 * function somehow).
1079 */
1080static void devman_fun_offline(ipc_callid_t iid, ipc_call_t *icall)
1081{
1082 fun_node_t *fun;
1083 int rc;
1084
1085 fun = find_fun_node(&device_tree, IPC_GET_ARG1(*icall));
1086 if (fun == NULL) {
1087 async_answer_0(iid, ENOENT);
1088 return;
1089 }
1090
1091 rc = driver_fun_offline(&device_tree, fun);
1092 fun_del_ref(fun);
1093
1094 async_answer_0(iid, (sysarg_t) rc);
1095}
1096
1097/** Find handle for the function instance identified by its service ID. */
1098static void devman_fun_sid_to_handle(ipc_callid_t iid, ipc_call_t *icall)
1099{
1100 fun_node_t *fun;
1101
1102 fun = find_loc_tree_function(&device_tree, IPC_GET_ARG1(*icall));
1103
1104 if (fun == NULL) {
1105 async_answer_0(iid, ENOENT);
1106 return;
1107 }
1108
1109 fibril_rwlock_read_lock(&device_tree.rwlock);
1110
1111 /* Check function state */
1112 if (fun->state == FUN_REMOVED) {
1113 fibril_rwlock_read_unlock(&device_tree.rwlock);
1114 async_answer_0(iid, ENOENT);
1115 return;
1116 }
1117
1118 async_answer_1(iid, EOK, fun->handle);
1119 fibril_rwlock_read_unlock(&device_tree.rwlock);
1120 fun_del_ref(fun);
1121}
1122
1123/** Function for handling connections from a client to the device manager. */
1124static void devman_connection_client(ipc_callid_t iid, ipc_call_t *icall)
1125{
1126 /* Accept connection. */
1127 async_answer_0(iid, EOK);
1128
1129 while (true) {
1130 ipc_call_t call;
1131 ipc_callid_t callid = async_get_call(&call);
1132
1133 if (!IPC_GET_IMETHOD(call))
1134 break;
1135
1136 switch (IPC_GET_IMETHOD(call)) {
1137 case DEVMAN_DEVICE_GET_HANDLE:
1138 devman_function_get_handle(callid, &call);
1139 break;
1140 case DEVMAN_DEV_GET_FUNCTIONS:
1141 devman_dev_get_functions(callid, &call);
1142 break;
1143 case DEVMAN_FUN_GET_CHILD:
1144 devman_fun_get_child(callid, &call);
1145 break;
1146 case DEVMAN_FUN_GET_NAME:
1147 devman_fun_get_name(callid, &call);
1148 break;
1149 case DEVMAN_FUN_GET_DRIVER_NAME:
1150 devman_fun_get_driver_name(callid, &call);
1151 break;
1152 case DEVMAN_FUN_GET_PATH:
1153 devman_fun_get_path(callid, &call);
1154 break;
1155 case DEVMAN_FUN_ONLINE:
1156 devman_fun_online(callid, &call);
1157 break;
1158 case DEVMAN_FUN_OFFLINE:
1159 devman_fun_offline(callid, &call);
1160 break;
1161 case DEVMAN_FUN_SID_TO_HANDLE:
1162 devman_fun_sid_to_handle(callid, &call);
1163 break;
1164 default:
1165 async_answer_0(callid, ENOENT);
1166 }
1167 }
1168}
1169
1170static void devman_forward(ipc_callid_t iid, ipc_call_t *icall,
1171 bool drv_to_parent)
1172{
1173 devman_handle_t handle = IPC_GET_ARG2(*icall);
1174 devman_handle_t fwd_h;
1175 fun_node_t *fun = NULL;
1176 dev_node_t *dev = NULL;
1177
1178 fun = find_fun_node(&device_tree, handle);
1179 if (fun == NULL)
1180 dev = find_dev_node(&device_tree, handle);
1181 else {
1182 fibril_rwlock_read_lock(&device_tree.rwlock);
1183 dev = fun->dev;
1184 if (dev != NULL)
1185 dev_add_ref(dev);
1186 fibril_rwlock_read_unlock(&device_tree.rwlock);
1187 }
1188
1189 /*
1190 * For a valid function to connect to we need a device. The root
1191 * function, for example, has no device and cannot be connected to.
1192 * This means @c dev needs to be valid regardless whether we are
1193 * connecting to a device or to a function.
1194 */
1195 if (dev == NULL) {
1196 log_msg(LVL_ERROR, "IPC forwarding failed - no device or "
1197 "function with handle %" PRIun " was found.", handle);
1198 async_answer_0(iid, ENOENT);
1199 goto cleanup;
1200 }
1201
1202 if (fun == NULL && !drv_to_parent) {
1203 log_msg(LVL_ERROR, NAME ": devman_forward error - cannot "
1204 "connect to handle %" PRIun ", refers to a device.",
1205 handle);
1206 async_answer_0(iid, ENOENT);
1207 goto cleanup;
1208 }
1209
1210 driver_t *driver = NULL;
1211
1212 fibril_rwlock_read_lock(&device_tree.rwlock);
1213
1214 if (drv_to_parent) {
1215 /* Connect to parent function of a device (or device function). */
1216 if (dev->pfun->dev != NULL)
1217 driver = dev->pfun->dev->drv;
1218
1219 fwd_h = dev->pfun->handle;
1220 } else if (dev->state == DEVICE_USABLE) {
1221 /* Connect to the specified function */
1222 driver = dev->drv;
1223 assert(driver != NULL);
1224
1225 fwd_h = handle;
1226 }
1227
1228 fibril_rwlock_read_unlock(&device_tree.rwlock);
1229
1230 if (driver == NULL) {
1231 log_msg(LVL_ERROR, "IPC forwarding refused - " \
1232 "the device %" PRIun " is not in usable state.", handle);
1233 async_answer_0(iid, ENOENT);
1234 goto cleanup;
1235 }
1236
1237 int method;
1238 if (drv_to_parent)
1239 method = DRIVER_DRIVER;
1240 else
1241 method = DRIVER_CLIENT;
1242
1243 if (!driver->sess) {
1244 log_msg(LVL_ERROR,
1245 "Could not forward to driver `%s'.", driver->name);
1246 async_answer_0(iid, EINVAL);
1247 goto cleanup;
1248 }
1249
1250 if (fun != NULL) {
1251 log_msg(LVL_DEBUG,
1252 "Forwarding request for `%s' function to driver `%s'.",
1253 fun->pathname, driver->name);
1254 } else {
1255 log_msg(LVL_DEBUG,
1256 "Forwarding request for `%s' device to driver `%s'.",
1257 dev->pfun->pathname, driver->name);
1258 }
1259
1260 async_exch_t *exch = async_exchange_begin(driver->sess);
1261 async_forward_fast(iid, exch, method, fwd_h, 0, IPC_FF_NONE);
1262 async_exchange_end(exch);
1263
1264cleanup:
1265 if (dev != NULL)
1266 dev_del_ref(dev);
1267
1268 if (fun != NULL)
1269 fun_del_ref(fun);
1270}
1271
1272/** Function for handling connections from a client forwarded by the location
1273 * service to the device manager. */
1274static void devman_connection_loc(ipc_callid_t iid, ipc_call_t *icall)
1275{
1276 service_id_t service_id = IPC_GET_ARG2(*icall);
1277 fun_node_t *fun;
1278 dev_node_t *dev;
1279 devman_handle_t handle;
1280 driver_t *driver;
1281
1282 fun = find_loc_tree_function(&device_tree, service_id);
1283
1284 fibril_rwlock_read_lock(&device_tree.rwlock);
1285
1286 if (fun == NULL || fun->dev == NULL || fun->dev->drv == NULL) {
1287 log_msg(LVL_WARN, "devman_connection_loc(): function "
1288 "not found.\n");
1289 fibril_rwlock_read_unlock(&device_tree.rwlock);
1290 async_answer_0(iid, ENOENT);
1291 return;
1292 }
1293
1294 dev = fun->dev;
1295 driver = dev->drv;
1296 handle = fun->handle;
1297
1298 fibril_rwlock_read_unlock(&device_tree.rwlock);
1299
1300 async_exch_t *exch = async_exchange_begin(driver->sess);
1301 async_forward_fast(iid, exch, DRIVER_CLIENT, handle, 0,
1302 IPC_FF_NONE);
1303 async_exchange_end(exch);
1304
1305 log_msg(LVL_DEBUG,
1306 "Forwarding loc service request for `%s' function to driver `%s'.",
1307 fun->pathname, driver->name);
1308
1309 fun_del_ref(fun);
1310}
1311
1312/** Function for handling connections to device manager. */
1313static void devman_connection(ipc_callid_t iid, ipc_call_t *icall, void *arg)
1314{
1315 /* Select port. */
1316 switch ((sysarg_t) (IPC_GET_ARG1(*icall))) {
1317 case DEVMAN_DRIVER:
1318 devman_connection_driver(iid, icall);
1319 break;
1320 case DEVMAN_CLIENT:
1321 devman_connection_client(iid, icall);
1322 break;
1323 case DEVMAN_CONNECT_TO_DEVICE:
1324 /* Connect client to selected device. */
1325 devman_forward(iid, icall, false);
1326 break;
1327 case DEVMAN_CONNECT_FROM_LOC:
1328 /* Someone connected through loc node. */
1329 devman_connection_loc(iid, icall);
1330 break;
1331 case DEVMAN_CONNECT_TO_PARENTS_DEVICE:
1332 /* Connect client to selected device. */
1333 devman_forward(iid, icall, true);
1334 break;
1335 default:
1336 /* No such interface */
1337 async_answer_0(iid, ENOENT);
1338 }
1339}
1340
1341static void *devman_client_data_create(void)
1342{
1343 client_t *client;
1344
1345 client = calloc(1, sizeof(client_t));
1346 if (client == NULL)
1347 return NULL;
1348
1349 fibril_mutex_initialize(&client->mutex);
1350 return client;
1351}
1352
1353static void devman_client_data_destroy(void *data)
1354{
1355 free(data);
1356}
1357
1358/** Initialize device manager internal structures. */
1359static bool devman_init(void)
1360{
1361 log_msg(LVL_DEBUG, "devman_init - looking for available drivers.");
1362
1363 /* Initialize list of available drivers. */
1364 init_driver_list(&drivers_list);
1365 if (lookup_available_drivers(&drivers_list,
1366 DRIVER_DEFAULT_STORE) == 0) {
1367 log_msg(LVL_FATAL, "No drivers found.");
1368 return false;
1369 }
1370
1371 log_msg(LVL_DEBUG, "devman_init - list of drivers has been initialized.");
1372
1373 /* Create root device node. */
1374 if (!init_device_tree(&device_tree, &drivers_list)) {
1375 log_msg(LVL_FATAL, "Failed to initialize device tree.");
1376 return false;
1377 }
1378
1379 /*
1380 * Caution: As the device manager is not a real loc
1381 * driver (it uses a completely different IPC protocol
1382 * than an ordinary loc driver), forwarding a connection
1383 * from client to the devman by location service will
1384 * not work.
1385 */
1386 loc_server_register(NAME);
1387
1388 return true;
1389}
1390
1391int main(int argc, char *argv[])
1392{
1393 printf("%s: HelenOS Device Manager\n", NAME);
1394
1395 int rc = log_init(NAME, LVL_WARN);
1396 if (rc != EOK) {
1397 printf("%s: Error initializing logging subsystem.\n", NAME);
1398 return rc;
1399 }
1400
1401 /* Set handlers for incoming connections. */
1402 async_set_client_data_constructor(devman_client_data_create);
1403 async_set_client_data_destructor(devman_client_data_destroy);
1404 async_set_client_connection(devman_connection);
1405
1406 if (!devman_init()) {
1407 log_msg(LVL_ERROR, "Error while initializing service.");
1408 return -1;
1409 }
1410
1411 /* Register device manager at naming service. */
1412 rc = service_register(SERVICE_DEVMAN);
1413 if (rc != EOK) {
1414 log_msg(LVL_ERROR, "Failed registering as a service.");
1415 return rc;
1416 }
1417
1418 printf("%s: Accepting connections.\n", NAME);
1419 task_retval(0);
1420 async_manager();
1421
1422 /* Never reached. */
1423 return 0;
1424}
1425
1426/** @}
1427 */
Note: See TracBrowser for help on using the repository browser.