Subversion Repositories HelenOS

Rev

Rev 3912 | Rev 4075 | 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. /** Allocates the specified type right before the actual packet content and returns its pointer.
  50.  *  The wrapper of the packet_prepend() function.
  51.  *  @param packet The packet to be used. Input parameter.
  52.  *  @param type The type to be allocated at the beginning of the packet content. Input parameter.
  53.  *  @returns The typed pointer to the allocated memory.
  54.  *  @returns NULL if the packet is not valid.
  55.  *  @returns NULL if there is not enough memory left.
  56.  */
  57. #define PACKET_PREFIX( packet, type )   ( type * ) packet_prepend(( packet ), sizeof( type ))
  58.  
  59. /** Allocates the specified type right after the actual packet content and returns its pointer.
  60.  *  The wrapper of the packet_append() function.
  61.  *  @param packet The packet to be used. Input parameter.
  62.  *  @param type The type to be allocated at the end of the packet content. Input parameter.
  63.  *  @returns The typed pointer to the allocated memory.
  64.  *  @returns NULL if the packet is not valid.
  65.  *  @returns NULL if there is not enough memory left.
  66.  */
  67. #define PACKET_SUFFIX( packet, type )   ( type * ) packet_append(( packet ), sizeof( type ))
  68.  
  69. /** Trims the actual packet content by the specified prefix and suffix types.
  70.  *  The wrapper of the packet_trim() function.
  71.  *  @param packet The packet to be trimmed. Input parameter.
  72.  *  @param prefix The type of the prefix to be removed from the beginning of the packet content. Input parameter.
  73.  *  @param suffix The type of the suffix to be removed from the end of the packet content. Input parameter.
  74.  *  @returns EOK on success.
  75.  *  @returns EINVAL if the packet is not valid.
  76.  *  @returns EINVAL if there is not enough memory left.
  77.  */
  78. #define PACKET_TRIM( packet, prefix, suffix )   packet_trim(( packet ), sizeof( prefix ), sizeof( suffix ))
  79.  
  80. /** Allocates the specified space right before the actual packet content and returns its pointer.
  81.  *  @param packet The packet to be used. Input parameter.
  82.  *  @param length The space length to be allocated at the beginning of the packet content. Input parameter.
  83.  *  @returns The pointer to the allocated memory.
  84.  *  @returns NULL if there is not enough memory left.
  85.  */
  86. void *  packet_prefix( packet_t packet, size_t length );
  87.  
  88. /** Allocates the specified space right after the actual packet content and returns its pointer.
  89.  *  @param packet The packet to be used. Input parameter.
  90.  *  @param length The space length to be allocated at the end of the packet content. Input parameter.
  91.  *  @returns The pointer to the allocated memory.
  92.  *  @returns NULL if there is not enough memory left.
  93.  */
  94. void *  packet_suffix( packet_t packet, size_t length );
  95.  
  96. /** Trims the actual packet content by the specified prefix and suffix lengths.
  97.  *  @param packet The packet to be trimmed. Input parameter.
  98.  *  @param prefix The prefix length to be removed from the beginning of the packet content. Input parameter.
  99.  *  @param suffix The suffix length to be removed from the end of the packet content. Input parameter.
  100.  *  @returns EOK on success.
  101.  *  @returns EINVAL if the packet is not valid.
  102.  *  @returns ENOMEM if there is not enough memory left.
  103.  */
  104. int packet_trim( packet_t packet, size_t prefix, size_t suffix );
  105.  
  106. /** Copies the packet content.
  107.  *  Obtains the new packet from the packet server.
  108.  *  @param phone The packet server module phone. Input parameter.
  109.  *  @param owner The owner of the new packet. Input parameter.
  110.  *  @param packet The packet reference. Input parameter.
  111.  *  @returns The packet copy.
  112.  *  @returns NULL if the source packet ids not valid.
  113.  *  @returns NULL on error.
  114.  *  \todo other error?
  115.  */
  116. packet_t    packet_copy( int phone, services_t owner, const packet_t packet );
  117.  
  118. /** Copies the specified data to the beginning of the actual packet content.
  119.  *  Pushes the content end if needed.
  120.  *  @param packet The packet to be filled. Input parameter.
  121.  *  @param data The data to be copied. Input parameter.
  122.  *  @param length The length of the copied data. Input parameter.
  123.  *  @returns EOK on success.
  124.  *  @returns EINVAL if the packet is not valid.
  125.  *  @returns ENOMEM if there is not enough memory left.
  126.  */
  127. int packet_copy_data( packet_t packet, const void * data, size_t length );
  128.  
  129. /** Returns the packet identifier.
  130.  *  @param packet The packet. Input parameter.
  131.  *  @returns The packet identifier.
  132.  *  @returns Zero (0) if the packet is not valid.
  133.  */
  134. packet_id_t packet_get_id( const packet_t packet );
  135.  
  136. /** Returns the packet content length.
  137.  *  @param packet The packet. Input parameter.
  138.  *  @returns The packet content length in bytes.
  139.  *  @returns Zero (0) if the packet is not valid.
  140.  */
  141. size_t  packet_get_data_length( const packet_t packet );
  142.  
  143. /** Returns the pointer to the beginning of the packet content.
  144.  *  @param packet The packet. Input parameter.
  145.  *  @returns The pointer to the beginning of the packet content.
  146.  *  @returns NULL if the packet is not valid.
  147.  */
  148. void *  packet_get_data( const packet_t packet );
  149.  
  150. /** Returns the stored packet addresses and their length.
  151.  *  @param packet The packet. Input parameter.
  152.  *  @param src The source address. Output parameter.
  153.  *  @param dest The destination address. Output parameter.
  154.  *  @returns The addresses length.
  155.  *  @returns Zero (0) if the addresses are not present.
  156.  *  @returns EINVAL if the packet is not valid.
  157.  *  @returns EINVAL if the src and/or the dest parameter is NULL.
  158.  */
  159. int packet_get_addr( const packet_t packet, uint8_t ** src, uint8_t ** dest );
  160.  
  161. /** Returns the packet operation mode.
  162.  *  @param packet The packet. Input parameter.
  163.  *  @returns The packet operation mode.
  164.  *  @see packet_mode
  165.  */
  166. packet_mode_t   packet_get_mode( const packet_t packet );
  167.  
  168. /** Sets the packet addresses.
  169.  *  @param packet The packet. Input parameter.
  170.  *  @param src The new source address. Output parameter.
  171.  *  @param dest The new destination address. Output parameter.
  172.  *  @param addr_len The addresses length.
  173.  *  @returns EOK on success.
  174.  *  @returns EINVAL if the packet is not valid.
  175.  *  @returns ENOMEM if there is not enough memory left.
  176.  */
  177. int packet_set_addr( packet_t packet, const uint8_t * src, const uint8_t * dest, size_t addr_len );
  178.  
  179. /** Sets the packet operation mode.
  180.  *  @param packet The packet. Input parameter.
  181.  *  @param mode The new packet operation mode. Input parameter.
  182.  *  @returns EOK on success.
  183.  *  @returns EINVAL if the packet is not valid.
  184.  *  @see packet_mode
  185.  */
  186. int packet_set_mode( packet_t packet, packet_mode_t mode );
  187.  
  188. /** Sets the packet owner.
  189.  *  @param packet The packet. Input parameter.
  190.  *  @param owner The new packet owner. Input parameter.
  191.  *  @returns EOK on success.
  192.  *  @returns EINVAL if the packet is not valid.
  193.  */
  194. int packet_set_owner( packet_t packet, services_t owner );
  195.  
  196. /** Translates the packet identifier to the packet reference.
  197.  *  Tries to find mapping first.
  198.  *  Contacts the packet server to share the packet if the mapping is not present.
  199.  *  @param phone The packet server module phone. Input parameter.
  200.  *  @param packet The packet reference. Output parameter.
  201.  *  @param packet_id The packet identifier. Input parameter.
  202.  *  @returns EOK on success.
  203.  *  @returns EINVAL if the packet parameter is NULL.
  204.  *  @returns Other error codes as defined for the NET_PACKET_GET_SIZE message.
  205.  *  \todo errors as packet_return()
  206.  */
  207. int packet_translate( int phone, packet_ref packet, packet_id_t packet_id );
  208.  
  209. /** Obtains the packet of the given dimensions.
  210.  *  Contacts the packet server to return the appropriate packet.
  211.  *  @param phone The packet server module phone. Input parameter.
  212.  *  @param owner The owner of the new packet. Input parameter.
  213.  *  @param addr_len The source and destination addresses maximal length in bytes. Input parameter.
  214.  *  @param max_prefix The maximal prefix length in bytes. Input parameter.
  215.  *  @param max_content The maximal content length in bytes. Input parameter.
  216.  *  @param max_suffix The maximal suffix length in bytes. Input parameter.
  217.  *  @returns The packet reference.
  218.  *  @returns NULL on error.
  219.  *  \todo error as NET_PACKET_CREATE_5, packet_return()
  220.  */
  221. packet_t packet_get_5( int phone, services_t owner, size_t max_content, size_t addr_len, size_t max_prefix, size_t max_suffix );
  222.  
  223. /** Obtains the packet of the given content size.
  224.  *  Contacts the packet server to return the appropriate packet.
  225.  *  @param phone The packet server module phone. Input parameter.
  226.  *  @param owner The owner of the new packet. Input parameter.
  227.  *  @param content The maximal content length in bytes. Input parameter.
  228.  *  @returns The packet reference.
  229.  *  @returns NULL on error.
  230.  *  \todo error as NET_PACKET_CREATE_1, packet_return()
  231.  */
  232. packet_t packet_get_1( int phone, services_t owner, size_t content );
  233.  
  234. /** Releases the packet.
  235.  *  The packet is marked as free for use.
  236.  *  The module should not use the packet after this point until it is received or obtained again.
  237.  *  @param phone The packet server module phone. Input parameter.
  238.  *  @param packet_id The packet identifier. Input parameter.
  239.  */
  240. void packet_release( int phone, packet_id_t packet_id );
  241.  
  242. #endif
  243.  
  244. /** @}
  245.  */
  246.