在Node.js中使用SO_RESUEPORT

作者：theanarkh 2021-07-26 05:24:59

今天下載了Node.js最新版代碼，并為Node.js的TCP模塊增加了SO_RESUEPORT的能力，本文介紹一下具體的實現。

前言：今天下載了Node.js最新版代碼，并為Node.js的TCP模塊增加了SO_RESUEPORT的能力，本文介紹一下具體的實現，關于SO_RESUEPORT的知識可以參考之前的文章或者網上文章。

1 Libuv

SO_RESUEPORT是操作系統內核提供的能力，所以第一步首先修改Libuv。考慮到操作系統兼容性的問題，目前只支持Linux系統，舊版Mac OS也支持相關屬性但是效果不符合預期，新版Mac OS倒是支持，考慮到Node.js在幾乎都是部署到Linux，所以可以先關注Linux內核。首先修改deps/uv/include/uv.h。

enum uv_tcp_flags { 
  UV_TCP_IPV6ONLY = 1, 
  // 支持SO_RESUEPORT flags 
  UV_TCP_REUSEPORT = 2 
 
};

接著修改deps/uv/src/unix/tcp.c。

#if defined(SO_REUSEPORT) && defined(__linux__)  
  on = 1; 
  if ((flags & UV_TCP_REUSEPORT) && setsockopt(tcp->io_watcher.fd, SOL_SOCKET, SO_REUSEPORT, &on, sizeof(on))) 
    return UV__ERR(errno); 
#endif

這里判斷一下是否有兩個宏，有的話才能使用SO_RESUEPORT。如果支持則通過setsockopt設置socket的SO_REUSEPORT標記，這是最核心的邏輯。

2 修改C++層

修改完底層的Libuv后，繼續修改C++層，因為這是一個可選的屬性，所以我們需要增加相關的邏輯。修改src/tcp_wrap.cc。首先導出一個新的常量

#if defined(SO_REUSEPORT) && defined(__linux__)  
 NODE_DEFINE_CONSTANT(constants, UV_TCP_REUSEPORT); 
 
#endif

在JS層可以通過判斷是否導出了這個常量來判斷系統是否支持SO_RESUEPORT。接著修改bind函數，因為我們再bind的時候可以設置SO_RESUEPORT。

template <typename T> 
 
void TCPWrap::Bind( 
 
    const FunctionCallbackInfo<Value>& args, 
    int family, 
    std::function<int(const char* ip_address, int port, T* addr)> uv_ip_addr) { 
  TCPWrap* wrap; 
  ASSIGN_OR_RETURN_UNWRAP(&wrap, 
                          args.Holder(), 
                          args.GetReturnValue().Set(UV_EBADF)); 
  Environment* env = wrap->env(); 
  node::Utf8Value ip_address(env->isolate(), args[0]); 
  int port; 
  unsigned int flags = 0; 
  if (!args[1]->Int32Value(env->context()).To(&port)) return; 
  // ipv6支持ipv6Only和SO_RESUEPORT 
  if (family == AF_INET6 && 
      !args[2]->Uint32Value(env->context()).To(&flags)) { 
    return; 
  // ipv4之前是不支持任何標記的，這里需要加上這個邏輯，因為我們需要支持SO_RESUEPORT 
  } else if (family == AF_INET4 && 
      !args[2]->Uint32Value(env->context()).To(&flags)) { 
    return; 
  } 
 
  T addr; 
  int err = uv_ip_addr(*ip_address, port, &addr); 
 
  if (err == 0) { 
    err = uv_tcp_bind(&wrap->handle_, 
                      reinterpret_cast<const sockaddr*>(&addr), 
                      flags); 
  } 
  args.GetReturnValue().Set(err); 
 
}

C++主要是完成透傳flags的邏輯。

3 修改JS層

修改JS層是最復雜的地方，主要是為了應用層的兼容性問題。也就是說如果Node.js真的支持了SO_RESUEPORT，在某些平臺不支持SO_RESUEPORT的情況下，我們如何能保證我們的代碼能在各個平臺上跑。簡單來說，如果我們平臺支持SO_RESUEPORT，我們可以開啟多個子進程，然后分別執行以下代碼。

const http = require('http'); 
http.createServer((req, res) => { 
    res.end('hello'); 
 
}) 
 
.listen({port: 8000， reuseport: true});

這時候，只需要修改一下Node.js的net.js，把reuseport標記傳到C++層再傳到Libuv就行，但是問題是，如果我們這樣寫代碼，就無法在不支持SO_RESUEPORT的平臺跑了，因為會導致重復監聽端口的錯誤。所以為了兼容性，我想的方案是利用Cluster模塊，目前Cluster模塊支持輪詢和共享兩種模式，那么我們再加一種reuseport模式就好了，這樣的好處是一旦我們平臺不支持SO_RESUEPORT，我們可以降級到Node.js現在到模式。我們知道Cluster模塊的原理有兩種，一種是主進程監聽，分發連接給子進程，另一種是主進程創建socket，通過文件描述符傳遞的方式傳給子進程，所有的進程都是共享一個socket的。下面我們看看怎么做。首先修改lib/internal/cluster/primary.js。

// 增加這if的邏輯 
if ((message.addressType === 4 ||  
 message.addressType === 6) &&  
 (message.flags & TCPConstants.UV_TCP_REUSEPORT)) { 
 handle = new ReusePort(key, address, message); 
} else if (schedulingPolicy !== SCHED_RR || 
    message.addressType === 'udp4' || 
    message.addressType === 'udp6') { 
  handle = new SharedHandle(key, address, message); 
} else { 
  handle = new RoundRobinHandle(key, address, message); 
}

我們在queryServer函數里增加了一個if的邏輯。如果addressType是4或6說明是TCP協議，并且設置了UV_TCP_REUSEPORT(listen的時候傳入)，就會走到reuseport的邏輯，剩下的兩個else是目前Node.js的邏輯。我們看看ReusePort.js做了什么。

'use strict'; 
 
const assert = require('internal/assert'); 
 
const net = require('net'); 
 
const { constants: TCPConstants } = internalBinding('tcp_wrap'); 
 
 
module.exports = ReusePort; 
 
function ReusePort(key, address, {port, addressType, fd, flags}) { 
  this.key = key; 
  this.workers = []; 
  this.handles = []; 
  this.list = [address, port, addressType, fd, flags]; 
 
} 
 
 
ReusePort.prototype.add = function(worker, send) { 
  assert(!this.workers.includes(worker)); 
  const rval = net._createServerHandle(...this.list); 
  let errno; 
  let handle; 
  if (typeof rval === 'number') 
    errno = rval; 
  else 
    handle = rval; 
  this.workers.push(worker); 
  this.handles.push(handle); 
  send(errno, null, handle); 
 
}; 
 
 
ReusePort.prototype.remove = function(worker) { 
  const index = this.workers.indexOf(worker); 
 
  if (index === -1) 
    return false; // The worker wasn't sharing this handle. 
 
  this.workers.splice(index, 1); 
  this.handles[index].close(); 
  this.handles.splice(index, 1); 
  return true; 
 
};

上面的代碼我們只需要關注net._createServerHandle。在不能多個進程同時監聽同一個端口的情況下，Node.js只會調net._createServerHandle創建一個socket，然后多個進程共享。而我們這里會給每個進程創建一個socket。這個socket就是在子進程調用queryServer的時候返回給子進程的。剩下的邏輯我們暫時不用關注。最后看一下_createServerHandle的邏輯。

const handle = new TCP(TCPConstants.SERVER); 
 
if (addressType === 6) { 
 
  err = handle.bind6(address, port, flags);}  
 
else { 
 
  err = handle.bind(address, port, flags || 0); 
 
}

_createServerHandle的邏輯是創建一個socket并且給socket綁定IP和端口，我們看到這里會給C++層傳入flags，C++層就會傳到LIbuv了，這樣我們就完成了整個過程，整體的流程如下。

1 子進程執行listen的時候，傳入reuseport為true

2 子進程通過進程間通信請求主進程

3 主進程返回一個新的socket并綁定到對應的地址

4 子進程執行listen啟動服務器。

4 使用

接下來我們看看如何使用，首先創建一個server.js。

const cluster = require('cluster'); 
 
const os = require('os'); 
 
const http = require('http'); 
 
const cpus = os.cpus().length; 
 
 
 
 if (cluster.isPrimary) { 
 
  const map = {}; 
  for (let i = 0; i < cpus; i++) { 
    const worker = cluster.fork(); 
    map[worker.process.pid] = 0; 
    worker.on('message', (pid) => { 
        map[pid]++; 
    }); 
  } 
 
  process.on('SIGINT', () => { 
    console.log(map); 
  }); 
 
} else { 
 
  http.createServer((req, res) => { 
      process.send(process.pid); 
      res.end('hello'); 
  }) 
 
  .listen({reuseport: true, port: 8000}); 
 
}

再創建一個客戶端client.js

const http = require('http'); 
function connect() { 
    setTimeout(() => { 
        http.get('http://localhost:8000/', (res) => { 
            console.log(res.statusCode); 
            connect(); 
        }); 
    }, 50); 
 
} 
 
connect();

客戶端串行訪問服務器，我們看到使用方式和目前Node.js的Cluster使用一樣。即使我們把reuseport改成false或者其他平臺跑也沒問題，效果如下

我們看到在reuseport的情況下，負載還是挺均衡的。

后記：目前是通過listen的時候傳入參數去控制是否開啟SO_RESUEPORT的，后續可以增加通過設置cluster.schedulingPolicy的方式，和目前共享、輪詢模式對齊，考慮到Cluster模塊不是必須，因為我們可以直接用子進程模塊監聽同一個端口。所以通過listen函數去控制是非常必要的。目前通過修改Node.js內核大概體驗了一下SO_RESUEPORT，后續review和改進一下代碼。

責任編輯：姜華來源：編程雜技