A detailed description of the functionality provided by the library.

package require logger
package require ip

namespace   ::ipExtension::
id:         CVS ID: keyword extraction
version:    current version of package
packageDir: directory where package is located
log:        instance log

1.

prefixToNative <prefix>

<prefix>
    string in the <ipaddr>/<mask> format

<prefix> in native format {<hexip> <hexmask>}

% ip::prefixToNative 1.1.1.0/24
0x01010100 0xffffff00

fixed bug in C extension that modified 
 calling context variable

nativeToPrefix <nativeList>|<native> [-ipv4]

<nativeList> 
    list of native form ip addresses native form is:
<native>
    tcllist in format {<hexip> <hexmask>}
-ipv4
    the provided native format addresses are in ipv4 format (default)

if nativeToPrefix is called with <native> a single (non-listified) address
    is returned
if nativeToPrefix is called with a <nativeList> address list, then 
    a list of addresses is returned

return form is: <ipaddr>/<mask>

% ip::nativeToPrefix {0x01010100 0xffffff00} -ipv4
1.1.1.0/24

intToString <integer/hex> [-ipv4]

<integer>
    ip address in integer form
-ipv4
    the provided integer addresses is ipv4 (default)

ip address in dotted form

ip::intToString 4294967295
255.255.255.255

toInteger <ipaddr>

<ipaddr>
    decimal dotted from ip address

integer form of <ipaddr>

% ::ip::toInteger 1.1.1.0
16843008

toHex <ipaddr>

<ipaddr>
    decimal dotted from ip address

hex form of <ipaddr>

% ::ip::toHex 1.1.1.0
0x01010100

maskToInt <mask>

<mask>
    mask in either dotted form or mask length form (255.255.255.0 or 24)

integer form of mask

::ip::maskToInt 24
4294967040

broadcastAddress <prefix> [-ipv4]

<prefix>
    route in the form of <ipaddr>/<mask> or native form {<hexip> <hexmask>}
-ipv4
    the provided native format addresses are in ipv4 format (default)
    note: broadcast addresses are not valid in ipv6

ipaddress of broadcast

::ip::broadcastAddress 1.1.1.0/24
1.1.1.255

::ip::broadcastAddress {0x01010100 0xffffff00}
0x010101ff

maskToLength <dottedMask>|<integerMask>|<hexMask> [-ipv4]

<dottedMask>
<integerMask>
<hexMask>
    mask to convert to prefix length format (eg /24)
 -ipv4
    the provided integer/hex format masks are ipv4 (default)

prefix length

::ip::maskToLength 0xffffff00 -ipv4
24

% ::ip::maskToLength 255.255.255.0
24

lengthToMask <maskLength> [-ipv4]

<maskLength>
    mask length   
-ipv4
    the provided mask length is ipv4 (default)

mask in dotted form

::ip::lengthToMask 24
255.255.255.0

nextNet <ipaddr> <mask> [<count>] [-ipv4]

<ipaddress>
    in hex/integer/dotted format
<mask>
    mask in hex/integer/dotted/maskLen format
<count>
    number of nets to skip over (default is 1)
-ipv4
    the provided hex/integer addresses are in ipv4 format (default)

ipaddress in same position in next network in hex

isOverlap <prefix> <prefix1> <prefix2>...

<prefix>
    in form <ipaddr>/<mask> prefix to compare <prefixN> against
<prefixN>
    in form <ipaddr>/<mask> prefixes to compare against

1 if there is an overlap

% ::ip::isOverlap 1.1.1.0/24 2.1.0.1/32
0

::ip::isOverlap 1.1.1.0/24 2.1.0.1/32 1.1.1.1/32
1

isOverlap <hexipaddr> <hexmask> {{<hexipaddr1> <hexmask1>} {<hexipaddr2> <hexmask2>...}

-all
    return all overlaps rather than the first one
-inline
    rather than returning index values, return the actual overlap prefixes
<hexipaddr>
    ipaddress in hex/integer form
<hexMask>
    mask in hex/integer form
-ipv4
    the provided native format addresses are in ipv4 format (default)

non-zero if there is an overlap, value is element # in list with overlap

isOverlapNative is avaliabel both as a C extension and in a native tcl form if the extension is loaded (tried automatically), isOverlapNative will be linked to isOverlapNativeC. If an extension is not loaded, then isOverlapNative will be linked to the native tcl proc: ipOverlapNativeTcl.

% ::ip::isOverlapNative 0x01010100 0xffffff00 {{0x02010001 0xffffffff}}
0

%::ip::isOverlapNative 0x01010100 0xffffff00 {{0x02010001 0xffffffff} {0x01010101 0xffffffff}}
2

ipToLayer2Multicast <ipaddr>

<ipaddr>
    ipaddress in dotted form

mac address in xx.xx.xx.xx.xx.xx form

% ::ip::ipToLayer2Multicast 224.0.0.2
01.00.5e.00.00.02

::ip::ipHostFromPrefix <prefix> [-exclude <list of prefixes>]

<prefix>
    prefix is <ipaddr>/<masklen>
-exclude <list of prefixes>
    list if ipprefixes that host should not be in

ip address

%::ip::ipHostFromPrefix  1.1.1.5/24
1.1.1.1

%::ip::ipHostFromPrefix  1.1.1.1/32
1.1.1.1

::ip::reduceToAggregates <prefixList>

<prefixList>
    prefixList a list in the from of
    is <ipaddr>/<masklen> or native format

non-overlapping ip prefixes

  % ::ip::reduceToAggregates {1.1.1.0/24 1.1.0.0/8  2.1.1.0/24 1.1.1.1/32 }
  1.0.0.0/8 2.1.1.0/24

::ip::longestPrefixMatch <ipaddr> <prefixList> [-ipv4]

<prefixList>
    is list of <ipaddr> in native or dotted form
<ipaddr>
    ip address in <ipprefix> format, dotted form, or integer form
-ipv4
    the provided integer format addresses are in ipv4 format (default)

<ipprefix> that is the most specific match to <ipaddr>

% ::ip::longestPrefixMatch 1.1.1.1 {1.1.1.0/24 1.0.0.0/8  2.1.1.0/24 1.1.1.0/28 }
1.1.1.0/28

::ip::cmpDotIP <ipaddr1> <ipaddr2>

<ipaddr1> <ipaddr2>
    prefix is in dotted ip address format

-1 if ipaddr1 is less that ipaddr2
 1 if ipaddr1 is more that ipaddr2
 0 if ipaddr1 and ipaddr2 are equal

% lsort -command ip::cmpDotIP {1.0.0.0 2.2.0.0 128.0.0.0 3.3.3.3}
1.0.0.0 2.2.0.0 3.3.3.3 128.0.0.0