Subversion Repositories HelenOS

Rev

Rev 4704 | 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 client.
  35.  *  The hosting module has to be compiled with both the packet.c and the packet_client.c source files.
  36.  *  To function correctly, initialization of the packet map by the pm_init() function has to happen at the first place.
  37.  *  The module should not send the packet messages to the packet server but use the functions provided.
  38.  *  The packet map should be released by the pm_destroy() function during the module termination.
  39.  *  The packets and the packet queues can't be locked at all.
  40.  *  The processing modules should process them sequentially - by passing the packets to the next module and stopping using the passed ones.
  41.  *  @see packet.h
  42.  */
  43.  
  44. #ifndef __NET_PACKET_CLIENT_H__
  45. #define __NET_PACKET_CLIENT_H__
  46.  
  47. #include "packet.h"
  48.  
  49. /** @name Packet client interface
  50.  */
  51. /*@{*/
  52.  
  53. /** Allocates the specified type right before the actual packet content and returns its pointer.
  54.  *  The wrapper of the packet_prepend() function.
  55.  *  @param packet The packet to be used. Input parameter.
  56.  *  @param type The type to be allocated at the beginning of the packet content. Input parameter.
  57.  *  @returns The typed pointer to the allocated memory.
  58.  *  @returns NULL if the packet is not valid.
  59.  *  @returns NULL if there is not enough memory left.
  60.  */
  61. #define PACKET_PREFIX( packet, type )   ( type * ) packet_prefix(( packet ), sizeof( type ))
  62.  
  63. /** Allocates the specified type right after the actual packet content and returns its pointer.
  64.  *  The wrapper of the packet_append() function.
  65.  *  @param packet The packet to be used. Input parameter.
  66.  *  @param type The type to be allocated at the end of the packet content. Input parameter.
  67.  *  @returns The typed pointer to the allocated memory.
  68.  *  @returns NULL if the packet is not valid.
  69.  *  @returns NULL if there is not enough memory left.
  70.  */
  71. #define PACKET_SUFFIX( packet, type )   ( type * ) packet_suffix(( packet ), sizeof( type ))
  72.  
  73. /** Trims the actual packet content by the specified prefix and suffix types.
  74.  *  The wrapper of the packet_trim() function.
  75.  *  @param packet The packet to be trimmed. Input parameter.
  76.  *  @param prefix The type of the prefix to be removed from the beginning of the packet content. Input parameter.
  77.  *  @param suffix The type of the suffix to be removed from the end of the packet content. Input parameter.
  78.  *  @returns EOK on success.
  79.  *  @returns EINVAL if the packet is not valid.
  80.  *  @returns ENOMEM if there is not enough memory left.
  81.  */
  82. #define PACKET_TRIM( packet, prefix, suffix )   packet_trim(( packet ), sizeof( prefix ), sizeof( suffix ))
  83.  
  84. /** Allocates the specified space right before the actual packet content and returns its pointer.
  85.  *  @param packet The packet to be used. Input parameter.
  86.  *  @param length The space length to be allocated at the beginning of the packet content. Input parameter.
  87.  *  @returns The pointer to the allocated memory.
  88.  *  @returns NULL if there is not enough memory left.
  89.  */
  90. void *  packet_prefix( packet_t packet, size_t length );
  91.  
  92. /** Allocates the specified space right after the actual packet content and returns its pointer.
  93.  *  @param packet The packet to be used. Input parameter.
  94.  *  @param length The space length to be allocated at the end of the packet content. Input parameter.
  95.  *  @returns The pointer to the allocated memory.
  96.  *  @returns NULL if there is not enough memory left.
  97.  */
  98. void *  packet_suffix( packet_t packet, size_t length );
  99.  
  100. /** Trims the actual packet content by the specified prefix and suffix lengths.
  101.  *  @param packet The packet to be trimmed. Input parameter.
  102.  *  @param prefix The prefix length to be removed from the beginning of the packet content. Input parameter.
  103.  *  @param suffix The suffix length to be removed from the end of the packet content. Input parameter.
  104.  *  @returns EOK on success.
  105.  *  @returns EINVAL if the packet is not valid.
  106.  *  @returns ENOMEM if there is not enough memory left.
  107.  */
  108. int packet_trim( packet_t packet, size_t prefix, size_t suffix );
  109.  
  110. /** Copies the specified data to the beginning of the actual packet content.
  111.  *  Pushes the content end if needed.
  112.  *  @param packet The packet to be filled. Input parameter.
  113.  *  @param data The data to be copied. Input parameter.
  114.  *  @param length The length of the copied data. Input parameter.
  115.  *  @returns EOK on success.
  116.  *  @returns EINVAL if the packet is not valid.
  117.  *  @returns ENOMEM if there is not enough memory left.
  118.  */
  119. int packet_copy_data( packet_t packet, const void * data, size_t length );
  120.  
  121. /** Returns the packet identifier.
  122.  *  @param packet The packet. Input parameter.
  123.  *  @returns The packet identifier.
  124.  *  @returns Zero (0) if the packet is not valid.
  125.  */
  126. packet_id_t packet_get_id( const packet_t packet );
  127.  
  128. /** Returns the packet content length.
  129.  *  @param packet The packet. Input parameter.
  130.  *  @returns The packet content length in bytes.
  131.  *  @returns Zero (0) if the packet is not valid.
  132.  */
  133. size_t  packet_get_data_length( const packet_t packet );
  134.  
  135. /** Returns the pointer to the beginning of the packet content.
  136.  *  @param packet The packet. Input parameter.
  137.  *  @returns The pointer to the beginning of the packet content.
  138.  *  @returns NULL if the packet is not valid.
  139.  */
  140. void *  packet_get_data( const packet_t packet );
  141.  
  142. /** Returns the stored packet addresses and their length.
  143.  *  @param packet The packet. Input parameter.
  144.  *  @param src The source address. May be NULL if not desired. Output parameter.
  145.  *  @param dest The destination address. May be NULL if not desired. Output parameter.
  146.  *  @returns The stored addresses length.
  147.  *  @returns Zero (0) if the addresses are not present.
  148.  *  @returns EINVAL if the packet is not valid.
  149.  */
  150. int packet_get_addr( const packet_t packet, uint8_t ** src, uint8_t ** dest );
  151.  
  152. /** Sets the packet addresses.
  153.  *  @param packet The packet. Input parameter.
  154.  *  @param src The new source address. May be NULL. Input parameter.
  155.  *  @param dest The new destination address. May be NULL. Input parameter.
  156.  *  @param addr_len The addresses length.
  157.  *  @returns EOK on success.
  158.  *  @returns EINVAL if the packet is not valid.
  159.  *  @returns ENOMEM if there is not enough memory left.
  160.  */
  161. int packet_set_addr( packet_t packet, const uint8_t * src, const uint8_t * dest, size_t addr_len );
  162.  
  163. /** Translates the packet identifier to the packet reference.
  164.  *  Tries to find mapping first.
  165.  *  Contacts the packet server to share the packet if the mapping is not present.
  166.  *  @param phone The packet server module phone. Input parameter.
  167.  *  @param packet The packet reference. Output parameter.
  168.  *  @param packet_id The packet identifier. Input parameter.
  169.  *  @returns EOK on success.
  170.  *  @returns EINVAL if the packet parameter is NULL.
  171.  *  @returns Other error codes as defined for the NET_PACKET_GET_SIZE message.
  172.  *  @returns Other error codes as defined for the packet_return() function.
  173.  */
  174. int packet_translate( int phone, packet_ref packet, packet_id_t packet_id );
  175.  
  176. /** Obtains the packet of the given dimensions.
  177.  *  Contacts the packet server to return the appropriate packet.
  178.  *  @param phone The packet server module phone. Input parameter.
  179.  *  @param addr_len The source and destination addresses maximal length in bytes. Input parameter.
  180.  *  @param max_prefix The maximal prefix length in bytes. Input parameter.
  181.  *  @param max_content The maximal content length in bytes. Input parameter.
  182.  *  @param max_suffix The maximal suffix length in bytes. Input parameter.
  183.  *  @returns The packet reference.
  184.  *  @returns NULL on error.
  185.  */
  186. packet_t packet_get_4( int phone, size_t max_content, size_t addr_len, size_t max_prefix, size_t max_suffix );
  187.  
  188. /** Obtains the packet of the given content size.
  189.  *  Contacts the packet server to return the appropriate packet.
  190.  *  @param phone The packet server module phone. Input parameter.
  191.  *  @param content The maximal content length in bytes. Input parameter.
  192.  *  @returns The packet reference.
  193.  *  @returns NULL on error.
  194.  */
  195. packet_t packet_get_1( int phone, size_t content );
  196.  
  197. /** Releases the packet queue.
  198.  *  All packets in the queue are marked as free for use.
  199.  *  The packet queue may be one packet only.
  200.  *  The module should not use the packets after this point until they are received or obtained again.
  201.  *  @param phone The packet server module phone. Input parameter.
  202.  *  @param packet_id The packet identifier. Input parameter.
  203.  */
  204. void pq_release( int phone, packet_id_t packet_id );
  205.  
  206. /*@}*/
  207.  
  208. #endif
  209.  
  210. /** @}
  211.  */
  212.