aboutsummaryrefslogtreecommitdiffstats
path: root/resources/traffic_scripts/icmpv6_echo_req_resp.py
blob: ec9cf94a67aa8784741358c15ae5ddaef3768112 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
#!/usr/bin/env python

# Copyright (c) 2016 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Send ICMPv6 echo request from one TG port to another through DUT nodes and
   send reply back. Also verify hop limit processing."""

import sys
import logging

# pylint: disable=no-name-in-module
# pylint: disable=import-error
logging.getLogger("scapy.runtime").setLevel(logging.ERROR)

from scapy.layers.inet6 import IPv6, ICMPv6ND_NA, ICMPv6ND_NS
from scapy.layers.inet6 import ICMPv6NDOptDstLLAddr
from scapy.layers.inet6 import ICMPv6EchoRequest, ICMPv6EchoReply
from scapy.all import Ether

from resources.libraries.python.PacketVerifier import RxQueue, TxQueue
from resources.libraries.python.PacketVerifier import checksum_equal
from resources.libraries.python.TrafficScriptArg import TrafficScriptArg


def main():
    args = TrafficScriptArg(['src_mac', 'dst_mac', 'src_nh_mac', 'dst_nh_mac',
                             'src_ip', 'dst_ip', 'h_num'])

    src_rxq = RxQueue(args.get_arg('rx_if'))
    src_txq = TxQueue(args.get_arg('rx_if'))
    dst_rxq = RxQueue(args.get_arg('tx_if'))
    dst_txq = TxQueue(args.get_arg('tx_if'))

    src_mac = args.get_arg('src_mac')
    dst_mac = args.get_arg('dst_mac')
    src_nh_mac = args.get_arg('src_nh_mac')
    dst_nh_mac = args.get_arg('dst_nh_mac')
    src_ip = args.get_arg('src_ip')
    dst_ip = args.get_arg('dst_ip')
    hop_num = int(args.get_arg('h_num'))
    hop_limit = 64
    echo_id = 0xa
    echo_seq = 0x1

    src_sent_packets = []
    dst_sent_packets = []

    # send ICMPv6 neighbor advertisement message
    pkt_send = (Ether(src=src_mac, dst='ff:ff:ff:ff:ff:ff') /
                IPv6(src=src_ip, dst='ff02::1:ff00:2') /
                ICMPv6ND_NA(tgt=src_ip, R=0) /
                ICMPv6NDOptDstLLAddr(lladdr=src_mac))
    src_sent_packets.append(pkt_send)
    src_txq.send(pkt_send)
    pkt_send = (Ether(src=dst_mac, dst='ff:ff:ff:ff:ff:ff') /
                IPv6(src=dst_ip, dst='ff02::1:ff00:2') /
                ICMPv6ND_NA(tgt=dst_ip, R=0) /
                ICMPv6NDOptDstLLAddr(lladdr=dst_mac))
    dst_sent_packets.append(pkt_send)
    dst_txq.send(pkt_send)

    # send ICMPv6 echo request from first TG interface
    pkt_send = (Ether(src=src_mac, dst=src_nh_mac) /
                IPv6(src=src_ip, dst=dst_ip, hlim=hop_limit) /
                ICMPv6EchoRequest(id=echo_id, seq=echo_seq))
    src_sent_packets.append(pkt_send)
    src_txq.send(pkt_send)

    # receive ICMPv6 echo request on second TG interface
    while True:
        ether = dst_rxq.recv(2, dst_sent_packets)
        if ether is None:
            raise RuntimeError('ICMPv6 echo reply Rx timeout')

        if ether.haslayer(ICMPv6ND_NS):
            # read another packet in the queue if the current one is ICMPv6ND_NS
            continue
        else:
            # otherwise process the current packet
            break

    if not ether.haslayer(IPv6):
        raise RuntimeError('Unexpected packet with no IPv6 received: {0}'.
                           format(ether.__repr__()))

    ipv6 = ether[IPv6]

    # verify hop limit processing
    if ipv6.hlim != (hop_limit - hop_num):
        raise RuntimeError('Invalid hop limit {0} should be {1}'.
                           format(ipv6.hlim,hop_limit - hop_num))

    if not ipv6.haslayer(ICMPv6EchoRequest):
        raise RuntimeError('Unexpected packet with no IPv6 ICMP received {0}'.
                           format(ipv6.__repr__()))

    icmpv6 = ipv6[ICMPv6EchoRequest]

    # check identifier and sequence number
    if icmpv6.id != echo_id or icmpv6.seq != echo_seq:
        raise RuntimeError('Invalid ICMPv6 echo reply received ID {0} '
                           'seq {1} should be ID {2} seq {3}'.
                           format(icmpv6.id, icmpv6.seq, echo_id, echo_seq))

    # verify checksum
    cksum = icmpv6.cksum
    del icmpv6.cksum
    tmp = ICMPv6EchoRequest(str(icmpv6))
    if not checksum_equal(tmp.cksum, cksum):
        raise RuntimeError('Invalid checksum {0} should be {1}'.
                           format(cksum, tmp.cksum))

    # send ICMPv6 echo reply from second TG interface
    pkt_send = (Ether(src=dst_mac, dst=dst_nh_mac) /
                IPv6(src=dst_ip, dst=src_ip) /
                ICMPv6EchoReply(id=echo_id, seq=echo_seq))
    dst_sent_packets.append(pkt_send)
    dst_txq.send(pkt_send)

    # receive ICMPv6 echo reply on first TG interface
    while True:
        ether = src_rxq.recv(2, src_sent_packets)
        if ether is None:
            raise RuntimeError('ICMPv6 echo reply Rx timeout')

        if ether.haslayer(ICMPv6ND_NS):
            # read another packet in the queue if the current one is ICMPv6ND_NS
            continue
        else:
            # otherwise process the current packet
            break

    if not ether.haslayer(IPv6):
        raise RuntimeError('Unexpected packet with no IPv6 layer received {0}'.
                           format(ether.__repr__()))

    ipv6 = ether[IPv6]

    # verify hop limit processing
    if ipv6.hlim != (hop_limit - hop_num):
        raise RuntimeError('Invalid hop limit {0} should be {1}'.
                           format(ipv6.hlim, hop_limit - hop_num))

    if not ipv6.haslayer(ICMPv6EchoReply):
        raise RuntimeError('Unexpected packet with no IPv6 ICMP received {0}'.
                           format(ipv6.__repr__()))

    icmpv6 = ipv6[ICMPv6EchoReply]

    # check identifier and sequence number
    if icmpv6.id != echo_id or icmpv6.seq != echo_seq:
        raise RuntimeError('Invalid ICMPv6 echo reply received ID {0} '
                           'seq {1} should be ID {2} seq {3}'.
                           format(icmpv6.id, icmpv6.seq, echo_id, echo_seq))

    # verify checksum
    cksum = icmpv6.cksum
    del icmpv6.cksum
    tmp = ICMPv6EchoReply(str(icmpv6))
    if not checksum_equal(tmp.cksum, cksum):
        raise RuntimeError('Invalid checksum {0} should be {1}'.
                           format(cksum, tmp.cksum))

    sys.exit(0)


if __name__ == "__main__":
    main()
sh_get_mem (index_by_name, this_constraint_c); if (p == 0) { clib_warning ("order constraint fcn '%s' not found", this_constraint_c); these_constraints++; continue; } if (prev_name == 0) { prev_name = this_constraint_c; these_constraints++; continue; } constraint_tuple = format (0, "%s,%s%c", prev_name, this_constraint_c, 0); vec_add1 (constraints, constraint_tuple); prev_name = this_constraint_c; these_constraints++; } this_reg = this_reg->next_init_function; } n_init_fns = vec_len (init_f_names); orig = clib_ptclosure_alloc (n_init_fns); for (i = 0; i < vec_len (constraints); i++) { this_constraint = constraints[i]; if (comma_split (this_constraint, &a_name, &b_name)) return clib_error_return (0, "comma_split failed!"); p = hash_get_mem (index_by_name, a_name); /* * Note: the next two errors mean that something is * b0rked. As in: if you code "A runs before on B," and you type * B incorrectly, you lose. Nonexistent init functions are tolerated. */ if (p == 0) { clib_warning ("init function '%s' not found (before '%s')", a_name, b_name); continue; } a_index = p[0]; p = hash_get_mem (index_by_name, b_name); if (p == 0) { clib_warning ("init function '%s' not found (after '%s')", b_name, a_name); continue; } b_index = p[0]; /* add a before b to the original set of constraints */ orig[a_index][b_index] = 1; vec_free (this_constraint); } /* Compute the positive transitive closure of the original constraints */ closure = clib_ptclosure (orig); /* Compute a partial order across feature nodes, if one exists. */ again: for (i = 0; i < n_init_fns; i++) { for (j = 0; j < n_init_fns; j++) { if (closure[i][j]) goto item_constrained; } /* Item i can be output */ vec_add1 (result, i); { for (k = 0; k < n_init_fns; k++) closure[k][i] = 0; /* * Add a "Magic" a before a constraint. * This means we'll never output it again */ closure[i][i] = 1; goto again; } item_constrained: ; } /* see if we got a partial order... */ if (vec_len (result) != n_init_fns) return clib_error_return (0, "Failed to find a suitable init function order!"); /* * We win. * Bind the index variables, and output the feature node name vector * using the partial order we just computed. Result is in stack * order, because the entry with the fewest constraints (e.g. none) * is output first, etc. * Reset the listhead, and add items in result (aka reverse) order. */ *head = 0; for (i = 0; i < n_init_fns; i++) { p = hash_get (reg_by_index, result[i]); ASSERT (p != 0); this_reg = (_vlib_init_function_list_elt_t *) p[0]; this_reg->next_init_function = *head; *head = this_reg; } /* Finally, clean up all the fine data we allocated */ /* *INDENT-OFF* */ hash_foreach_pair (hp, index_by_name, ({ vec_add1 (keys_to_delete, (u8 *)hp->key); })); /* *INDENT-ON* */ hash_free (index_by_name); for (i = 0; i < vec_len (keys_to_delete); i++) vec_free (keys_to_delete[i]); vec_free (keys_to_delete); hash_free (reg_by_index); vec_free (result); clib_ptclosure_free (orig); clib_ptclosure_free (closure); return 0; } /** * @brief call a set of init / exit / main-loop enter functions * @param vm vlib_main_t * @param head address of the listhead to sort and then invoke * @returns 0 on success, clib_error_t * on error * * The "init_functions_called" hash supports a subtle mix of procedural * and formally-specified ordering constraints. The following schemes * are *roughly* equivalent: * * static clib_error_t *init_runs_first (vlib_main_t *vm) * { * clib_error_t *error; * * ... do some stuff... * * if ((error = vlib_call_init_function (init_runs_next))) * return error; * ... * } * VLIB_INIT_FUNCTION (init_runs_first); * * and * * static clib_error_t *init_runs_first (vlib_main_t *vm) * { * ... do some stuff... * } * VLIB_INIT_FUNCTION (init_runs_first) = * { * .runs_before = VLIB_INITS("init_runs_next"), * }; * * The first form will [most likely] call "init_runs_next" on the * spot. The second form means that "init_runs_first" runs before * "init_runs_next," possibly much earlier in the sequence. * * Please DO NOT construct sets of init functions where A before B * actually means A *right before* B. It's not necessary - simply combine * A and B - and it leads to hugely annoying debugging exercises. */ static inline clib_error_t * call_init_exit_functions_internal (vlib_main_t *vm, _vlib_init_function_list_elt_t **headp, int call_once, int do_sort, int is_global) { vlib_global_main_t *vgm = vlib_get_global_main (); clib_error_t *error = 0; _vlib_init_function_list_elt_t *i; if (do_sort && (error = vlib_sort_init_exit_functions (headp))) return (error); i = *headp; while (i) { uword *h; if (is_global) h = hash_get (vgm->init_functions_called, i->f); else h = hash_get (vm->worker_init_functions_called, i->f); if (call_once && !h) { if (call_once) { if (is_global) hash_set1 (vgm->init_functions_called, i->f); else hash_set1 (vm->worker_init_functions_called, i->f); } error = i->f (vm); if (error) return error; } i = i->next_init_function; } return error; } clib_error_t * vlib_call_init_exit_functions (vlib_main_t *vm, _vlib_init_function_list_elt_t **headp, int call_once, int is_global) { return call_init_exit_functions_internal (vm, headp, call_once, 1 /* do_sort */, is_global); } clib_error_t * vlib_call_init_exit_functions_no_sort (vlib_main_t *vm, _vlib_init_function_list_elt_t **headp, int call_once, int is_global) { return call_init_exit_functions_internal (vm, headp, call_once, 0 /* do_sort */, is_global); } clib_error_t * vlib_call_all_init_functions (vlib_main_t * vm) { vlib_global_main_t *vgm = vlib_get_global_main (); /* Call placeholder functions to make sure purely static modules are linked in. */ #define _(f) vlib_##f##_reference (); foreach_vlib_module_reference; #undef _ return vlib_call_init_exit_functions (vm, &vgm->init_function_registrations, 1 /* call_once */, 1 /* is_global */); } clib_error_t * vlib_call_all_main_loop_enter_functions (vlib_main_t * vm) { vlib_global_main_t *vgm = vlib_get_global_main (); return vlib_call_init_exit_functions ( vm, &vgm->main_loop_enter_function_registrations, 1 /* call_once */, 1 /* is_global */); } clib_error_t * vlib_call_all_main_loop_exit_functions (vlib_main_t * vm) { vlib_global_main_t *vgm = vlib_get_global_main (); return vlib_call_init_exit_functions ( vm, &vgm->main_loop_exit_function_registrations, 1 /* call_once */, 1 /* is_global */); } clib_error_t * vlib_call_all_config_functions (vlib_main_t * vm, unformat_input_t * input, int is_early) { vlib_global_main_t *vgm = vlib_get_global_main (); clib_error_t *error = 0; vlib_config_function_runtime_t *c, **all; uword *hash = 0, *p; uword i; hash = hash_create_string (0, sizeof (uword)); all = 0; c = vgm->config_function_registrations; while (c) { hash_set_mem (hash, c->name, vec_len (all)); vec_add1 (all, c); unformat_init (&c->input, 0, 0); c = c->next_registration; } while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) { u8 *s, *v; if (!unformat (input, "%s %v", &s, &v) || !(p = hash_get_mem (hash, s))) { error = clib_error_create ("unknown input `%s %v'", s, v); goto done; } c = all[p[0]]; if (vec_len (c->input.buffer) > 0) vec_add1 (c->input.buffer, ' '); vec_add (c->input.buffer, v, vec_len (v)); vec_free (v); vec_free (s); } for (i = 0; i < vec_len (all); i++) { c = all[i]; /* Is this an early config? Are we doing early configs? */ if (is_early ^ c->is_early) continue; /* Already called? */ if (hash_get (vgm->init_functions_called, c->function)) continue; hash_set1 (vgm->init_functions_called, c->function); error = c->function (vm, &c->input); if (error) goto done; } done: for (i = 0; i < vec_len (all); i++) { c = all[i]; unformat_free (&c->input); } vec_free (all); hash_free (hash); return error; } void vlib_init_dump (void) { vlib_global_main_t *vgm = vlib_get_global_main (); int i = 0; _vlib_init_function_list_elt_t *head, *this; head = vgm->init_function_registrations; this = head; while (this) { fformat (stdout, "[%d]: %s\n", i++, this->name); this = this->next_init_function; } } static clib_error_t * show_init_function_command_fn (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { vlib_global_main_t *vgm = vlib_get_global_main (); int which = 1; int verbose = 0; int i, n_init_fns; _vlib_init_function_list_elt_t *head, *this; uword *index_by_name; uword *reg_by_index; u8 **init_f_names = 0; u8 *init_f_name; uword *p; _vlib_init_function_list_elt_t *this_reg = 0; hash_pair_t *hp; u8 **keys_to_delete = 0; while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) { if (unformat (input, "init")) which = 1; else if (unformat (input, "enter")) which = 2; else if (unformat (input, "exit")) which = 3; else if (unformat (input, "verbose %d", &verbose)) ; else if (unformat (input, "verbose")) verbose = 1; else break; } switch (which) { case 1: head = vgm->init_function_registrations; break; case 2: head = vgm->main_loop_enter_function_registrations; break; case 3: head = vgm->main_loop_exit_function_registrations; break; default: return clib_error_return (0, "BUG"); } if (verbose == 0) { this = head; i = 0; while (this) { vlib_cli_output (vm, "[%d]: %s", i++, this->name); this = this->next_init_function; } return 0; } index_by_name = hash_create_string (0, sizeof (uword)); reg_by_index = hash_create (0, sizeof (uword)); this_reg = head; n_init_fns = 0; /* collect init fcn names */ while (this_reg) { init_f_name = format (0, "%s%c", this_reg->name, 0); hash_set (reg_by_index, vec_len (init_f_names), (uword) this_reg); hash_set_mem (index_by_name, init_f_name, vec_len (init_f_names)); vec_add1 (init_f_names, init_f_name); n_init_fns++; this_reg = this_reg->next_init_function; } for (i = 0; i < n_init_fns; i++) { p = hash_get (reg_by_index, i); ASSERT (p != 0); this_reg = (_vlib_init_function_list_elt_t *) p[0]; vlib_cli_output (vm, "[%d] %s", i, this_reg->name); { char **runs_before, **runs_after, **init_order; runs_before = this_reg->runs_before; while (runs_before && runs_before[0]) { _vlib_init_function_list_elt_t *successor; uword successor_index; p = hash_get_mem (index_by_name, runs_before[0]); if (p == 0) { clib_warning ("couldn't find successor '%s'", runs_before[0]); runs_before++; continue; } successor_index = p[0]; p = hash_get (reg_by_index, p[0]); ASSERT (p != 0); successor = (_vlib_init_function_list_elt_t *) p[0]; vlib_cli_output (vm, " before '%s' [%lld]", successor->name, successor_index); runs_before++; } runs_after = this_reg->runs_after; while (runs_after && runs_after[0]) { _vlib_init_function_list_elt_t *predecessor; uword predecessor_index; p = hash_get_mem (index_by_name, runs_after[0]); if (p == 0) { clib_warning ("couldn't find predecessor '%s'", runs_after[0]); runs_after++; continue; } predecessor_index = p[0]; p = hash_get (reg_by_index, p[0]); ASSERT (p != 0); predecessor = (_vlib_init_function_list_elt_t *) p[0]; vlib_cli_output (vm, " after '%s' [%lld]", predecessor->name, predecessor_index); runs_after++; } init_order = this_reg->init_order; while (init_order && init_order[0]) { _vlib_init_function_list_elt_t *inorder; uword inorder_index; p = hash_get_mem (index_by_name, init_order[0]); if (p == 0) { clib_warning ("couldn't find order element'%s'", init_order[0]); init_order++; continue; } inorder_index = p[0]; p = hash_get (reg_by_index, p[0]); ASSERT (p != 0); inorder = (_vlib_init_function_list_elt_t *) p[0]; vlib_cli_output (vm, " in order '%s' [%lld]", inorder->name, inorder_index); init_order++; } } } /* *INDENT-OFF* */ hash_foreach_pair (hp, index_by_name, ({ vec_add1 (keys_to_delete, (u8 *)hp->key); })); /* *INDENT-ON* */ hash_free (index_by_name); for (i = 0; i < vec_len (keys_to_delete); i++) vec_free (keys_to_delete[i]); vec_free (keys_to_delete); hash_free (reg_by_index); return 0; } /*? * Show init function order * * @cliexpar * @cliexstart{show init-function [init | enter | exit] [verbose [nn]]} * @cliexend ?*/ /* *INDENT-OFF* */ VLIB_CLI_COMMAND (show_init_function, static) = { .path = "show init-function", .short_help = "show init-function [init | enter | exit][verbose [nn]]", .function = show_init_function_command_fn, }; /* *INDENT-ON* */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */