source: mainline/uspace/srv/devman/main.c@ 0f3744d

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 0f3744d was a96a982, checked in by Martin Decky <martin@…>, 14 years ago

do not discard the error value
  • Property mode set to 100644
File size: 33.4 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 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 return;
637 }
638
639 driver_t *driver = dev->drv;
640 fibril_rwlock_read_unlock(&device_tree.rwlock);
641
642 if (driver)
643 detach_driver(&device_tree, dev);
644
645 fibril_rwlock_write_lock(&device_tree.rwlock);
646 remove_dev_node(&device_tree, dev);
647
648 /* Delete ref created when node was inserted */
649 dev_del_ref(dev);
650 /* Delete ref created by dev_add_ref(dev) above */
651 dev_del_ref(dev);
652 }
653 } else {
654 if (fun->service_id != 0) {
655 /* Unregister from location service */
656 rc = loc_service_unregister(fun->service_id);
657 if (rc != EOK) {
658 log_msg(LVL_ERROR, "Failed unregistering tree "
659 "service.");
660 fibril_rwlock_write_unlock(&tree->rwlock);
661 fun_del_ref(fun);
662 async_answer_0(callid, EIO);
663 return;
664 }
665 }
666 }
667
668 remove_fun_node(&device_tree, fun);
669 fibril_rwlock_write_unlock(&tree->rwlock);
670
671 /* Delete ref added when inserting function into tree */
672 fun_del_ref(fun);
673 /* Delete ref added above when looking up function */
674 fun_del_ref(fun);
675
676 log_msg(LVL_DEBUG, "devman_remove_function() succeeded.");
677 async_answer_0(callid, EOK);
678}
679
680/** Initialize driver which has registered itself as running and ready.
681 *
682 * The initialization is done in a separate fibril to avoid deadlocks (if the
683 * driver needed to be served by devman during the driver's initialization).
684 */
685static int init_running_drv(void *drv)
686{
687 driver_t *driver = (driver_t *) drv;
688
689 initialize_running_driver(driver, &device_tree);
690 log_msg(LVL_DEBUG, "The `%s` driver was successfully initialized.",
691 driver->name);
692 return 0;
693}
694
695/** Function for handling connections from a driver to the device manager. */
696static void devman_connection_driver(ipc_callid_t iid, ipc_call_t *icall)
697{
698 client_t *client;
699 driver_t *driver;
700
701 /* Accept the connection. */
702 async_answer_0(iid, EOK);
703
704 client = async_get_client_data();
705 if (client == NULL) {
706 log_msg(LVL_ERROR, "Failed to allocate client data.");
707 return;
708 }
709
710 while (true) {
711 ipc_call_t call;
712 ipc_callid_t callid = async_get_call(&call);
713
714 if (!IPC_GET_IMETHOD(call))
715 break;
716
717 if (IPC_GET_IMETHOD(call) != DEVMAN_DRIVER_REGISTER) {
718 fibril_mutex_lock(&client->mutex);
719 driver = client->driver;
720 fibril_mutex_unlock(&client->mutex);
721 if (driver == NULL) {
722 /* First call must be to DEVMAN_DRIVER_REGISTER */
723 async_answer_0(callid, ENOTSUP);
724 continue;
725 }
726 }
727
728 switch (IPC_GET_IMETHOD(call)) {
729 case DEVMAN_DRIVER_REGISTER:
730 fibril_mutex_lock(&client->mutex);
731 if (client->driver != NULL) {
732 fibril_mutex_unlock(&client->mutex);
733 async_answer_0(callid, EINVAL);
734 continue;
735 }
736 client->driver = devman_driver_register(callid, &call);
737 fibril_mutex_unlock(&client->mutex);
738 break;
739 case DEVMAN_ADD_FUNCTION:
740 devman_add_function(callid, &call);
741 break;
742 case DEVMAN_ADD_DEVICE_TO_CATEGORY:
743 devman_add_function_to_cat(callid, &call);
744 break;
745 case DEVMAN_DRV_FUN_ONLINE:
746 devman_drv_fun_online(callid, &call, driver);
747 break;
748 case DEVMAN_DRV_FUN_OFFLINE:
749 devman_drv_fun_offline(callid, &call, driver);
750 break;
751 case DEVMAN_REMOVE_FUNCTION:
752 devman_remove_function(callid, &call);
753 break;
754 default:
755 async_answer_0(callid, EINVAL);
756 break;
757 }
758 }
759}
760
761/** Find handle for the device instance identified by the device's path in the
762 * device tree. */
763static void devman_function_get_handle(ipc_callid_t iid, ipc_call_t *icall)
764{
765 char *pathname;
766 devman_handle_t handle;
767
768 int rc = async_data_write_accept((void **) &pathname, true, 0, 0, 0, 0);
769 if (rc != EOK) {
770 async_answer_0(iid, rc);
771 return;
772 }
773
774 fun_node_t *fun = find_fun_node_by_path(&device_tree, pathname);
775
776 free(pathname);
777
778 if (fun == NULL) {
779 async_answer_0(iid, ENOENT);
780 return;
781 }
782
783 fibril_rwlock_read_lock(&device_tree.rwlock);
784
785 /* Check function state */
786 if (fun->state == FUN_REMOVED) {
787 fibril_rwlock_read_unlock(&device_tree.rwlock);
788 async_answer_0(iid, ENOENT);
789 return;
790 }
791 handle = fun->handle;
792
793 fibril_rwlock_read_unlock(&device_tree.rwlock);
794
795 /* Delete reference created above by find_fun_node_by_path() */
796 fun_del_ref(fun);
797
798 async_answer_1(iid, EOK, handle);
799}
800
801/** Get device name. */
802static void devman_fun_get_name(ipc_callid_t iid, ipc_call_t *icall)
803{
804 devman_handle_t handle = IPC_GET_ARG1(*icall);
805
806 fun_node_t *fun = find_fun_node(&device_tree, handle);
807 if (fun == NULL) {
808 async_answer_0(iid, ENOMEM);
809 return;
810 }
811
812 ipc_callid_t data_callid;
813 size_t data_len;
814 if (!async_data_read_receive(&data_callid, &data_len)) {
815 async_answer_0(iid, EINVAL);
816 fun_del_ref(fun);
817 return;
818 }
819
820 void *buffer = malloc(data_len);
821 if (buffer == NULL) {
822 async_answer_0(data_callid, ENOMEM);
823 async_answer_0(iid, ENOMEM);
824 fun_del_ref(fun);
825 return;
826 }
827
828 fibril_rwlock_read_lock(&device_tree.rwlock);
829
830 /* Check function state */
831 if (fun->state == FUN_REMOVED) {
832 fibril_rwlock_read_unlock(&device_tree.rwlock);
833 free(buffer);
834
835 async_answer_0(data_callid, ENOENT);
836 async_answer_0(iid, ENOENT);
837 fun_del_ref(fun);
838 return;
839 }
840
841 size_t sent_length = str_size(fun->name);
842 if (sent_length > data_len) {
843 sent_length = data_len;
844 }
845
846 async_data_read_finalize(data_callid, fun->name, sent_length);
847 async_answer_0(iid, EOK);
848
849 fibril_rwlock_read_unlock(&device_tree.rwlock);
850 fun_del_ref(fun);
851 free(buffer);
852}
853
854
855/** Get device path. */
856static void devman_fun_get_path(ipc_callid_t iid, ipc_call_t *icall)
857{
858 devman_handle_t handle = IPC_GET_ARG1(*icall);
859
860 fun_node_t *fun = find_fun_node(&device_tree, handle);
861 if (fun == NULL) {
862 async_answer_0(iid, ENOMEM);
863 return;
864 }
865
866 ipc_callid_t data_callid;
867 size_t data_len;
868 if (!async_data_read_receive(&data_callid, &data_len)) {
869 async_answer_0(iid, EINVAL);
870 fun_del_ref(fun);
871 return;
872 }
873
874 void *buffer = malloc(data_len);
875 if (buffer == NULL) {
876 async_answer_0(data_callid, ENOMEM);
877 async_answer_0(iid, ENOMEM);
878 fun_del_ref(fun);
879 return;
880 }
881
882 fibril_rwlock_read_lock(&device_tree.rwlock);
883
884 /* Check function state */
885 if (fun->state == FUN_REMOVED) {
886 fibril_rwlock_read_unlock(&device_tree.rwlock);
887 free(buffer);
888
889 async_answer_0(data_callid, ENOENT);
890 async_answer_0(iid, ENOENT);
891 fun_del_ref(fun);
892 return;
893 }
894
895 size_t sent_length = str_size(fun->pathname);
896 if (sent_length > data_len) {
897 sent_length = data_len;
898 }
899
900 async_data_read_finalize(data_callid, fun->pathname, sent_length);
901 async_answer_0(iid, EOK);
902
903 fibril_rwlock_read_unlock(&device_tree.rwlock);
904 fun_del_ref(fun);
905 free(buffer);
906}
907
908static void devman_dev_get_functions(ipc_callid_t iid, ipc_call_t *icall)
909{
910 ipc_callid_t callid;
911 size_t size;
912 size_t act_size;
913 int rc;
914
915 if (!async_data_read_receive(&callid, &size)) {
916 async_answer_0(callid, EREFUSED);
917 async_answer_0(iid, EREFUSED);
918 return;
919 }
920
921 fibril_rwlock_read_lock(&device_tree.rwlock);
922
923 dev_node_t *dev = find_dev_node_no_lock(&device_tree,
924 IPC_GET_ARG1(*icall));
925 if (dev == NULL || dev->state == DEVICE_REMOVED) {
926 fibril_rwlock_read_unlock(&device_tree.rwlock);
927 async_answer_0(callid, ENOENT);
928 async_answer_0(iid, ENOENT);
929 return;
930 }
931
932 devman_handle_t *hdl_buf = (devman_handle_t *) malloc(size);
933 if (hdl_buf == NULL) {
934 fibril_rwlock_read_unlock(&device_tree.rwlock);
935 async_answer_0(callid, ENOMEM);
936 async_answer_0(iid, ENOMEM);
937 return;
938 }
939
940 rc = dev_get_functions(&device_tree, dev, hdl_buf, size, &act_size);
941 if (rc != EOK) {
942 fibril_rwlock_read_unlock(&device_tree.rwlock);
943 async_answer_0(callid, rc);
944 async_answer_0(iid, rc);
945 return;
946 }
947
948 fibril_rwlock_read_unlock(&device_tree.rwlock);
949
950 sysarg_t retval = async_data_read_finalize(callid, hdl_buf, size);
951 free(hdl_buf);
952
953 async_answer_1(iid, retval, act_size);
954}
955
956
957/** Get handle for child device of a function. */
958static void devman_fun_get_child(ipc_callid_t iid, ipc_call_t *icall)
959{
960 fun_node_t *fun;
961
962 fibril_rwlock_read_lock(&device_tree.rwlock);
963
964 fun = find_fun_node_no_lock(&device_tree, IPC_GET_ARG1(*icall));
965 if (fun == NULL || fun->state == FUN_REMOVED) {
966 fibril_rwlock_read_unlock(&device_tree.rwlock);
967 async_answer_0(iid, ENOENT);
968 return;
969 }
970
971 if (fun->child == NULL) {
972 fibril_rwlock_read_unlock(&device_tree.rwlock);
973 async_answer_0(iid, ENOENT);
974 return;
975 }
976
977 async_answer_1(iid, EOK, fun->child->handle);
978
979 fibril_rwlock_read_unlock(&device_tree.rwlock);
980}
981
982/** Online function.
983 *
984 * Send a request to online a function to the responsible driver.
985 * The driver may offline other functions if necessary (i.e. if the state
986 * of this function is linked to state of another function somehow).
987 */
988static void devman_fun_online(ipc_callid_t iid, ipc_call_t *icall)
989{
990 fun_node_t *fun;
991 int rc;
992
993 fun = find_fun_node(&device_tree, IPC_GET_ARG1(*icall));
994 if (fun == NULL) {
995 async_answer_0(iid, ENOENT);
996 return;
997 }
998
999 rc = driver_fun_online(&device_tree, fun);
1000 fun_del_ref(fun);
1001
1002 async_answer_0(iid, (sysarg_t) rc);
1003}
1004
1005/** Offline function.
1006 *
1007 * Send a request to offline a function to the responsible driver. As
1008 * a result the subtree rooted at that function should be cleanly
1009 * detatched. The driver may offline other functions if necessary
1010 * (i.e. if the state of this function is linked to state of another
1011 * function somehow).
1012 */
1013static void devman_fun_offline(ipc_callid_t iid, ipc_call_t *icall)
1014{
1015 fun_node_t *fun;
1016 int rc;
1017
1018 fun = find_fun_node(&device_tree, IPC_GET_ARG1(*icall));
1019 if (fun == NULL) {
1020 async_answer_0(iid, ENOENT);
1021 return;
1022 }
1023
1024 rc = driver_fun_offline(&device_tree, fun);
1025 fun_del_ref(fun);
1026
1027 async_answer_0(iid, (sysarg_t) rc);
1028}
1029
1030/** Find handle for the function instance identified by its service ID. */
1031static void devman_fun_sid_to_handle(ipc_callid_t iid, ipc_call_t *icall)
1032{
1033 fun_node_t *fun;
1034
1035 fun = find_loc_tree_function(&device_tree, IPC_GET_ARG1(*icall));
1036
1037 if (fun == NULL) {
1038 async_answer_0(iid, ENOENT);
1039 return;
1040 }
1041
1042 fibril_rwlock_read_lock(&device_tree.rwlock);
1043
1044 /* Check function state */
1045 if (fun->state == FUN_REMOVED) {
1046 fibril_rwlock_read_unlock(&device_tree.rwlock);
1047 async_answer_0(iid, ENOENT);
1048 return;
1049 }
1050
1051 async_answer_1(iid, EOK, fun->handle);
1052 fibril_rwlock_read_unlock(&device_tree.rwlock);
1053 fun_del_ref(fun);
1054}
1055
1056/** Function for handling connections from a client to the device manager. */
1057static void devman_connection_client(ipc_callid_t iid, ipc_call_t *icall)
1058{
1059 /* Accept connection. */
1060 async_answer_0(iid, EOK);
1061
1062 while (true) {
1063 ipc_call_t call;
1064 ipc_callid_t callid = async_get_call(&call);
1065
1066 if (!IPC_GET_IMETHOD(call))
1067 break;
1068
1069 switch (IPC_GET_IMETHOD(call)) {
1070 case DEVMAN_DEVICE_GET_HANDLE:
1071 devman_function_get_handle(callid, &call);
1072 break;
1073 case DEVMAN_DEV_GET_FUNCTIONS:
1074 devman_dev_get_functions(callid, &call);
1075 break;
1076 case DEVMAN_FUN_GET_CHILD:
1077 devman_fun_get_child(callid, &call);
1078 break;
1079 case DEVMAN_FUN_GET_NAME:
1080 devman_fun_get_name(callid, &call);
1081 break;
1082 case DEVMAN_FUN_GET_PATH:
1083 devman_fun_get_path(callid, &call);
1084 break;
1085 case DEVMAN_FUN_ONLINE:
1086 devman_fun_online(callid, &call);
1087 break;
1088 case DEVMAN_FUN_OFFLINE:
1089 devman_fun_offline(callid, &call);
1090 break;
1091 case DEVMAN_FUN_SID_TO_HANDLE:
1092 devman_fun_sid_to_handle(callid, &call);
1093 break;
1094 default:
1095 async_answer_0(callid, ENOENT);
1096 }
1097 }
1098}
1099
1100static void devman_forward(ipc_callid_t iid, ipc_call_t *icall,
1101 bool drv_to_parent)
1102{
1103 devman_handle_t handle = IPC_GET_ARG2(*icall);
1104 devman_handle_t fwd_h;
1105 fun_node_t *fun = NULL;
1106 dev_node_t *dev = NULL;
1107
1108 fun = find_fun_node(&device_tree, handle);
1109 if (fun == NULL)
1110 dev = find_dev_node(&device_tree, handle);
1111 else {
1112 fibril_rwlock_read_lock(&device_tree.rwlock);
1113 dev = fun->dev;
1114 if (dev != NULL)
1115 dev_add_ref(dev);
1116 fibril_rwlock_read_unlock(&device_tree.rwlock);
1117 }
1118
1119 /*
1120 * For a valid function to connect to we need a device. The root
1121 * function, for example, has no device and cannot be connected to.
1122 * This means @c dev needs to be valid regardless whether we are
1123 * connecting to a device or to a function.
1124 */
1125 if (dev == NULL) {
1126 log_msg(LVL_ERROR, "IPC forwarding failed - no device or "
1127 "function with handle %" PRIun " was found.", handle);
1128 async_answer_0(iid, ENOENT);
1129 goto cleanup;
1130 }
1131
1132 if (fun == NULL && !drv_to_parent) {
1133 log_msg(LVL_ERROR, NAME ": devman_forward error - cannot "
1134 "connect to handle %" PRIun ", refers to a device.",
1135 handle);
1136 async_answer_0(iid, ENOENT);
1137 goto cleanup;
1138 }
1139
1140 driver_t *driver = NULL;
1141
1142 fibril_rwlock_read_lock(&device_tree.rwlock);
1143
1144 if (drv_to_parent) {
1145 /* Connect to parent function of a device (or device function). */
1146 if (dev->pfun->dev != NULL)
1147 driver = dev->pfun->dev->drv;
1148 fwd_h = dev->pfun->handle;
1149 } else if (dev->state == DEVICE_USABLE) {
1150 /* Connect to the specified function */
1151 driver = dev->drv;
1152 assert(driver != NULL);
1153
1154 fwd_h = handle;
1155 }
1156
1157 fibril_rwlock_read_unlock(&device_tree.rwlock);
1158
1159 if (driver == NULL) {
1160 log_msg(LVL_ERROR, "IPC forwarding refused - " \
1161 "the device %" PRIun " is not in usable state.", handle);
1162 async_answer_0(iid, ENOENT);
1163 goto cleanup;
1164 }
1165
1166 int method;
1167 if (drv_to_parent)
1168 method = DRIVER_DRIVER;
1169 else
1170 method = DRIVER_CLIENT;
1171
1172 if (!driver->sess) {
1173 log_msg(LVL_ERROR,
1174 "Could not forward to driver `%s'.", driver->name);
1175 async_answer_0(iid, EINVAL);
1176 goto cleanup;
1177 }
1178
1179 if (fun != NULL) {
1180 log_msg(LVL_DEBUG,
1181 "Forwarding request for `%s' function to driver `%s'.",
1182 fun->pathname, driver->name);
1183 } else {
1184 log_msg(LVL_DEBUG,
1185 "Forwarding request for `%s' device to driver `%s'.",
1186 dev->pfun->pathname, driver->name);
1187 }
1188
1189 async_exch_t *exch = async_exchange_begin(driver->sess);
1190 async_forward_fast(iid, exch, method, fwd_h, 0, IPC_FF_NONE);
1191 async_exchange_end(exch);
1192
1193cleanup:
1194 if (dev != NULL)
1195 dev_del_ref(dev);
1196 if (fun != NULL)
1197 fun_del_ref(fun);
1198}
1199
1200/** Function for handling connections from a client forwarded by the location
1201 * service to the device manager. */
1202static void devman_connection_loc(ipc_callid_t iid, ipc_call_t *icall)
1203{
1204 service_id_t service_id = IPC_GET_ARG2(*icall);
1205 fun_node_t *fun;
1206 dev_node_t *dev;
1207 devman_handle_t handle;
1208 driver_t *driver;
1209
1210 fun = find_loc_tree_function(&device_tree, service_id);
1211
1212 fibril_rwlock_read_lock(&device_tree.rwlock);
1213
1214 if (fun == NULL || fun->dev == NULL || fun->dev->drv == NULL) {
1215 log_msg(LVL_WARN, "devman_connection_loc(): function "
1216 "not found.\n");
1217 fibril_rwlock_read_unlock(&device_tree.rwlock);
1218 async_answer_0(iid, ENOENT);
1219 return;
1220 }
1221
1222 dev = fun->dev;
1223 driver = dev->drv;
1224 handle = fun->handle;
1225
1226 fibril_rwlock_read_unlock(&device_tree.rwlock);
1227
1228 async_exch_t *exch = async_exchange_begin(driver->sess);
1229 async_forward_fast(iid, exch, DRIVER_CLIENT, handle, 0,
1230 IPC_FF_NONE);
1231 async_exchange_end(exch);
1232
1233 log_msg(LVL_DEBUG,
1234 "Forwarding loc service request for `%s' function to driver `%s'.",
1235 fun->pathname, driver->name);
1236
1237 fun_del_ref(fun);
1238}
1239
1240/** Function for handling connections to device manager. */
1241static void devman_connection(ipc_callid_t iid, ipc_call_t *icall, void *arg)
1242{
1243 /* Select port. */
1244 switch ((sysarg_t) (IPC_GET_ARG1(*icall))) {
1245 case DEVMAN_DRIVER:
1246 devman_connection_driver(iid, icall);
1247 break;
1248 case DEVMAN_CLIENT:
1249 devman_connection_client(iid, icall);
1250 break;
1251 case DEVMAN_CONNECT_TO_DEVICE:
1252 /* Connect client to selected device. */
1253 devman_forward(iid, icall, false);
1254 break;
1255 case DEVMAN_CONNECT_FROM_LOC:
1256 /* Someone connected through loc node. */
1257 devman_connection_loc(iid, icall);
1258 break;
1259 case DEVMAN_CONNECT_TO_PARENTS_DEVICE:
1260 /* Connect client to selected device. */
1261 devman_forward(iid, icall, true);
1262 break;
1263 default:
1264 /* No such interface */
1265 async_answer_0(iid, ENOENT);
1266 }
1267}
1268
1269static void *devman_client_data_create(void)
1270{
1271 client_t *client;
1272
1273 client = calloc(1, sizeof(client_t));
1274 if (client == NULL)
1275 return NULL;
1276
1277 fibril_mutex_initialize(&client->mutex);
1278 return client;
1279}
1280
1281static void devman_client_data_destroy(void *data)
1282{
1283 free(data);
1284}
1285
1286/** Initialize device manager internal structures. */
1287static bool devman_init(void)
1288{
1289 log_msg(LVL_DEBUG, "devman_init - looking for available drivers.");
1290
1291 /* Initialize list of available drivers. */
1292 init_driver_list(&drivers_list);
1293 if (lookup_available_drivers(&drivers_list,
1294 DRIVER_DEFAULT_STORE) == 0) {
1295 log_msg(LVL_FATAL, "No drivers found.");
1296 return false;
1297 }
1298
1299 log_msg(LVL_DEBUG, "devman_init - list of drivers has been initialized.");
1300
1301 /* Create root device node. */
1302 if (!init_device_tree(&device_tree, &drivers_list)) {
1303 log_msg(LVL_FATAL, "Failed to initialize device tree.");
1304 return false;
1305 }
1306
1307 /*
1308 * !!! devman_connection ... as the device manager is not a real loc
1309 * driver (it uses a completely different ipc protocol than an ordinary
1310 * loc driver) forwarding a connection from client to the devman by
1311 * location service would not work.
1312 */
1313 loc_server_register(NAME, devman_connection);
1314
1315 return true;
1316}
1317
1318int main(int argc, char *argv[])
1319{
1320 printf(NAME ": HelenOS Device Manager\n");
1321
1322 if (log_init(NAME, LVL_WARN) != EOK) {
1323 printf(NAME ": Error initializing logging subsystem.\n");
1324 return -1;
1325 }
1326
1327 if (!devman_init()) {
1328 log_msg(LVL_ERROR, "Error while initializing service.");
1329 return -1;
1330 }
1331
1332 /* Set handlers for incoming connections. */
1333 async_set_client_data_constructor(devman_client_data_create);
1334 async_set_client_data_destructor(devman_client_data_destroy);
1335 async_set_client_connection(devman_connection);
1336
1337 /* Register device manager at naming service. */
1338 if (service_register(SERVICE_DEVMAN) != EOK) {
1339 log_msg(LVL_ERROR, "Failed registering as a service.");
1340 return -1;
1341 }
1342
1343 printf(NAME ": Accepting connections.\n");
1344 task_retval(0);
1345 async_manager();
1346
1347 /* Never reached. */
1348 return 0;
1349}
1350
1351/** @}
1352 */
Note: See TracBrowser for help on using the repository browser.