Subversion Repositories HelenOS

Rev

Rev 4395 | Rev 4731 | 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 header.
  35.  */
  36.  
  37. #ifndef __NET_PACKET_HEADER_H__
  38. #define __NET_PACKET_HEADER_H__
  39.  
  40. #include "packet.h"
  41.  
  42. /** Packet integrity check magic value.
  43.  */
  44. #define PACKET_MAGIC_VALUE  0x11227788
  45.  
  46. /** Packet header.
  47.  */
  48. struct packet{
  49.     /** Packet identifier.
  50.      */
  51.     packet_id_t     packet_id;
  52.     /** Packet queue sorting value.
  53.      *  The packet queue is sorted the ascending order.
  54.      */
  55.     int             order;
  56.     /** Packet metric.
  57.      */
  58.     size_t          metric;
  59.     /** Previous packet in the queue.
  60.      */
  61.     packet_id_t     previous;
  62.     /** Next packet in the queue.
  63.      */
  64.     packet_id_t     next;
  65.     /** Total length of the packet.
  66.      *  Contains the header, the addresses and the data of the packet.
  67.      *  Corresponds to the mapped sharable memory block.
  68.      */
  69.     size_t          length;
  70.     /** Stored source and destination addresses length.
  71.      */
  72.     size_t          addr_len;
  73.     /** Souce address offset in bytes from the beginning of the packet header.
  74.      */
  75.     size_t          src_addr;
  76.     /** Destination address offset in bytes from the beginning of the packet header.
  77.      */
  78.     size_t          dest_addr;
  79.     /** Reserved data prefix length in bytes.
  80.      */
  81.     size_t          max_prefix;
  82.     /** Reserved content length in bytes.
  83.      */
  84.     size_t          max_content;
  85.     /** Actual data start offset in bytes from the beginning of the packet header.
  86.      */
  87.     size_t          data_start;
  88.     /** Actual data end offset in bytes from the beginning of the packet header.
  89.      */
  90.     size_t          data_end;
  91.     /** Integrity check magic value.
  92.      */
  93.     int             magic_value;
  94. };
  95.  
  96. /** Returns whether the packet is valid.
  97.  *  @param packet The packet to be checked. Input parameter.
  98.  *  @returns true if the packet is not NULL and the magic value is correct.
  99.  *  @returns false otherwise.
  100.  */
  101. static inline int   packet_is_valid( const packet_t packet ){
  102.     return packet && ( packet->magic_value == PACKET_MAGIC_VALUE );
  103. }
  104.  
  105. #endif
  106.  
  107. /** @}
  108.  */
  109.