前言
swoole_client
提供了 tcp/udp socket
的客户端的封装代码,使用时仅需 new swoole_client
即可。 swoole
的 socket client
对比 PHP
提供的 stream
族函数有哪些好处:
-
stream
函数存在超时设置的陷阱和Bug
,一旦没处理好会导致Server
端长时间阻塞 -
fread
有8192
长度限制,无法支持UDP
的大包 -
swoole_client
支持waitall
,在有确定包长度时可一次取完,不必循环读取 -
swoole_client
支持UDP connect
,解决了UDP
串包问题 -
swoole_client
是纯C
的代码,专门处理socket
,stream
函数非常复杂。swoole_client
性能更好
除了普通的同步阻塞+select
的使用方法外,swoole_client
还支持异步非阻塞回调。
swoole_client::__construct
构造函数
构造函数的逻辑很简单,就是更新 swoole_client_class_entry_ptr
指针的 type
属性与 key
属性。
当 type
是异步客户端的时候,不能在 CLI
模式下使用 SWOOLE_KEEP
。
#define php_swoole_socktype(type) (type & (~SW_FLAG_SYNC) & (~SW_FLAG_ASYNC) & (~SW_FLAG_KEEP) & (~SW_SOCK_SSL))
static PHP_METHOD(swoole_client, __construct)
{
long async = 0;
long type = 0;
char *id = NULL;
zend_size_t len = 0;
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l|ls", &type, &async, &id, &len) == FAILURE)
{
swoole_php_fatal_error(E_ERROR, "socket type param is required.");
RETURN_FALSE;
}
if (async == 1)
{
type |= SW_FLAG_ASYNC;
}
if ((type & SW_FLAG_ASYNC))
{
if ((type & SW_FLAG_KEEP) && SWOOLE_G(cli))
{
swoole_php_fatal_error(E_ERROR, "The 'SWOOLE_KEEP' flag can only be used in the php-fpm or apache environment.");
}
php_swoole_check_reactor();
}
int client_type = php_swoole_socktype(type);
if (client_type < SW_SOCK_TCP || client_type > SW_SOCK_UNIX_STREAM)
{
swoole_php_fatal_error(E_ERROR, "Unknown client type '%d'.", client_type);
}
zend_update_property_long(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("type"), type TSRMLS_CC);
if (id)
{
zend_update_property_stringl(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("id"), id, len TSRMLS_CC);
}
else
{
zend_update_property_null(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("id") TSRMLS_CC);
}
//init
swoole_set_object(getThis(), NULL);
swoole_set_property(getThis(), client_property_callback, NULL);
#ifdef SWOOLE_SOCKETS_SUPPORT
swoole_set_property(getThis(), client_property_socket, NULL);
#endif
RETURN_TRUE;
}
swoole_client->set
属性设置
设置客户端参数,必须在 connect
前执行。本函数用于从 zend
中读出 client
的属性,并且和用户的配置参数合并。
static PHP_METHOD(swoole_client, set)
{
zval *zset;
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &zset) == FAILURE)
{
return;
}
if (Z_TYPE_P(zset) != IS_ARRAY)
{
RETURN_FALSE;
}
zval *zsetting = php_swoole_read_init_property(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("setting") TSRMLS_CC);
sw_php_array_merge(Z_ARRVAL_P(zsetting), Z_ARRVAL_P(zset));
RETURN_TRUE;
}
static sw_inline zval* php_swoole_read_init_property(zend_class_entry *scope, zval *object, const char *p, size_t pl TSRMLS_DC)
{
zval *property = sw_zend_read_property(scope, object, p, pl, 1 TSRMLS_CC);
if (property == NULL || ZVAL_IS_NULL(property))
{
SW_MAKE_STD_ZVAL(property);
array_init(property);
zend_update_property(scope, object, p, pl, property TSRMLS_CC);
sw_zval_ptr_dtor(&property);
return sw_zend_read_property(scope, object, p, pl, 1 TSRMLS_CC);
}
else
{
return property;
}
}
swoole_client->on
注册异步事件回调函数
注册异步事件回调函数,函数主要更新 swoole_client_class_entry_ptr
中的各个属性,并将其属性回调函数赋值给 client_property_callback
当中。
static PHP_METHOD(swoole_client, on)
{
char *cb_name;
zend_size_t cb_name_len;
zval *zcallback;
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sz", &cb_name, &cb_name_len, &zcallback) == FAILURE)
{
return;
}
zval *ztype = sw_zend_read_property(swoole_client_class_entry_ptr, getThis(), SW_STRL("type")-1, 0 TSRMLS_CC);
client_callback *cb = (client_callback *) swoole_get_property(getThis(), client_property_callback);
if (!cb)
{
cb = (client_callback *) emalloc(sizeof(client_callback));
bzero(cb, sizeof(client_callback));
swoole_set_property(getThis(), client_property_callback, cb);
}
if (strncasecmp("connect", cb_name, cb_name_len) == 0)
{
zend_update_property(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("onConnect"), zcallback TSRMLS_CC);
cb->onConnect = sw_zend_read_property(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("onConnect"), 0 TSRMLS_CC);
sw_copy_to_stack(cb->onConnect, cb->_onConnect);
#ifdef PHP_SWOOLE_ENABLE_FASTCALL
cb->cache_onConnect = func_cache;
#endif
}
else if (strncasecmp("receive", cb_name, cb_name_len) == 0)
{
zend_update_property(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("onReceive"), zcallback TSRMLS_CC);
cb->onReceive = sw_zend_read_property(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("onReceive"), 0 TSRMLS_CC);
sw_copy_to_stack(cb->onReceive, cb->_onReceive);
#ifdef PHP_SWOOLE_ENABLE_FASTCALL
cb->cache_onReceive = func_cache;
#endif
}
else if (strncasecmp("close", cb_name, cb_name_len) == 0)
{
zend_update_property(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("onClose"), zcallback TSRMLS_CC);
cb->onClose = sw_zend_read_property(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("onClose"), 0 TSRMLS_CC);
sw_copy_to_stack(cb->onClose, cb->_onClose);
#ifdef PHP_SWOOLE_ENABLE_FASTCALL
cb->cache_onClose = func_cache;
#endif
}
else if (strncasecmp("error", cb_name, cb_name_len) == 0)
{
zend_update_property(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("onError"), zcallback TSRMLS_CC);
cb->onError = sw_zend_read_property(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("onError"), 0 TSRMLS_CC);
sw_copy_to_stack(cb->onError, cb->_onError);
#ifdef PHP_SWOOLE_ENABLE_FASTCALL
cb->cache_onError = func_cache;
#endif
}
else if (strncasecmp("bufferFull", cb_name, cb_name_len) == 0)
{
zend_update_property(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("onBufferFull"), zcallback TSRMLS_CC);
cb->onBufferFull = sw_zend_read_property(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("onBufferFull"), 0 TSRMLS_CC);
sw_copy_to_stack(cb->onBufferFull, cb->_onBufferFull);
#ifdef PHP_SWOOLE_ENABLE_FASTCALL
cb->cache_onBufferFull = func_cache;
#endif
}
else if (strncasecmp("bufferEmpty", cb_name, cb_name_len) == 0)
{
zend_update_property(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("onBufferEmpty"), zcallback TSRMLS_CC);
cb->onBufferEmpty = sw_zend_read_property(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("onBufferEmpty"), 0 TSRMLS_CC);
sw_copy_to_stack(cb->onBufferEmpty, cb->_onBufferEmpty);
#ifdef PHP_SWOOLE_ENABLE_FASTCALL
cb->cache_onBufferEmpty = func_cache;
#endif
}
else
{
swoole_php_fatal_error(E_WARNING, "Unknown event callback type name '%s'.", cb_name);
RETURN_FALSE;
}
RETURN_TRUE;
}
swoole_client->connect
connect
connect
是客户端模块核心的函数。
-
PHP
内部函数使用zend_parse_parameters() API
接受参数,将输入参数转换成c
变量。不幸的是,每次调用这个函数时都要对这个这个字符串进行解析,这会加重性能开销。在PHP7中新提供的方式。是为了提高参数解析的性能。对应经常使用的方法,建议使用FAST ZPP
方式。 - 利用
php_swoole_client_new
函数创建一个swClient
客户端对象 - 如果是异步的
TCP
客户端,设置sock_flag
为 1,为后面的异步connect
的参数 - 如果客户端当前状态是激活而且是保持长连接的,直接返回成功,不需要再次连接。
- 根据配置参数,利用函数
php_swoole_client_check_setting
设置swClient
对象的属性 -
如果客户端是异步的:
- 如果是
TCP
客户端,需要验证是否设置了onConnect
、onError
、onClose
三个回调函数,如果没有返回错误。onBufferFull
、onBufferEmpty
是可选回调函数。 - 如果是
UDP
客户端,需要验证是否设置了onReceive
等函数,否则返回错误。onConnect
、onClose
两个函数是可选回调函数。 - 值得注意的是,
swClient
中的onConnect
等函数并没有直接使用用户的回调函数,而是使用client_onConnect
等函数,将用户的回调函数放在了cli->object
的属性中。
- 如果是
- 最后调用
connect
函数与服务端进行连接。
static PHP_METHOD(swoole_client, connect)
{
zend_long port = 0, sock_flag = 0;
char *host = NULL;
zend_size_t host_len;
double timeout = SW_CLIENT_DEFAULT_TIMEOUT;
#ifdef FAST_ZPP
ZEND_PARSE_PARAMETERS_START(1, 4)
Z_PARAM_STRING(host, host_len)
Z_PARAM_OPTIONAL
Z_PARAM_LONG(port)
Z_PARAM_DOUBLE(timeout)
Z_PARAM_LONG(sock_flag)
ZEND_PARSE_PARAMETERS_END();
#else
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|ldl", &host, &host_len, &port, &timeout, &sock_flag) == FAILURE)
{
return;
}
#endif
swClient *cli = (swClient *) swoole_get_object(getThis());
cli = php_swoole_client_new(getThis(), host, host_len, port);
swoole_set_object(getThis(), cli);
if (cli->type == SW_SOCK_TCP || cli->type == SW_SOCK_TCP6)
{
if (cli->async == 1)
{
//for tcp: nonblock
//for udp: have udp connect
sock_flag = 1;
}
}
if (cli->keep == 1 && cli->socket->active == 1)
{
zend_update_property_bool(swoole_client_class_entry_ptr, getThis(), SW_STRL("reuse")-1, 1 TSRMLS_CC);
RETURN_TRUE;
}
else if (cli->socket->active == 1)
{
swoole_php_fatal_error(E_WARNING, "connection to the server has already been established.");
RETURN_FALSE;
}
zval *zset = sw_zend_read_property(swoole_client_class_entry_ptr, getThis(), ZEND_STRL("setting"), 1 TSRMLS_CC);
if (zset && !ZVAL_IS_NULL(zset))
{
php_swoole_client_check_setting(cli, zset TSRMLS_CC);
}
//nonblock async
if (cli->async)
{
client_callback *cb = (client_callback *) swoole_get_property(getThis(), 0);
if (!cb)
{
swoole_php_fatal_error(E_ERROR, "no event callback function.");
RETURN_FALSE;
}
if (swSocket_is_stream(cli->type))
{
if (!cb->onConnect)
{
swoole_php_fatal_error(E_ERROR, "no 'onConnect' callback function.");
RETURN_FALSE;
}
if (!cb->onError)
{
swoole_php_fatal_error(E_ERROR, "no 'onError' callback function.");
RETURN_FALSE;
}
if (!cb->onClose)
{
swoole_php_fatal_error(E_ERROR, "no 'onClose' callback function.");
RETURN_FALSE;
}
cli->onConnect = client_onConnect;
cli->onClose = client_onClose;
cli->onError = client_onError;
cli->onReceive = client_onReceive;
cli->reactor_fdtype = PHP_SWOOLE_FD_STREAM_CLIENT;
if (cb->onBufferFull)
{
cli->onBufferFull = client_onBufferFull;
}
if (cb->onBufferEmpty)
{
cli->onBufferEmpty = client_onBufferEmpty;
}
}
else
{
if (!cb || !cb->onReceive)
{
swoole_php_fatal_error(E_ERROR, "no 'onReceive' callback function.");
RETURN_FALSE;
}
if (cb->onConnect)
{
cli->onConnect = client_onConnect;
}
if (cb->onClose)
{
cli->onClose = client_onClose;
}
cli->onReceive = client_onReceive;
cli->reactor_fdtype = PHP_SWOOLE_FD_DGRAM_CLIENT;
}
zval *zobject = getThis();
cli->object = zobject;
sw_copy_to_stack(cli->object, cb->_object);
sw_zval_add_ref(&zobject);
}
//nonblock async
if (cli->connect(cli, host, port, timeout, sock_flag) < 0)
{
if (errno == 0 )
{
if (SwooleG.error == SW_ERROR_DNSLOOKUP_RESOLVE_FAILED)
{
swoole_php_error(E_WARNING, "connect to server[%s:%d] failed. Error: %s[%d]", host, (int )port,
hstrerror(h_errno), h_errno);
}
zend_update_property_long(swoole_client_class_entry_ptr, getThis(), SW_STRL("errCode")-1, SwooleG.error TSRMLS_CC);
}
else
{
swoole_php_sys_error(E_WARNING, "connect to server[%s:%d] failed.", host, (int )port);
zend_update_property_long(swoole_client_class_entry_ptr, getThis(), SW_STRL("errCode")-1, errno TSRMLS_CC);
}
RETURN_FALSE;
}
RETURN_TRUE;
}
php_swoole_client_new
php_swoole_client_new
会新建一个 swClient
客户端对象,具体流程如下:
- 首先取出
type
属性,观察是否是异步客户端SW_FLAG_ASYNC
- 接着取出
id
属性,观察是否存在着connection_id
,如果没有传入connection_id
就要根据主域与端口号来创建connection_id
-
如果当前客户端要保持长连接,要试图从
php_sw_long_connections
中根据connection_id
取出客户端对象,复用连接- 如果
php_sw_long_connections
哈希表中并没有connection_id
,那么新申请一个swClient
放入哈希表中,并调到create_socket
创建客户端对象。 - 如果取出了客户端对象,那么要尝试接受数据,如果报错,说明连接已经失效,需要关闭该连接,并调到
create_socket
创建一个新的客户端对象;如果还可以使用连接,就递增reuse_count
,
- 如果
- 如果当前客户端不需要复用长连接,那么就利用
swClient_create
创建一个新的客户端
swClient* php_swoole_client_new(zval *object, char *host, int host_len, int port)
{
zval *ztype;
int async = 0;
char conn_key[SW_LONG_CONNECTION_KEY_LEN];
int conn_key_len = 0;
uint64_t tmp_buf;
int ret;
ztype = sw_zend_read_property(Z_OBJCE_P(object), object, SW_STRL("type")-1, 0 TSRMLS_CC);
long type = Z_LVAL_P(ztype);
//new flag, swoole-1.6.12+
if (type & SW_FLAG_ASYNC)
{
async = 1;
}
swClient *cli;
bzero(conn_key, SW_LONG_CONNECTION_KEY_LEN);
zval *connection_id = sw_zend_read_property(Z_OBJCE_P(object), object, ZEND_STRL("id"), 1 TSRMLS_CC);
if (connection_id == NULL || ZVAL_IS_NULL(connection_id))
{
conn_key_len = snprintf(conn_key, SW_LONG_CONNECTION_KEY_LEN, "%s:%d", host, port) + 1;
}
else
{
conn_key_len = snprintf(conn_key, SW_LONG_CONNECTION_KEY_LEN, "%s", Z_STRVAL_P(connection_id)) + 1;
}
//keep the tcp connection
if (type & SW_FLAG_KEEP)
{
swClient *find = swHashMap_find(php_sw_long_connections, conn_key, conn_key_len);
if (find == NULL)
{
cli = (swClient*) pemalloc(sizeof(swClient), 1);
if (swHashMap_add(php_sw_long_connections, conn_key, conn_key_len, cli) == FAILURE)
{
swoole_php_fatal_error(E_WARNING, "failed to add swoole_client_create_socket to hashtable.");
}
goto create_socket;
}
else
{
cli = find;
//try recv, check connection status
ret = recv(cli->socket->fd, &tmp_buf, sizeof(tmp_buf), MSG_DONTWAIT | MSG_PEEK);
if (ret == 0 || (ret < 0 && swConnection_error(errno) == SW_CLOSE))
{
cli->close(cli);
goto create_socket;
}
cli->reuse_count ++;
zend_update_property_long(Z_OBJCE_P(object), object, ZEND_STRL("reuseCount"), cli->reuse_count TSRMLS_CC);
}
}
else
{
cli = (swClient*) emalloc(sizeof(swClient));
create_socket:
if (swClient_create(cli, php_swoole_socktype(type), async) < 0)
{
swoole_php_fatal_error(E_WARNING, "swClient_create() failed. Error: %s [%d]", strerror(errno), errno);
zend_update_property_long(Z_OBJCE_P(object), object, ZEND_STRL("errCode"), errno TSRMLS_CC);
return NULL;
}
//don't forget free it
cli->server_str = sw_strndup(conn_key, conn_key_len);
cli->server_strlen = conn_key_len;
}
zend_update_property_long(Z_OBJCE_P(object), object, ZEND_STRL("sock"), cli->socket->fd TSRMLS_CC);
if (type & SW_FLAG_KEEP)
{
cli->keep = 1;
}
#ifdef SW_USE_OPENSSL
if (type & SW_SOCK_SSL)
{
cli->open_ssl = 1;
}
#endif
return cli;
}
swClient_create
- 创建客户端就是利用
type
类型来创建不同的socket
套接字 - 如果是异步客户端,设置客户端的
reactor
对象(可以分为reactor
线程和其他进程reactor
) - 设置
cli->socket
属性 - 如果是异步客户端,利用
cli->reactor->setHandle
设定reactor
的回调函数 - 根据异步或者同步、数据流或者数据报,设置
swClient
的各种函数
int swClient_create(swClient *cli, int type, int async)
{
int _domain;
int _type;
bzero(cli, sizeof(swClient));
switch (type)
{
case SW_SOCK_TCP:
_domain = AF_INET;
_type = SOCK_STREAM;
break;
case SW_SOCK_TCP6:
_domain = AF_INET6;
_type = SOCK_STREAM;
break;
case SW_SOCK_UNIX_STREAM:
_domain = AF_UNIX;
_type = SOCK_STREAM;
break;
case SW_SOCK_UDP:
_domain = AF_INET;
_type = SOCK_DGRAM;
break;
case SW_SOCK_UDP6:
_domain = AF_INET6;
_type = SOCK_DGRAM;
break;
case SW_SOCK_UNIX_DGRAM:
_domain = AF_UNIX;
_type = SOCK_DGRAM;
break;
default:
return SW_ERR;
}
#ifdef SOCK_CLOEXEC
int sockfd = socket(_domain, _type | SOCK_CLOEXEC, 0);
#else
int sockfd = socket(_domain, _type, 0);
#endif
if (sockfd < 0)
{
swWarn("socket() failed. Error: %s[%d]", strerror(errno), errno);
return SW_ERR;
}
if (async)
{
if (swIsMaster() && SwooleTG.type == SW_THREAD_REACTOR)
{
cli->reactor = SwooleTG.reactor;
}
else
{
cli->reactor = SwooleG.main_reactor;
}
cli->socket = swReactor_get(cli->reactor, sockfd);
}
else
{
cli->socket = sw_malloc(sizeof(swConnection));
}
cli->buffer_input_size = SW_CLIENT_BUFFER_SIZE;
bzero(cli->socket, sizeof(swConnection));
cli->socket->fd = sockfd;
cli->socket->object = cli;
if (async)
{
swSetNonBlock(cli->socket->fd);
if (!swReactor_handle_isset(cli->reactor, SW_FD_STREAM_CLIENT))
{
cli->reactor->setHandle(cli->reactor, SW_FD_STREAM_CLIENT | SW_EVENT_READ, swClient_onStreamRead);
cli->reactor->setHandle(cli->reactor, SW_FD_DGRAM_CLIENT | SW_EVENT_READ, swClient_onDgramRead);
cli->reactor->setHandle(cli->reactor, SW_FD_STREAM_CLIENT | SW_EVENT_WRITE, swClient_onWrite);
cli->reactor->setHandle(cli->reactor, SW_FD_STREAM_CLIENT | SW_EVENT_ERROR, swClient_onError);
}
}
if (swSocket_is_stream(type))
{
cli->recv = swClient_tcp_recv_no_buffer;
if (async)
{
cli->connect = swClient_tcp_connect_async;
cli->send = swClient_tcp_send_async;
cli->sendfile = swClient_tcp_sendfile_async;
cli->pipe = swClient_tcp_pipe;
cli->socket->dontwait = 1;
}
else
{
cli->connect = swClient_tcp_connect_sync;
cli->send = swClient_tcp_send_sync;
cli->sendfile = swClient_tcp_sendfile_sync;
}
cli->reactor_fdtype = SW_FD_STREAM_CLIENT;
}
else
{
cli->connect = swClient_udp_connect;
cli->recv = swClient_udp_recv;
cli->send = swClient_udp_send;
cli->reactor_fdtype = SW_FD_DGRAM_CLIENT;
}
cli->_sock_domain = _domain;
cli->_sock_type = _type;
cli->close = swClient_close;
cli->type = type;
cli->async = async;
cli->protocol.package_length_type = 'N';
cli->protocol.package_length_size = 4;
cli->protocol.package_body_offset = 0;
cli->protocol.package_max_length = SW_BUFFER_INPUT_SIZE;
cli->protocol.onPackage = swClient_onPackage;
return SW_OK;
}
swClient_tcp_connect_async
异步客户端数据流连接
- 对于异步的数据流连接来说,首先要验证
onConnect
、onError
、onClose
回调函数不能少。 -
swClient_inet_addr
用于为cli->server_addr.addr
赋值,主要是要利用htons
、inet_pton
转化数值。 - 对于异步的客户端来说
cli->wait_dns
是 1,需要AIO
模块来异步加载DNS
,进行swAio_dispatch
之后本函数就会立刻返回true
- 当
AIO
模块解析了DNS
之后,cli->wait_dns
会被重置为 0,再次调用本函数swClient_tcp_connect_async
- 调用
connect
函数进行建立连接,遇到EINTR
信号中断要进行重试 - 当错误是
EINPROGRESS
的时候,将套接字放入reactor
中,并设置超时时间。当我们以非阻塞的方式来进行连接的时候,返回的结果如果是 -1, 这并不代表这次连接发生了错误,如果它的返回结果是EINPROGRESS
,那么就代表连接还在进行中。 后面可以将套接字放入reactor
中,如果可以写,说明连接完成了。
static int swClient_tcp_connect_async(swClient *cli, char *host, int port, double timeout, int nonblock)
{
int ret;
cli->timeout = timeout;
if (!cli->buffer)
{
//alloc input memory buffer
cli->buffer = swString_new(cli->buffer_input_size);
if (!cli->buffer)
{
return SW_ERR;
}
}
if (!(cli->onConnect && cli->onError && cli->onClose))
{
swWarn("onConnect/onError/onClose callback have not set.");
return SW_ERR;
}
if (cli->onBufferFull && cli->buffer_high_watermark == 0)
{
cli->buffer_high_watermark = cli->socket->buffer_size * 0.8;
}
if (swClient_inet_addr(cli, host, port) < 0)
{
return SW_ERR;
}
if (cli->wait_dns)
{
if (SwooleAIO.init == 0)
{
swAio_init();
}
swAio_event ev;
bzero(&ev, sizeof(swAio_event));
int len = strlen(cli->server_host);
if (strlen(cli->server_host) < SW_IP_MAX_LENGTH)
{
ev.nbytes = SW_IP_MAX_LENGTH;
}
else
{
ev.nbytes = len + 1;
}
ev.buf = sw_malloc(ev.nbytes);
if (!ev.buf)
{
swWarn("malloc failed.");
return SW_ERR;
}
memcpy(ev.buf, cli->server_host, len);
((char *) ev.buf)[len] = 0;
ev.flags = cli->_sock_domain;
ev.type = SW_AIO_GETHOSTBYNAME;
ev.object = cli;
ev.fd = cli->socket->fd;
ev.callback = swClient_onResolveCompleted;
if (swAio_dispatch(&ev) < 0)
{
sw_free(ev.buf);
return SW_ERR;
}
else
{
return SW_OK;
}
}
while (1)
{
ret = connect(cli->socket->fd, (struct sockaddr *) &cli->server_addr.addr, cli->server_addr.len);
if (ret < 0)
{
if (errno == EINTR)
{
continue;
}
SwooleG.error = errno;
}
break;
}
if ((ret < 0 && errno == EINPROGRESS) || ret == 0)
{
if (cli->reactor->add(cli->reactor, cli->socket->fd, cli->reactor_fdtype | SW_EVENT_WRITE) < 0)
{
return SW_ERR;
}
if (timeout > 0)
{
if (SwooleG.timer.fd == 0)
{
swTimer_init((int) (timeout * 1000));
}
cli->timer = SwooleG.timer.add(&SwooleG.timer, (int) (timeout * 1000), 0, cli, swClient_onTimeout);
}
return SW_OK;
}
return ret;
}
swClient_inet_addr
转化地址
为了解决大端小端问题,就不能直接在 connect
函数参数中传数组,而是应该利用 htons
、inet_pton
等函数进行转化。
static int swClient_inet_addr(swClient *cli, char *host, int port)
{
...
cli->server_host = host;
cli->server_port = port;
void *addr = NULL;
if (cli->type == SW_SOCK_TCP || cli->type == SW_SOCK_UDP)
{
cli->server_addr.addr.inet_v4.sin_family = AF_INET;
cli->server_addr.addr.inet_v4.sin_port = htons(port);
cli->server_addr.len = sizeof(cli->server_addr.addr.inet_v4);
addr = &cli->server_addr.addr.inet_v4.sin_addr.s_addr;
if (inet_pton(AF_INET, host, addr))
{
return SW_OK;
}
}
else if (cli->type == SW_SOCK_TCP6 || cli->type == SW_SOCK_UDP6)
{
cli->server_addr.addr.inet_v6.sin6_family = AF_INET6;
cli->server_addr.addr.inet_v6.sin6_port = htons(port);
cli->server_addr.len = sizeof(cli->server_addr.addr.inet_v6);
addr = cli->server_addr.addr.inet_v6.sin6_addr.s6_addr;
if (inet_pton(AF_INET6, host, addr))
{
return SW_OK;
}
}
else if (cli->type == SW_SOCK_UNIX_STREAM || cli->type == SW_SOCK_UNIX_DGRAM)
{
cli->server_addr.addr.un.sun_family = AF_UNIX;
strncpy(cli->server_addr.addr.un.sun_path, host, sizeof(cli->server_addr.addr.un.sun_path) - 1);
cli->server_addr.addr.un.sun_path[sizeof(cli->server_addr.addr.un.sun_path) - 1] = 0;
cli->server_addr.len = sizeof(cli->server_addr.addr.un.sun_path);
return SW_OK;
}
else
{
return SW_ERR;
}
if (!cli->async)
{
...
}
else
{
cli->wait_dns = 1;
}
return SW_OK;
}
AIO
异步 DNS
解析
所谓的 AIO
异步并不是操作系统中真正的异步系统调用,而是 swoole
利用线程池 + reactor
实现的异步任务系统,当线程完成任务后,就会执行相应的 callback
函数,这里 DNS
异步解析事件的回调函数就是 swClient_onResolveCompleted
:
static void swClient_onResolveCompleted(swAio_event *event)
{
swConnection *socket = swReactor_get(SwooleG.main_reactor, event->fd);
if (socket->removed)
{
sw_free(event->buf);
return;
}
swClient *cli = event->object;
cli->wait_dns = 0;
if (event->error == 0)
{
swClient_tcp_connect_async(cli, event->buf, cli->server_port, cli->timeout, 1);
}
else
{
SwooleG.error = SW_ERROR_DNSLOOKUP_RESOLVE_FAILED;
cli->socket->removed = 1;
cli->close(cli);
if (cli->onError)
{
cli->onError(cli);
}
}
sw_free(event->buf);
}
DNS
解析
DNS
具体的解析函数是 swoole_gethostbyname
:
- 获取
DNS
的方法有两种:gethostbyname2_r
与gethostbyname2
,gethostbyname2_r
是线程安全函数,可以用于多线程。 -
gethostbyname2_r
中的第四个参数buf
用于存放临时数据 - 主机的
ip
地址可能会有多个,函数只把第一个ip
地址复制到addr
中。
struct hostent {
char *h_name; //主机的规范名
char **h_aliases; //主机的别名
int h_addrtype;//主机ip地址的类型,到底是(AF_INET),还是(AF_INET6)
int h_length;//主机ip地址的长度
char **h_addr_list;//主机的ip地址
};
#ifdef HAVE_GETHOSTBYNAME2_R
int swoole_gethostbyname(int flags, char *name, char *addr)
{
int __af = flags & (~SW_DNS_LOOKUP_RANDOM);
int index = 0;
int rc, err;
int buf_len = 256;
struct hostent hbuf;
struct hostent *result;
char *buf = (char*) sw_malloc(buf_len);
memset(buf, 0, buf_len);
while ((rc = gethostbyname2_r(name, __af, &hbuf, buf, buf_len, &result, &err)) == ERANGE)
{
buf_len *= 2;
void *tmp = sw_realloc(buf, buf_len);
if (NULL == tmp)
{
sw_free(buf);
return SW_ERR;
}
else
{
buf = tmp;
}
}
if (0 != rc || NULL == result)
{
sw_free(buf);
return SW_ERR;
}
union
{
char v4[INET_ADDRSTRLEN];
char v6[INET6_ADDRSTRLEN];
} addr_list[SW_DNS_HOST_BUFFER_SIZE];
int i = 0;
for (i = 0; i < SW_DNS_HOST_BUFFER_SIZE; i++)
{
if (hbuf.h_addr_list[i] == NULL)
{
break;
}
if (__af == AF_INET)
{
memcpy(addr_list[i].v4, hbuf.h_addr_list[i], hbuf.h_length);
}
else
{
memcpy(addr_list[i].v6, hbuf.h_addr_list[i], hbuf.h_length);
}
}
if (__af == AF_INET)
{
memcpy(addr, addr_list[index].v4, hbuf.h_length);
}
else
{
memcpy(addr, addr_list[index].v6, hbuf.h_length);
}
sw_free(buf);
return SW_OK;
}
#else
int swoole_gethostbyname(int flags, char *name, char *addr)
{
int __af = flags & (~SW_DNS_LOOKUP_RANDOM);
int index = 0;
struct hostent *host_entry;
if (!(host_entry = gethostbyname2(name, __af)))
{
return SW_ERR;
}
union
{
char v4[INET_ADDRSTRLEN];
char v6[INET6_ADDRSTRLEN];
} addr_list[SW_DNS_HOST_BUFFER_SIZE];
int i = 0;
for (i = 0; i < SW_DNS_HOST_BUFFER_SIZE; i++)
{
if (host_entry->h_addr_list[i] == NULL)
{
break;
}
if (__af == AF_INET)
{
memcpy(addr_list[i].v4, host_entry->h_addr_list[i], host_entry->h_length);
}
else
{
memcpy(addr_list[i].v6, host_entry->h_addr_list[i], host_entry->h_length);
}
}
if (__af == AF_INET)
{
memcpy(addr, addr_list[index].v4, host_entry->h_length);
}
else
{
memcpy(addr, addr_list[index].v6, host_entry->h_length);
}
return SW_OK;
}
#endif
swClient_tcp_connect_sync
同步数据流连接
- 与异步的
TCP
连接类似,函数首先要调用swClient_inet_addr
来转化主域与端口号,如果inet_pton
函数返回成功,说明并不需要进行DNS
解析,直接返回;否则就要同步调用swoole_gethostbyname
函数进行DNS
的解析。 - 利用
swSocket_set_timeout
函数为套接字设置超时时间。 - 如果使用
openssl
要进行SSL
握手。
static int swClient_inet_addr(swClient *cli, char *host, int port)
{
...
if (!cli->async)
{
if (swoole_gethostbyname(cli->_sock_domain, host, addr) < 0)
{
SwooleG.error = SW_ERROR_DNSLOOKUP_RESOLVE_FAILED;
return SW_ERR;
}
}
...
}
int swSocket_set_timeout(int sock, double timeout)
{
int ret;
struct timeval timeo;
timeo.tv_sec = (int) timeout;
timeo.tv_usec = (int) ((timeout - timeo.tv_sec) * 1000 * 1000);
ret = setsockopt(sock, SOL_SOCKET, SO_SNDTIMEO, (void *) &timeo, sizeof(timeo));
if (ret < 0)
{
swWarn("setsockopt(SO_SNDTIMEO) failed. Error: %s[%d]", strerror(errno), errno);
return SW_ERR;
}
ret = setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, (void *) &timeo, sizeof(timeo));
if (ret < 0)
{
swWarn("setsockopt(SO_RCVTIMEO) failed. Error: %s[%d]", strerror(errno), errno);
return SW_ERR;
}
return SW_OK;
}
static int swClient_tcp_connect_sync(swClient *cli, char *host, int port, double timeout, int nonblock)
{
int ret, n;
char buf[1024];
cli->timeout = timeout;
if (swClient_inet_addr(cli, host, port) < 0)
{
return SW_ERR;
}
if (nonblock == 1)
{
swSetNonBlock(cli->socket->fd);
}
else
{
if (cli->timeout > 0)
{
swSocket_set_timeout(cli->socket->fd, timeout);
}
}
while (1)
{
ret = connect(cli->socket->fd, (struct sockaddr *) &cli->server_addr.addr, cli->server_addr.len);
#endif
if (ret < 0)
{
if (errno == EINTR)
{
continue;
}
}
break;
}
if (ret >= 0)
{
cli->socket->active = 1;
#ifdef SW_USE_OPENSSL
if (cli->open_ssl)
{
if (swClient_enable_ssl_encrypt(cli) < 0)
{
return SW_ERR;
}
if (swClient_ssl_handshake(cli) < 0)
{
return SW_ERR;
}
}
#endif
}
return ret;
}
SSL
客户端加密
- 其过程与服务端
SSL
隧道加密流程相似,首先需要创建上下文swSSL_get_context
;如果要验证对端证书,需要调用swSSL_set_capath
设置证书地址;如果使用http2
协商,要使用SSL_CTX_set_alpn_protos
函数设置h2
-
创建上下文之后,就可以利用
swSSL_create
创建SSL
对象绑定套接字,并利用SSL_set_tlsext_host_name
设置SSL
主域,SSL_set_tlsext_host_name(s,name)
函数来设置ClientHello
中的Server Name
SNI
是Server Name Indication
的缩写,是为了解决一个服务器使用多个域名和证书的SSL/TLS
扩展。它允许客户端在发起SSL
握手请求时(客户端发出ClientHello
消息中)提交请求的HostName
信息,使得服务器能够切换到正确的域并返回相应的证书。在
SNI
出现之前,HostName
信息只存在于HTTP
请求中,但SSL/TLS
层无法获知这一信息。通过将HostName
的信息加入到SNI
扩展中,SSL/TLS
允许服务器使用一个IP
为不同的域名提供不同的证书,从而能够与使用同一个IP
的多个“虚拟主机”更方便地建立安全连接。 -
swSSL_connect
函数进行SSL
握手连接 - 如果要验证服务端证书,则调用
swClient_ssl_verify
函数。
int swClient_enable_ssl_encrypt(swClient *cli)
{
cli->ssl_context = swSSL_get_context(&cli->ssl_option);
if (cli->ssl_context == NULL)
{
return SW_ERR;
}
if (cli->ssl_option.verify_peer)
{
if (swSSL_set_capath(&cli->ssl_option, cli->ssl_context) < 0)
{
return SW_ERR;
}
}
cli->socket->ssl_send = 1;
#if defined(SW_USE_HTTP2) && defined(SW_USE_OPENSSL) && OPENSSL_VERSION_NUMBER >= 0x10002000L
if (cli->http2)
{
if (SSL_CTX_set_alpn_protos(cli->ssl_context, (const unsigned char *) "\x02h2", 3) < 0)
{
return SW_ERR;
}
}
#endif
return SW_OK;
}
int swClient_ssl_handshake(swClient *cli)
{
if (!cli->socket->ssl)
{
if (swSSL_create(cli->socket, cli->ssl_context, SW_SSL_CLIENT) < 0)
{
return SW_ERR;
}
#ifdef SSL_CTRL_SET_TLSEXT_HOSTNAME
if (cli->ssl_option.tls_host_name)
{
SSL_set_tlsext_host_name(cli->socket->ssl, cli->ssl_option.tls_host_name);
}
#endif
}
if (swSSL_connect(cli->socket) < 0)
{
return SW_ERR;
}
if (cli->socket->ssl_state == SW_SSL_STATE_READY && cli->ssl_option.verify_peer)
{
if (swClient_ssl_verify(cli, cli->ssl_option.allow_self_signed) < 0)
{
return SW_ERR;
}
}
return SW_OK;
}
swSSL_set_capath
提供可信任证书库:
// 在创建上下文结构之后,必须加载一个可信任证书库。这是成功验证每个证书所必需的。
// 如果不能确认证书是可信任的,那么 OpenSSL 会将证书标记为无效(但连接仍可以继续)。
// OpenSSL 附带了一组可信任证书。它们位于源文件目录树的 certs/demo 目录中。
// 不过,每个证书都是一个独立的文件,也就是说,需要单独加载每一个证书。
// 在 certs 目录下,还有一个 expired 存放过期证书的子目录,试图加载这些证书将会出错。
// 在数字证书进行信任验证之前,
// 必须为在为安全连接设置时创建的 OpenSSL SSL_CTX 对象提供一个默认的信任证书,
// 这可以使用几种方法来提供,
// 但是最简单的方法是将这个证书保存为一个 PEM 文件,
// 并使用
// SSL_CTX_load_verify_locations( ctx, file, path );
// 将其加载到 OpenSSL 中。
// 该函数有三个参数:
// ctx - 上下文指针( SSL_CTX_new 函数返回 );
// file - 包含一个或多个 PEM 格式的证书的文件的路径(必需);
// path - 到一个或多个 PEM 格式文件的路径,不过文件名必须使用特定的格式(可为 NULL);
// 如果指定成功,则返回 1 ,如果遇到问题,则返回 0 。
// 尽管当信任证书在一个目录中有多个单独的文件时更容易添加或更新,
// 但是您不太可能会如此频繁地更新信任证书,因此不必担心这个问题。
int swSSL_set_capath(swSSL_option *cfg, SSL_CTX *ctx)
{
if (cfg->cafile || cfg->capath)
{
if (!SSL_CTX_load_verify_locations(ctx, cfg->cafile, cfg->capath))
{
return SW_ERR;
}
}
else
{
if (!SSL_CTX_set_default_verify_paths(ctx))
{
swWarn("Unable to set default verify locations and no CA settings specified.");
return SW_ERR;
}
}
if (cfg->verify_depth > 0)
{
SSL_CTX_set_verify_depth(ctx, cfg->verify_depth);
}
return SW_OK;
}
swSSL_connect
函数就是简单调用 SSL_connect
来连接服务端:
int swSSL_connect(swConnection *conn)
{
int n = SSL_connect(conn->ssl);
if (n == 1)
{
conn->ssl_state = SW_SSL_STATE_READY;
conn->ssl_want_read = 0;
conn->ssl_want_write = 0;
#ifdef SW_LOG_TRACE_OPEN
const char *ssl_version = SSL_get_version(conn->ssl);
const char *ssl_cipher = SSL_get_cipher_name(conn->ssl);
swTraceLog(SW_TRACE_SSL, "connected (%s %s)", ssl_version, ssl_cipher);
#endif
return SW_OK;
}
long err = SSL_get_error(conn->ssl, n);
if (err == SSL_ERROR_WANT_READ)
{
conn->ssl_want_read = 1;
conn->ssl_want_write = 0;
conn->ssl_state = SW_SSL_STATE_WAIT_STREAM;
return SW_OK;
}
else if (err == SSL_ERROR_WANT_WRITE)
{
conn->ssl_want_read = 0;
conn->ssl_want_write = 1;
conn->ssl_state = SW_SSL_STATE_WAIT_STREAM;
return SW_OK;
}
else if (err == SSL_ERROR_ZERO_RETURN)
{
swDebug("SSL_connect(fd=%d) closed.", conn->fd);
return SW_ERR;
}
else if (err == SSL_ERROR_SYSCALL)
{
if (n)
{
SwooleG.error = errno;
return SW_ERR;
}
}
swWarn("SSL_connect(fd=%d) failed. Error: %s[%ld|%d].", conn->fd, ERR_reason_error_string(err), err, errno);
return SW_ERR;
}
swClient_ssl_verify
验证连接的有效性:
// 连接建立后,必须检查证书,以确定它是否有效。
// 实际上,OpenSSL 为我们完成了这项任务。
// 如果证书有致命的问题(例如,哈希值无效),那么将无法建立连接。
// 但是,如果证书的问题并不是致命的(当它已经过期或者尚不合法时),那么仍可以继续使用连接。
// 可以将 SSL 结构作为惟一参数,
// 调用 SSL_get_verify_result 来查明证书是否通过了 OpenSSL 的检验。
// 如果证书通过了包括信任检查在内的 OpenSSL 的内部检查,则返回 X509_V_OK。
// 如果有地方出了问题,则返回一个错误代码,在 OpenSSL 文档的 verify 部分中都进行了介绍。
// 注:该错误代码被记录在命令行工具的 verify 选项下。
// 应该注意的是,验证失败并不意味着连接不能使用。
// 是否应该使用连接取决于验证结果和安全方面的考虑。
// 例如,失败的信任验证可能只是意味着没有可信任的证书。
// 连接仍然可用,只是需要从思想上提高安全意识。
// OpenSSL 在对证书进行验证时,有一些安全性检查并没有执行,
// 包括证书的失效检查和对证书中通用名的有效性验证。
int swClient_ssl_verify(swClient *cli, int allow_self_signed)
{
if (swSSL_verify(cli->socket, allow_self_signed) < 0)
{
return SW_ERR;
}
if (cli->ssl_option.tls_host_name && swSSL_check_host(cli->socket, cli->ssl_option.tls_host_name) < 0)
{
return SW_ERR;
}
return SW_OK;
}
int swSSL_verify(swConnection *conn, int allow_self_signed)
{
int err = SSL_get_verify_result(conn->ssl);
switch (err)
{
case X509_V_OK:
return SW_OK;
case X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT:
if (allow_self_signed)
{
return SW_OK;
}
else
{
return SW_ERR;
}
default:
swoole_error_log(SW_LOG_NOTICE, SW_ERROR_SSL_VEFIRY_FAILED, "Could not verify peer: code:%d %s", err, X509_verify_cert_error_string(err));
return SW_ERR;
}
return SW_ERR;
}
验证了证书的有效性之后,还要验证域名的统一。高版本可以直接使用 X509_check_host
函数验证。
int swSSL_check_host(swConnection *conn, char *tls_host_name)
{
X509 *cert = SSL_get_peer_certificate(conn->ssl);
if (cert == NULL)
{
return SW_ERR;
}
#ifdef X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT
/* X509_check_host() is only available in OpenSSL 1.0.2+ */
if (X509_check_host(cert, tls_host_name, strlen(tls_host_name), 0, NULL) != 1)
{
swWarn("X509_check_host(): no match");
goto failed;
}
goto found;
#else
...
failed: X509_free(cert);
return SW_ERR;
found: X509_free(cert);
return SW_OK;
}
swClient_udp_connect
数据报连接
- 对于
UDP
来说,swoole
并不会connect
服务端进行三次握手,只是会调用bind
来绑定本机的一个随机端口,这个时候客户端可以接受任何服务端发来的消息。 -
如果调用
connect
函数的时候指定了第 5 个参数为true
,那么就会调用connect
函数,这时候虽然客户端仍然不会进行三次握手,但是却只能接受特定服务端发来的消息调用了
connect
之后的UDP
特点:- 不需要给输出操作指定目的IP和目的端口,写到UDP的缓冲区里的数据,将自动发送到你调用connect指定的IP和端口。
- 在一个已连接的UDP套接字上,内核由输入操作返回的数据报只有那些来自connect所指定的协议地址的数据报。目的地为这个已连接的UDP套接字的本地协议地址(IP和端口),远端地址不是该套接字早先connect到的协议地址的数据报,不会投递到该套接字。这样就限制了已连接的UDP套接字能且只能与一个对端交换数据报。
- 由已连接的套接字引发的异步错误发回给他们所在的进程,而未连接的UDP套接字不接受任何异步错误。
- 读写的操作接口方法增多了,除了可以使用sendto和recvfrom的接口外,还可以使用tcp的那套操作接口--read/readv/readmsg和write/writev等
-
UDP
客户端可选设置onConnect
,socket
创建成功会立即回调onConnect
static int swClient_udp_connect(swClient *cli, char *host, int port, double timeout, int udp_connect)
{
if (swClient_inet_addr(cli, host, port) < 0)
{
return SW_ERR;
}
cli->socket->active = 1;
cli->timeout = timeout;
int bufsize = SwooleG.socket_buffer_size;
if (timeout > 0)
{
swSocket_set_timeout(cli->socket->fd, timeout);
}
if (cli->type == SW_SOCK_UNIX_DGRAM)
{
struct sockaddr_un* client_addr = &cli->socket->info.addr.un;
sprintf(client_addr->sun_path, "/tmp/swoole-client.%d.%d.sock", getpid(), cli->socket->fd);
client_addr->sun_family = AF_UNIX;
unlink(client_addr->sun_path);
if (bind(cli->socket->fd, (struct sockaddr *) client_addr, sizeof(cli->socket->info.addr.un)) < 0)
{
swSysError("bind(%s) failed.", client_addr->sun_path);
return SW_ERR;
}
}
if (udp_connect != 1)
{
goto connect_ok;
}
if (connect(cli->socket->fd, (struct sockaddr *) (&cli->server_addr), cli->server_addr.len) == 0)
{
swSocket_clean(cli->socket->fd);
connect_ok:
setsockopt(cli->socket->fd, SOL_SOCKET, SO_SNDBUF, &bufsize, sizeof(bufsize));
setsockopt(cli->socket->fd, SOL_SOCKET, SO_RCVBUF, &bufsize, sizeof(bufsize));
if (cli->async && cli->onConnect)
{
if (cli->reactor->add(cli->reactor, cli->socket->fd, cli->reactor_fdtype | SW_EVENT_READ) < 0)
{
return SW_ERR;
}
execute_onConnect(cli);
}
return SW_OK;
}
else
{
swSysError("connect() failed.");
cli->socket->active = 0;
cli->socket->removed = 1;
return SW_ERR;
}
}
swoole_client->isConnected
异步连接判定
static PHP_METHOD(swoole_client, isConnected)
{
swClient *cli = (swClient *) swoole_get_object(getThis());
if (!cli)
{
RETURN_FALSE;
}
if (!cli->socket)
{
RETURN_FALSE;
}
RETURN_BOOL(cli->socket->active);
}
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。