Subversion Repositories HelenOS

Rev

Rev 4715 | 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 icmp
  30.  *  @{
  31.  */
  32.  
  33. /** @file
  34.  *  ICMP module interface.
  35.  *  The same interface is used for standalone remote modules as well as for bundle modules.
  36.  *  The standalone remote modules have to be compiled with the icmp_remote.c source file.
  37.  *  The bundle modules with the icmp.c source file.
  38.  */
  39.  
  40. #ifndef __NET_ICMP_INTERFACE_H__
  41. #define __NET_ICMP_INTERFACE_H__
  42.  
  43. #include <sys/types.h>
  44.  
  45. #include "device.h"
  46.  
  47. #include "../structures/measured_strings.h"
  48. #include "../structures/packet/packet.h"
  49.  
  50. #include "inet.h"
  51. #include "ip_codes.h"
  52. #include "socket_codes.h"
  53.  
  54. #include "icmp_codes.h"
  55. #include "icmp_common.h"
  56.  
  57. /** @name ICMP module interface
  58.  *  This interface is used by other modules.
  59.  */
  60. /*@{*/
  61.  
  62. /** Sends the Destination Unreachable error notification packet.
  63.  *  Beginning of the packet is sent as the notification packet data.
  64.  *  The source and the destination addresses should be set in the original packet.
  65.  *  @param icmp_phone The ICMP module phone used for (semi)remote calls. Input parameter.
  66.  *  @param code The error specific code. Input parameter.
  67.  *  @param mtu The error MTU value. Input parameter.
  68.  *  @param packet The original packet.
  69.  *  @returns EOK on success.
  70.  *  @returns EPERM if the ICMP error notifications are disabled.
  71.  *  @returns ENOMEM if there is not enough memory left.
  72.  */
  73. int icmp_destination_unreachable_msg( int icmp_phone, icmp_code_t code, icmp_param_t mtu, packet_t packet );
  74.  
  75. /** Sends the Source Quench error notification packet.
  76.  *  Beginning of the packet is sent as the notification packet data.
  77.  *  The source and the destination addresses should be set in the original packet.
  78.  *  @param icmp_phone The ICMP module phone used for (semi)remote calls. Input parameter.
  79.  *  @param packet The original packet.
  80.  *  @returns EOK on success.
  81.  *  @returns EPERM if the ICMP error notifications are disabled.
  82.  *  @returns ENOMEM if there is not enough memory left.
  83.  */
  84. int icmp_source_quench_msg( int icmp_phone, packet_t packet );
  85.  
  86. /** Sends the Time Exceeded error notification packet.
  87.  *  Beginning of the packet is sent as the notification packet data.
  88.  *  The source and the destination addresses should be set in the original packet.
  89.  *  @param icmp_phone The ICMP module phone used for (semi)remote calls. Input parameter.
  90.  *  @param code The error specific code. Input parameter.
  91.  *  @param packet The original packet.
  92.  *  @returns EOK on success.
  93.  *  @returns EPERM if the ICMP error notifications are disabled.
  94.  *  @returns ENOMEM if there is not enough memory left.
  95.  */
  96. int icmp_time_exceeded_msg( int icmp_phone, icmp_code_t code, packet_t packet );
  97.  
  98. /** Sends the Parameter Problem error notification packet.
  99.  *  Beginning of the packet is sent as the notification packet data.
  100.  *  The source and the destination addresses should be set in the original packet.
  101.  *  @param icmp_phone The ICMP module phone used for (semi)remote calls. Input parameter.
  102.  *  @param code The error specific code. Input parameter.
  103.  *  @param pointer The problematic parameter offset. Input parameter.
  104.  *  @param packet The original packet.
  105.  *  @returns EOK on success.
  106.  *  @returns EPERM if the ICMP error notifications are disabled.
  107.  *  @returns ENOMEM if there is not enough memory left.
  108.  */
  109. int icmp_parameter_problem_msg( int icmp_phone, icmp_code_t code, icmp_param_t pointer, packet_t packet );
  110.  
  111. /*@}*/
  112.  
  113. #endif
  114.  
  115. /** @}
  116.  */
  117.