source: mainline/uspace/srv/net/tl/icmp/icmp.c@ 96b02eb9

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 96b02eb9 was 46d4d9f, checked in by Jakub Jermar <jakub@…>, 15 years ago

Redefine packet_t to be just a type alias for struct packet.
  • Property mode set to 100644
File size: 25.8 KB
Line 
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 implementation.
35 * @see icmp.h
36 */
37
38#include "icmp.h"
39#include "icmp_module.h"
40
41#include <async.h>
42#include <atomic.h>
43#include <fibril.h>
44#include <fibril_synch.h>
45#include <stdint.h>
46#include <str.h>
47#include <ipc/ipc.h>
48#include <ipc/services.h>
49#include <ipc/net.h>
50#include <ipc/tl.h>
51#include <ipc/icmp.h>
52#include <sys/time.h>
53#include <sys/types.h>
54#include <byteorder.h>
55#include <errno.h>
56
57#include <net/socket_codes.h>
58#include <net/ip_protocols.h>
59#include <net/inet.h>
60#include <net/modules.h>
61#include <net/icmp_api.h>
62#include <net/icmp_codes.h>
63#include <net/icmp_common.h>
64
65#include <packet_client.h>
66#include <packet_remote.h>
67#include <net_checksum.h>
68#include <icmp_client.h>
69#include <icmp_interface.h>
70#include <il_interface.h>
71#include <ip_client.h>
72#include <ip_interface.h>
73#include <net_interface.h>
74#include <tl_interface.h>
75#include <tl_local.h>
76#include <icmp_header.h>
77
78/** ICMP module name. */
79#define NAME "ICMP protocol"
80
81/** Default ICMP error reporting. */
82#define NET_DEFAULT_ICMP_ERROR_REPORTING true
83
84/** Default ICMP echo replying. */
85#define NET_DEFAULT_ICMP_ECHO_REPLYING true
86
87/** Original datagram length in bytes transfered to the error notification
88 * message.
89 */
90#define ICMP_KEEP_LENGTH 8
91
92/** Free identifier numbers pool start. */
93#define ICMP_FREE_IDS_START 1
94
95/** Free identifier numbers pool end. */
96#define ICMP_FREE_IDS_END UINT16_MAX
97
98/** Computes the ICMP datagram checksum.
99 *
100 * @param[in,out] header The ICMP datagram header.
101 * @param[in] length The total datagram length.
102 * @return The computed checksum.
103 */
104#define ICMP_CHECKSUM(header, length) \
105 htons(ip_checksum((uint8_t *) (header), (length)))
106
107/** An echo request datagrams pattern. */
108#define ICMP_ECHO_TEXT "Hello from HelenOS."
109
110/** Computes an ICMP reply data key.
111 *
112 * @param[in] id The message identifier.
113 * @param[in] sequence The message sequence number.
114 * @return The computed ICMP reply data key.
115 */
116#define ICMP_GET_REPLY_KEY(id, sequence) \
117 (((id) << 16) | (sequence & 0xFFFF))
118
119
120/** ICMP global data. */
121icmp_globals_t icmp_globals;
122
123INT_MAP_IMPLEMENT(icmp_replies, icmp_reply_t);
124INT_MAP_IMPLEMENT(icmp_echo_data, icmp_echo_t);
125
126/** Releases the packet and returns the result.
127 *
128 * @param[in] packet The packet queue to be released.
129 * @param[in] result The result to be returned.
130 * @return The result parameter.
131 */
132static int icmp_release_and_return(packet_t *packet, int result)
133{
134 pq_release_remote(icmp_globals.net_phone, packet_get_id(packet));
135 return result;
136}
137
138/** Sends the ICMP message.
139 *
140 * Sets the message type and code and computes the checksum.
141 * Error messages are sent only if allowed in the configuration.
142 * Releases the packet on errors.
143 *
144 * @param[in] type The message type.
145 * @param[in] code The message code.
146 * @param[in] packet The message packet to be sent.
147 * @param[in] header The ICMP header.
148 * @param[in] error The error service to be announced. Should be
149 * SERVICE_ICMP or zero.
150 * @param[in] ttl The time to live.
151 * @param[in] tos The type of service.
152 * @param[in] dont_fragment The value indicating whether the datagram must not
153 * be fragmented. Is used as a MTU discovery.
154 * @return EOK on success.
155 * @return EPERM if the error message is not allowed.
156 */
157static int icmp_send_packet(icmp_type_t type, icmp_code_t code, packet_t *packet,
158 icmp_header_t *header, services_t error, ip_ttl_t ttl, ip_tos_t tos,
159 int dont_fragment)
160{
161 int rc;
162
163 /* Do not send an error if disabled */
164 if (error && !icmp_globals.error_reporting)
165 return icmp_release_and_return(packet, EPERM);
166
167 header->type = type;
168 header->code = code;
169 header->checksum = 0;
170 header->checksum = ICMP_CHECKSUM(header,
171 packet_get_data_length(packet));
172
173 rc = ip_client_prepare_packet(packet, IPPROTO_ICMP, ttl, tos,
174 dont_fragment, 0);
175 if (rc != EOK)
176 return icmp_release_and_return(packet, rc);
177
178 return ip_send_msg(icmp_globals.ip_phone, -1, packet, SERVICE_ICMP,
179 error);
180}
181
182/** Prepares the ICMP error packet.
183 *
184 * Truncates the original packet if longer than ICMP_KEEP_LENGTH bytes.
185 * Prefixes and returns the ICMP header.
186 *
187 * @param[in,out] packet The original packet.
188 * @return The prefixed ICMP header.
189 * @return NULL on errors.
190 */
191static icmp_header_t *icmp_prepare_packet(packet_t *packet)
192{
193 icmp_header_t *header;
194 size_t header_length;
195 size_t total_length;
196
197 total_length = packet_get_data_length(packet);
198 if (total_length <= 0)
199 return NULL;
200
201 header_length = ip_client_header_length(packet);
202 if (header_length <= 0)
203 return NULL;
204
205 /* Truncate if longer than 64 bits (without the IP header) */
206 if ((total_length > header_length + ICMP_KEEP_LENGTH) &&
207 (packet_trim(packet, 0,
208 total_length - header_length - ICMP_KEEP_LENGTH) != EOK)) {
209 return NULL;
210 }
211
212 header = PACKET_PREFIX(packet, icmp_header_t);
213 if (!header)
214 return NULL;
215
216 bzero(header, sizeof(*header));
217 return header;
218}
219
220/** Requests an echo message.
221 *
222 * Sends a packet with specified parameters to the target host and waits for
223 * the reply upto the given timeout.
224 * Blocks the caller until the reply or the timeout occurs.
225 *
226 * @param[in] id The message identifier.
227 * @param[in] sequence The message sequence parameter.
228 * @param[in] size The message data length in bytes.
229 * @param[in] timeout The timeout in miliseconds.
230 * @param[in] ttl The time to live.
231 * @param[in] tos The type of service.
232 * @param[in] dont_fragment The value indicating whether the datagram must not
233 * be fragmented. Is used as a MTU discovery.
234 * @param[in] addr The target host address.
235 * @param[in] addrlen The torget host address length.
236 * @return ICMP_ECHO on success.
237 * @return ETIMEOUT if the reply has not arrived before the
238 * timeout.
239 * @return ICMP type of the received error notification.
240 * @return EINVAL if the addrlen parameter is less or equal to
241 * zero.
242 * @return ENOMEM if there is not enough memory left.
243 * @return EPARTY if there was an internal error.
244 */
245static int icmp_echo(icmp_param_t id, icmp_param_t sequence, size_t size,
246 mseconds_t timeout, ip_ttl_t ttl, ip_tos_t tos, int dont_fragment,
247 const struct sockaddr * addr, socklen_t addrlen)
248{
249 icmp_header_t *header;
250 packet_t *packet;
251 size_t length;
252 uint8_t *data;
253 icmp_reply_t *reply;
254 int reply_key;
255 int index;
256 int rc;
257
258 if (addrlen <= 0)
259 return EINVAL;
260
261 length = (size_t) addrlen;
262 /* TODO do not ask all the time */
263 rc = ip_packet_size_req(icmp_globals.ip_phone, -1,
264 &icmp_globals.packet_dimension);
265 if (rc != EOK)
266 return rc;
267
268 packet = packet_get_4_remote(icmp_globals.net_phone, size,
269 icmp_globals.packet_dimension.addr_len,
270 ICMP_HEADER_SIZE + icmp_globals.packet_dimension.prefix,
271 icmp_globals.packet_dimension.suffix);
272 if (!packet)
273 return ENOMEM;
274
275 /* Prepare the requesting packet, set the destination address. */
276 rc = packet_set_addr(packet, NULL, (const uint8_t *) addr, length);
277 if (rc != EOK)
278 return icmp_release_and_return(packet, rc);
279
280 /* Allocate space in the packet */
281 data = (uint8_t *) packet_suffix(packet, size);
282 if (!data)
283 return icmp_release_and_return(packet, ENOMEM);
284
285 /* Fill the data */
286 length = 0;
287 while (size > length + sizeof(ICMP_ECHO_TEXT)) {
288 memcpy(data + length, ICMP_ECHO_TEXT, sizeof(ICMP_ECHO_TEXT));
289 length += sizeof(ICMP_ECHO_TEXT);
290 }
291 memcpy(data + length, ICMP_ECHO_TEXT, size - length);
292
293 /* Prefix the header */
294 header = PACKET_PREFIX(packet, icmp_header_t);
295 if (!header)
296 return icmp_release_and_return(packet, ENOMEM);
297
298 bzero(header, sizeof(*header));
299 header->un.echo.identifier = id;
300 header->un.echo.sequence_number = sequence;
301
302 /* Prepare the reply structure */
303 reply = malloc(sizeof(*reply));
304 if (!reply)
305 return icmp_release_and_return(packet, ENOMEM);
306
307 fibril_mutex_initialize(&reply->mutex);
308 fibril_mutex_lock(&reply->mutex);
309 fibril_condvar_initialize(&reply->condvar);
310 reply_key = ICMP_GET_REPLY_KEY(header->un.echo.identifier,
311 header->un.echo.sequence_number);
312 index = icmp_replies_add(&icmp_globals.replies, reply_key, reply);
313 if (index < 0) {
314 free(reply);
315 return icmp_release_and_return(packet, index);
316 }
317
318 /* Unlock the globals so that we can wait for the reply */
319 fibril_rwlock_write_unlock(&icmp_globals.lock);
320
321 /* Send the request */
322 icmp_send_packet(ICMP_ECHO, 0, packet, header, 0, ttl, tos,
323 dont_fragment);
324
325 /* Wait for the reply. Timeout in microseconds. */
326 rc = fibril_condvar_wait_timeout(&reply->condvar, &reply->mutex,
327 timeout * 1000);
328 if (rc == EOK)
329 rc = reply->result;
330
331 /* Drop the reply mutex before locking the globals again */
332 fibril_mutex_unlock(&reply->mutex);
333 fibril_rwlock_write_lock(&icmp_globals.lock);
334
335 /* Destroy the reply structure */
336 icmp_replies_exclude_index(&icmp_globals.replies, index);
337
338 return rc;
339}
340
341static int icmp_destination_unreachable_msg_local(int icmp_phone,
342 icmp_code_t code, icmp_param_t mtu, packet_t *packet)
343{
344 icmp_header_t *header;
345
346 header = icmp_prepare_packet(packet);
347 if (!header)
348 return icmp_release_and_return(packet, ENOMEM);
349
350 if (mtu)
351 header->un.frag.mtu = mtu;
352
353 return icmp_send_packet(ICMP_DEST_UNREACH, code, packet, header,
354 SERVICE_ICMP, 0, 0, 0);
355}
356
357static int icmp_source_quench_msg_local(int icmp_phone, packet_t *packet)
358{
359 icmp_header_t *header;
360
361 header = icmp_prepare_packet(packet);
362 if (!header)
363 return icmp_release_and_return(packet, ENOMEM);
364
365 return icmp_send_packet(ICMP_SOURCE_QUENCH, 0, packet, header,
366 SERVICE_ICMP, 0, 0, 0);
367}
368
369static int icmp_time_exceeded_msg_local(int icmp_phone, icmp_code_t code,
370 packet_t *packet)
371{
372 icmp_header_t *header;
373
374 header = icmp_prepare_packet(packet);
375 if (!header)
376 return icmp_release_and_return(packet, ENOMEM);
377
378 return icmp_send_packet(ICMP_TIME_EXCEEDED, code, packet, header,
379 SERVICE_ICMP, 0, 0, 0);
380}
381
382static int icmp_parameter_problem_msg_local(int icmp_phone, icmp_code_t code,
383 icmp_param_t pointer, packet_t *packet)
384{
385 icmp_header_t *header;
386
387 header = icmp_prepare_packet(packet);
388 if (!header)
389 return icmp_release_and_return(packet, ENOMEM);
390
391 header->un.param.pointer = pointer;
392 return icmp_send_packet(ICMP_PARAMETERPROB, code, packet, header,
393 SERVICE_ICMP, 0, 0, 0);
394}
395
396/** Initializes the ICMP module.
397 *
398 * @param[in] client_connection The client connection processing function. The
399 * module skeleton propagates its own one.
400 * @return EOK on success.
401 * @return ENOMEM if there is not enough memory left.
402 */
403int icmp_initialize(async_client_conn_t client_connection)
404{
405 measured_string_t names[] = {
406 {
407 (char *) "ICMP_ERROR_REPORTING",
408 20
409 },
410 {
411 (char *) "ICMP_ECHO_REPLYING",
412 18
413 }
414 };
415 measured_string_t *configuration;
416 size_t count = sizeof(names) / sizeof(measured_string_t);
417 char *data;
418 int rc;
419
420 fibril_rwlock_initialize(&icmp_globals.lock);
421 fibril_rwlock_write_lock(&icmp_globals.lock);
422 icmp_replies_initialize(&icmp_globals.replies);
423 icmp_echo_data_initialize(&icmp_globals.echo_data);
424
425 icmp_globals.ip_phone = ip_bind_service(SERVICE_IP, IPPROTO_ICMP,
426 SERVICE_ICMP, client_connection);
427 if (icmp_globals.ip_phone < 0) {
428 fibril_rwlock_write_unlock(&icmp_globals.lock);
429 return icmp_globals.ip_phone;
430 }
431
432 rc = ip_packet_size_req(icmp_globals.ip_phone, -1,
433 &icmp_globals.packet_dimension);
434 if (rc != EOK) {
435 fibril_rwlock_write_unlock(&icmp_globals.lock);
436 return rc;
437 }
438
439 icmp_globals.packet_dimension.prefix += ICMP_HEADER_SIZE;
440 icmp_globals.packet_dimension.content -= ICMP_HEADER_SIZE;
441
442 icmp_globals.error_reporting = NET_DEFAULT_ICMP_ERROR_REPORTING;
443 icmp_globals.echo_replying = NET_DEFAULT_ICMP_ECHO_REPLYING;
444
445 /* Get configuration */
446 configuration = &names[0];
447 rc = net_get_conf_req(icmp_globals.net_phone, &configuration, count,
448 &data);
449 if (rc != EOK) {
450 fibril_rwlock_write_unlock(&icmp_globals.lock);
451 return rc;
452 }
453
454 if (configuration) {
455 if (configuration[0].value) {
456 icmp_globals.error_reporting =
457 (configuration[0].value[0] == 'y');
458 }
459 if (configuration[1].value) {
460 icmp_globals.echo_replying =
461 (configuration[1].value[0] == 'y');
462 }
463 net_free_settings(configuration, data);
464 }
465
466 fibril_rwlock_write_unlock(&icmp_globals.lock);
467 return EOK;
468}
469
470/** Tries to set the pending reply result as the received message type.
471 *
472 * If the reply data is not present, the reply timed out and the other fibril
473 * is already awake.
474 * Releases the packet.
475 *
476 * @param[in] packet The received reply message.
477 * @param[in] header The ICMP message header.
478 * @param[in] type The received reply message type.
479 * @param[in] code The received reply message code.
480 */
481static void icmp_process_echo_reply(packet_t *packet, icmp_header_t *header,
482 icmp_type_t type, icmp_code_t code)
483{
484 int reply_key;
485 icmp_reply_t *reply;
486
487 /* Compute the reply key */
488 reply_key = ICMP_GET_REPLY_KEY(header->un.echo.identifier,
489 header->un.echo.sequence_number);
490 pq_release_remote(icmp_globals.net_phone, packet_get_id(packet));
491
492 /* Find the pending reply */
493 fibril_rwlock_write_lock(&icmp_globals.lock);
494 reply = icmp_replies_find(&icmp_globals.replies, reply_key);
495 if (reply) {
496 reply->result = type;
497 fibril_condvar_signal(&reply->condvar);
498 }
499 fibril_rwlock_write_unlock(&icmp_globals.lock);
500}
501
502/** Processes the received ICMP packet.
503 *
504 * Notifies the destination socket application.
505 *
506 * @param[in,out] packet The received packet.
507 * @param[in] error The packet error reporting service. Prefixes the
508 * received packet.
509 * @return EOK on success.
510 * @return EINVAL if the packet is not valid.
511 * @return EINVAL if the stored packet address is not the an_addr_t.
512 * @return EINVAL if the packet does not contain any data.
513 * @return NO_DATA if the packet content is shorter than the user
514 * datagram header.
515 * @return ENOMEM if there is not enough memory left.
516 * @return EADDRNOTAVAIL if the destination socket does not exist.
517 * @return Other error codes as defined for the
518 * ip_client_process_packet() function.
519 */
520static int icmp_process_packet(packet_t *packet, services_t error)
521{
522 size_t length;
523 uint8_t *src;
524 int addrlen;
525 int result;
526 void *data;
527 icmp_header_t *header;
528 icmp_type_t type;
529 icmp_code_t code;
530 int rc;
531
532 switch (error) {
533 case SERVICE_NONE:
534 break;
535 case SERVICE_ICMP:
536 /* Process error */
537 result = icmp_client_process_packet(packet, &type, &code, NULL,
538 NULL);
539 if (result < 0)
540 return result;
541 length = (size_t) result;
542 /* Remove the error header */
543 rc = packet_trim(packet, length, 0);
544 if (rc != EOK)
545 return rc;
546 break;
547 default:
548 return ENOTSUP;
549 }
550
551 /* Get rid of the IP header */
552 length = ip_client_header_length(packet);
553 rc = packet_trim(packet, length, 0);
554 if (rc != EOK)
555 return rc;
556
557 length = packet_get_data_length(packet);
558 if (length <= 0)
559 return EINVAL;
560
561 if (length < ICMP_HEADER_SIZE)
562 return EINVAL;
563
564 data = packet_get_data(packet);
565 if (!data)
566 return EINVAL;
567
568 /* Get ICMP header */
569 header = (icmp_header_t *) data;
570
571 if (header->checksum) {
572 while (ICMP_CHECKSUM(header, length) != IP_CHECKSUM_ZERO) {
573 /*
574 * Set the original message type on error notification.
575 * Type swap observed in Qemu.
576 */
577 if (error) {
578 switch (header->type) {
579 case ICMP_ECHOREPLY:
580 header->type = ICMP_ECHO;
581 continue;
582 }
583 }
584 return EINVAL;
585 }
586 }
587
588 switch (header->type) {
589 case ICMP_ECHOREPLY:
590 if (error)
591 icmp_process_echo_reply(packet, header, type, code);
592 else
593 icmp_process_echo_reply(packet, header, ICMP_ECHO, 0);
594
595 return EOK;
596
597 case ICMP_ECHO:
598 if (error) {
599 icmp_process_echo_reply(packet, header, type, code);
600 return EOK;
601 }
602
603 /* Do not send a reply if disabled */
604 if (icmp_globals.echo_replying) {
605 addrlen = packet_get_addr(packet, &src, NULL);
606
607 /*
608 * Set both addresses to the source one (avoids the
609 * source address deletion before setting the
610 * destination one).
611 */
612 if ((addrlen > 0) && (packet_set_addr(packet, src, src,
613 (size_t) addrlen) == EOK)) {
614 /* Send the reply */
615 icmp_send_packet(ICMP_ECHOREPLY, 0, packet,
616 header, 0, 0, 0, 0);
617 return EOK;
618 }
619
620 return EINVAL;
621 }
622
623 return EPERM;
624
625 case ICMP_DEST_UNREACH:
626 case ICMP_SOURCE_QUENCH:
627 case ICMP_REDIRECT:
628 case ICMP_ALTERNATE_ADDR:
629 case ICMP_ROUTER_ADV:
630 case ICMP_ROUTER_SOL:
631 case ICMP_TIME_EXCEEDED:
632 case ICMP_PARAMETERPROB:
633 case ICMP_CONVERSION_ERROR:
634 case ICMP_REDIRECT_MOBILE:
635 case ICMP_SKIP:
636 case ICMP_PHOTURIS:
637 ip_received_error_msg(icmp_globals.ip_phone, -1, packet,
638 SERVICE_IP, SERVICE_ICMP);
639 return EOK;
640
641 default:
642 return ENOTSUP;
643 }
644}
645
646/** Processes the received ICMP packet.
647 *
648 * Is used as an entry point from the underlying IP module.
649 * Releases the packet on error.
650 *
651 * @param device_id The device identifier. Ignored parameter.
652 * @param[in,out] packet The received packet.
653 * @param receiver The target service. Ignored parameter.
654 * @param[in] error The packet error reporting service. Prefixes the
655 * received packet.
656 * @return EOK on success.
657 * @return Other error codes as defined for the
658 * icmp_process_packet() function.
659 */
660static int icmp_received_msg_local(device_id_t device_id, packet_t *packet,
661 services_t receiver, services_t error)
662{
663 int rc;
664
665 rc = icmp_process_packet(packet, error);
666 if (rc != EOK)
667 return icmp_release_and_return(packet, rc);
668
669 return EOK;
670}
671
672/** Processes the generic client messages.
673 *
674 * @param[in] call The message parameters.
675 * @return EOK on success.
676 * @return ENOTSUP if the message is not known.
677 * @return Other error codes as defined for the packet_translate()
678 * function.
679 * @return Other error codes as defined for the
680 * icmp_destination_unreachable_msg_local() function.
681 * @return Other error codes as defined for the
682 * icmp_source_quench_msg_local() function.
683 * @return Other error codes as defined for the
684 * icmp_time_exceeded_msg_local() function.
685 * @return Other error codes as defined for the
686 * icmp_parameter_problem_msg_local() function.
687 *
688 * @see icmp_interface.h
689 */
690static int icmp_process_message(ipc_call_t *call)
691{
692 packet_t *packet;
693 int rc;
694
695 switch (IPC_GET_METHOD(*call)) {
696 case NET_ICMP_DEST_UNREACH:
697 rc = packet_translate_remote(icmp_globals.net_phone, &packet,
698 IPC_GET_PACKET(call));
699 if (rc != EOK)
700 return rc;
701 return icmp_destination_unreachable_msg_local(0,
702 ICMP_GET_CODE(call), ICMP_GET_MTU(call), packet);
703 case NET_ICMP_SOURCE_QUENCH:
704 rc = packet_translate_remote(icmp_globals.net_phone, &packet,
705 IPC_GET_PACKET(call));
706 if (rc != EOK)
707 return rc;
708 return icmp_source_quench_msg_local(0, packet);
709 case NET_ICMP_TIME_EXCEEDED:
710 rc = packet_translate_remote(icmp_globals.net_phone, &packet,
711 IPC_GET_PACKET(call));
712 if (rc != EOK)
713 return rc;
714 return icmp_time_exceeded_msg_local(0, ICMP_GET_CODE(call),
715 packet);
716 case NET_ICMP_PARAMETERPROB:
717 rc = packet_translate_remote(icmp_globals.net_phone, &packet,
718 IPC_GET_PACKET(call));
719 if (rc != EOK)
720 return rc;
721 return icmp_parameter_problem_msg_local(0, ICMP_GET_CODE(call),
722 ICMP_GET_POINTER(call), packet);
723 default:
724 return ENOTSUP;
725 }
726}
727
728/** Assigns a new identifier for the connection.
729 *
730 * Fills the echo data parameter with the assigned values.
731 *
732 * @param[in,out] echo_data The echo data to be bound.
733 * @return Index of the inserted echo data.
734 * @return EBADMEM if the echo_data parameter is NULL.
735 * @return ENOTCONN if no free identifier have been found.
736 */
737static int icmp_bind_free_id(icmp_echo_t *echo_data)
738{
739 icmp_param_t index;
740
741 if (!echo_data)
742 return EBADMEM;
743
744 /* From the last used one */
745 index = icmp_globals.last_used_id;
746 do {
747 index++;
748 /* til the range end */
749 if (index >= ICMP_FREE_IDS_END) {
750 /* start from the range beginning */
751 index = ICMP_FREE_IDS_START - 1;
752 do {
753 index++;
754 /* til the last used one */
755 if (index >= icmp_globals.last_used_id) {
756 /* none found */
757 return ENOTCONN;
758 }
759 } while(icmp_echo_data_find(&icmp_globals.echo_data,
760 index) != NULL);
761
762 /* Found, break immediately */
763 break;
764 }
765 } while (icmp_echo_data_find(&icmp_globals.echo_data, index) != NULL);
766
767 echo_data->identifier = index;
768 echo_data->sequence_number = 0;
769
770 return icmp_echo_data_add(&icmp_globals.echo_data, index, echo_data);
771}
772
773/** Processes the client messages.
774 *
775 * Remembers the assigned identifier and sequence numbers.
776 * Runs until the client module disconnects.
777 *
778 * @param[in] callid The message identifier.
779 * @param[in] call The message parameters.
780 * @return EOK.
781 *
782 * @see icmp_interface.h
783 * @see icmp_api.h
784 */
785static int icmp_process_client_messages(ipc_callid_t callid, ipc_call_t call)
786{
787 bool keep_on_going = true;
788 ipc_call_t answer;
789 int answer_count;
790 size_t length;
791 struct sockaddr *addr;
792 ipc_callid_t data_callid;
793 icmp_echo_t *echo_data;
794 int rc = EOK;
795
796 /*
797 * Accept the connection
798 * - Answer the first NET_ICMP_INIT call.
799 */
800 answer_count = 0;
801
802 echo_data = (icmp_echo_t *) malloc(sizeof(*echo_data));
803 if (!echo_data)
804 return ENOMEM;
805
806 /* Assign a new identifier */
807 fibril_rwlock_write_lock(&icmp_globals.lock);
808 rc = icmp_bind_free_id(echo_data);
809 fibril_rwlock_write_unlock(&icmp_globals.lock);
810 if (rc < 0) {
811 free(echo_data);
812 return rc;
813 }
814
815 while (keep_on_going) {
816 /* Answer the call */
817 answer_call(callid, rc, &answer, answer_count);
818
819 /* Refresh data */
820 refresh_answer(&answer, &answer_count);
821
822 /* Get the next call */
823 callid = async_get_call(&call);
824
825 /* Process the call */
826 switch (IPC_GET_METHOD(call)) {
827 case IPC_M_PHONE_HUNGUP:
828 keep_on_going = false;
829 rc = EHANGUP;
830 break;
831
832 case NET_ICMP_ECHO:
833 if (!async_data_write_receive(&data_callid, &length)) {
834 rc = EINVAL;
835 break;
836 }
837
838 addr = malloc(length);
839 if (!addr) {
840 rc = ENOMEM;
841 break;
842 }
843
844 rc = async_data_write_finalize(data_callid, addr,
845 length);
846 if (rc != EOK) {
847 free(addr);
848 break;
849 }
850
851 fibril_rwlock_write_lock(&icmp_globals.lock);
852 rc = icmp_echo(echo_data->identifier,
853 echo_data->sequence_number, ICMP_GET_SIZE(call),
854 ICMP_GET_TIMEOUT(call), ICMP_GET_TTL(call),
855 ICMP_GET_TOS(call), ICMP_GET_DONT_FRAGMENT(call),
856 addr, (socklen_t) length);
857 fibril_rwlock_write_unlock(&icmp_globals.lock);
858
859 free(addr);
860
861 if (echo_data->sequence_number < UINT16_MAX)
862 echo_data->sequence_number++;
863 else
864 echo_data->sequence_number = 0;
865
866 break;
867
868 default:
869 rc = icmp_process_message(&call);
870 }
871
872 }
873
874 /* Release the identifier */
875 fibril_rwlock_write_lock(&icmp_globals.lock);
876 icmp_echo_data_exclude(&icmp_globals.echo_data, echo_data->identifier);
877 fibril_rwlock_write_unlock(&icmp_globals.lock);
878
879 return rc;
880}
881
882/** Processes the ICMP message.
883 *
884 * @param[in] callid The message identifier.
885 * @param[in] call The message parameters.
886 * @param[out] answer The message answer parameters.
887 * @param[out] answer_count The last parameter for the actual answer in the
888 * answer parameter.
889 * @return EOK on success.
890 * @return ENOTSUP if the message is not known.
891 *
892 * @see icmp_interface.h
893 * @see IS_NET_ICMP_MESSAGE()
894 */
895int icmp_message_standalone(ipc_callid_t callid, ipc_call_t *call,
896 ipc_call_t *answer, int *answer_count)
897{
898 packet_t *packet;
899 int rc;
900
901 *answer_count = 0;
902 switch (IPC_GET_METHOD(*call)) {
903 case NET_TL_RECEIVED:
904 rc = packet_translate_remote(icmp_globals.net_phone, &packet,
905 IPC_GET_PACKET(call));
906 if (rc != EOK)
907 return rc;
908 return icmp_received_msg_local(IPC_GET_DEVICE(call), packet,
909 SERVICE_ICMP, IPC_GET_ERROR(call));
910
911 case NET_ICMP_INIT:
912 return icmp_process_client_messages(callid, * call);
913
914 default:
915 return icmp_process_message(call);
916 }
917
918 return ENOTSUP;
919}
920
921
922/** Default thread for new connections.
923 *
924 * @param[in] iid The initial message identifier.
925 * @param[in] icall The initial message call structure.
926 *
927 */
928static void tl_client_connection(ipc_callid_t iid, ipc_call_t *icall)
929{
930 /*
931 * Accept the connection
932 * - Answer the first IPC_M_CONNECT_ME_TO call.
933 */
934 ipc_answer_0(iid, EOK);
935
936 while (true) {
937 ipc_call_t answer;
938 int answer_count;
939
940 /* Clear the answer structure */
941 refresh_answer(&answer, &answer_count);
942
943 /* Fetch the next message */
944 ipc_call_t call;
945 ipc_callid_t callid = async_get_call(&call);
946
947 /* Process the message */
948 int res = tl_module_message_standalone(callid, &call, &answer,
949 &answer_count);
950
951 /*
952 * End if told to either by the message or the processing
953 * result.
954 */
955 if ((IPC_GET_METHOD(call) == IPC_M_PHONE_HUNGUP) ||
956 (res == EHANGUP))
957 return;
958
959 /* Answer the message */
960 answer_call(callid, res, &answer, answer_count);
961 }
962}
963
964/** Starts the module.
965 *
966 * @return EOK on success.
967 * @return Other error codes as defined for each specific module
968 * start function.
969 */
970int main(int argc, char *argv[])
971{
972 int rc;
973
974 /* Start the module */
975 rc = tl_module_start_standalone(tl_client_connection);
976 return rc;
977}
978
979/** @}
980 */
981
Note: See TracBrowser for help on using the repository browser.