src/vnet/ip/ping.h

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15 #ifndef included_vnet_ping_h
  16 #define included_vnet_ping_h
  17
  18
  19 #include <vnet/ip/ip.h>
  20
  21 #include <vnet/ip/lookup.h>
  22
  23 typedef enum
  24 {
  25   PING_RESPONSE_IP6 = 42,
  26   PING_RESPONSE_IP4,
  27 } ping_response_type_t;
  28
  29 #define foreach_ip46_ping_result                                      \
  30   _ (OK, "OK")                                                        \
  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")                   \
  36
  37 typedef enum
  38 {
  39 #define _(v, s) SEND_PING_##v,
  40     foreach_ip46_ping_result
  41 #undef _
  42 } send_ip46_ping_result_t;
  43
  44 /*
  45  * Currently running ping command.
  46  */
  47 typedef struct ping_run_t
  48 {
  49   u16 icmp_id;
  50   uword cli_process_id;
  51 } ping_run_t;
  52
  53 typedef struct ping_main_t
  54 {
  55   ip6_main_t *ip6_main;
  56   ip4_main_t *ip4_main;
  57   /* a vector of current ping runs. */
  58   ping_run_t *active_ping_runs;
  59   /* a lock held while add/remove/search on active_ping_runs */
  60   clib_spinlock_t ping_run_check_lock;
  61 } ping_main_t;
  62
  63 extern ping_main_t ping_main;
  64
  65 #define PING_DEFAULT_DATA_LEN 60
  66 #define PING_DEFAULT_INTERVAL 1.0
  67
  68 #define PING_MAXIMUM_DATA_SIZE 32768
  69
  70 #define PING_CLI_UNKNOWN_NODE (~0)
  71
  72 /* *INDENT-OFF* */
  73
  74 typedef CLIB_PACKED (struct {
  75   u16 id;
  76   u16 seq;
  77   u64 time_sent;
  78   u8 data[0];
  79 }) icmp46_echo_request_t;
  80
  81 /* *INDENT-ON* */
  82
  83
  84 typedef enum
  85 {
  86   ICMP46_ECHO_REPLY_NEXT_DROP,
  87   ICMP46_ECHO_REPLY_NEXT_PUNT,
  88   ICMP46_ECHO_REPLY_N_NEXT,
  89 } icmp46_echo_reply_next_t;
  90
  91 #endif /* included_vnet_ping_h */