Subversion Repositories HelenOS

Rev

Rev 4731 | 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>
4731 mejdrech 38
#include <assert.h>
3901 mejdrech 39
#include <async.h>
40
#include <errno.h>
4582 mejdrech 41
#include <fibril_sync.h>
3901 mejdrech 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"
4307 mejdrech 51
#include "packet_client.h"
3901 mejdrech 52
#include "packet_header.h"
4307 mejdrech 53
#include "packet_messages.h"
3901 mejdrech 54
#include "packet_server.h"
55
 
4307 mejdrech 56
#define FREE_QUEUES_COUNT   7
57
 
4192 mejdrech 58
/** The default address length reserved for new packets.
59
 */
60
#define DEFAULT_ADDR_LEN    32
61
 
62
/** The default prefix reserved for new packets.
63
 */
4706 mejdrech 64
#define DEFAULT_PREFIX      64
4192 mejdrech 65
 
66
/** The default suffix reserved for new packets.
67
 */
4706 mejdrech 68
#define DEFAULT_SUFFIX      64
4192 mejdrech 69
 
3912 mejdrech 70
/** Packet server global data.
71
 */
3901 mejdrech 72
static struct{
3914 mejdrech 73
    /** Safety lock.
74
     */
4582 mejdrech 75
    fibril_mutex_t lock;
3912 mejdrech 76
    /** Free packet queues.
77
     */
3901 mejdrech 78
    packet_t free[ FREE_QUEUES_COUNT ];
3912 mejdrech 79
    /** Packet length upper bounds of the free packet queues.
80
     *  The maximal lengths of packets in each queue in the ascending order.
81
     *  The last queue is not limited.
82
     */
4243 mejdrech 83
    size_t sizes[ FREE_QUEUES_COUNT ];
3912 mejdrech 84
    /** Total packets allocated.
85
     */
3901 mejdrech 86
    unsigned int count;
87
} ps_globals = {
4582 mejdrech 88
    { .counter = 1, .waiters = { .prev = & ps_globals.lock.waiters, .next = & ps_globals.lock.waiters, }},
3901 mejdrech 89
    { NULL, NULL, NULL, NULL, NULL, NULL, NULL },
90
    { PAGE_SIZE, PAGE_SIZE * 2, PAGE_SIZE * 4, PAGE_SIZE * 8, PAGE_SIZE * 16, PAGE_SIZE * 32, PAGE_SIZE * 64 },
91
 
92
};
93
 
4704 mejdrech 94
/** @name Packet server support functions
95
 */
96
/*@{*/
97
 
3912 mejdrech 98
/** Returns the packet of dimensions at least as given.
99
 *  Tries to reuse free packets first.
100
 *  Creates a&nbsp;new packet aligned to the memory page size if none available.
3914 mejdrech 101
 *  Locks the global data during its processing.
3912 mejdrech 102
 *  @param addr_len The source and destination addresses maximal length in bytes. Input parameter.
103
 *  @param max_prefix The maximal prefix length in bytes. Input parameter.
104
 *  @param max_content The maximal content length in bytes. Input parameter.
105
 *  @param max_suffix The maximal suffix length in bytes. Input parameter.
106
 *  @returns The packet of dimensions at least as given.
107
 *  @returns NULL if there is not enough memory left.
108
 */
4307 mejdrech 109
packet_t    packet_get( size_t addr_len, size_t max_prefix, size_t max_content, size_t max_suffix );
3912 mejdrech 110
 
4351 mejdrech 111
/** Releases the packet queue.
112
 *  @param packet_id The first packet identifier. Input parameter.
113
 *  @returns EOK on success.
114
 *  @returns ENOENT if there is no such packet.
4307 mejdrech 115
 */
116
int packet_release_wrapper( packet_id_t packet_id );
117
 
118
/** Releases the packet and returns it to the appropriate free packet queue.
119
 *  Should be used only when the global data are locked.
120
 *  @param packet The packet to be released. Input parameter.
121
 */
122
void packet_release( packet_t packet );
123
 
3912 mejdrech 124
/** Creates a&nbsp;new packet of dimensions at least as given.
3914 mejdrech 125
 *  Should be used only when the global data are locked.
3912 mejdrech 126
 *  @param length The total length of the packet, including the header, the addresses and the data of the packet. Input parameter.
127
 *  @param addr_len The source and destination addresses maximal length in bytes. Input parameter.
128
 *  @param max_prefix The maximal prefix length in bytes. Input parameter.
129
 *  @param max_content The maximal content length in bytes. Input parameter.
130
 *  @param max_suffix The maximal suffix length in bytes. Input parameter.
131
 *  @returns The packet of dimensions at least as given.
132
 *  @returns NULL if there is not enough memory left.
133
 */
3990 mejdrech 134
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 135
 
4395 mejdrech 136
/** Clears and initializes the packet according to the given dimensions.
3912 mejdrech 137
 *  @param packet The packet to be initialized. Input parameter.
138
 *  @param addr_len The source and destination addresses maximal length in bytes. Input parameter.
139
 *  @param max_prefix The maximal prefix length in bytes. Input parameter.
140
 *  @param max_content The maximal content length in bytes. Input parameter.
141
 *  @param max_suffix The maximal suffix length in bytes. Input parameter.
142
 */
3990 mejdrech 143
void    packet_init( packet_t packet, size_t addr_len, size_t max_prefix, size_t max_content, size_t max_suffix );
3912 mejdrech 144
 
145
/** Shares the packet memory block.
146
 *  @param packet The packet to be shared.
147
 *  @returns EOK on success.
148
 *  @returns EINVAL if the packet is not valid.
149
 *  @returns EINVAL if the calling module does not accept the memory.
150
 *  @returns ENOMEM if the desired and actual sizes differ.
151
 *  @returns Other error codes as defined for the ipc_share_in_finalize() function.
152
 */
3901 mejdrech 153
int packet_reply( const packet_t packet );
154
 
4704 mejdrech 155
/*@}*/
156
 
4307 mejdrech 157
int packet_translate( int phone, packet_ref packet, packet_id_t packet_id ){
158
    if( ! packet ) return EINVAL;
159
    * packet = pm_find( packet_id );
160
    return ( * packet ) ? EOK : ENOENT;
161
}
162
 
163
packet_t packet_get_4( int phone, size_t max_content, size_t addr_len, size_t max_prefix, size_t max_suffix ){
164
    return packet_get( addr_len, max_prefix, max_content, max_suffix );
165
}
166
 
167
packet_t packet_get_1( int phone, size_t content ){
168
    return packet_get( DEFAULT_ADDR_LEN, DEFAULT_PREFIX, content, DEFAULT_SUFFIX );
169
}
170
 
171
void pq_release( int phone, packet_id_t packet_id ){
172
    ( void ) packet_release_wrapper( packet_id );
173
}
174
 
3901 mejdrech 175
int packet_server_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count ){
176
    packet_t packet;
177
 
178
    * answer_count = 0;
179
    switch( IPC_GET_METHOD( * call )){
180
        case IPC_M_PHONE_HUNGUP:
181
            return EOK;
182
        case NET_PACKET_CREATE_1:
4192 mejdrech 183
            packet = packet_get( DEFAULT_ADDR_LEN, DEFAULT_PREFIX, IPC_GET_CONTENT( call ), DEFAULT_SUFFIX );
3901 mejdrech 184
            if( ! packet ) return ENOMEM;
185
            * answer_count = 2;
186
            IPC_SET_ARG1( * answer, packet->packet_id );
187
            IPC_SET_ARG2( * answer, packet->length );
188
            return EOK;
3990 mejdrech 189
        case NET_PACKET_CREATE_4:
4192 mejdrech 190
            packet = packet_get( IPC_GET_ADDR_LEN( call ), IPC_GET_PREFIX( call ), IPC_GET_CONTENT( call ), IPC_GET_SUFFIX( call ));
3901 mejdrech 191
            if( ! packet ) return ENOMEM;
192
            * answer_count = 2;
193
            IPC_SET_ARG1( * answer, packet->packet_id );
194
            IPC_SET_ARG2( * answer, packet->length );
195
            return EOK;
196
        case NET_PACKET_GET:
197
            packet = pm_find( IPC_GET_ID( call ));
198
            if( ! packet_is_valid( packet )) return ENOENT;
199
            return packet_reply( packet );
200
        case NET_PACKET_GET_SIZE:
201
            packet = pm_find( IPC_GET_ID( call ));
202
            if( ! packet_is_valid( packet )) return ENOENT;
4505 mejdrech 203
            IPC_SET_ARG1( * answer, packet->length );
3901 mejdrech 204
            * answer_count = 1;
205
            return EOK;
206
        case NET_PACKET_RELEASE:
4307 mejdrech 207
            return packet_release_wrapper( IPC_GET_ID( call ));
3901 mejdrech 208
    }
209
    return ENOTSUP;
210
}
211
 
4307 mejdrech 212
int packet_release_wrapper( packet_id_t packet_id ){
213
    packet_t    packet;
214
 
215
    packet = pm_find( packet_id );
216
    if( ! packet_is_valid( packet )) return ENOENT;
4582 mejdrech 217
    fibril_mutex_lock( & ps_globals.lock );
4307 mejdrech 218
    pq_destroy( packet, packet_release );
4582 mejdrech 219
    fibril_mutex_unlock( & ps_globals.lock );
4307 mejdrech 220
    return EOK;
221
}
222
 
3901 mejdrech 223
void packet_release( packet_t packet ){
224
    int index;
225
 
4743 mejdrech 226
    // remove debug dump
227
//  printf( "packet %d released\n", packet->packet_id );
3901 mejdrech 228
    for( index = 0; ( index < FREE_QUEUES_COUNT - 1 ) && ( packet->length > ps_globals.sizes[ index ] ); ++ index );
229
    ps_globals.free[ index ] = pq_add( ps_globals.free[ index ], packet, packet->length, packet->length );
4731 mejdrech 230
    assert( ps_globals.free[ index ] );
3901 mejdrech 231
}
232
 
3990 mejdrech 233
packet_t packet_get( size_t addr_len, size_t max_prefix, size_t max_content, size_t max_suffix ){
3901 mejdrech 234
    int index;
235
    packet_t packet;
236
    size_t length;
237
 
3912 mejdrech 238
    length = ALIGN_UP( sizeof( struct packet ) + 2 * addr_len + max_prefix + max_content + max_suffix, PAGE_SIZE );
4582 mejdrech 239
    fibril_mutex_lock( & ps_globals.lock );
3901 mejdrech 240
    for( index = 0; index < FREE_QUEUES_COUNT - 1; ++ index ){
241
        if( length <= ps_globals.sizes[ index ] ){
242
            packet = ps_globals.free[ index ];
243
            while( packet_is_valid( packet ) && ( packet->length < length )){
244
                packet = pm_find( packet->next );
245
            }
4505 mejdrech 246
            if( packet_is_valid( packet )){
247
                if( packet == ps_globals.free[ index ] ){
248
                    ps_globals.free[ index ] = pq_detach( packet );
249
                }else{
250
                    pq_detach( packet );
251
                }
3990 mejdrech 252
                packet_init( packet, addr_len, max_prefix, max_content, max_suffix );
4582 mejdrech 253
                fibril_mutex_unlock( & ps_globals.lock );
4743 mejdrech 254
                // remove debug dump
255
//              printf( "packet %d got\n", packet->packet_id );
3901 mejdrech 256
                return packet;
257
            }
258
        }
259
    }
3990 mejdrech 260
    packet = packet_create( length, addr_len, max_prefix, max_content, max_suffix );
4582 mejdrech 261
    fibril_mutex_unlock( & ps_globals.lock );
4743 mejdrech 262
    // remove debug dump
263
    printf( "packet %d created\n", packet->packet_id );
3914 mejdrech 264
    return packet;
3901 mejdrech 265
}
266
 
3990 mejdrech 267
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 268
    ERROR_DECLARE;
269
 
270
    packet_t    packet;
271
 
3914 mejdrech 272
    // already locked
3901 mejdrech 273
    packet = ( packet_t ) mmap( NULL, length, PROTO_READ | PROTO_WRITE, MAP_SHARED | MAP_ANONYMOUS, 0, 0 );
274
    if( packet == MAP_FAILED ) return NULL;
275
    ++ ps_globals.count;
276
    packet->packet_id = ps_globals.count;
277
    packet->length = length;
3990 mejdrech 278
    packet_init( packet, addr_len, max_prefix, max_content, max_suffix );
4505 mejdrech 279
    packet->magic_value = PACKET_MAGIC_VALUE;
3912 mejdrech 280
    if( ERROR_OCCURRED( pm_add( packet ))){
3901 mejdrech 281
        munmap( packet, packet->length );
282
        return NULL;
283
    }
284
    return packet;
285
}
286
 
3990 mejdrech 287
void packet_init( packet_t packet, size_t addr_len, size_t max_prefix, size_t max_content, size_t max_suffix ){
4505 mejdrech 288
    // clear the packet content
289
    bzero((( void * ) packet ) + sizeof( struct packet ), packet->length - sizeof( struct packet ));
290
    // clear the packet header
3901 mejdrech 291
    packet->order = 0;
292
    packet->metric = 0;
293
    packet->previous = 0;
294
    packet->next = 0;
4395 mejdrech 295
    packet->addr_len = 0;
4505 mejdrech 296
    packet->src_addr = sizeof( struct packet );
4395 mejdrech 297
    packet->dest_addr = packet->src_addr + addr_len;
3901 mejdrech 298
    packet->max_prefix = max_prefix;
299
    packet->max_content = max_content;
4395 mejdrech 300
    packet->data_start = packet->dest_addr + addr_len + packet->max_prefix;
3901 mejdrech 301
    packet->data_end = packet->data_start;
302
}
303
 
304
int packet_reply( const packet_t packet ){
305
    ipc_callid_t    callid;
306
    size_t          size;
307
 
308
    if( ! packet_is_valid( packet )) return EINVAL;
309
    if( ipc_share_in_receive( & callid, & size ) <= 0 ) return EINVAL;
310
    if( size != packet->length ) return ENOMEM;
311
    return ipc_share_in_finalize( callid, packet, PROTO_READ | PROTO_WRITE );
312
}
313
 
314
/** @}
315
 */