Subversion Repositories HelenOS

Rev

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