Index: uspace/srv/net/tl/icmp/icmp.c =================================================================== --- uspace/srv/net/tl/icmp/icmp.c (revision 472020fcce0d34f10b66ca0bd38c3b005abb9a4c) +++ uspace/srv/net/tl/icmp/icmp.c (revision edc5a98512c61122a292d2a3427de652aa345ec4) @@ -28,11 +28,14 @@ /** @addtogroup icmp - * @{ + * @{ */ /** @file - * ICMP module implementation. - * @see icmp.h - */ + * ICMP module implementation. + * @see icmp.h + */ + +#include "icmp.h" +#include "icmp_module.h" #include @@ -56,13 +59,13 @@ #include #include - #include +#include +#include +#include + #include #include #include -#include #include -#include -#include #include #include @@ -74,205 +77,176 @@ #include -#include "icmp.h" -#include "icmp_module.h" - -/** ICMP module name. - */ +/** ICMP module name. */ #define NAME "ICMP protocol" -/** Default ICMP error reporting. - */ +/** Default ICMP error reporting. */ #define NET_DEFAULT_ICMP_ERROR_REPORTING true -/** Default ICMP echo replying. - */ +/** Default ICMP echo replying. */ #define NET_DEFAULT_ICMP_ECHO_REPLYING true -/** Original datagram length in bytes transfered to the error notification message. +/** Original datagram length in bytes transfered to the error notification + * message. */ #define ICMP_KEEP_LENGTH 8 -/** Free identifier numbers pool start. - */ +/** Free identifier numbers pool start. */ #define ICMP_FREE_IDS_START 1 -/** Free identifier numbers pool end. - */ +/** Free identifier numbers pool end. */ #define ICMP_FREE_IDS_END UINT16_MAX /** Computes the ICMP datagram checksum. - * @param[in,out] header The ICMP datagram header. - * @param[in] length The total datagram length. - * @returns The computed checksum. - */ -#define ICMP_CHECKSUM(header, length) htons(ip_checksum((uint8_t *) (header), (length))) - -/** An echo request datagrams pattern. - */ -#define ICMP_ECHO_TEXT "Hello from HelenOS." + * + * @param[in,out] header The ICMP datagram header. + * @param[in] length The total datagram length. + * @returns The computed checksum. + */ +#define ICMP_CHECKSUM(header, length) \ + htons(ip_checksum((uint8_t *) (header), (length))) + +/** An echo request datagrams pattern. */ +#define ICMP_ECHO_TEXT "Hello from HelenOS." /** Computes an ICMP reply data key. - * @param[in] id The message identifier. - * @param[in] sequence The message sequence number. - * @returns The computed ICMP reply data key. - */ -#define ICMP_GET_REPLY_KEY(id, sequence) (((id) << 16) | (sequence &0xFFFF)) - -/** Processes the received ICMP packet. - * Is used as an entry point from the underlying IP module. - * Releases the packet on error. - * @param device_id The device identifier. Ignored parameter. - * @param[in,out] packet The received packet. - * @param receiver The target service. Ignored parameter. - * @param[in] error The packet error reporting service. Prefixes the received packet. - * @returns EOK on success. - * @returns Other error codes as defined for the icmp_process_packet() function. - */ -int icmp_received_msg(device_id_t device_id, packet_t packet, services_t receiver, services_t error); - -/** Processes the received ICMP packet. - * Notifies the destination socket application. - * @param[in,out] packet The received packet. - * @param[in] error The packet error reporting service. Prefixes the received packet. - * @returns EOK on success. - * @returns EINVAL if the packet is not valid. - * @returns EINVAL if the stored packet address is not the an_addr_t. - * @returns EINVAL if the packet does not contain any data. - * @returns NO_DATA if the packet content is shorter than the user datagram header. - * @returns ENOMEM if there is not enough memory left. - * @returns EADDRNOTAVAIL if the destination socket does not exist. - * @returns Other error codes as defined for the ip_client_process_packet() function. - */ -int icmp_process_packet(packet_t packet, services_t error); - -/** Processes the client messages. - * Remembers the assigned identifier and sequence numbers. - * Runs until the client module disconnects. - * @param[in] callid The message identifier. - * @param[in] call The message parameters. - * @returns EOK. - * @see icmp_interface.h - * @see icmp_api.h - */ -int icmp_process_client_messages(ipc_callid_t callid, ipc_call_t call); - -/** Processes the generic client messages. - * @param[in] call The message parameters. - * @returns EOK on success. - * @returns ENOTSUP if the message is not known. - * @returns Other error codes as defined for the packet_translate() function. - * @returns Other error codes as defined for the icmp_destination_unreachable_msg() function. - * @returns Other error codes as defined for the icmp_source_quench_msg() function. - * @returns Other error codes as defined for the icmp_time_exceeded_msg() function. - * @returns Other error codes as defined for the icmp_parameter_problem_msg() function. - * @see icmp_interface.h - */ -int icmp_process_message(ipc_call_t * call); + * + * @param[in] id The message identifier. + * @param[in] sequence The message sequence number. + * @returns The computed ICMP reply data key. + */ +#define ICMP_GET_REPLY_KEY(id, sequence) \ + (((id) << 16) | (sequence & 0xFFFF)) + + +/** ICMP global data. */ +icmp_globals_t icmp_globals; + +INT_MAP_IMPLEMENT(icmp_replies, icmp_reply_t); +INT_MAP_IMPLEMENT(icmp_echo_data, icmp_echo_t); /** Releases the packet and returns the result. - * @param[in] packet The packet queue to be released. - * @param[in] result The result to be returned. - * @returns The result parameter. - */ -int icmp_release_and_return(packet_t packet, int result); + * + * @param[in] packet The packet queue to be released. + * @param[in] result The result to be returned. + * @returns The result parameter. + */ +static int icmp_release_and_return(packet_t packet, int result) +{ + pq_release_remote(icmp_globals.net_phone, packet_get_id(packet)); + return result; +} + +/** Sends the ICMP message. + * + * Sets the message type and code and computes the checksum. + * Error messages are sent only if allowed in the configuration. + * Releases the packet on errors. + * + * @param[in] type The message type. + * @param[in] code The message code. + * @param[in] packet The message packet to be sent. + * @param[in] header The ICMP header. + * @param[in] error The error service to be announced. Should be + * SERVICE_ICMP or zero. + * @param[in] ttl The time to live. + * @param[in] tos The type of service. + * @param[in] dont_fragment The value indicating whether the datagram must not + * be fragmented. Is used as a MTU discovery. + * @returns EOK on success. + * @returns EPERM if the error message is not allowed. + */ +static int +icmp_send_packet(icmp_type_t type, icmp_code_t code, packet_t packet, + icmp_header_ref header, services_t error, ip_ttl_t ttl, ip_tos_t tos, + int dont_fragment) +{ + ERROR_DECLARE; + + // do not send an error if disabled + if (error && !icmp_globals.error_reporting) + return icmp_release_and_return(packet, EPERM); + + header->type = type; + header->code = code; + header->checksum = 0; + header->checksum = ICMP_CHECKSUM(header, + packet_get_data_length(packet)); + if (ERROR_OCCURRED(ip_client_prepare_packet(packet, IPPROTO_ICMP, ttl, + tos, dont_fragment, 0))) { + return icmp_release_and_return(packet, ERROR_CODE); + } + + return ip_send_msg(icmp_globals.ip_phone, -1, packet, SERVICE_ICMP, + error); +} + +/** Prepares the ICMP error packet. + * + * Truncates the original packet if longer than ICMP_KEEP_LENGTH bytes. + * Prefixes and returns the ICMP header. + * + * @param[in,out] packet The original packet. + * @returns The prefixed ICMP header. + * @returns NULL on errors. + */ +static icmp_header_ref icmp_prepare_packet(packet_t packet) +{ + icmp_header_ref header; + size_t header_length; + size_t total_length; + + total_length = packet_get_data_length(packet); + if (total_length <= 0) + return NULL; + + header_length = ip_client_header_length(packet); + if (header_length <= 0) + return NULL; + + // truncate if longer than 64 bits (without the IP header) + if ((total_length > header_length + ICMP_KEEP_LENGTH) && + (packet_trim(packet, 0, + total_length - header_length - ICMP_KEEP_LENGTH) != EOK)) { + return NULL; + } + + header = PACKET_PREFIX(packet, icmp_header_t); + if (!header) + return NULL; + + bzero(header, sizeof(*header)); + return header; +} /** Requests an echo message. - * Sends a packet with specified parameters to the target host and waits for the reply upto the given timeout. - * Blocks the caller until the reply or the timeout occurs. - * @param[in] id The message identifier. - * @param[in] sequence The message sequence parameter. - * @param[in] size The message data length in bytes. - * @param[in] timeout The timeout in miliseconds. - * @param[in] ttl The time to live. - * @param[in] tos The type of service. - * @param[in] dont_fragment The value indicating whether the datagram must not be fragmented. Is used as a MTU discovery. - * @param[in] addr The target host address. - * @param[in] addrlen The torget host address length. - * @returns ICMP_ECHO on success. - * @returns ETIMEOUT if the reply has not arrived before the timeout. - * @returns ICMP type of the received error notification. - * @returns EINVAL if the addrlen parameter is less or equal to zero (<=0). - * @returns ENOMEM if there is not enough memory left. - * @returns EPARTY if there was an internal error. - */ -int icmp_echo(icmp_param_t id, icmp_param_t sequence, size_t size, mseconds_t timeout, ip_ttl_t ttl, ip_tos_t tos, int dont_fragment, const struct sockaddr * addr, socklen_t addrlen); - -/** Prepares the ICMP error packet. - * Truncates the original packet if longer than ICMP_KEEP_LENGTH bytes. - * Prefixes and returns the ICMP header. - * @param[in,out] packet The original packet. - * @returns The prefixed ICMP header. - * @returns NULL on errors. - */ -icmp_header_ref icmp_prepare_packet(packet_t packet); - -/** Sends the ICMP message. - * Sets the message type and code and computes the checksum. - * Error messages are sent only if allowed in the configuration. - * Releases the packet on errors. - * @param[in] type The message type. - * @param[in] code The message code. - * @param[in] packet The message packet to be sent. - * @param[in] header The ICMP header. - * @param[in] error The error service to be announced. Should be SERVICE_ICMP or zero (0). - * @param[in] ttl The time to live. - * @param[in] tos The type of service. - * @param[in] dont_fragment The value indicating whether the datagram must not be fragmented. Is used as a MTU discovery. - * @returns EOK on success. - * @returns EPERM if the error message is not allowed. - */ -int icmp_send_packet(icmp_type_t type, icmp_code_t code, packet_t packet, icmp_header_ref header, services_t error, ip_ttl_t ttl, ip_tos_t tos, int dont_fragment); - -/** Tries to set the pending reply result as the received message type. - * If the reply data is not present, the reply timed out and the other fibril - * is already awake. - * Releases the packet. - * @param[in] packet The received reply message. - * @param[in] header The ICMP message header. - * @param[in] type The received reply message type. - * @param[in] code The received reply message code. - * @returns EOK. - */ -int icmp_process_echo_reply(packet_t packet, icmp_header_ref header, icmp_type_t type, icmp_code_t code); - -/** Assigns a new identifier for the connection. - * Fills the echo data parameter with the assigned values. - * @param[in,out] echo_data The echo data to be bound. - * @returns Index of the inserted echo data. - * @returns EBADMEM if the echo_data parameter is NULL. - * @returns ENOTCONN if no free identifier have been found. - */ -int icmp_bind_free_id(icmp_echo_ref echo_data); - -/** ICMP global data. - */ -icmp_globals_t icmp_globals; - -INT_MAP_IMPLEMENT(icmp_replies, icmp_reply_t); - -INT_MAP_IMPLEMENT(icmp_echo_data, icmp_echo_t); - -int icmp_echo_msg(int icmp_phone, size_t size, mseconds_t timeout, ip_ttl_t ttl, ip_tos_t tos, int dont_fragment, const struct sockaddr * addr, socklen_t addrlen){ - icmp_echo_ref echo_data; - int res; - - fibril_rwlock_write_lock(&icmp_globals.lock); - // use the phone as the echo data index - echo_data = icmp_echo_data_find(&icmp_globals.echo_data, icmp_phone); - if(! echo_data){ - res = ENOENT; - }else{ - res = icmp_echo(echo_data->identifier, echo_data->sequence_number, size, timeout, ttl, tos, dont_fragment, addr, addrlen); - if(echo_data->sequence_number < UINT16_MAX){ - ++ echo_data->sequence_number; - }else{ - echo_data->sequence_number = 0; - } - } - fibril_rwlock_write_unlock(&icmp_globals.lock); - return res; -} - -int icmp_echo(icmp_param_t id, icmp_param_t sequence, size_t size, mseconds_t timeout, ip_ttl_t ttl, ip_tos_t tos, int dont_fragment, const struct sockaddr * addr, socklen_t addrlen){ + * + * Sends a packet with specified parameters to the target host and waits for + * the reply upto the given timeout. + * Blocks the caller until the reply or the timeout occurs. + * + * @param[in] id The message identifier. + * @param[in] sequence The message sequence parameter. + * @param[in] size The message data length in bytes. + * @param[in] timeout The timeout in miliseconds. + * @param[in] ttl The time to live. + * @param[in] tos The type of service. + * @param[in] dont_fragment The value indicating whether the datagram must not + * be fragmented. Is used as a MTU discovery. + * @param[in] addr The target host address. + * @param[in] addrlen The torget host address length. + * @returns ICMP_ECHO on success. + * @returns ETIMEOUT if the reply has not arrived before the + * timeout. + * @returns ICMP type of the received error notification. + * @returns EINVAL if the addrlen parameter is less or equal to + * zero. + * @returns ENOMEM if there is not enough memory left. + * @returns EPARTY if there was an internal error. + */ +static int +icmp_echo(icmp_param_t id, icmp_param_t sequence, size_t size, + mseconds_t timeout, ip_ttl_t ttl, ip_tos_t tos, int dont_fragment, + const struct sockaddr * addr, socklen_t addrlen) +{ ERROR_DECLARE; @@ -280,5 +254,5 @@ packet_t packet; size_t length; - uint8_t * data; + uint8_t *data; icmp_reply_ref reply; int reply_key; @@ -286,37 +260,44 @@ int index; - if(addrlen <= 0){ + if (addrlen <= 0) return EINVAL; - } + length = (size_t) addrlen; // TODO do not ask all the time - ERROR_PROPAGATE(ip_packet_size_req(icmp_globals.ip_phone, -1, &icmp_globals.packet_dimension)); - packet = packet_get_4_remote(icmp_globals.net_phone, size, icmp_globals.packet_dimension.addr_len, ICMP_HEADER_SIZE + icmp_globals.packet_dimension.prefix, icmp_globals.packet_dimension.suffix); - if(! packet){ + ERROR_PROPAGATE(ip_packet_size_req(icmp_globals.ip_phone, -1, + &icmp_globals.packet_dimension)); + + packet = packet_get_4_remote(icmp_globals.net_phone, size, + icmp_globals.packet_dimension.addr_len, + ICMP_HEADER_SIZE + icmp_globals.packet_dimension.prefix, + icmp_globals.packet_dimension.suffix); + if (!packet) return ENOMEM; - } // prepare the requesting packet // set the destination address - if(ERROR_OCCURRED(packet_set_addr(packet, NULL, (const uint8_t *) addr, length))){ + if (ERROR_OCCURRED(packet_set_addr(packet, NULL, (const uint8_t *) addr, + length))) { return icmp_release_and_return(packet, ERROR_CODE); } + // allocate space in the packet data = (uint8_t *) packet_suffix(packet, size); - if(! data){ + if (!data) return icmp_release_and_return(packet, ENOMEM); - } + // fill the data length = 0; - while(size > length + sizeof(ICMP_ECHO_TEXT)){ + while (size > length + sizeof(ICMP_ECHO_TEXT)) { memcpy(data + length, ICMP_ECHO_TEXT, sizeof(ICMP_ECHO_TEXT)); length += sizeof(ICMP_ECHO_TEXT); } memcpy(data + length, ICMP_ECHO_TEXT, size - length); + // prefix the header header = PACKET_PREFIX(packet, icmp_header_t); - if(! header){ + if (!header) return icmp_release_and_return(packet, ENOMEM); - } + bzero(header, sizeof(*header)); header->un.echo.identifier = id; @@ -325,13 +306,14 @@ // prepare the reply structure reply = malloc(sizeof(*reply)); - if(! reply){ + if (!reply) return icmp_release_and_return(packet, ENOMEM); - } + fibril_mutex_initialize(&reply->mutex); fibril_mutex_lock(&reply->mutex); fibril_condvar_initialize(&reply->condvar); - reply_key = ICMP_GET_REPLY_KEY(header->un.echo.identifier, header->un.echo.sequence_number); + reply_key = ICMP_GET_REPLY_KEY(header->un.echo.identifier, + header->un.echo.sequence_number); index = icmp_replies_add(&icmp_globals.replies, reply_key, reply); - if(index < 0){ + if (index < 0) { free(reply); return icmp_release_and_return(packet, index); @@ -342,11 +324,13 @@ // send the request - icmp_send_packet(ICMP_ECHO, 0, packet, header, 0, ttl, tos, dont_fragment); + icmp_send_packet(ICMP_ECHO, 0, packet, header, 0, ttl, tos, + dont_fragment); // wait for the reply // timeout in microseconds - if(ERROR_OCCURRED(fibril_condvar_wait_timeout(&reply->condvar, &reply->mutex, timeout * 1000))){ + if (ERROR_OCCURRED(fibril_condvar_wait_timeout(&reply->condvar, + &reply->mutex, timeout * 1000))) { result = ERROR_CODE; - }else{ + } else { // read the result result = reply->result; @@ -359,101 +343,89 @@ // destroy the reply structure icmp_replies_exclude_index(&icmp_globals.replies, index); + return result; } -int icmp_destination_unreachable_msg(int icmp_phone, icmp_code_t code, icmp_param_t mtu, packet_t packet){ +static int +icmp_destination_unreachable_msg_local(int icmp_phone, icmp_code_t code, + icmp_param_t mtu, packet_t packet) +{ icmp_header_ref header; header = icmp_prepare_packet(packet); - if(! header){ + if (!header) return icmp_release_and_return(packet, ENOMEM); - } - if(mtu){ + + if (mtu) header->un.frag.mtu = mtu; - } - return icmp_send_packet(ICMP_DEST_UNREACH, code, packet, header, SERVICE_ICMP, 0, 0, 0); -} - -int icmp_source_quench_msg(int icmp_phone, packet_t packet){ + + return icmp_send_packet(ICMP_DEST_UNREACH, code, packet, header, + SERVICE_ICMP, 0, 0, 0); +} + +static int icmp_source_quench_msg_local(int icmp_phone, packet_t packet) +{ icmp_header_ref header; header = icmp_prepare_packet(packet); - if(! header){ + if (!header) return icmp_release_and_return(packet, ENOMEM); - } - return icmp_send_packet(ICMP_SOURCE_QUENCH, 0, packet, header, SERVICE_ICMP, 0, 0, 0); -} - -int icmp_time_exceeded_msg(int icmp_phone, icmp_code_t code, packet_t packet){ + + return icmp_send_packet(ICMP_SOURCE_QUENCH, 0, packet, header, + SERVICE_ICMP, 0, 0, 0); +} + +static int +icmp_time_exceeded_msg_local(int icmp_phone, icmp_code_t code, packet_t packet) +{ icmp_header_ref header; header = icmp_prepare_packet(packet); - if(! header){ + if (!header) return icmp_release_and_return(packet, ENOMEM); - } - return icmp_send_packet(ICMP_TIME_EXCEEDED, code, packet, header, SERVICE_ICMP, 0, 0, 0); -} - -int icmp_parameter_problem_msg(int icmp_phone, icmp_code_t code, icmp_param_t pointer, packet_t packet){ + + return icmp_send_packet(ICMP_TIME_EXCEEDED, code, packet, header, + SERVICE_ICMP, 0, 0, 0); +} + +static int +icmp_parameter_problem_msg_local(int icmp_phone, icmp_code_t code, + icmp_param_t pointer, packet_t packet) +{ icmp_header_ref header; header = icmp_prepare_packet(packet); - if(! header){ + if (!header) return icmp_release_and_return(packet, ENOMEM); - } + header->un.param.pointer = pointer; - return icmp_send_packet(ICMP_PARAMETERPROB, code, packet, header, SERVICE_ICMP, 0, 0, 0); -} - -icmp_header_ref icmp_prepare_packet(packet_t packet){ - icmp_header_ref header; - size_t header_length; - size_t total_length; - - total_length = packet_get_data_length(packet); - if(total_length <= 0){ - return NULL; - } - header_length = ip_client_header_length(packet); - if(header_length <= 0){ - return NULL; - } - // truncate if longer than 64 bits (without the IP header) - if((total_length > header_length + ICMP_KEEP_LENGTH) - && (packet_trim(packet, 0, total_length - header_length - ICMP_KEEP_LENGTH) != EOK)){ - return NULL; - } - header = PACKET_PREFIX(packet, icmp_header_t); - if(! header){ - return NULL; - } - bzero(header, sizeof(*header)); - return header; -} - -int icmp_send_packet(icmp_type_t type, icmp_code_t code, packet_t packet, icmp_header_ref header, services_t error, ip_ttl_t ttl, ip_tos_t tos, int dont_fragment){ + return icmp_send_packet(ICMP_PARAMETERPROB, code, packet, header, + SERVICE_ICMP, 0, 0, 0); +} + +/** Initializes the ICMP module. + * + * @param[in] client_connection The client connection processing function. The + * module skeleton propagates its own one. + * @returns EOK on success. + * @returns ENOMEM if there is not enough memory left. + */ +int icmp_initialize(async_client_conn_t client_connection) +{ ERROR_DECLARE; - // do not send an error if disabled - if(error && (! icmp_globals.error_reporting)){ - return icmp_release_and_return(packet, EPERM); - } - header->type = type; - header->code = code; - header->checksum = 0; - header->checksum = ICMP_CHECKSUM(header, packet_get_data_length(packet)); - if(ERROR_OCCURRED(ip_client_prepare_packet(packet, IPPROTO_ICMP, ttl, tos, dont_fragment, 0))){ - return icmp_release_and_return(packet, ERROR_CODE); - } - return ip_send_msg(icmp_globals.ip_phone, -1, packet, SERVICE_ICMP, error); -} - -int icmp_initialize(async_client_conn_t client_connection){ - ERROR_DECLARE; - - measured_string_t names[] = {{str_dup("ICMP_ERROR_REPORTING"), 20}, {str_dup("ICMP_ECHO_REPLYING"), 18}}; + measured_string_t names[] = { + { + str_dup("ICMP_ERROR_REPORTING"), + 20 + }, + { + str_dup("ICMP_ECHO_REPLYING"), + 18 + } + }; measured_string_ref configuration; size_t count = sizeof(names) / sizeof(measured_string_t); - char * data; + char *data; fibril_rwlock_initialize(&icmp_globals.lock); @@ -461,67 +433,118 @@ icmp_replies_initialize(&icmp_globals.replies); icmp_echo_data_initialize(&icmp_globals.echo_data); - icmp_globals.ip_phone = ip_bind_service(SERVICE_IP, IPPROTO_ICMP, SERVICE_ICMP, client_connection); - if(icmp_globals.ip_phone < 0){ + icmp_globals.ip_phone = ip_bind_service(SERVICE_IP, IPPROTO_ICMP, + SERVICE_ICMP, client_connection); + if (icmp_globals.ip_phone < 0) return icmp_globals.ip_phone; - } - ERROR_PROPAGATE(ip_packet_size_req(icmp_globals.ip_phone, -1, &icmp_globals.packet_dimension)); + + ERROR_PROPAGATE(ip_packet_size_req(icmp_globals.ip_phone, -1, + &icmp_globals.packet_dimension)); icmp_globals.packet_dimension.prefix += ICMP_HEADER_SIZE; icmp_globals.packet_dimension.content -= ICMP_HEADER_SIZE; - // get configuration + icmp_globals.error_reporting = NET_DEFAULT_ICMP_ERROR_REPORTING; icmp_globals.echo_replying = NET_DEFAULT_ICMP_ECHO_REPLYING; + + // get configuration configuration = &names[0]; - ERROR_PROPAGATE(net_get_conf_req(icmp_globals.net_phone, &configuration, count, &data)); - if(configuration){ - if(configuration[0].value){ - icmp_globals.error_reporting = (configuration[0].value[0] == 'y'); - } - if(configuration[1].value){ - icmp_globals.echo_replying = (configuration[1].value[0] == 'y'); + ERROR_PROPAGATE(net_get_conf_req(icmp_globals.net_phone, &configuration, + count, &data)); + if (configuration) { + if (configuration[0].value) { + icmp_globals.error_reporting = + (configuration[0].value[0] == 'y'); + } + if (configuration[1].value) { + icmp_globals.echo_replying = + (configuration[1].value[0] == 'y'); } net_free_settings(configuration, data); } + fibril_rwlock_write_unlock(&icmp_globals.lock); return EOK; } -int icmp_received_msg(device_id_t device_id, packet_t packet, services_t receiver, services_t error){ +/** Tries to set the pending reply result as the received message type. + * + * If the reply data is not present, the reply timed out and the other fibril + * is already awake. + * Releases the packet. + * + * @param[in] packet The received reply message. + * @param[in] header The ICMP message header. + * @param[in] type The received reply message type. + * @param[in] code The received reply message code. + */ +static void +icmp_process_echo_reply(packet_t packet, icmp_header_ref header, + icmp_type_t type, icmp_code_t code) +{ + int reply_key; + icmp_reply_ref reply; + + // compute the reply key + reply_key = ICMP_GET_REPLY_KEY(header->un.echo.identifier, + header->un.echo.sequence_number); + pq_release_remote(icmp_globals.net_phone, packet_get_id(packet)); + + fibril_rwlock_write_lock(&icmp_globals.lock); + // find the pending reply + reply = icmp_replies_find(&icmp_globals.replies, reply_key); + if (reply) { + reply->result = type; + fibril_condvar_signal(&reply->condvar); + } + fibril_rwlock_write_unlock(&icmp_globals.lock); +} + +/** Processes the received ICMP packet. + * + * Notifies the destination socket application. + * + * @param[in,out] packet The received packet. + * @param[in] error The packet error reporting service. Prefixes the + * received packet. + * @returns EOK on success. + * @returns EINVAL if the packet is not valid. + * @returns EINVAL if the stored packet address is not the an_addr_t. + * @returns EINVAL if the packet does not contain any data. + * @returns NO_DATA if the packet content is shorter than the user + * datagram header. + * @returns ENOMEM if there is not enough memory left. + * @returns EADDRNOTAVAIL if the destination socket does not exist. + * @returns Other error codes as defined for the + * ip_client_process_packet() function. + */ +static int icmp_process_packet(packet_t packet, services_t error) +{ ERROR_DECLARE; - if(ERROR_OCCURRED(icmp_process_packet(packet, error))){ - return icmp_release_and_return(packet, ERROR_CODE); - } - - return EOK; -} - -int icmp_process_packet(packet_t packet, services_t error){ - ERROR_DECLARE; - size_t length; - uint8_t * src; + uint8_t *src; int addrlen; int result; - void * data; + void *data; icmp_header_ref header; icmp_type_t type; icmp_code_t code; - if(error){ - switch(error){ - case SERVICE_ICMP: - // process error - result = icmp_client_process_packet(packet, &type, &code, NULL, NULL); - if(result < 0){ - return result; - } - length = (size_t) result; - // remove the error header - ERROR_PROPAGATE(packet_trim(packet, length, 0)); - break; - default: - return ENOTSUP; - } - } + switch (error) { + case SERVICE_NONE: + break; + case SERVICE_ICMP: + // process error + result = icmp_client_process_packet(packet, &type, &code, NULL, + NULL); + if (result < 0) + return result; + length = (size_t) result; + // remove the error header + ERROR_PROPAGATE(packet_trim(packet, length, 0)); + break; + default: + return ENOTSUP; + } + // get rid of the ip header length = ip_client_header_length(packet); @@ -529,26 +552,26 @@ length = packet_get_data_length(packet); - if(length <= 0){ + if (length <= 0) return EINVAL; - } - if(length < ICMP_HEADER_SIZE){ + + if (length < ICMP_HEADER_SIZE) return EINVAL; - } + data = packet_get_data(packet); - if(! data){ + if (!data) return EINVAL; - } + // get icmp header header = (icmp_header_ref) data; - // checksum - if(header->checksum){ - while(ICMP_CHECKSUM(header, length) != IP_CHECKSUM_ZERO){ + + if (header->checksum) { + while (ICMP_CHECKSUM(header, length) != IP_CHECKSUM_ZERO) { // set the original message type on error notification // type swap observed in Qemu - if(error){ - switch(header->type){ - case ICMP_ECHOREPLY: - header->type = ICMP_ECHO; - continue; + if (error) { + switch (header->type) { + case ICMP_ECHOREPLY: + header->type = ICMP_ECHO; + continue; } } @@ -556,98 +579,211 @@ } } - switch(header->type){ - case ICMP_ECHOREPLY: - if(error){ - return icmp_process_echo_reply(packet, header, type, code); - }else{ - return icmp_process_echo_reply(packet, header, ICMP_ECHO, 0); + + switch (header->type) { + case ICMP_ECHOREPLY: + if (error) + icmp_process_echo_reply(packet, header, type, code); + else + icmp_process_echo_reply(packet, header, ICMP_ECHO, 0); + + return EOK; + + case ICMP_ECHO: + if (error) { + icmp_process_echo_reply(packet, header, type, code); + return EOK; + } + + // do not send a reply if disabled + if (icmp_globals.echo_replying) { + addrlen = packet_get_addr(packet, &src, NULL); + + // set both addresses to the source one (avoids the + // source address deletion before setting the + // destination one) + if ((addrlen > 0) && (packet_set_addr(packet, src, src, + (size_t) addrlen) == EOK)) { + // send the reply + icmp_send_packet(ICMP_ECHOREPLY, 0, packet, + header, 0, 0, 0, 0); + return EOK; } - case ICMP_ECHO: - if(error){ - return icmp_process_echo_reply(packet, header, type, code); - // do not send a reply if disabled - }else if(icmp_globals.echo_replying){ - addrlen = packet_get_addr(packet, &src, NULL); - if((addrlen > 0) - // set both addresses to the source one (avoids the source address deletion before setting the destination one) - && (packet_set_addr(packet, src, src, (size_t) addrlen) == EOK)){ - // send the reply - icmp_send_packet(ICMP_ECHOREPLY, 0, packet, header, 0, 0, 0, 0); - return EOK; - }else{ - return EINVAL; + + return EINVAL; + } + + return EPERM; + + case ICMP_DEST_UNREACH: + case ICMP_SOURCE_QUENCH: + case ICMP_REDIRECT: + case ICMP_ALTERNATE_ADDR: + case ICMP_ROUTER_ADV: + case ICMP_ROUTER_SOL: + case ICMP_TIME_EXCEEDED: + case ICMP_PARAMETERPROB: + case ICMP_CONVERSION_ERROR: + case ICMP_REDIRECT_MOBILE: + case ICMP_SKIP: + case ICMP_PHOTURIS: + ip_received_error_msg(icmp_globals.ip_phone, -1, packet, + SERVICE_IP, SERVICE_ICMP); + return EOK; + + default: + return ENOTSUP; + } +} + +/** Processes the received ICMP packet. + * + * Is used as an entry point from the underlying IP module. + * Releases the packet on error. + * + * @param device_id The device identifier. Ignored parameter. + * @param[in,out] packet The received packet. + * @param receiver The target service. Ignored parameter. + * @param[in] error The packet error reporting service. Prefixes the + * received packet. + * @returns EOK on success. + * @returns Other error codes as defined for the + * icmp_process_packet() function. + */ +static int +icmp_received_msg_local(device_id_t device_id, packet_t packet, + services_t receiver, services_t error) +{ + ERROR_DECLARE; + + if (ERROR_OCCURRED(icmp_process_packet(packet, error))) + return icmp_release_and_return(packet, ERROR_CODE); + + return EOK; +} + +/** Processes the generic client messages. + * + * @param[in] call The message parameters. + * @returns EOK on success. + * @returns ENOTSUP if the message is not known. + * @returns Other error codes as defined for the packet_translate() + * function. + * @returns Other error codes as defined for the + * icmp_destination_unreachable_msg_local() function. + * @returns Other error codes as defined for the + * icmp_source_quench_msg_local() function. + * @returns Other error codes as defined for the + * icmp_time_exceeded_msg_local() function. + * @returns Other error codes as defined for the + * icmp_parameter_problem_msg_local() function. + * + * @see icmp_interface.h + */ +static int icmp_process_message(ipc_call_t *call) +{ + ERROR_DECLARE; + + packet_t packet; + + switch (IPC_GET_METHOD(*call)) { + case NET_ICMP_DEST_UNREACH: + if (ERROR_NONE(packet_translate_remote(icmp_globals.net_phone, + &packet, IPC_GET_PACKET(call)))) { + ERROR_CODE = icmp_destination_unreachable_msg_local(0, + ICMP_GET_CODE(call), ICMP_GET_MTU(call), packet); + } + return ERROR_CODE; + case NET_ICMP_SOURCE_QUENCH: + if (ERROR_NONE(packet_translate_remote(icmp_globals.net_phone, + &packet, IPC_GET_PACKET(call)))) { + ERROR_CODE = icmp_source_quench_msg_local(0, packet); + } + return ERROR_CODE; + case NET_ICMP_TIME_EXCEEDED: + if (ERROR_NONE(packet_translate_remote(icmp_globals.net_phone, + &packet, IPC_GET_PACKET(call)))) { + ERROR_CODE = icmp_time_exceeded_msg_local(0, + ICMP_GET_CODE(call), packet); + } + return ERROR_CODE; + case NET_ICMP_PARAMETERPROB: + if (ERROR_NONE(packet_translate_remote(icmp_globals.net_phone, + &packet, IPC_GET_PACKET(call)))) { + ERROR_CODE = icmp_parameter_problem_msg_local(0, + ICMP_GET_CODE(call), ICMP_GET_POINTER(call), + packet); + } + return ERROR_CODE; + default: + return ENOTSUP; + } +} + +/** Assigns a new identifier for the connection. + * + * Fills the echo data parameter with the assigned values. + * + * @param[in,out] echo_data The echo data to be bound. + * @returns Index of the inserted echo data. + * @returns EBADMEM if the echo_data parameter is NULL. + * @returns ENOTCONN if no free identifier have been found. + */ +static int icmp_bind_free_id(icmp_echo_ref echo_data) +{ + icmp_param_t index; + + if (!echo_data) + return EBADMEM; + + // from the last used one + index = icmp_globals.last_used_id; + do { + index++; + // til the range end + if (index >= ICMP_FREE_IDS_END) { + // start from the range beginning + index = ICMP_FREE_IDS_START - 1; + do { + index++; + // til the last used one + if (index >= icmp_globals.last_used_id) { + // none found + return ENOTCONN; } - }else{ - return EPERM; - } - case ICMP_DEST_UNREACH: - case ICMP_SOURCE_QUENCH: - case ICMP_REDIRECT: - case ICMP_ALTERNATE_ADDR: - case ICMP_ROUTER_ADV: - case ICMP_ROUTER_SOL: - case ICMP_TIME_EXCEEDED: - case ICMP_PARAMETERPROB: - case ICMP_CONVERSION_ERROR: - case ICMP_REDIRECT_MOBILE: - case ICMP_SKIP: - case ICMP_PHOTURIS: - ip_received_error_msg(icmp_globals.ip_phone, -1, packet, SERVICE_IP, SERVICE_ICMP); - return EOK; - default: - return ENOTSUP; - } -} - -int icmp_process_echo_reply(packet_t packet, icmp_header_ref header, icmp_type_t type, icmp_code_t code){ - int reply_key; - icmp_reply_ref reply; - - // compute the reply key - reply_key = ICMP_GET_REPLY_KEY(header->un.echo.identifier, header->un.echo.sequence_number); - pq_release_remote(icmp_globals.net_phone, packet_get_id(packet)); - // lock the globals - fibril_rwlock_write_lock(&icmp_globals.lock); - // find the pending reply - reply = icmp_replies_find(&icmp_globals.replies, reply_key); - if(reply){ - // set the result - reply->result = type; - // notify the waiting fibril - fibril_condvar_signal(&reply->condvar); - } - fibril_rwlock_write_unlock(&icmp_globals.lock); - return EOK; -} - -int icmp_message_standalone(ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count){ + } while(icmp_echo_data_find(&icmp_globals.echo_data, + index) != NULL); + + // found, break immediately + break; + } + } while(icmp_echo_data_find(&icmp_globals.echo_data, index) != NULL); + + echo_data->identifier = index; + echo_data->sequence_number = 0; + + return icmp_echo_data_add(&icmp_globals.echo_data, index, echo_data); +} + +/** Processes the client messages. + * + * Remembers the assigned identifier and sequence numbers. + * Runs until the client module disconnects. + * + * @param[in] callid The message identifier. + * @param[in] call The message parameters. + * @returns EOK. + * + * @see icmp_interface.h + * @see icmp_api.h + */ +static int icmp_process_client_messages(ipc_callid_t callid, ipc_call_t call) +{ ERROR_DECLARE; - packet_t packet; - - *answer_count = 0; - switch(IPC_GET_METHOD(*call)){ - case NET_TL_RECEIVED: - if(! ERROR_OCCURRED(packet_translate_remote(icmp_globals.net_phone, &packet, IPC_GET_PACKET(call)))){ - ERROR_CODE = icmp_received_msg(IPC_GET_DEVICE(call), packet, SERVICE_ICMP, IPC_GET_ERROR(call)); - } - return ERROR_CODE; - case NET_ICMP_INIT: - return icmp_process_client_messages(callid, * call); - default: - return icmp_process_message(call); - } - return ENOTSUP; -} - -int icmp_process_client_messages(ipc_callid_t callid, ipc_call_t call){ - ERROR_DECLARE; - bool keep_on_going = true; -// fibril_rwlock_t lock; ipc_call_t answer; int answer_count; size_t length; - struct sockaddr * addr; + struct sockaddr *addr; ipc_callid_t data_callid; icmp_echo_ref echo_data; @@ -661,10 +797,7 @@ answer_count = 0; -// fibril_rwlock_initialize(&lock); - echo_data = (icmp_echo_ref) malloc(sizeof(*echo_data)); - if(! echo_data){ + if (!echo_data) return ENOMEM; - } // assign a new identifier @@ -672,11 +805,10 @@ res = icmp_bind_free_id(echo_data); fibril_rwlock_write_unlock(&icmp_globals.lock); - if(res < 0){ + if (res < 0) { free(echo_data); return res; } - while(keep_on_going){ - + while (keep_on_going) { // answer the call answer_call(callid, res, &answer, answer_count); @@ -689,38 +821,50 @@ // process the call - switch(IPC_GET_METHOD(call)){ - case IPC_M_PHONE_HUNGUP: - keep_on_going = false; - res = EHANGUP; + switch (IPC_GET_METHOD(call)) { + case IPC_M_PHONE_HUNGUP: + keep_on_going = false; + res = EHANGUP; + break; + + case NET_ICMP_ECHO: + if (!async_data_write_receive(&data_callid, &length)) { + res = EINVAL; break; - case NET_ICMP_ECHO: -// fibril_rwlock_write_lock(&lock); - if(! async_data_write_receive(&data_callid, &length)){ - res = EINVAL; - }else{ - addr = malloc(length); - if(! addr){ - res = ENOMEM; - }else{ - if(! ERROR_OCCURRED(async_data_write_finalize(data_callid, addr, length))){ - fibril_rwlock_write_lock(&icmp_globals.lock); - res = icmp_echo(echo_data->identifier, echo_data->sequence_number, ICMP_GET_SIZE(call), ICMP_GET_TIMEOUT(call), ICMP_GET_TTL(call), ICMP_GET_TOS(call), ICMP_GET_DONT_FRAGMENT(call), addr, (socklen_t) length); - fibril_rwlock_write_unlock(&icmp_globals.lock); - free(addr); - if(echo_data->sequence_number < UINT16_MAX){ - ++ echo_data->sequence_number; - }else{ - echo_data->sequence_number = 0; - } - }else{ - res = ERROR_CODE; - } - } - } -// fibril_rwlock_write_unlock(&lock); + } + + addr = malloc(length); + if (!addr) { + res = ENOMEM; break; - default: - res = icmp_process_message(&call); - } + } + + if (ERROR_OCCURRED(async_data_write_finalize( + data_callid, addr, length))) { + free(addr); + res = ERROR_CODE; + break; + } + + fibril_rwlock_write_lock(&icmp_globals.lock); + res = icmp_echo(echo_data->identifier, + echo_data->sequence_number, ICMP_GET_SIZE(call), + ICMP_GET_TIMEOUT(call), ICMP_GET_TTL(call), + ICMP_GET_TOS(call), ICMP_GET_DONT_FRAGMENT(call), + addr, (socklen_t) length); + fibril_rwlock_write_unlock(&icmp_globals.lock); + + free(addr); + + if (echo_data->sequence_number < UINT16_MAX) + echo_data->sequence_number++; + else + echo_data->sequence_number = 0; + + break; + + default: + res = icmp_process_message(&call); + } + } @@ -729,81 +873,58 @@ icmp_echo_data_exclude(&icmp_globals.echo_data, echo_data->identifier); fibril_rwlock_write_unlock(&icmp_globals.lock); + return res; } -int icmp_process_message(ipc_call_t * call){ +/** Processes the ICMP message. + * + * @param[in] callid The message identifier. + * @param[in] call The message parameters. + * @param[out] answer The message answer parameters. + * @param[out] answer_count The last parameter for the actual answer in the + * answer parameter. + * @returns EOK on success. + * @returns ENOTSUP if the message is not known. + * + * @see icmp_interface.h + * @see IS_NET_ICMP_MESSAGE() + */ +int +icmp_message_standalone(ipc_callid_t callid, ipc_call_t *call, + ipc_call_t *answer, int *answer_count) +{ ERROR_DECLARE; packet_t packet; - switch(IPC_GET_METHOD(*call)){ - case NET_ICMP_DEST_UNREACH: - if(! ERROR_OCCURRED(packet_translate_remote(icmp_globals.net_phone, &packet, IPC_GET_PACKET(call)))){ - ERROR_CODE = icmp_destination_unreachable_msg(0, ICMP_GET_CODE(call), ICMP_GET_MTU(call), packet); - } - return ERROR_CODE; - case NET_ICMP_SOURCE_QUENCH: - if(! ERROR_OCCURRED(packet_translate_remote(icmp_globals.net_phone, &packet, IPC_GET_PACKET(call)))){ - ERROR_CODE = icmp_source_quench_msg(0, packet); - } - return ERROR_CODE; - case NET_ICMP_TIME_EXCEEDED: - if(! ERROR_OCCURRED(packet_translate_remote(icmp_globals.net_phone, &packet, IPC_GET_PACKET(call)))){ - ERROR_CODE = icmp_time_exceeded_msg(0, ICMP_GET_CODE(call), packet); - } - return ERROR_CODE; - case NET_ICMP_PARAMETERPROB: - if(! ERROR_OCCURRED(packet_translate_remote(icmp_globals.net_phone, &packet, IPC_GET_PACKET(call)))){ - ERROR_CODE = icmp_parameter_problem_msg(0, ICMP_GET_CODE(call), ICMP_GET_POINTER(call), packet); - } - return ERROR_CODE; - default: - return ENOTSUP; - } -} - -int icmp_release_and_return(packet_t packet, int result){ - pq_release_remote(icmp_globals.net_phone, packet_get_id(packet)); - return result; -} - -int icmp_bind_free_id(icmp_echo_ref echo_data){ - icmp_param_t index; - - if(! echo_data){ - return EBADMEM; - } - // from the last used one - index = icmp_globals.last_used_id; - do{ - ++ index; - // til the range end - if(index >= ICMP_FREE_IDS_END){ - // start from the range beginning - index = ICMP_FREE_IDS_START - 1; - do{ - ++ index; - // til the last used one - if(index >= icmp_globals.last_used_id){ - // none found - return ENOTCONN; - } - }while(icmp_echo_data_find(&icmp_globals.echo_data, index) != NULL); - // found, break immediately - break; - } - }while(icmp_echo_data_find(&icmp_globals.echo_data, index) != NULL); - echo_data->identifier = index; - echo_data->sequence_number = 0; - return icmp_echo_data_add(&icmp_globals.echo_data, index, echo_data); -} + *answer_count = 0; + switch (IPC_GET_METHOD(*call)) { + case NET_TL_RECEIVED: + if (ERROR_NONE(packet_translate_remote(icmp_globals.net_phone, + &packet, IPC_GET_PACKET(call)))) { + ERROR_CODE = + icmp_received_msg_local(IPC_GET_DEVICE(call), + packet, SERVICE_ICMP, IPC_GET_ERROR(call)); + } + return ERROR_CODE; + + case NET_ICMP_INIT: + return icmp_process_client_messages(callid, * call); + + default: + return icmp_process_message(call); + } + + return ENOTSUP; +} + /** Default thread for new connections. * - * @param[in] iid The initial message identifier. - * @param[in] icall The initial message call structure. - * - */ -static void tl_client_connection(ipc_callid_t iid, ipc_call_t * icall) + * @param[in] iid The initial message identifier. + * @param[in] icall The initial message call structure. + * + */ +static void tl_client_connection(ipc_callid_t iid, ipc_call_t *icall) { /* @@ -813,5 +934,5 @@ ipc_answer_0(iid, EOK); - while(true) { + while (true) { ipc_call_t answer; int answer_count; @@ -828,6 +949,10 @@ &answer_count); - /* End if said to either by the message or the processing result */ - if ((IPC_GET_METHOD(call) == IPC_M_PHONE_HUNGUP) || (res == EHANGUP)) + /* + * End if told to either by the message or the processing + * result. + */ + if ((IPC_GET_METHOD(call) == IPC_M_PHONE_HUNGUP) || + (res == EHANGUP)) return; @@ -839,10 +964,7 @@ /** Starts the module. * - * @param argc The count of the command line arguments. Ignored parameter. - * @param argv The command line parameters. Ignored parameter. - * - * @returns EOK on success. - * @returns Other error codes as defined for each specific module start function. - * + * @returns EOK on success. + * @returns Other error codes as defined for each specific module + * start function. */ int main(int argc, char *argv[]) @@ -851,7 +973,5 @@ /* Start the module */ - if (ERROR_OCCURRED(tl_module_start_standalone(tl_client_connection))) - return ERROR_CODE; - + ERROR_PROPAGATE(tl_module_start_standalone(tl_client_connection)); return EOK; } @@ -859,2 +979,3 @@ /** @} */ + Index: uspace/srv/net/tl/icmp/icmp.h =================================================================== --- uspace/srv/net/tl/icmp/icmp.h (revision 472020fcce0d34f10b66ca0bd38c3b005abb9a4c) +++ uspace/srv/net/tl/icmp/icmp.h (revision edc5a98512c61122a292d2a3427de652aa345ec4) @@ -28,90 +28,81 @@ /** @addtogroup icmp - * @{ + * @{ */ /** @file - * ICMP module. + * ICMP module. */ -#ifndef __NET_ICMP_H__ -#define __NET_ICMP_H__ +#ifndef NET_ICMP_H_ +#define NET_ICMP_H_ #include #include +#include #include #include /** Type definition of the ICMP reply data. - * @see icmp_reply + * @see icmp_reply */ -typedef struct icmp_reply icmp_reply_t; +typedef struct icmp_reply icmp_reply_t; /** Type definition of the ICMP reply data pointer. - * @see icmp_reply + * @see icmp_reply */ -typedef icmp_reply_t * icmp_reply_ref; +typedef icmp_reply_t *icmp_reply_ref; /** Type definition of the ICMP global data. - * @see icmp_globals + * @see icmp_globals */ -typedef struct icmp_globals icmp_globals_t; +typedef struct icmp_globals icmp_globals_t; /** Pending replies map. - * Maps message identifiers to the pending replies. - * Sending fibril waits for its associated reply event. - * Receiving fibril sets the associated reply with the return value and signals the event. + * + * Maps message identifiers to the pending replies. + * Sending fibril waits for its associated reply event. + * Receiving fibril sets the associated reply with the return value and signals + * the event. */ INT_MAP_DECLARE(icmp_replies, icmp_reply_t); /** Echo specific data map. - * The identifier is used in the future semi-remote calls instead of the ICMP phone. + * + * The identifier is used in the future semi-remote calls instead of the ICMP + * phone. */ INT_MAP_DECLARE(icmp_echo_data, icmp_echo_t); -/** ICMP reply data. - */ -struct icmp_reply{ - /** Reply result. - */ +/** ICMP reply data. */ +struct icmp_reply { + /** Reply result. */ int result; - /** Safety lock. - */ + /** Safety lock. */ fibril_mutex_t mutex; - /** Received or timeouted reply signaling. - */ + /** Received or timeouted reply signaling. */ fibril_condvar_t condvar; }; -/** ICMP global data. - */ -struct icmp_globals{ - /** IP module phone. - */ +/** ICMP global data. */ +struct icmp_globals { + /** IP module phone. */ int ip_phone; - /** Packet dimension. - */ + /** Packet dimension. */ packet_dimension_t packet_dimension; - /** Networking module phone. - */ + /** Networking module phone. */ int net_phone; - /** Indicates whether ICMP error reporting is enabled. - */ + /** Indicates whether ICMP error reporting is enabled. */ int error_reporting; - /** Indicates whether ICMP echo replying (ping) is enabled. - */ + /** Indicates whether ICMP echo replying (ping) is enabled. */ int echo_replying; - /** The last used identifier number. - */ + /** The last used identifier number. */ icmp_param_t last_used_id; - /** The budled modules assigned echo specific data. - */ + /** The budled modules assigned echo specific data. */ icmp_echo_data_t echo_data; - /** Echo timeout locks. - */ + /** Echo timeout locks. */ icmp_replies_t replies; - /** Safety lock. - */ + /** Safety lock. */ fibril_rwlock_t lock; }; @@ -121,3 +112,2 @@ /** @} */ - Index: uspace/srv/net/tl/icmp/icmp_module.c =================================================================== --- uspace/srv/net/tl/icmp/icmp_module.c (revision 472020fcce0d34f10b66ca0bd38c3b005abb9a4c) +++ uspace/srv/net/tl/icmp/icmp_module.c (revision edc5a98512c61122a292d2a3427de652aa345ec4) @@ -28,13 +28,16 @@ /** @addtogroup icmp - * @{ + * @{ */ /** @file - * ICMP standalone module implementation. - * Contains skeleton module functions mapping. - * The functions are used by the module skeleton as module specific entry points. - * @see module.c + * ICMP standalone module implementation. + * Contains skeleton module functions mapping. + * The functions are used by the module skeleton as module specific entry points. + * @see module.c */ + +#include "icmp.h" +#include "icmp_module.h" #include @@ -47,21 +50,12 @@ #include #include + #include -#include "icmp.h" -#include "icmp_module.h" +/** ICMP module global data. */ +extern icmp_globals_t icmp_globals; -/** ICMP module global data. - */ -extern icmp_globals_t icmp_globals; - -/** Starts the ICMP module. - * Initializes the client connection serving function, initializes the module, registers the module service and starts the async manager, processing IPC messages in an infinite loop. - * @param[in] client_connection The client connection processing function. The module skeleton propagates its own one. - * @returns EOK on successful module termination. - * @returns Other error codes as defined for the arp_initialize() function. - * @returns Other error codes as defined for the REGISTER_ME() macro function. - */ -int tl_module_start_standalone(async_client_conn_t client_connection){ +int tl_module_start_standalone(async_client_conn_t client_connection) +{ ERROR_DECLARE; @@ -70,10 +64,10 @@ async_set_client_connection(client_connection); icmp_globals.net_phone = net_connect_module(); - if(icmp_globals.net_phone < 0){ + if (icmp_globals.net_phone < 0) return icmp_globals.net_phone; - } + ERROR_PROPAGATE(pm_init()); - if(ERROR_OCCURRED(icmp_initialize(client_connection)) - || ERROR_OCCURRED(REGISTER_ME(SERVICE_ICMP, &phonehash))){ + if (ERROR_OCCURRED(icmp_initialize(client_connection)) || + ERROR_OCCURRED(REGISTER_ME(SERVICE_ICMP, &phonehash))) { pm_destroy(); return ERROR_CODE; @@ -86,13 +80,8 @@ } -/** Processes the ICMP message. - * @param[in] callid The message identifier. - * @param[in] call The message parameters. - * @param[out] answer The message answer parameters. - * @param[out] answer_count The last parameter for the actual answer in the answer parameter. - * @returns EOK on success. - * @returns Other error codes as defined for the icmp_message() function. - */ -int tl_module_message_standalone(ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count){ +int +tl_module_message_standalone(ipc_callid_t callid, ipc_call_t *call, + ipc_call_t *answer, int *answer_count) +{ return icmp_message_standalone(callid, call, answer, answer_count); } @@ -100,2 +89,3 @@ /** @} */ + Index: uspace/srv/net/tl/icmp/icmp_module.h =================================================================== --- uspace/srv/net/tl/icmp/icmp_module.h (revision 472020fcce0d34f10b66ca0bd38c3b005abb9a4c) +++ uspace/srv/net/tl/icmp/icmp_module.h (revision edc5a98512c61122a292d2a3427de652aa345ec4) @@ -28,36 +28,21 @@ /** @addtogroup icmp - * @{ + * @{ */ /** @file - * ICMP module functions. - * The functions are used as ICMP module entry points. + * ICMP module functions. + * The functions are used as ICMP module entry points. */ -#ifndef __NET_ICMP_MODULE_H__ -#define __NET_ICMP_MODULE_H__ +#ifndef NET_ICMP_MODULE_H_ +#define NET_ICMP_MODULE_H_ #include #include -/** Initializes the ICMP module. - * @param[in] client_connection The client connection processing function. The module skeleton propagates its own one. - * @returns EOK on success. - * @returns ENOMEM if there is not enough memory left. - */ -int icmp_initialize(async_client_conn_t client_connection); - -/** Processes the ICMP message. - * @param[in] callid The message identifier. - * @param[in] call The message parameters. - * @param[out] answer The message answer parameters. - * @param[out] answer_count The last parameter for the actual answer in the answer parameter. - * @returns EOK on success. - * @returns ENOTSUP if the message is not known. - * @see icmp_interface.h - * @see IS_NET_ICMP_MESSAGE() - */ -int icmp_message_standalone(ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count); +extern int icmp_initialize(async_client_conn_t); +extern int icmp_message_standalone(ipc_callid_t, ipc_call_t *, ipc_call_t *, + int *); #endif