1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
|
/* SPDX-License-Identifier: MIT */
/*
* Simple ping/pong backend which can use the io_uring NAPI support.
*
* Needs to be run as root because it sets SCHED_FIFO scheduling class,
* but will work without that.
*
* Example:
*
* sudo examples/napi-busy-poll-server -l -a 192.168.2.2 -n100000 \
* -p4444 -t10 -b -u
*
* will respond to 100k packages, using NAPI.
*/
#include <ctype.h>
#include <errno.h>
#include <getopt.h>
#include <liburing.h>
#include <math.h>
#include <sched.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <time.h>
#include <unistd.h>
#include <arpa/inet.h>
#include <netdb.h>
#include <netinet/in.h>
#define MAXBUFLEN 100
#define PORTNOLEN 10
#define ADDRLEN 80
#define RINGSIZE 1024
#define printable(ch) (isprint((unsigned char)ch) ? ch : '#')
enum {
IOURING_RECV,
IOURING_SEND,
IOURING_RECVMSG,
IOURING_SENDMSG
};
struct ctx
{
struct io_uring ring;
union {
struct sockaddr_in6 saddr6;
struct sockaddr_in saddr;
};
struct iovec iov;
struct msghdr msg;
int sockfd;
int buffer_len;
int num_pings;
bool napi_check;
union {
char buffer[MAXBUFLEN];
struct timespec ts;
};
};
struct options
{
int num_pings;
__u32 timeout;
bool listen;
bool defer_tw;
bool sq_poll;
bool busy_loop;
bool prefer_busy_poll;
bool ipv6;
char port[PORTNOLEN];
char addr[ADDRLEN];
};
static struct options opt;
static struct option longopts[] =
{
{"address" , 1, NULL, 'a'},
{"busy" , 0, NULL, 'b'},
{"help" , 0, NULL, 'h'},
{"listen" , 0, NULL, 'l'},
{"num_pings", 1, NULL, 'n'},
{"port" , 1, NULL, 'p'},
{"prefer" , 1, NULL, 'u'},
{"sqpoll" , 0, NULL, 's'},
{"timeout" , 1, NULL, 't'},
{NULL , 0, NULL, 0 }
};
static void printUsage(const char *name)
{
fprintf(stderr,
"Usage: %s [-l|--listen] [-a|--address ip_address] [-p|--port port-no] [-s|--sqpoll]"
" [-b|--busy] [-n|--num pings] [-t|--timeout busy-poll-timeout] [-u|--prefer] [-6] [-h|--help]\n"
" --listen\n"
"-l : Server mode\n"
"--address\n"
"-a : remote or local ipv6 address\n"
"--busy\n"
"-b : busy poll io_uring instead of blocking.\n"
"--num_pings\n"
"-n : number of pings\n"
"--port\n"
"-p : port\n"
"--sqpoll\n"
"-s : Configure io_uring to use SQPOLL thread\n"
"--timeout\n"
"-t : Configure NAPI busy poll timeout"
"--prefer\n"
"-u : prefer NAPI busy poll\n"
"-6 : use IPV6\n"
"--help\n"
"-h : Display this usage message\n\n",
name);
}
static void printError(const char *msg, int opt)
{
if (msg && opt)
fprintf(stderr, "%s (-%c)\n", msg, printable(opt));
}
static void setProcessScheduler(void)
{
struct sched_param param;
param.sched_priority = sched_get_priority_max(SCHED_FIFO);
if (sched_setscheduler(0, SCHED_FIFO, ¶m) < 0)
fprintf(stderr, "sched_setscheduler() failed: (%d) %s\n",
errno, strerror(errno));
}
static uint64_t encodeUserData(char type, int fd)
{
return (uint32_t)fd | ((__u64)type << 56);
}
static void decodeUserData(uint64_t data, char *type, int *fd)
{
*type = data >> 56;
*fd = data & 0xffffffffU;
}
static const char *opTypeToStr(char type)
{
const char *res;
switch (type) {
case IOURING_RECV:
res = "IOURING_RECV";
break;
case IOURING_SEND:
res = "IOURING_SEND";
break;
case IOURING_RECVMSG:
res = "IOURING_RECVMSG";
break;
case IOURING_SENDMSG:
res = "IOURING_SENDMSG";
break;
default:
res = "Unknown";
}
return res;
}
static void reportNapi(struct ctx *ctx)
{
unsigned int napi_id = 0;
socklen_t len = sizeof(napi_id);
getsockopt(ctx->sockfd, SOL_SOCKET, SO_INCOMING_NAPI_ID, &napi_id, &len);
if (napi_id)
printf(" napi id: %d\n", napi_id);
else
printf(" unassigned napi id\n");
ctx->napi_check = true;
}
static void sendPing(struct ctx *ctx)
{
struct io_uring_sqe *sqe = io_uring_get_sqe(&ctx->ring);
io_uring_prep_sendmsg(sqe, ctx->sockfd, &ctx->msg, 0);
sqe->user_data = encodeUserData(IOURING_SENDMSG, ctx->sockfd);
}
static void receivePing(struct ctx *ctx)
{
struct io_uring_sqe *sqe;
bzero(&ctx->msg, sizeof(struct msghdr));
if (opt.ipv6) {
ctx->msg.msg_name = &ctx->saddr6;
ctx->msg.msg_namelen = sizeof(struct sockaddr_in6);
} else {
ctx->msg.msg_name = &ctx->saddr;
ctx->msg.msg_namelen = sizeof(struct sockaddr_in);
}
ctx->iov.iov_base = ctx->buffer;
ctx->iov.iov_len = MAXBUFLEN;
ctx->msg.msg_iov = &ctx->iov;
ctx->msg.msg_iovlen = 1;
sqe = io_uring_get_sqe(&ctx->ring);
io_uring_prep_recvmsg(sqe, ctx->sockfd, &ctx->msg, 0);
sqe->user_data = encodeUserData(IOURING_RECVMSG, ctx->sockfd);
}
static void completion(struct ctx *ctx, struct io_uring_cqe *cqe)
{
char type;
int fd;
int res = cqe->res;
decodeUserData(cqe->user_data, &type, &fd);
if (res < 0) {
fprintf(stderr, "unexpected %s failure: (%d) %s\n",
opTypeToStr(type), -res, strerror(-res));
abort();
}
switch (type) {
case IOURING_SENDMSG:
receivePing(ctx);
--ctx->num_pings;
break;
case IOURING_RECVMSG:
ctx->iov.iov_len = res;
sendPing(ctx);
if (!ctx->napi_check)
reportNapi(ctx);
break;
default:
fprintf(stderr, "unexpected %s completion\n",
opTypeToStr(type));
abort();
break;
}
}
int main(int argc, char *argv[])
{
int flag;
struct ctx ctx;
struct __kernel_timespec *tsPtr;
struct __kernel_timespec ts;
struct io_uring_params params;
struct io_uring_napi napi;
int ret, af;
memset(&opt, 0, sizeof(struct options));
// Process flags.
while ((flag = getopt_long(argc, argv, ":lhs:bua:n:p:t:6d:", longopts, NULL)) != -1) {
switch (flag) {
case 'a':
strcpy(opt.addr, optarg);
break;
case 'b':
opt.busy_loop = true;
break;
case 'h':
printUsage(argv[0]);
exit(0);
break;
case 'l':
opt.listen = true;
break;
case 'n':
opt.num_pings = atoi(optarg) + 1;
break;
case 'p':
strcpy(opt.port, optarg);
break;
case 's':
opt.sq_poll = !!atoi(optarg);
break;
case 't':
opt.timeout = atoi(optarg);
break;
case 'u':
opt.prefer_busy_poll = true;
break;
case '6':
opt.ipv6 = true;
break;
case 'd':
opt.defer_tw = !!atoi(optarg);
break;
case ':':
printError("Missing argument", optopt);
printUsage(argv[0]);
exit(-1);
break;
case '?':
printError("Unrecognized option", optopt);
printUsage(argv[0]);
exit(-1);
break;
default:
fprintf(stderr, "Fatal: Unexpected case in CmdLineProcessor switch()\n");
exit(-1);
break;
}
}
if (strlen(opt.addr) == 0) {
fprintf(stderr, "address option is mandatory\n");
printUsage(argv[0]);
exit(1);
}
if (opt.ipv6) {
af = AF_INET6;
ctx.saddr6.sin6_port = htons(atoi(opt.port));
ctx.saddr6.sin6_family = AF_INET6;
} else {
af = AF_INET;
ctx.saddr.sin_port = htons(atoi(opt.port));
ctx.saddr.sin_family = AF_INET;
}
if (opt.ipv6)
ret = inet_pton(AF_INET6, opt.addr, &ctx.saddr6.sin6_addr);
else
ret = inet_pton(AF_INET, opt.addr, &ctx.saddr.sin_addr);
if (ret <= 0) {
fprintf(stderr, "inet_pton error for %s\n", optarg);
printUsage(argv[0]);
exit(1);
}
// Connect to server.
fprintf(stdout, "Listening %s : %s...\n", opt.addr, opt.port);
if ((ctx.sockfd = socket(af, SOCK_DGRAM, 0)) < 0) {
fprintf(stderr, "socket() failed: (%d) %s\n", errno, strerror(errno));
exit(1);
}
if (opt.ipv6)
ret = bind(ctx.sockfd, (struct sockaddr *)&ctx.saddr6, sizeof(struct sockaddr_in6));
else
ret = bind(ctx.sockfd, (struct sockaddr *)&ctx.saddr, sizeof(struct sockaddr_in));
if (ret < 0) {
fprintf(stderr, "bind() failed: (%d) %s\n", errno, strerror(errno));
exit(1);
}
// Setup ring.
memset(¶ms, 0, sizeof(params));
memset(&ts, 0, sizeof(ts));
memset(&napi, 0, sizeof(napi));
params.flags = IORING_SETUP_SINGLE_ISSUER;
if (opt.defer_tw) {
params.flags |= IORING_SETUP_DEFER_TASKRUN;
} else if (opt.sq_poll) {
params.flags = IORING_SETUP_SQPOLL;
params.sq_thread_idle = 50;
} else {
params.flags |= IORING_SETUP_COOP_TASKRUN;
}
ret = io_uring_queue_init_params(RINGSIZE, &ctx.ring, ¶ms);
if (ret) {
fprintf(stderr, "io_uring_queue_init_params() failed: (%d) %s\n",
ret, strerror(-ret));
exit(1);
}
if (opt.timeout || opt.prefer_busy_poll) {
napi.prefer_busy_poll = opt.prefer_busy_poll;
napi.busy_poll_to = opt.timeout;
ret = io_uring_register_napi(&ctx.ring, &napi);
if (ret) {
fprintf(stderr, "io_uring_register_napi: %d\n", ret);
exit(1);
}
}
if (opt.busy_loop)
tsPtr = &ts;
else
tsPtr = NULL;
// Use realtime scheduler.
setProcessScheduler();
// Copy payload.
clock_gettime(CLOCK_REALTIME, &ctx.ts);
// Setup context.
ctx.napi_check = false;
ctx.buffer_len = sizeof(struct timespec);
ctx.num_pings = opt.num_pings;
// Receive initial message to get napi id.
receivePing(&ctx);
while (ctx.num_pings != 0) {
int res;
unsigned int num_completed = 0;
unsigned int head;
struct io_uring_cqe *cqe;
do {
res = io_uring_submit_and_wait_timeout(&ctx.ring, &cqe, 1, tsPtr, NULL);
if (res >= 0)
break;
else if (res == -ETIME)
continue;
fprintf(stderr, "submit_and_wait: %d\n", res);
exit(1);
} while (1);
io_uring_for_each_cqe(&ctx.ring, head, cqe) {
++num_completed;
completion(&ctx, cqe);
}
if (num_completed)
io_uring_cq_advance(&ctx.ring, num_completed);
}
// Clean up.
if (opt.timeout || opt.prefer_busy_poll) {
ret = io_uring_unregister_napi(&ctx.ring, &napi);
if (ret)
fprintf(stderr, "io_uring_unregister_napi: %d\n", ret);
}
io_uring_queue_exit(&ctx.ring);
close(ctx.sockfd);
return 0;
}
|