Subversion Repositories HelenOS

Rev

Rev 4307 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
4192 mejdrech 1
/*
2
 * Copyright (c) 2009 Lukas Mejdrech
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
 
4307 mejdrech 29
/** @addtogroup net
4192 mejdrech 30
 *  @{
31
 */
32
 
4350 mejdrech 33
/** @file
34
 *  Character string to module map.
4192 mejdrech 35
 */
36
 
37
#ifndef __NET_MODULES_MAP_H__
38
#define __NET_MODULES_MAP_H__
39
 
40
#include <task.h>
41
 
42
#include <ipc/services.h>
43
 
4307 mejdrech 44
#include "../modules.h"
45
 
4192 mejdrech 46
#include "generic_char_map.h"
47
 
4350 mejdrech 48
/** Type definition of the module structure.
49
 *  @see module_struct
50
 */
4192 mejdrech 51
typedef struct module_struct    module_t;
4350 mejdrech 52
 
53
/** Type definition of the module structure pointer.
54
 *  @see module_struct
55
 */
4192 mejdrech 56
typedef module_t *              module_ref;
57
 
4350 mejdrech 58
/** Module map.
59
 *  Sorted by module names.
60
 *  @see generic_char_map.h
61
 */
4192 mejdrech 62
GENERIC_CHAR_MAP_DECLARE( modules, module_t )
63
 
4350 mejdrech 64
/** Module structure.
65
 */
4192 mejdrech 66
struct  module_struct{
4350 mejdrech 67
    /** Module task identifier if running.
68
     */
4192 mejdrech 69
    task_id_t   task_id;
4350 mejdrech 70
    /** Module service identifier.
71
     */
4192 mejdrech 72
    services_t  service;
4350 mejdrech 73
    /** Module phone if running and connected.
74
     */
4192 mejdrech 75
    int         phone;
4350 mejdrech 76
    /** Usage counter.
77
     */
4192 mejdrech 78
    int         usage;
4350 mejdrech 79
    /** Module name.
80
     */
4192 mejdrech 81
    char *      name;
4350 mejdrech 82
    /** Module full path filename.
83
     */
4192 mejdrech 84
    char *      filename;
4350 mejdrech 85
    /** Connecting function.
86
     */
4307 mejdrech 87
    connect_module_t *  connect_module;
4192 mejdrech 88
};
89
 
4350 mejdrech 90
/** Adds module to the module map.
91
 *  @param module The module structure added. Output parameter.
92
 *  @param modules The module map. Input parameter.
93
 *  @param name The module name. Input parameter.
94
 *  @param filename The full path filename. Input parameter.
95
 *  @param service The module service. Input parameter.
96
 *  @param task_id The module current task identifier. Zero (0) means not running. Input parameter.
97
 *  @param connect_module The module connecting function. Input parameter.
98
 *  @returns EOK on success.
99
 *  @returns ENOMEM if there is not enough memory left.
100
 */
4307 mejdrech 101
int add_module( module_ref * module, modules_ref modules, char * name, char * filename, services_t service, task_id_t task_id, connect_module_t * connect_module );
4350 mejdrech 102
 
103
/** Searches and returns the specified module.
104
 *  If the module is not running, the module filaname is spawned.
105
 *  If the module is not connected, the connect_function is called.
106
 *  @param modules The module map. Input parameter.
107
 *  @param name The module name. Input parameter.
108
 *  @returns The running module found. It does not have to be connected.
109
 *  @returns NULL if there is no such module.
110
 */
4192 mejdrech 111
module_ref  get_running_module( modules_ref modules, char * name );
4350 mejdrech 112
 
113
/** Starts the given module.
114
 *  @param fname The module full or relative path filename. Input parameter.
115
 *  @returns The new module task identifier on success.
116
 *  @returns 0 if there is no such module.
117
 */
4192 mejdrech 118
task_id_t   spawn( char * fname );
119
 
120
#endif
121
 
122
/** @}
123
 */