Subversion Repositories HelenOS

Rev

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