Subversion Repositories HelenOS

Rev

Rev 3914 | Rev 4243 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

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