Subversion Repositories HelenOS

Rev

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