1NetAddr::IP::UtilPP(3)User Contributed Perl DocumentationNetAddr::IP::UtilPP(3)
2
6 NetAddr::IP::UtilPP -- pure Perl functions for NetAddr::IP::Util
7
9 use NetAddr::IP::UtilPP qw(
10 hasbits
11 shiftleft
12 addconst
13 add128
14 sub128
15 notcontiguous
16 ipv4to6
17 mask4to6
18 ipanyto6
19 maskanyto6
20 ipv6to4
21 bin2bcd
22 bcd2bin
23 );
24 use NetAddr::IP::UtilPP qw(:all)
26 $rv = hasbits($bits128);
28 $bitsX2 = shiftleft($bits128,$n);
29 $carry = addconst($ipv6naddr,$signed_32con);
30 ($carry,$ipv6naddr)=addconst($ipv6naddr,$signed_32con);
31 $carry = add128($ipv6naddr1,$ipv6naddr2);
32 ($carry,$ipv6naddr)=add128($ipv6naddr1,$ipv6naddr2);
33 $carry = sub128($ipv6naddr1,$ipv6naddr2);
34 ($spurious,$cidr) = notcontiguous($mask128);
35 ($carry,$ipv6naddr)=sub128($ipv6naddr1,$ipv6naddr2);
36 $ipv6naddr = ipv4to6($netaddr);
37 $ipv6naddr = mask4to6($netaddr);
38 $ipv6naddr = ipanyto6($netaddr);
39 $ipv6naddr = maskanyto6($netaddr);
40 $netaddr = ipv6to4($pv6naddr);
41 $bcdtext = bin2bcd($bits128);
42 $bits128 = bcd2bin($bcdtxt);
43
45 NetAddr::IP::UtilPP provides pure Perl functions for NetAddr::IP::Util
46 · $rv = hasbits($bits128);
48 This function returns true if there are one's present in the 128
50 bit string and false if all the bits are zero.
51 i.e. if (hasbits($bits128)) {
53 &do_something;
54 }
55 or if (hasbits($bits128 & $mask128) {
57 &do_something;
58 }
59 This allows the implementation of logical functions of the form of:
61 if ($bits128 & $mask128) {
63 ...
64 input: 128 bit IPv6 string
66 returns: true if any bits are present
67 · $bitsXn = shiftleft($bits128,$n);
69 input: 128 bit string variable,
71 number of shifts [optional]
72 returns: bits X n shifts
73 NOTE: input bits are returned
75 if $n is not specified
76 · addconst($ipv6naddr,$signed_32con);
78 Add a signed constant to a 128 bit string variable.
80 input: 128 bit IPv6 string,
82 signed 32 bit integer
83 returns: scalar carry
84 array (carry, result)
85 · add128($ipv6naddr1,$ipv6naddr2);
87 Add two 128 bit string variables.
89 input: 128 bit string var1,
91 128 bit string var2
92 returns: scalar carry
93 array (carry, result)
94 · sub128($ipv6naddr1,$ipv6naddr2);
96 Subtract two 128 bit string variables.
98 input: 128 bit string var1,
100 128 bit string var2
101 returns: scalar carry
102 array (carry, result)
103 Note: The carry from this operation is the result of adding the
105 one's complement of ARG2 +1 to the ARG1. It is logically NOT
106 borrow.
107 i.e. if ARG1 >= ARG2 then carry = 1
109 or if ARG1 < ARG2 then carry = 0
110 · ($spurious,$cidr) = notcontiguous($mask128);
112 This function counts the bit positions remaining in the mask when
114 the rightmost '0's are removed.
115 input: 128 bit netmask
117 returns true if there are spurious
118 zero bits remaining in the
119 mask, false if the mask is
120 contiguous one's,
121 128 bit cidr
122 · $ipv6naddr = ipv4to6($netaddr);
124 Convert an ipv4 network address into an ipv6 network address.
126 input: 32 bit network address
128 returns: 128 bit network address
129 · $ipv6naddr = mask4to6($netaddr);
131 Convert an ipv4 netowrk address into an ipv6 network mask.
133 input: 32 bit network/mask address
135 returns: 128 bit network/mask address
136 NOTE: returns the high 96 bits as one's
138 · $ipv6naddr = ipanyto6($netaddr);
140 Similar to ipv4to6 except that this function takes either an IPv4
142 or IPv6 input and always returns a 128 bit IPv6 network address.
143 input: 32 or 128 bit network address
145 returns: 128 bit network address
146 · $ipv6naddr = maskanyto6($netaddr);
148 Similar to mask4to6 except that this function takes either an IPv4
150 or IPv6 netmask and always returns a 128 bit IPv6 netmask.
151 input: 32 or 128 bit network mask
153 returns: 128 bit network mask
154 · $netaddr = ipv6to4($pv6naddr);
156 Truncate the upper 96 bits of a 128 bit address and return the
158 lower 32 bits. Returns an IPv4 address as returned by inet_aton.
159 input: 128 bit network address
161 returns: 32 bit inet_aton network address
162 · $bcdtext = bin2bcd($bits128);
164 Convert a 128 bit binary string into binary coded decimal text
166 digits.
167 input: 128 bit string variable
169 returns: string of bcd text digits
170 · $bits128 = bcd2bin($bcdtxt);
172 Convert a bcd text string to 128 bit string variable
174 input: string of bcd text digits
176 returns: 128 bit string variable
177
179 hasbits
180 shiftleft
181 addconst
182 add128
183 sub128
184 notcontiguous
185 ipv4to6
186 mask4to6
187 ipanyto6
188 maskanyto6
189 ipv6to4
190 bin2bcd
191 bcd2bin
192 comp128
193 bin2bcdn
194 bcdn2txt
195 bcdn2bin
196 simple_pack
197 threads
198
200 Michael Robinton <michael@bizsystems.com>
201
203 Copyright 2003 - 2012, Michael Robinton <michael@bizsystems.com>
204 All rights reserved.
206 This program is free software; you can redistribute it and/or modify it
208 under the terms of either:
209 a) the GNU General Public License as published by the Free
211 Software Foundation; either version 2, or (at your option) any
212 later version, or
213 b) the "Artistic License" which comes with this distribution.
215 This program is distributed in the hope that it will be useful, but
217 WITHOUT ANY WARRANTY; without even the implied warranty of
218 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See either the
219 GNU General Public License or the Artistic License for more details.
220 You should have received a copy of the Artistic License with this
222 distribution, in the file named "Artistic". If not, I'll be glad to
223 provide one.
224 You should also have received a copy of the GNU General Public License
226 along with this program in the file named "Copying". If not, write to
227 the
228 Free Software Foundation, Inc.,
230 51 Franklin Street, Fifth Floor
231 Boston, MA 02110-1301 USA
232 or visit their web page on the internet at:
234 http://www.gnu.org/copyleft/gpl.html.
236
238 Michael Robinton <michael@bizsystems.com>
239perl v5.26.3 2012-08-10 NetAddr::IP::UtilPP(3)