2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
15 #ifndef included_ping_ping_h
16 #define included_ping_ping_h
19 #include <vnet/ip/ip.h>
21 #include <vnet/ip/lookup.h>
25 PING_RESPONSE_IP6 = 42,
27 } ping_response_type_t;
29 #define foreach_ip46_ping_result \
31 _ (ALLOC_FAIL, "packet allocation failed") \
32 _ (NO_INTERFACE, "no egress interface") \
33 _ (NO_TABLE, "no FIB table for lookup") \
34 _ (NO_SRC_ADDRESS, "no source address for egress interface") \
35 _ (NO_BUFFERS, "could not allocate a new buffer") \
39 #define _(v, s) SEND_PING_##v,
40 foreach_ip46_ping_result
42 } send_ip46_ping_result_t;
45 * Currently running ping command.
47 typedef struct ping_run_t
53 typedef struct ping_main_t
55 /* API message ID base */
60 /* a vector of current ping runs. */
61 ping_run_t *active_ping_runs;
62 /* a lock held while add/remove/search on active_ping_runs */
63 clib_spinlock_t ping_run_check_lock;
66 extern ping_main_t ping_main;
68 #define PING_DEFAULT_DATA_LEN 60
69 #define PING_DEFAULT_INTERVAL 1.0
71 #define PING_MAXIMUM_DATA_SIZE 32768
73 #define PING_CLI_UNKNOWN_NODE (~0)
76 typedef CLIB_PACKED (struct {
81 }) icmp46_echo_request_t;
87 ICMP46_ECHO_REPLY_NEXT_DROP,
88 ICMP46_ECHO_REPLY_NEXT_PUNT,
89 ICMP46_ECHO_REPLY_N_NEXT,
90 } icmp46_echo_reply_next_t;
92 static_always_inline uword
93 get_cli_process_id_by_icmp_id_mt (vlib_main_t *vm, u16 icmp_id)
95 ping_main_t *pm = &ping_main;
96 uword cli_process_id = PING_CLI_UNKNOWN_NODE;
99 clib_spinlock_lock_if_init (&pm->ping_run_check_lock);
100 vec_foreach (pr, pm->active_ping_runs)
102 if (pr->icmp_id == icmp_id)
104 cli_process_id = pr->cli_process_id;
108 clib_spinlock_unlock_if_init (&pm->ping_run_check_lock);
109 return cli_process_id;
112 static_always_inline void
113 set_cli_process_id_by_icmp_id_mt (vlib_main_t *vm, u16 icmp_id,
114 uword cli_process_id)
116 ping_main_t *pm = &ping_main;
119 clib_spinlock_lock_if_init (&pm->ping_run_check_lock);
120 vec_foreach (pr, pm->active_ping_runs)
122 if (pr->icmp_id == icmp_id)
124 pr->cli_process_id = cli_process_id;
125 goto have_found_and_set;
128 /* no such key yet - add a new one */
129 ping_run_t new_pr = { .icmp_id = icmp_id, .cli_process_id = cli_process_id };
130 vec_add1 (pm->active_ping_runs, new_pr);
132 clib_spinlock_unlock_if_init (&pm->ping_run_check_lock);
135 static_always_inline void
136 clear_cli_process_id_by_icmp_id_mt (vlib_main_t *vm, u16 icmp_id)
138 ping_main_t *pm = &ping_main;
141 clib_spinlock_lock_if_init (&pm->ping_run_check_lock);
142 vec_foreach (pr, pm->active_ping_runs)
144 if (pr->icmp_id == icmp_id)
146 vec_del1 (pm->active_ping_runs, pr - pm->active_ping_runs);
150 clib_spinlock_unlock_if_init (&pm->ping_run_check_lock);
152 clib_error_t *ping_plugin_api_hookup (vlib_main_t *vm);
153 send_ip46_ping_result_t send_ip4_ping (vlib_main_t *vm, u32 table_id,
154 ip4_address_t *pa4, u32 sw_if_index,
155 u16 seq_host, u16 id_host, u16 data_len,
156 u32 burst, u8 verbose);
157 send_ip46_ping_result_t send_ip6_ping (vlib_main_t *vm, u32 table_id,
158 ip6_address_t *pa6, u32 sw_if_index,
159 u16 seq_host, u16 id_host, u16 data_len,
160 u32 burst, u8 verbose);
162 #endif /* included_ping_ping_h */