Subversion Repositories HelenOS

Rev

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

Rev Author Line No. Line
3901 mejdrech 1
/*
3912 mejdrech 2
 * Copyright (c) 2009 Lukas Mejdrech
3901 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
 
3912 mejdrech 29
/** @addtogroup packet
3901 mejdrech 30
 *  @{
31
 */
32
 
33
/** @file
3912 mejdrech 34
 *  Packet server implementation.
3901 mejdrech 35
 */
36
 
3914 mejdrech 37
#include <align.h>
3901 mejdrech 38
#include <async.h>
39
#include <errno.h>
3914 mejdrech 40
#include <futex.h>
3901 mejdrech 41
//#include <stdio.h>
42
#include <unistd.h>
43
 
44
#include <ipc/ipc.h>
45
#include <sys/mman.h>
46
 
47
#include "../../err.h"
48
#include "../../messages.h"
49
 
50
#include "packet.h"
51
#include "packet_header.h"
52
#include "packet_server.h"
53
 
4192 mejdrech 54
/** The default address length reserved for new packets.
55
 */
56
#define DEFAULT_ADDR_LEN    32
57
 
58
/** The default prefix reserved for new packets.
59
 */
60
#define DEFAULT_PREFIX      0
61
 
62
/** The default suffix reserved for new packets.
63
 */
64
#define DEFAULT_SUFFIX      0
65
 
3912 mejdrech 66
/** Returns the packet identifier message parameter.
67
 */
3901 mejdrech 68
#define IPC_GET_ID( call )          ( packet_id_t ) IPC_GET_ARG1( * call )
3912 mejdrech 69
 
70
/** Returns the maximal content length message parameter.
71
 */
3990 mejdrech 72
#define IPC_GET_CONTENT( call )     ( size_t ) IPC_GET_ARG1( * call )
3912 mejdrech 73
 
74
/** Returns the maximal address length message parameter.
75
 */
3990 mejdrech 76
#define IPC_GET_ADDR_LEN( call )    ( size_t ) IPC_GET_ARG2( * call )
3912 mejdrech 77
 
78
/** Returns the maximal prefix length message parameter.
79
 */
3990 mejdrech 80
#define IPC_GET_PREFIX( call )      ( size_t ) IPC_GET_ARG3( * call )
3912 mejdrech 81
 
82
/** Returns the maximal suffix length message parameter.
83
 */
4192 mejdrech 84
#define IPC_GET_SUFFIX( call )      ( size_t ) IPC_GET_ARG4( * call )
3901 mejdrech 85
 
86
#define FREE_QUEUES_COUNT   7
87
 
3912 mejdrech 88
/** Packet server global data.
89
 */
3901 mejdrech 90
static struct{
3914 mejdrech 91
    /** Safety lock.
92
     */
93
    futex_t lock;
3912 mejdrech 94
    /** Free packet queues.
95
     */
3901 mejdrech 96
    packet_t free[ FREE_QUEUES_COUNT ];
3912 mejdrech 97
    /** Packet length upper bounds of the free packet queues.
98
     *  The maximal lengths of packets in each queue in the ascending order.
99
     *  The last queue is not limited.
100
     */
4243 mejdrech 101
    size_t sizes[ FREE_QUEUES_COUNT ];
3912 mejdrech 102
    /** Total packets allocated.
103
     */
3901 mejdrech 104
    unsigned int count;
105
} ps_globals = {
3914 mejdrech 106
    { 1 },
3901 mejdrech 107
    { NULL, NULL, NULL, NULL, NULL, NULL, NULL },
108
    { PAGE_SIZE, PAGE_SIZE * 2, PAGE_SIZE * 4, PAGE_SIZE * 8, PAGE_SIZE * 16, PAGE_SIZE * 32, PAGE_SIZE * 64 },
109
 
110
};
111
 
3912 mejdrech 112
/** Releases the packet and returns it to the appropriate free packet queue.
3914 mejdrech 113
 *  Should be used only when the global data are locked.
3912 mejdrech 114
 *  @param packet The packet to be released. Input parameter.
115
 */
3901 mejdrech 116
void packet_release( packet_t packet );
3912 mejdrech 117
 
118
/** Returns the packet of dimensions at least as given.
119
 *  Tries to reuse free packets first.
120
 *  Creates a&nbsp;new packet aligned to the memory page size if none available.
3914 mejdrech 121
 *  Locks the global data during its processing.
3912 mejdrech 122
 *  @param addr_len The source and destination addresses maximal length in bytes. Input parameter.
123
 *  @param max_prefix The maximal prefix length in bytes. Input parameter.
124
 *  @param max_content The maximal content length in bytes. Input parameter.
125
 *  @param max_suffix The maximal suffix length in bytes. Input parameter.
126
 *  @returns The packet of dimensions at least as given.
127
 *  @returns NULL if there is not enough memory left.
128
 */
3990 mejdrech 129
packet_t packet_get( size_t addr_len, size_t max_prefix, size_t max_content, size_t max_suffix );
3912 mejdrech 130
 
131
/** Creates a&nbsp;new packet of dimensions at least as given.
3914 mejdrech 132
 *  Should be used only when the global data are locked.
3912 mejdrech 133
 *  @param length The total length of the packet, including the header, the addresses and the data of the packet. Input parameter.
134
 *  @param addr_len The source and destination addresses maximal length in bytes. Input parameter.
135
 *  @param max_prefix The maximal prefix length in bytes. Input parameter.
136
 *  @param max_content The maximal content length in bytes. Input parameter.
137
 *  @param max_suffix The maximal suffix length in bytes. Input parameter.
138
 *  @returns The packet of dimensions at least as given.
139
 *  @returns NULL if there is not enough memory left.
140
 */
3990 mejdrech 141
packet_t    packet_create( size_t length, size_t addr_len, size_t max_prefix, size_t max_content, size_t max_suffix );
3912 mejdrech 142
 
143
/** Initializes the packet according to the given dimensions.
144
 *  @param packet The packet to be initialized. Input parameter.
145
 *  @param addr_len The source and destination addresses maximal length in bytes. Input parameter.
146
 *  @param max_prefix The maximal prefix length in bytes. Input parameter.
147
 *  @param max_content The maximal content length in bytes. Input parameter.
148
 *  @param max_suffix The maximal suffix length in bytes. Input parameter.
149
 */
3990 mejdrech 150
void    packet_init( packet_t packet, size_t addr_len, size_t max_prefix, size_t max_content, size_t max_suffix );
3912 mejdrech 151
 
152
/** Shares the packet memory block.
153
 *  @param packet The packet to be shared.
154
 *  @returns EOK on success.
155
 *  @returns EINVAL if the packet is not valid.
156
 *  @returns EINVAL if the calling module does not accept the memory.
157
 *  @returns ENOMEM if the desired and actual sizes differ.
158
 *  @returns Other error codes as defined for the ipc_share_in_finalize() function.
159
 */
3901 mejdrech 160
int packet_reply( const packet_t packet );
161
 
162
int packet_server_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count ){
163
    packet_t packet;
164
 
165
    * answer_count = 0;
166
    switch( IPC_GET_METHOD( * call )){
167
        case IPC_M_PHONE_HUNGUP:
168
            return EOK;
169
        case NET_PACKET_CREATE_1:
4192 mejdrech 170
            packet = packet_get( DEFAULT_ADDR_LEN, DEFAULT_PREFIX, IPC_GET_CONTENT( call ), DEFAULT_SUFFIX );
3901 mejdrech 171
            if( ! packet ) return ENOMEM;
172
            * answer_count = 2;
173
            IPC_SET_ARG1( * answer, packet->packet_id );
174
            IPC_SET_ARG2( * answer, packet->length );
175
            return EOK;
3990 mejdrech 176
        case NET_PACKET_CREATE_4:
4192 mejdrech 177
            packet = packet_get( IPC_GET_ADDR_LEN( call ), IPC_GET_PREFIX( call ), IPC_GET_CONTENT( call ), IPC_GET_SUFFIX( call ));
3901 mejdrech 178
            if( ! packet ) return ENOMEM;
179
            * answer_count = 2;
180
            IPC_SET_ARG1( * answer, packet->packet_id );
181
            IPC_SET_ARG2( * answer, packet->length );
182
            return EOK;
183
        case NET_PACKET_GET:
184
            packet = pm_find( IPC_GET_ID( call ));
185
            if( ! packet_is_valid( packet )) return ENOENT;
186
            return packet_reply( packet );
187
        case NET_PACKET_GET_SIZE:
188
            packet = pm_find( IPC_GET_ID( call ));
189
            if( ! packet_is_valid( packet )) return ENOENT;
190
            * answer_count = 1;
191
            IPC_SET_ARG1( * answer, packet->length );
192
            return EOK;
193
        case NET_PACKET_RELEASE:
194
            packet = pm_find( IPC_GET_ID( call ));
195
            if( ! packet_is_valid( packet )) return ENOENT;
3914 mejdrech 196
            futex_down( & ps_globals.lock );
3901 mejdrech 197
            pq_destroy( packet, packet_release );
3914 mejdrech 198
            futex_up( & ps_globals.lock );
3901 mejdrech 199
            return EOK;
200
    }
201
    return ENOTSUP;
202
}
203
 
204
void packet_release( packet_t packet ){
205
    int index;
206
 
207
    for( index = 0; ( index < FREE_QUEUES_COUNT - 1 ) && ( packet->length > ps_globals.sizes[ index ] ); ++ index );
208
    ps_globals.free[ index ] = pq_add( ps_globals.free[ index ], packet, packet->length, packet->length );
209
}
210
 
3990 mejdrech 211
packet_t packet_get( size_t addr_len, size_t max_prefix, size_t max_content, size_t max_suffix ){
3901 mejdrech 212
    int index;
213
    packet_t packet;
214
    size_t length;
215
 
3912 mejdrech 216
    length = ALIGN_UP( sizeof( struct packet ) + 2 * addr_len + max_prefix + max_content + max_suffix, PAGE_SIZE );
3914 mejdrech 217
    futex_down( & ps_globals.lock );
3901 mejdrech 218
    for( index = 0; index < FREE_QUEUES_COUNT - 1; ++ index ){
219
        if( length <= ps_globals.sizes[ index ] ){
220
            packet = ps_globals.free[ index ];
221
            while( packet_is_valid( packet ) && ( packet->length < length )){
222
                packet = pm_find( packet->next );
223
            }
224
            if( packet ){
3990 mejdrech 225
                packet_init( packet, addr_len, max_prefix, max_content, max_suffix );
3914 mejdrech 226
                futex_up( & ps_globals.lock );
3901 mejdrech 227
                return packet;
228
            }
229
        }
230
    }
3990 mejdrech 231
    packet = packet_create( length, addr_len, max_prefix, max_content, max_suffix );
3914 mejdrech 232
    futex_up( & ps_globals.lock );
233
    return packet;
3901 mejdrech 234
}
235
 
3990 mejdrech 236
packet_t packet_create( size_t length, size_t addr_len, size_t max_prefix, size_t max_content, size_t max_suffix ){
3901 mejdrech 237
    ERROR_DECLARE;
238
 
239
    packet_t    packet;
240
 
3914 mejdrech 241
    // already locked
3901 mejdrech 242
    packet = ( packet_t ) mmap( NULL, length, PROTO_READ | PROTO_WRITE, MAP_SHARED | MAP_ANONYMOUS, 0, 0 );
243
    if( packet == MAP_FAILED ) return NULL;
244
    ++ ps_globals.count;
245
    packet->packet_id = ps_globals.count;
246
    packet->length = length;
3990 mejdrech 247
    packet_init( packet, addr_len, max_prefix, max_content, max_suffix );
3901 mejdrech 248
    packet->magic_value = PACKET_MAGIC_VALUE;
3912 mejdrech 249
    if( ERROR_OCCURRED( pm_add( packet ))){
3901 mejdrech 250
        munmap( packet, packet->length );
251
        return NULL;
252
    }
253
    packet_release( packet );
254
    return packet;
255
}
256
 
3990 mejdrech 257
void packet_init( packet_t packet, size_t addr_len, size_t max_prefix, size_t max_content, size_t max_suffix ){
3901 mejdrech 258
    packet->order = 0;
259
    packet->metric = 0;
260
    packet->previous = 0;
261
    packet->next = 0;
262
    packet->addr_len = addr_len;
263
    packet->src_addr = sizeof( struct packet );
264
    packet->dest_addr = packet->src_addr + packet->addr_len;
265
    packet->max_prefix = max_prefix;
266
    packet->max_content = max_content;
267
    packet->data_start = packet->dest_addr + packet->addr_len + packet->max_prefix;
268
    packet->data_end = packet->data_start;
269
}
270
 
271
int packet_reply( const packet_t packet ){
272
    ipc_callid_t    callid;
273
    size_t          size;
274
 
275
    if( ! packet_is_valid( packet )) return EINVAL;
276
    if( ipc_share_in_receive( & callid, & size ) <= 0 ) return EINVAL;
277
    if( size != packet->length ) return ENOMEM;
278
    return ipc_share_in_finalize( callid, packet, PROTO_READ | PROTO_WRITE );
279
}
280
 
281
/** @}
282
 */