| 1 | /*
|
|---|
| 2 | * Copyright (c) 2008 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.
|
|---|
| 35 | */
|
|---|
| 36 |
|
|---|
| 37 | #ifndef __NET_ICMP_H__
|
|---|
| 38 | #define __NET_ICMP_H__
|
|---|
| 39 |
|
|---|
| 40 | #include <fibril_synch.h>
|
|---|
| 41 |
|
|---|
| 42 | #include <net/icmp_codes.h>
|
|---|
| 43 | #include <adt/int_map.h>
|
|---|
| 44 | #include <icmp_header.h>
|
|---|
| 45 |
|
|---|
| 46 | /** Type definition of the ICMP reply data.
|
|---|
| 47 | * @see icmp_reply
|
|---|
| 48 | */
|
|---|
| 49 | typedef struct icmp_reply icmp_reply_t;
|
|---|
| 50 |
|
|---|
| 51 | /** Type definition of the ICMP reply data pointer.
|
|---|
| 52 | * @see icmp_reply
|
|---|
| 53 | */
|
|---|
| 54 | typedef icmp_reply_t * icmp_reply_ref;
|
|---|
| 55 |
|
|---|
| 56 | /** Type definition of the ICMP global data.
|
|---|
| 57 | * @see icmp_globals
|
|---|
| 58 | */
|
|---|
| 59 | typedef struct icmp_globals icmp_globals_t;
|
|---|
| 60 |
|
|---|
| 61 | /** Pending replies map.
|
|---|
| 62 | * Maps message identifiers to the pending replies.
|
|---|
| 63 | * Sending fibril waits for its associated reply event.
|
|---|
| 64 | * Receiving fibril sets the associated reply with the return value and signals the event.
|
|---|
| 65 | */
|
|---|
| 66 | INT_MAP_DECLARE(icmp_replies, icmp_reply_t);
|
|---|
| 67 |
|
|---|
| 68 | /** Echo specific data map.
|
|---|
| 69 | * The identifier is used in the future semi-remote calls instead of the ICMP phone.
|
|---|
| 70 | */
|
|---|
| 71 | INT_MAP_DECLARE(icmp_echo_data, icmp_echo_t);
|
|---|
| 72 |
|
|---|
| 73 | /** ICMP reply data.
|
|---|
| 74 | */
|
|---|
| 75 | struct icmp_reply{
|
|---|
| 76 | /** Reply result.
|
|---|
| 77 | */
|
|---|
| 78 | int result;
|
|---|
| 79 | /** Safety lock.
|
|---|
| 80 | */
|
|---|
| 81 | fibril_mutex_t mutex;
|
|---|
| 82 | /** Received or timeouted reply signaling.
|
|---|
| 83 | */
|
|---|
| 84 | fibril_condvar_t condvar;
|
|---|
| 85 | };
|
|---|
| 86 |
|
|---|
| 87 | /** ICMP global data.
|
|---|
| 88 | */
|
|---|
| 89 | struct icmp_globals{
|
|---|
| 90 | /** IP module phone.
|
|---|
| 91 | */
|
|---|
| 92 | int ip_phone;
|
|---|
| 93 | /** Packet dimension.
|
|---|
| 94 | */
|
|---|
| 95 | packet_dimension_t packet_dimension;
|
|---|
| 96 | /** Networking module phone.
|
|---|
| 97 | */
|
|---|
| 98 | int net_phone;
|
|---|
| 99 | /** Indicates whether ICMP error reporting is enabled.
|
|---|
| 100 | */
|
|---|
| 101 | int error_reporting;
|
|---|
| 102 | /** Indicates whether ICMP echo replying (ping) is enabled.
|
|---|
| 103 | */
|
|---|
| 104 | int echo_replying;
|
|---|
| 105 | /** The last used identifier number.
|
|---|
| 106 | */
|
|---|
| 107 | icmp_param_t last_used_id;
|
|---|
| 108 | /** The budled modules assigned echo specific data.
|
|---|
| 109 | */
|
|---|
| 110 | icmp_echo_data_t echo_data;
|
|---|
| 111 | /** Echo timeout locks.
|
|---|
| 112 | */
|
|---|
| 113 | icmp_replies_t replies;
|
|---|
| 114 | /** Safety lock.
|
|---|
| 115 | */
|
|---|
| 116 | fibril_rwlock_t lock;
|
|---|
| 117 | };
|
|---|
| 118 |
|
|---|
| 119 | #endif
|
|---|
| 120 |
|
|---|
| 121 | /** @}
|
|---|
| 122 | */
|
|---|
| 123 |
|
|---|
