WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/module.c


/*
 * Copyright (c) 2009 Lukas Mejdrech
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup net
 *  @{
 */
 
/** @file
 *  Generic module skeleton implementation.
 */
 
#include <async.h>
#include <stdio.h>
#include <task.h>
 
#include <ipc/ipc.h>
 
#include "err.h"
 
/** @name External module functions.
 *  This functions have to be implemented in every module.
 */
/*@{*/
 
/** External message processing function.
 *  Should process the messages.
 *  The function has to be defined in each module.
 *  @param callid The message identifier. Input parameter.
 *  @param call The message parameters. Input parameter.
 *  @param answer The message answer parameters. Output parameter.
 *  @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
 *  @returns EOK on success.
 *  @returns ENOTSUP if the message is not known.
 *  @returns Other error codes as defined for each specific module message function.
 */
extern int  module_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
 
/** External function to print the module name.
 *  Should print the module name.
 *  The function has to be defined in each module.
 */
extern void module_print_name( void );
 
/** External module startup function.
 *  Should start and initialize the module and register the given client connection function.
 *  The function has to be defined in each module.
 *  @param client_connection The client connection function to be registered. Input parameter.
 */
extern int  module_start( async_client_conn_t client_connection );
 
/*@}*/
 
/** Default thread for new connections.
 *  @param iid The initial message identifier. Input parameter.
 *  @param icall The initial message call structure. Input parameter.
 */
void    client_connection( ipc_callid_t iid, ipc_call_t * icall );
 
/** Starts the module.
 *  @param argc The count of the command line arguments. Ignored parameter.
 *  @param argv The command line parameters. Ignored parameter.
 *  @returns EOK on success.
 *  @returns Other error codes as defined for each specific module start function.
 */
int main( int argc, char * argv[] );
 
void client_connection( ipc_callid_t iid, ipc_call_t * icall ){
    ipc_callid_t    callid;
    ipc_call_t  call;
    ipc_call_t  answer;
    int     count;
    int     res;
 
    /*
     * Accept the connection
     *  - Answer the first IPC_M_CONNECT_ME_TO call.
     */
    ipc_answer_0( iid, EOK );
 
    while( true ){
        // refresh data
        count = 0;
        IPC_SET_RETVAL( answer, 0 );
        // just to be precize
        IPC_SET_METHOD( answer, 0 );
        IPC_SET_ARG1( answer, 0 );
        IPC_SET_ARG2( answer, 0 );
        IPC_SET_ARG3( answer, 0 );
        IPC_SET_ARG4( answer, 0 );
        IPC_SET_ARG5( answer, 0 );
 
        callid = async_get_call( & call );
        res = module_message( callid, & call, & answer, & count );
 
        switch( count ){
            case 0:     ipc_answer_0( callid, res );
                    continue;
            case 1:     ipc_answer_1( callid, res, IPC_GET_ARG1( answer ));
                    continue;
            case 2:     ipc_answer_2( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ));
                    continue;
            case 3:     ipc_answer_3( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ), IPC_GET_ARG3( answer ));
                    continue;
            case 4:     ipc_answer_4( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ), IPC_GET_ARG3( answer ), IPC_GET_ARG4( answer ));
                    continue;
            default:    ipc_answer_5( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ), IPC_GET_ARG3( answer ), IPC_GET_ARG4( answer ), IPC_GET_ARG5( answer ));
                    continue;
        }
    }
}
 
int main( int argc, char * argv[] ){
    ERROR_DECLARE;
 
    printf("Task %d - ", task_get_id());
    module_print_name();
    printf( "\n" );
    if( ERROR_OCCURRED( module_start( client_connection ))){
        printf( " - ERROR %i\n", ERROR_CODE );
        return ERROR_CODE;
    }
    return EOK;
}
 
/** @}
 */
 

Rev 4577	Rev 4704
1	/*	1	/*
2	* Copyright (c) 2009 Lukas Mejdrech	2	* Copyright (c) 2009 Lukas Mejdrech
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	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	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.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	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	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	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	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	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	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.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup net	29	/** @addtogroup net
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	* Generic module skeleton implementation.	34	* Generic module skeleton implementation.
35	*/	35	*/
36		36
37	#include <async.h>	37	#include <async.h>
38	#include <stdio.h>	38	#include <stdio.h>
39	#include <task.h>	39	#include <task.h>
40		40
41	#include <ipc/ipc.h>	41	#include <ipc/ipc.h>
42		42
43	#include "err.h"	43	#include "err.h"
44		44
-		45	/** @name External module functions.
-		46	* This functions have to be implemented in every module.
-		47	*/
-		48	/@{/
-		49
45	/** External message processing function.	50	/** External message processing function.
46	* Should process the messages.	51	* Should process the messages.
47	* The function has to be defined in each module.	52	* The function has to be defined in each module.
48	* @param callid The message identifier. Input parameter.	53	* @param callid The message identifier. Input parameter.
49	* @param call The message parameters. Input parameter.	54	* @param call The message parameters. Input parameter.
50	* @param answer The message answer parameters. Output parameter.	55	* @param answer The message answer parameters. Output parameter.
51	* @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.	56	* @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
52	* @returns EOK on success.	57	* @returns EOK on success.
53	* @returns ENOTSUP if the message is not known.	58	* @returns ENOTSUP if the message is not known.
54	* @returns Other error codes as defined for each specific module message function.	59	* @returns Other error codes as defined for each specific module message function.
55	*/	60	*/
56	extern int module_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );	61	extern int module_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
57		62
58	/** External function to print the module name.	63	/** External function to print the module name.
59	* Should print the module name.	64	* Should print the module name.
60	* The function has to be defined in each module.	65	* The function has to be defined in each module.
61	*/	66	*/
62	extern void module_print_name( void );	67	extern void module_print_name( void );
63		68
64	/** External module startup function.	69	/** External module startup function.
65	* Should start and initialize the module and register the given client connection function.	70	* Should start and initialize the module and register the given client connection function.
66	* The function has to be defined in each module.	71	* The function has to be defined in each module.
67	* @param client_connection The client connection functio to be registered. Input parameter.	72	* @param client_connection The client connection function to be registered. Input parameter.
68	*/	73	*/
69	extern int module_start( async_client_conn_t client_connection );	74	extern int module_start( async_client_conn_t client_connection );
70		75
-		76	/@}/
-		77
71	/** Default thread for new connections.	78	/** Default thread for new connections.
72	* @param iid The initial message identifier. Input parameter.	79	* @param iid The initial message identifier. Input parameter.
73	* @param icall The initial message call structure. Input parameter.	80	* @param icall The initial message call structure. Input parameter.
74	*/	81	*/
75	void client_connection( ipc_callid_t iid, ipc_call_t * icall );	82	void client_connection( ipc_callid_t iid, ipc_call_t * icall );
76		83
77	/** Starts the module.	84	/** Starts the module.
78	* @param argc The count of the command line arguments. Ignored parameter.	85	* @param argc The count of the command line arguments. Ignored parameter.
79	* @param argv The command line parameters. Ignored parameter.	86	* @param argv The command line parameters. Ignored parameter.
80	* @returns EOK on success.	87	* @returns EOK on success.
81	* @returns Other error codes as defined for each specific module start function.	88	* @returns Other error codes as defined for each specific module start function.
82	*/	89	*/
83	int main( int argc, char * argv[] );	90	int main( int argc, char * argv[] );
84		91
85	void client_connection( ipc_callid_t iid, ipc_call_t * icall ){	92	void client_connection( ipc_callid_t iid, ipc_call_t * icall ){
86	ipc_callid_t callid;	93	ipc_callid_t callid;
87	ipc_call_t call;	94	ipc_call_t call;
88	ipc_call_t answer;	95	ipc_call_t answer;
89	int count;	96	int count;
90	int res;	97	int res;
91		98
92	/*	99	/*
93	* Accept the connection	100	* Accept the connection
94	* - Answer the first IPC_M_CONNECT_ME_TO call.	101	* - Answer the first IPC_M_CONNECT_ME_TO call.
95	*/	102	*/
96	ipc_answer_0( iid, EOK );	103	ipc_answer_0( iid, EOK );
97		104
98	while( true ){	105	while( true ){
99	// refresh data	106	// refresh data
100	count = 0;	107	count = 0;
101	IPC_SET_RETVAL( answer, 0 );	108	IPC_SET_RETVAL( answer, 0 );
102	// just to be precize	109	// just to be precize
103	IPC_SET_METHOD( answer, 0 );	110	IPC_SET_METHOD( answer, 0 );
104	IPC_SET_ARG1( answer, 0 );	111	IPC_SET_ARG1( answer, 0 );
105	IPC_SET_ARG2( answer, 0 );	112	IPC_SET_ARG2( answer, 0 );
106	IPC_SET_ARG3( answer, 0 );	113	IPC_SET_ARG3( answer, 0 );
107	IPC_SET_ARG4( answer, 0 );	114	IPC_SET_ARG4( answer, 0 );
108	IPC_SET_ARG5( answer, 0 );	115	IPC_SET_ARG5( answer, 0 );
109		116
110	callid = async_get_call( & call );	117	callid = async_get_call( & call );
111	res = module_message( callid, & call, & answer, & count );	118	res = module_message( callid, & call, & answer, & count );
112		119
113	switch( count ){	120	switch( count ){
114	case 0: ipc_answer_0( callid, res );	121	case 0: ipc_answer_0( callid, res );
115	continue;	122	continue;
116	case 1: ipc_answer_1( callid, res, IPC_GET_ARG1( answer ));	123	case 1: ipc_answer_1( callid, res, IPC_GET_ARG1( answer ));
117	continue;	124	continue;
118	case 2: ipc_answer_2( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ));	125	case 2: ipc_answer_2( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ));
119	continue;	126	continue;
120	case 3: ipc_answer_3( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ), IPC_GET_ARG3( answer ));	127	case 3: ipc_answer_3( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ), IPC_GET_ARG3( answer ));
121	continue;	128	continue;
122	case 4: ipc_answer_4( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ), IPC_GET_ARG3( answer ), IPC_GET_ARG4( answer ));	129	case 4: ipc_answer_4( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ), IPC_GET_ARG3( answer ), IPC_GET_ARG4( answer ));
123	continue;	130	continue;
124	default: ipc_answer_5( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ), IPC_GET_ARG3( answer ), IPC_GET_ARG4( answer ), IPC_GET_ARG5( answer ));	131	default: ipc_answer_5( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ), IPC_GET_ARG3( answer ), IPC_GET_ARG4( answer ), IPC_GET_ARG5( answer ));
125	continue;	132	continue;
126	}	133	}
127	}	134	}
128	}	135	}
129		136
130	int main( int argc, char * argv[] ){	137	int main( int argc, char * argv[] ){
131	ERROR_DECLARE;	138	ERROR_DECLARE;
132		139
133	printf("Task %d - ", task_get_id());	140	printf("Task %d - ", task_get_id());
134	module_print_name();	141	module_print_name();
135	printf( "\n" );	142	printf( "\n" );
136	if( ERROR_OCCURRED( module_start( client_connection ))){	143	if( ERROR_OCCURRED( module_start( client_connection ))){
137	printf( " - ERROR %i\n", ERROR_CODE );	144	printf( " - ERROR %i\n", ERROR_CODE );
138	return ERROR_CODE;	145	return ERROR_CODE;
139	}	146	}
140	return EOK;	147	return EOK;
141	}	148	}
142		149
143	/** @}	150	/** @}
144	*/	151	*/
145		152

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/module.c – Rev 4577 → 4704