Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sukkaw/fast-cidr-tools
cidr-tools but up to 20x faster
https://github.com/sukkaw/fast-cidr-tools
cidr cidr-calculator cidr-tools ipv4 ipv6
Last synced: 26 days ago
JSON representation
cidr-tools but up to 20x faster
- Host: GitHub
- URL: https://github.com/sukkaw/fast-cidr-tools
- Owner: SukkaW
- License: mit
- Created: 2023-12-06T06:28:27.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-10-10T10:16:32.000Z (about 1 month ago)
- Last Synced: 2024-10-13T15:56:13.580Z (about 1 month ago)
- Topics: cidr, cidr-calculator, cidr-tools, ipv4, ipv6
- Language: TypeScript
- Homepage: http://npm.im/fast-cidr-tools
- Size: 366 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fast-cidr-tools
Tools to work with IPv4 and IPv6 CIDR, but 20x faster than [cidr-tools](https://www.npmjs.com/package/cidr-tools), and is **not** Pure ESM (publish both CommonJS and ESM).
Requires [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#browser_compatibility) supports.
## Usage
```tsx
import {
ip2bigint, // support both IPv4 and IPv6
bigint2ip, // support both IPv4 and IPv6
contains,
exclude,
expand,
merge,
overlap
} from 'fast-cidr-tools';
contains(['1.0.0.0/24', '2.0.0.0/24'], ['1.0.0.1']) //=> true
exclude(['::1/127'], ['::1/128']) //=> ['::/128']
expand(['2001:db8::/126']) //=> ['2001:db8::', '2001:db8::1', '2001:db8::2', '2001:db8::3']
merge(['1.0.0.0/24'], ['1.0.1.0/24']); //=> ['1.0.0.0/23']
overlap(['1.0.0.0/24'], ['1.0.0.128/25']) //=> true
```
## Performance
`fast-cidr-tools` is very fast, and is specfically optimized for IPv4. In some cases, it can be 20x faster than `cidr-tools`. `fast-cidr-tools` acheive this performance by:
- Doing less things, E.g.:
- `cidr-tools` will cast input to an array if it is string (`cidrTools.merge('1.0.0.0/24', '1.0.1.0/24')`). `fast-cidr-tools` only supports array input.
- `cidr-tools` sort the return value of `merge` and `exclude` by default. `fast-cidr-tools`'s sort is opt-in.
- And many more.
- Use efficient calculation and avoid unnecessary string operations.
- how `cidr-tools` and `fast-cidr-tools` calculate the "biggest power of two":
```tsx
// cidr-tools
function biggestPowerOfTwo(num) {
if (num === 0n) return 0n;
return 2n ** BigInt(String(num.toString(2).length - 1));
}
// fast-cidr-tools
// Not the actual implementation: fast-cidr-tools actually inlines the calculation
// for better performance
const uint64 = new BigUint64Array(1);
const uint32 = new Uint32Array(uint64.buffer);
function clz64(bigint: bigint) {
uint64[0] = bigint;
let r = Math.clz32(uint32[1]);
if (r === 32) {
r += Math.clz32(uint32[0]);
}
return r;
}
function biggestPowerOfTwo(num: bigint) {
if (num === 0n) return 0n;
const power = BigInt(64 - clz64(size) - 1);
return 2n ** (power === -1n ? 128n : power);
}
```
- how `cidr-tools` and `fast-cidr-tools` calculate the prefix of a CIDR:
```tsx
// cidr-tools
const zeroes = (part.end + 1n - part.start).toString(2);
const prefix = bits[v] - (zeroes.match(/0/g) || []).length;
// fast-cidr-tools
function fast_popcnt(value: bigint | number) {
let v = Number(value);
v -= v >>> 1 & 0x55_55_55_55;
v = (v & 0x33_33_33_33) + (v >>> 2 & 0x33_33_33_33);
return BigInt((((v + (v >>> 4)) & 0x0F_0F_0F_0F) * 0x01_01_01_01) >>> 24);
}
const uint64_0 = new BigInt64Array(1);
const uint32_0 = new Int32Array(uint64_0.buffer);
function fast_popcnt64(value: bigint) {
uint64_0[0] = value;
return fast_popcnt(uint32_0[0]) + fast_popcnt(uint32_0[1]);
}
const prefix = bits[v] - (v === 4 ? fast_popcnt(end - start) : fast_popcnt64(end - start));
```
- Use a more compact internal data structure. Compare how `cidr-tools` and `fast-cidr-tools` represent a CIDR internally:
```tsx
// cidr-tools
parse('::/64'); //=> { cidr: '::/64', version: 6, prefix: '64', start: 0n, end: 18446744073709551615n }
// fast-cidr-tools
parse('::/64'); //=> [0n, 18446744073709551615n, 6]
```
- Avoid repeated calculations. Notice how `fast-cidr-tools` pre-parse inputs instead of parsing them repeatedly:
- [cidr-tools](https://github.com/silverwind/cidr-tools/blob/db0a5a0a69299592ad11109be476fcb9ed1796ab/index.js#L377-L380)
- [fast-cidr-tools](https://github.com/SukkaW/fast-cidr-tools/blob/5a91cd521c3e4cbd832e1d6a47d522a8233e24f2/src/index.ts#L339-L348)
----
**fast-cidr-tools** © [Sukka](https://github.com/SukkaW), Authored and maintained by Sukka with help from contributors ([list](https://github.com/SukkaW/fas-cidr-tools/graphs/contributors)).
> [Personal Website](https://skk.moe) · [Blog](https://blog.skk.moe) · GitHub [@SukkaW](https://github.com/SukkaW) · Telegram Channel [@SukkaChannel](https://t.me/SukkaChannel) · Twitter [@isukkaw](https://twitter.com/isukkaw) · Keybase [@sukka](https://keybase.io/sukka)
