Go1.18 快訊：新的 IP 包
本文轉載自微信公眾號「polarisxu」，作者站長polaris 。轉載本文請聯系polarisxu公眾號。
大家好，我是 polarisxu。
Go 1.18 標準庫新增了一個包：net/netip，大部分人可能用不上這個包，但這個包的設計思路以及和現有標準庫 IP 的比較值得學習。
01 標準庫 net.IP 的問題
前 Go Team 成員之一 Brad Fitzpatrick 加入 Tailscale[1] 后，經常需要操作 IP 地址。因為使用 Go 語言實現的，自然會使用過標準庫的 net.IP 和 net.IPNet 等類型。但他們認為標準庫的相關類型有很多問題，所以他們自己寫了一個包：https://github.com/inetaf/netaddr。
早在 2017 年 1 月，Brad Fitzpatrick 就提了 issue，認為 net.IP 的設計存在問題：https://github.com/golang/go/issues/18804，那時他還在 Go Team。
具體來說，net.IP 存在如下幾個問題：
- 可變的。net.IP 的底層類型是 []byte，它的定義是：type IP []byte，這意味著你可以隨意修改它。不可變數據結構更安全、更簡單。
- 不可比較的。因為 Go 中 slice 類型是不可比較的，也就是說 net.IP 不支持 ==，也不能作為 map 的 key。
- 有兩個 IP 地址類型，net.IP 表示基本的 IPv4 或 IPv6 地址，而 net.IPAddr 表示支持 zone scopes 的 IPv6。因為有兩個類型，使用時就存在選擇問題，到底使用哪個。標準庫存在兩個這樣的方法：Resolver.LookupIP vs Resolver.LookupIPAddr。(關于什么是 IPv6 zone scopes 見維基百科：https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses_(with_zone_index 。)
- 太大。在 Go 中，64 位機器上，slice 類型占 24 個字節，這只是 slice header。因此，net.IP 的大小實際包含兩部分：24 字節的 slice header 和 4 或 6 字節的 IP 地址。而 net.IPAddr 更有額外的字符串類型 Zone 字段，占用空間更多。
- 不是 allocates free 的，會增加 GC 的工作。當你調用 net.ParseIP 或接收一個 UDP 包時，它為了記錄 IP 地址會分配底層數組的內存，然后指針放入 net.IP 的 slice header 中。
- 當解析一個字符串形式的 IP 地址時，net.IP 無法區分 IPv4 映射的 IPv6 地址[2]和 IPv4 地址。因為 net.IP 不會記錄原始的地址族(address family)。見 issue 37921[3]
- 它是一種透明類型(transparent type)。因為它的定義是：type IP []byte，底層類型是一個字節切片。這有什么問題呢?我們沒法改變 IP 的底層類型了，因為它已經是導出 API 的一部分。標準庫中一個很好的例子是 time.Time 類型，它是一個不透明類型：type Time struct { /* unexported */ }，也就是里面有什么沒公開，這樣庫作者可以隨便修改里面的內容，只需要保證導出 API 不變即可。實際上 Go1.9 就改過一次 time.Time 的內部結構，完全不會破壞兼容性。
但為了兼容性，以上這些問題沒法通過改進 net.IP 類型解決。于是才有了 Brad Fitzpatrick 上面開發的包。該包已經正式合入 Go1.18 標準庫中，這就是 net/netip 包，這里可以查看包文檔：https://pkg.go.dev/net/netip@master。
02 net/netip 包設計思路
新的 netip 包定義了一個 IP 地址(Addr)類型，它是一個小值類型。基于該 Addr 類型，該包還定義了 AddrPort(一個 IP 地址和一個端口)和 Prefix(一個 IP 地址和一個位長前綴)。
與 net.IP 類型相比，netip 包的 Addr 類型占用更少的內存(24 byte)，不可變(immutable)，并且具有可比性(支持 == 并作為 map 鍵)。(本文基于 64 位機器講解)
該包的具體 API 等信息可以查看文檔，這里著重講解 netip 的設計思路。(來自 Brad Fitzpatrick 的文章)
net.IP 類型的特性：
net.IP特性
基于此，netip 包的演進過程中，有幾種設計。
1)wgcfg.IP，查看具體代碼[4]。
- // Internally the address is always represented in its IPv6 form.
- // IPv4 addresses use the IPv4-in-IPv6 syntax.
- type IP struct {
- Addr [16]byte
- }
這種結構相比 net.IP 結果：
wgcfg 對比
可見還存在幾個問題：1)無法區分 IPv4 和 IPv6;2)不支持 IPv6 zone。而不透明可以通過將字段 Addr 改為 addr 解決。
2)netaddr.IP，查看具體代碼[5]。
不知道大家是否知道，Go 中的 interface 是可比較的(即可通過 == 比較和用作 map 的鍵，不過如果接口的底層值是不可比的，則運行時會 panic)。利用這一點，設計了 netaddr.IP 類型：
- type IP struct {
- ipImpl
- }
- type ipImpl interface {
- is4() bool
- is6() bool
- String() string
- }
- type v4Addr [4]byte
- type v6Addr [16]byte
- type v6AddrZone struct {
- v6Addr
- zone string
- }
該結構的對比：
netaddr.IP
這種結構存在的問題：不夠小(20-23 byte)，不是 Allocation free。
因此繼續優化。
3)allocation-free 24 字節表示
為什么定為 24 字節?Go 標準庫中 net.IP 的 Slice Header 大小是 24 字節，而 Go 中 Slice 很常見。time.Time 類型的大小目前也是 24 字節。所以，Go 編譯器肯定能夠很好的處理 24 字節值類型。所以，tailscale 團隊定了目標，要求表示 IP 的類型不超過 24 字節。
由于 IPv6 地址已經占去 16 個字節，因此剩下 8 字節用于編碼以下內容：
- 地址族(v4、v6 或兩者都不是，例如 IP 零值)，至少需要 2 位
- IPv6 zone
此外，還需要能比較。
剩下的內容只能占 8 字節，因此沒法使用 interface{}(它占用 16 字節)，字符串也不行(16 字節)。
可以嘗試采用了 bit-packing 的方式：
- type IP struct {
- addr [16]byte
- zoneAndFamily uint64
- }
將地址族和 IPv6 zone 打包(packing)進 zoneAndFamily 字段中(8 字節)。不過這種方式編碼不是太方便，可能還會有一些問題。
最后采用了指針的方式：
- type IP struct {
- addr [16]byte
- z *intern.Value // zone and family
- }
具體的過程分析可以參考 https://tailscale.com/blog/netaddr-new-ip-type-for-go/。
這樣可以定義三個哨兵：
- var (
- z0 *intern.Value // nil for the zero value
- z4 = new(intern.Value) // sentinel value to mean IPv4
- z6noz = new(intern.Value) // sentinel value to mean IPv6 with no zone
- )
這接近最終實現。不過，基于此有進一步的優化，感興趣的可以閱讀上面參考文章以及 Go1.18 的 net/netip 實現。
allocation-free
03 總結
這個包你可能用不到，不過標準庫中之前的 IP 實現的問題，以及新 IP 類型的設計思路還是值得認真看一下的。對其中更多細節感興趣的，可以認真研讀這篇文章：https://tailscale.com/blog/netaddr-new-ip-type-for-go/。
參考資料
[1]Tailscale: https://tailscale.com/
[2]IPv4 映射的 IPv6 地址: https://en.wikipedia.org/wiki/IPv6#IPv4-mapped_IPv6_addresses
[3]issue 37921: https://github.com/golang/go/issues/37921
[4]具體代碼: https://github.com/tailscale/wireguard-go/commit/89476f8cb53b7b6e3e67041d204a972b69902565#diff-d6e6f254849cb9119d9aaa21a41ee7f26f499251ce073522bdd89361a316814bR13
[5]具體代碼: https://github.com/inetaf/netaddr/commit/7f2e8c8409b7c27c5b44192839c8a94fca95aa21#diff-5aea5a23fd374194efa71dd12c8ddf8ede924f1043045520a8283d2490f40f12R27
