// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
// Copyright (c) 2001-2007 International Computer Science Institute
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software")
// to deal in the Software without restriction, subject to the conditions
// listed in the XORP LICENSE file. These conditions include: you must
// preserve this copyright notice, and you cannot mention the copyright
// holders in advertising related to the Software without their permission.
// The Software is provided WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED. This
// notice is a summary of the XORP LICENSE file; the license in that file is
// legally binding.
#ident "$XORP: xorp/libxorp/test_ipv6net.cc,v 1.16 2007/02/16 22:46:24 pavlin Exp $"
#include "libxorp_module.h"
#include "libxorp/xorp.h"
#include "libxorp/xlog.h"
#include "libxorp/exceptions.hh"
#include "libxorp/timer.hh"
#include "libxorp/test_main.hh"
#ifdef HAVE_GETOPT_H
#include <getopt.h>
#endif
#include "ipv6net.hh"
//
// TODO: XXX: remove after the switch to the TestMain facility is completed
//
#if 0
//
// XXX: MODIFY FOR YOUR TEST PROGRAM
//
static const char *program_name = "test_ipv6net";
static const char *program_description = "Test IPv6Net address class";
static const char *program_version_id = "0.1";
static const char *program_date = "December 2, 2002";
static const char *program_copyright = "See file LICENSE.XORP";
static const char *program_return_value = "0 on success, 1 if test error, 2 if internal error";
#endif // 0
static bool s_verbose = false;
bool verbose() { return s_verbose; }
void set_verbose(bool v) { s_verbose = v; }
static int s_failures = 0;
bool failures() { return (s_failures)? (true) : (false); }
void incr_failures() { s_failures++; }
void reset_failures() { s_failures = 0; }
//
// printf(3)-like facility to conditionally print a message if verbosity
// is enabled.
//
#define verbose_log(x...) _verbose_log(__FILE__,__LINE__, x)
#define _verbose_log(file, line, x...) \
do { \
if (verbose()) { \
printf("From %s:%d: ", file, line); \
printf(x); \
} \
} while(0)
//
// Test and print a message whether two strings are lexicographically same.
// The strings can be either C or C++ style.
//
#define verbose_match(s1, s2) \
_verbose_match(__FILE__, __LINE__, s1, s2)
bool
_verbose_match(const char* file, int line, const string& s1, const string& s2)
{
bool match = s1 == s2;
_verbose_log(file, line, "Comparing %s == %s : %s\n",
s1.c_str(), s2.c_str(), match ? "OK" : "FAIL");
if (match == false)
incr_failures();
return match;
}
//
// Test and print a message whether a condition is true.
//
// The first argument is the condition to test.
// The second argument is a string with a brief description of the tested
// condition.
//
#define verbose_assert(cond, desc) \
_verbose_assert(__FILE__, __LINE__, cond, desc)
bool
_verbose_assert(const char* file, int line, bool cond, const string& desc)
{
_verbose_log(file, line,
"Testing %s : %s\n", desc.c_str(), cond ? "OK" : "FAIL");
if (cond == false)
incr_failures();
return cond;
}
//
// TODO: XXX: remove after the switch to the TestMain facility is completed
//
#if 0
/**
* Print program info to output stream.
*
* @param stream the output stream the print the program info to.
*/
static void
print_program_info(FILE *stream)
{
fprintf(stream, "Name: %s\n", program_name);
fprintf(stream, "Description: %s\n", program_description);
fprintf(stream, "Version: %s\n", program_version_id);
fprintf(stream, "Date: %s\n", program_date);
fprintf(stream, "Copyright: %s\n", program_copyright);
fprintf(stream, "Return: %s\n", program_return_value);
}
/**
* Print program usage information to the stderr.
*
* @param progname the name of the program.
*/
static void
usage(const char* progname)
{
print_program_info(stderr);
fprintf(stderr, "usage: %s [-v] [-h]\n", progname);
fprintf(stderr, " -h : usage (this message)\n");
fprintf(stderr, " -v : verbose output\n");
}
#endif // 0
/**
* Test IPv6Net valid constructors.
*/
bool
test_ipv6net_valid_constructors(TestInfo& test_info)
{
UNUSED(test_info);
// Test values for IPv6 address: "1234:5678:9abc:def0:fed:cba9:8765:4321"
const char *addr_string = "1234:5678:9abc:def0:fed:cba9:8765:4321";
struct in6_addr in6_addr = { { { 0x12, 0x34, 0x56, 0x78,
0x9a, 0xbc, 0xde, 0xf0,
0x0f, 0xed, 0xcb, 0xa9,
0x87, 0x65, 0x43, 0x21 } } };
uint8_t ui8[16];
uint32_t ui32[4];
memcpy(&ui8[0], &in6_addr, sizeof(in6_addr));
memcpy(&ui32[0], &in6_addr, sizeof(in6_addr));
struct sockaddr_in6 sin6;
memset(&sin6, 0, sizeof(sin6));
#ifdef HAVE_SIN6_LEN
sin6.sin6_len = sizeof(sin6);
#endif
sin6.sin6_family = AF_INET6;
sin6.sin6_addr = in6_addr;
const char *netaddr_string = "1234:5678::/32";
//
// Default constructor.
//
IPv6Net ipnet1;
verbose_match(ipnet1.str(), "::/0");
//
// Constructor from a given base address and a prefix length.
//
IPv6 ip2(addr_string);
IPv6Net ipnet2(ip2, 32);
verbose_match(ipnet2.str(), "1234:5678::/32");
//
// Constructor from a string.
//
IPv6Net ipnet3(netaddr_string);
verbose_match(ipnet3.str(), netaddr_string);
//
// Constructor from another IPv6Net address.
//
IPv6Net ipnet4(ipnet3);
verbose_match(ipnet4.str(), netaddr_string);
return (! failures());
}
/**
* Test IPv6Net invalid constructors.
*/
bool
test_ipv6net_invalid_constructors(TestInfo& test_info)
{
UNUSED(test_info);
//
// Constructor for invalid prefix length.
//
try {
IPv6 ip("1234:5678:9abc:def0:fed:cba9:8765:4321");
IPv6Net ipnet(ip, ip.addr_bitlen() + 1);
verbose_log("Cannot catch invalid prefix length : FAIL\n");
incr_failures();
UNUSED(ipnet);
} catch (const InvalidNetmaskLength& e) {
// The problem was caught
verbose_log("%s : OK\n", e.str().c_str());
}
//
// Constructor from an invalid address string.
//
try {
// Invalid address string: note the typo -- lack of prefix length
IPv6Net ipnet("1234:5678::/");
verbose_log("Cannot catch invalid IP network address \"1234:5678::/\" : FAIL\n");
incr_failures();
UNUSED(ipnet);
} catch (const InvalidString& e) {
// The problem was caught
verbose_log("%s : OK\n", e.str().c_str());
}
//
// Constructor from an address string with invalid prefix length.
//
try {
// Invalid address string: prefix length too long
IPv6Net ipnet("1234:5678::/129");
verbose_log("Cannot catch invalid IP network address \"1234:5678::/129\" : FAIL\n");
incr_failures();
UNUSED(ipnet);
} catch (const InvalidNetmaskLength& e) {
// The problem was caught
verbose_log("%s : OK\n", e.str().c_str());
}
return (! failures());
}
/**
* Test IPv6Net operators.
*/
bool
test_ipv6net_operators(TestInfo& test_info)
{
UNUSED(test_info);
IPv6Net ipnet_a("1234:5678::/32");
IPv6Net ipnet_b("1234:5679::/32");
IPv6Net ipnet_c("1234:5678:9abc::/48");
//
// Assignment operator
//
IPv6Net ipnet1;
ipnet1 = ipnet_a;
verbose_assert(ipnet1.str() == ipnet_a.str(), "operator=");
//
// Equality Operator
//
verbose_assert(ipnet_a == ipnet_a, "operator==");
verbose_assert(!(ipnet_a == ipnet_b), "operator==");
verbose_assert(!(ipnet_a == ipnet_c), "operator==");
//
// Less-Than Operator
//
verbose_assert((IPv6Net("1234:5678::/32") < IPv6Net("1234:5678::/32"))
== false,
"operator<");
verbose_assert((IPv6Net("1234:5678::/32") < IPv6Net("1234:5678:9abc::/48"))
== false,
"operator<");
verbose_assert((IPv6Net("1234:5678::/32") < IPv6Net("1234::/16"))
== true,
"operator<");
verbose_assert((IPv6Net("1234:5678::/32") < IPv6Net("1234:5679::/32"))
== true,
"operator<");
//
// Decrement Operator
//
verbose_assert(--IPv6Net("1234:5678::/32") == IPv6Net("1234:5677::/32"),
"operator--()");
verbose_assert(--IPv6Net("::/32") == IPv6Net("ffff:ffff::/32"),
"operator--()");
//
// Increment Operator
//
verbose_assert(++IPv6Net("1234:5678::/32") == IPv6Net("1234:5679::/32"),
"operator++()");
verbose_assert(++IPv6Net("ffff:ffff::/32") == IPv6Net("::/32"),
"operator++()");
//
// Test if the object contains a real (non-default) value.
//
verbose_assert(! IPv6Net().is_valid(), "is_valid()");
verbose_assert(! IPv6Net("::/0").is_valid(), "is_valid()");
verbose_assert(IPv6Net("::/1").is_valid(), "is_valid()");
return (! failures());
}
/**
* Test IPv6Net address type.
*/
bool
test_ipv6net_address_type(TestInfo& test_info)
{
UNUSED(test_info);
IPv6Net ipnet_default("::/0"); // Default route: unicast
IPv6Net ipnet_unicast1("::/1"); // Unicast
IPv6Net ipnet_unicast2("1234:5678::/32"); // Unicast
IPv6Net ipnet_multicast1("ff00::/8"); // Multicast
IPv6Net ipnet_multicast2("ff00:1::/32"); // Multicast
IPv6Net ipnet_odd1("8000::/1"); // Odd: includes multicast
IPv6Net ipnet_odd2("fe00::/7"); // Odd: includes multicast
//
// Test if a subnet is within the unicast address range.
//
verbose_assert(ipnet_default.is_unicast() == true, "is_unicast()");
verbose_assert(ipnet_unicast1.is_unicast() == true, "is_unicast()");
verbose_assert(ipnet_unicast2.is_unicast() == true, "is_unicast()");
verbose_assert(ipnet_multicast1.is_unicast() == false, "is_unicast()");
verbose_assert(ipnet_multicast2.is_unicast() == false, "is_unicast()");
verbose_assert(ipnet_odd1.is_unicast() == false, "is_unicast()");
verbose_assert(ipnet_odd2.is_unicast() == false, "is_unicast()");
//
// Test if a subnet is within the multicast address range.
//
verbose_assert(ipnet_default.is_multicast() == false, "is_multicast()");
verbose_assert(ipnet_unicast1.is_multicast() == false, "is_multicast()");
verbose_assert(ipnet_unicast2.is_multicast() == false, "is_multicast()");
verbose_assert(ipnet_multicast1.is_multicast() == true, "is_multicast()");
verbose_assert(ipnet_multicast2.is_multicast() == true, "is_multicast()");
verbose_assert(ipnet_odd1.is_multicast() == false, "is_multicast()");
verbose_assert(ipnet_odd2.is_multicast() == false, "is_multicast()");
return (! failures());
}
/**
* Test IPv6Net address overlap.
*/
bool
test_ipv6net_address_overlap(TestInfo& test_info)
{
UNUSED(test_info);
IPv6Net ipnet_a("1234:5678::/32");
IPv6Net ipnet_b("1234:5679::/32");
IPv6Net ipnet_c("1234:5678:9abc::/48");
IPv6Net ipnet_d("1234:0020::/32");
IPv6Net ipnet_e("1234:0021::/32");
IPv6Net ipnet_f("0001:0002:0001::/48");
IPv6Net ipnet_g("0001:0002:0003::/48");
//
// Test if subnets overlap.
//
verbose_assert(ipnet_a.is_overlap(ipnet_b) == false, "is_overlap()");
verbose_assert(ipnet_a.is_overlap(ipnet_c) == true, "is_overlap()");
verbose_assert(ipnet_c.is_overlap(ipnet_a) == true, "is_overlap()");
//
// Test if a subnet contains (or is equal to) another subnet.
//
verbose_assert(ipnet_a.contains(ipnet_a) == true, "contains(IPv6Net)");
verbose_assert(ipnet_a.contains(ipnet_b) == false, "contains(IPv6Net)");
verbose_assert(ipnet_a.contains(ipnet_c) == true, "contains(IPv6Net)");
verbose_assert(ipnet_c.contains(ipnet_a) == false, "contains(IPv6Net)");
//
// Test if an address is within a subnet.
//
verbose_assert(ipnet_a.contains(ipnet_a.masked_addr()) == true,
"contains(IPv6)");
verbose_assert(ipnet_a.contains(ipnet_b.masked_addr()) == false,
"contains(IPv6)");
verbose_assert(ipnet_a.contains(ipnet_c.masked_addr()) == true,
"contains(IPv6)");
//
// Determine the number of the most significant bits overlapping with
// another subnet.
//
verbose_assert(ipnet_a.overlap(ipnet_a) == 32, "overlap()");
verbose_assert(ipnet_a.overlap(ipnet_b) == 31, "overlap()");
verbose_assert(ipnet_a.overlap(ipnet_c) == 32, "overlap()");
verbose_assert(ipnet_d.overlap(ipnet_e) == 31, "overlap()");
verbose_assert(ipnet_f.overlap(ipnet_g) == 46, "overlap()");
return (! failures());
}
/**
* Test performance of IPv6Net address overlap.
*/
bool
test_performance_ipv6net_address_overlap(TestInfo& test_info)
{
UNUSED(test_info);
IPv6Net ipnet_a("ffff:ffff::/32");
IPv6Net ipnet_b("ffff:ffff:ffff:ffff:ffff:ffff::/96");
//
// Test overlapping subnets.
//
do {
size_t i;
size_t c = 0;
TimeVal begin_timeval, end_timeval, delta_timeval;
TimerList::system_gettimeofday(&begin_timeval);
for (i = 0; i < 0xffffff; i++) {
c += ipnet_a.overlap(ipnet_b);
}
TimerList::system_gettimeofday(&end_timeval);
delta_timeval = end_timeval - begin_timeval;
verbose_log("Execution time IPv6Net::overlap(): %s seconds\n",
delta_timeval.str().c_str());
} while (false);
return (! failures());
}
/**
* Test IPv6Net address constant values.
*/
bool
test_ipv6net_address_const(TestInfo& test_info)
{
UNUSED(test_info);
IPv6Net ipnet_a("1234:5678::/32");
//
// Test the address family.
//
verbose_assert(IPv6Net::af() == AF_INET6, "af()");
//
// Get the base address.
//
IPv6 ip1;
ip1 = ipnet_a.masked_addr();
verbose_match(ip1.str(), "1234:5678::");
//
// Get the prefix length.
//
verbose_assert(ipnet_a.prefix_len() == 32, "prefix_len()");
//
// Get the network mask.
//
IPv6 ip2;
ip2 = ipnet_a.netmask();
verbose_match(ip2.str(), "ffff:ffff::");
//
// Return the subnet containing all multicast addresses.
//
verbose_match(IPv6Net::ip_multicast_base_prefix().str(), "ff00::/8");
return (! failures());
}
/**
* Test IPv6Net address manipulation.
*/
bool
test_ipv6net_manipulate_address(TestInfo& test_info)
{
UNUSED(test_info);
IPv6Net ipnet_a("1234:5678::/32");
//
// Get the highest address within this subnet.
//
verbose_match(ipnet_a.top_addr().str(),
"1234:5678:ffff:ffff:ffff:ffff:ffff:ffff");
//
// Get the smallest subnet containing both subnets.
//
verbose_match(IPv6Net::common_subnet(IPv6Net("1234:5678:1::/48"),
IPv6Net("1234:5678:8000::/48")).str(),
"1234:5678::/32");
return (! failures());
}
int
main(int argc, char * const argv[])
{
XorpUnexpectedHandler x(xorp_unexpected_handler);
//
// Initialize and start xlog
//
xlog_init(argv[0], NULL);
xlog_set_verbose(XLOG_VERBOSE_LOW); // Least verbose messages
// XXX: verbosity of the error messages temporary increased
xlog_level_set_verbose(XLOG_LEVEL_ERROR, XLOG_VERBOSE_HIGH);
xlog_add_default_output();
xlog_start();
TestMain test_main(argc, argv);
string test = test_main.get_optional_args("-t", "--test",
"run only the specified test");
test_main.complete_args_parsing();
//
// TODO: XXX: a temporary glue until we complete the switch to the
// TestMain facility.
//
if (test_main.get_verbose())
set_verbose(true);
struct test {
string test_name;
XorpCallback1<bool, TestInfo&>::RefPtr cb;
bool run_by_default;
} tests[] = {
{ "test_ipv6net_valid_constructors",
callback(test_ipv6net_valid_constructors),
true
},
{ "test_ipv6net_invalid_constructors",
callback(test_ipv6net_invalid_constructors),
true
},
{ "test_ipv6net_operators",
callback(test_ipv6net_operators),
true
},
{ "test_ipv6net_address_type",
callback(test_ipv6net_address_type),
true
},
{ "test_ipv6net_address_overlap",
callback(test_ipv6net_address_overlap),
true
},
{ "test_ipv6net_address_const",
callback(test_ipv6net_address_const),
true
},
{ "test_ipv6net_manipulate_address",
callback(test_ipv6net_manipulate_address),
true
},
{ "test_performance_ipv6net_address_overlap",
callback(test_performance_ipv6net_address_overlap),
false
}
};
try {
if (test.empty()) {
for (size_t i = 0; i < sizeof(tests) / sizeof(struct test); i++) {
if (! tests[i].run_by_default)
continue;
reset_failures();
test_main.run(tests[i].test_name, tests[i].cb);
}
} else {
for (size_t i = 0; i < sizeof(tests) / sizeof(struct test); i++) {
if (test == tests[i].test_name) {
reset_failures();
test_main.run(tests[i].test_name, tests[i].cb);
return test_main.exit();
}
}
test_main.failed("No test with name " + test + " found\n");
}
} catch (...) {
xorp_print_standard_exceptions();
}
//
// Gracefully stop and exit xlog
//
xlog_stop();
xlog_exit();
return test_main.exit();
}
syntax highlighted by Code2HTML, v. 0.9.1