proto_tcp.c revision 218138
1/*- 2 * Copyright (c) 2009-2010 The FreeBSD Foundation 3 * All rights reserved. 4 * 5 * This software was developed by Pawel Jakub Dawidek under sponsorship from 6 * the FreeBSD Foundation. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30#include <sys/cdefs.h> 31__FBSDID("$FreeBSD: head/sbin/hastd/proto_tcp4.c 218138 2011-01-31 18:32:17Z pjd $"); 32 33#include <sys/param.h> /* MAXHOSTNAMELEN */ 34 35#include <netinet/in.h> 36#include <netinet/tcp.h> 37 38#include <errno.h> 39#include <fcntl.h> 40#include <netdb.h> 41#include <stdbool.h> 42#include <stdint.h> 43#include <stdio.h> 44#include <string.h> 45#include <unistd.h> 46 47#include "hast.h" 48#include "pjdlog.h" 49#include "proto_impl.h" 50#include "subr.h" 51 52#define TCP4_CTX_MAGIC 0x7c441c 53struct tcp4_ctx { 54 int tc_magic; 55 struct sockaddr_in tc_sin; 56 int tc_fd; 57 int tc_side; 58#define TCP4_SIDE_CLIENT 0 59#define TCP4_SIDE_SERVER_LISTEN 1 60#define TCP4_SIDE_SERVER_WORK 2 61}; 62 63static void tcp4_close(void *ctx); 64 65static in_addr_t 66str2ip(const char *str) 67{ 68 struct hostent *hp; 69 in_addr_t ip; 70 71 ip = inet_addr(str); 72 if (ip != INADDR_NONE) { 73 /* It is a valid IP address. */ 74 return (ip); 75 } 76 /* Check if it is a valid host name. */ 77 hp = gethostbyname(str); 78 if (hp == NULL) 79 return (INADDR_NONE); 80 return (((struct in_addr *)(void *)hp->h_addr)->s_addr); 81} 82 83/* 84 * Function converts the given string to unsigned number. 85 */ 86static int 87numfromstr(const char *str, intmax_t minnum, intmax_t maxnum, intmax_t *nump) 88{ 89 intmax_t digit, num; 90 91 if (str[0] == '\0') 92 goto invalid; /* Empty string. */ 93 num = 0; 94 for (; *str != '\0'; str++) { 95 if (*str < '0' || *str > '9') 96 goto invalid; /* Non-digit character. */ 97 digit = *str - '0'; 98 if (num > num * 10 + digit) 99 goto invalid; /* Overflow. */ 100 num = num * 10 + digit; 101 if (num > maxnum) 102 goto invalid; /* Too big. */ 103 } 104 if (num < minnum) 105 goto invalid; /* Too small. */ 106 *nump = num; 107 return (0); 108invalid: 109 errno = EINVAL; 110 return (-1); 111} 112 113static int 114tcp4_addr(const char *addr, struct sockaddr_in *sinp) 115{ 116 char iporhost[MAXHOSTNAMELEN]; 117 const char *pp; 118 size_t size; 119 in_addr_t ip; 120 121 if (addr == NULL) 122 return (-1); 123 124 if (strncasecmp(addr, "tcp4://", 7) == 0) 125 addr += 7; 126 else if (strncasecmp(addr, "tcp://", 6) == 0) 127 addr += 6; 128 else { 129 /* 130 * Because TCP4 is the default assume IP or host is given without 131 * prefix. 132 */ 133 } 134 135 sinp->sin_family = AF_INET; 136 sinp->sin_len = sizeof(*sinp); 137 /* Extract optional port. */ 138 pp = strrchr(addr, ':'); 139 if (pp == NULL) { 140 /* Port not given, use the default. */ 141 sinp->sin_port = htons(HASTD_PORT); 142 } else { 143 intmax_t port; 144 145 if (numfromstr(pp + 1, 1, 65535, &port) < 0) 146 return (errno); 147 sinp->sin_port = htons(port); 148 } 149 /* Extract host name or IP address. */ 150 if (pp == NULL) { 151 size = sizeof(iporhost); 152 if (strlcpy(iporhost, addr, size) >= size) 153 return (ENAMETOOLONG); 154 } else { 155 size = (size_t)(pp - addr + 1); 156 if (size > sizeof(iporhost)) 157 return (ENAMETOOLONG); 158 (void)strlcpy(iporhost, addr, size); 159 } 160 /* Convert string (IP address or host name) to in_addr_t. */ 161 ip = str2ip(iporhost); 162 if (ip == INADDR_NONE) 163 return (EINVAL); 164 sinp->sin_addr.s_addr = ip; 165 166 return (0); 167} 168 169static int 170tcp4_common_setup(const char *addr, void **ctxp, int side) 171{ 172 struct tcp4_ctx *tctx; 173 int ret, val; 174 175 tctx = malloc(sizeof(*tctx)); 176 if (tctx == NULL) 177 return (errno); 178 179 /* Parse given address. */ 180 if ((ret = tcp4_addr(addr, &tctx->tc_sin)) != 0) { 181 free(tctx); 182 return (ret); 183 } 184 185 tctx->tc_fd = socket(AF_INET, SOCK_STREAM, 0); 186 if (tctx->tc_fd == -1) { 187 ret = errno; 188 free(tctx); 189 return (ret); 190 } 191 192 /* Socket settings. */ 193 val = 1; 194 if (setsockopt(tctx->tc_fd, IPPROTO_TCP, TCP_NODELAY, &val, 195 sizeof(val)) == -1) { 196 pjdlog_warning("Unable to set TCP_NOELAY on %s", addr); 197 } 198 val = 131072; 199 if (setsockopt(tctx->tc_fd, SOL_SOCKET, SO_SNDBUF, &val, 200 sizeof(val)) == -1) { 201 pjdlog_warning("Unable to set send buffer size on %s", addr); 202 } 203 val = 131072; 204 if (setsockopt(tctx->tc_fd, SOL_SOCKET, SO_RCVBUF, &val, 205 sizeof(val)) == -1) { 206 pjdlog_warning("Unable to set receive buffer size on %s", addr); 207 } 208 209 tctx->tc_side = side; 210 tctx->tc_magic = TCP4_CTX_MAGIC; 211 *ctxp = tctx; 212 213 return (0); 214} 215 216static int 217tcp4_client(const char *addr, void **ctxp) 218{ 219 220 return (tcp4_common_setup(addr, ctxp, TCP4_SIDE_CLIENT)); 221} 222 223static int 224tcp4_connect(void *ctx) 225{ 226 struct tcp4_ctx *tctx = ctx; 227 struct timeval tv; 228 fd_set fdset; 229 socklen_t esize; 230 int error, flags, ret; 231 232 PJDLOG_ASSERT(tctx != NULL); 233 PJDLOG_ASSERT(tctx->tc_magic == TCP4_CTX_MAGIC); 234 PJDLOG_ASSERT(tctx->tc_side == TCP4_SIDE_CLIENT); 235 PJDLOG_ASSERT(tctx->tc_fd >= 0); 236 237 flags = fcntl(tctx->tc_fd, F_GETFL); 238 if (flags == -1) { 239 KEEP_ERRNO(pjdlog_common(LOG_DEBUG, 1, errno, 240 "fcntl(F_GETFL) failed")); 241 return (errno); 242 } 243 /* 244 * We make socket non-blocking so we can handle connection timeout 245 * manually. 246 */ 247 flags |= O_NONBLOCK; 248 if (fcntl(tctx->tc_fd, F_SETFL, flags) == -1) { 249 KEEP_ERRNO(pjdlog_common(LOG_DEBUG, 1, errno, 250 "fcntl(F_SETFL, O_NONBLOCK) failed")); 251 return (errno); 252 } 253 254 if (connect(tctx->tc_fd, (struct sockaddr *)&tctx->tc_sin, 255 sizeof(tctx->tc_sin)) == 0) { 256 error = 0; 257 goto done; 258 } 259 if (errno != EINPROGRESS) { 260 error = errno; 261 pjdlog_common(LOG_DEBUG, 1, errno, "connect() failed"); 262 goto done; 263 } 264 /* 265 * Connection can't be established immediately, let's wait 266 * for HAST_TIMEOUT seconds. 267 */ 268 tv.tv_sec = HAST_TIMEOUT; 269 tv.tv_usec = 0; 270again: 271 FD_ZERO(&fdset); 272 FD_SET(tctx->tc_fd, &fdset); 273 ret = select(tctx->tc_fd + 1, NULL, &fdset, NULL, &tv); 274 if (ret == 0) { 275 error = ETIMEDOUT; 276 goto done; 277 } else if (ret == -1) { 278 if (errno == EINTR) 279 goto again; 280 error = errno; 281 pjdlog_common(LOG_DEBUG, 1, errno, "select() failed"); 282 goto done; 283 } 284 PJDLOG_ASSERT(ret > 0); 285 PJDLOG_ASSERT(FD_ISSET(tctx->tc_fd, &fdset)); 286 esize = sizeof(error); 287 if (getsockopt(tctx->tc_fd, SOL_SOCKET, SO_ERROR, &error, 288 &esize) == -1) { 289 error = errno; 290 pjdlog_common(LOG_DEBUG, 1, errno, 291 "getsockopt(SO_ERROR) failed"); 292 goto done; 293 } 294 if (error != 0) { 295 pjdlog_common(LOG_DEBUG, 1, error, 296 "getsockopt(SO_ERROR) returned error"); 297 goto done; 298 } 299 error = 0; 300done: 301 flags &= ~O_NONBLOCK; 302 if (fcntl(tctx->tc_fd, F_SETFL, flags) == -1) { 303 if (error == 0) 304 error = errno; 305 pjdlog_common(LOG_DEBUG, 1, errno, 306 "fcntl(F_SETFL, ~O_NONBLOCK) failed"); 307 } 308 return (error); 309} 310 311static int 312tcp4_server(const char *addr, void **ctxp) 313{ 314 struct tcp4_ctx *tctx; 315 int ret, val; 316 317 ret = tcp4_common_setup(addr, ctxp, TCP4_SIDE_SERVER_LISTEN); 318 if (ret != 0) 319 return (ret); 320 321 tctx = *ctxp; 322 323 val = 1; 324 /* Ignore failure. */ 325 (void)setsockopt(tctx->tc_fd, SOL_SOCKET, SO_REUSEADDR, &val, 326 sizeof(val)); 327 328 if (bind(tctx->tc_fd, (struct sockaddr *)&tctx->tc_sin, 329 sizeof(tctx->tc_sin)) < 0) { 330 ret = errno; 331 tcp4_close(tctx); 332 return (ret); 333 } 334 if (listen(tctx->tc_fd, 8) < 0) { 335 ret = errno; 336 tcp4_close(tctx); 337 return (ret); 338 } 339 340 return (0); 341} 342 343static int 344tcp4_accept(void *ctx, void **newctxp) 345{ 346 struct tcp4_ctx *tctx = ctx; 347 struct tcp4_ctx *newtctx; 348 socklen_t fromlen; 349 int ret; 350 351 PJDLOG_ASSERT(tctx != NULL); 352 PJDLOG_ASSERT(tctx->tc_magic == TCP4_CTX_MAGIC); 353 PJDLOG_ASSERT(tctx->tc_side == TCP4_SIDE_SERVER_LISTEN); 354 PJDLOG_ASSERT(tctx->tc_fd >= 0); 355 356 newtctx = malloc(sizeof(*newtctx)); 357 if (newtctx == NULL) 358 return (errno); 359 360 fromlen = sizeof(tctx->tc_sin); 361 newtctx->tc_fd = accept(tctx->tc_fd, (struct sockaddr *)&tctx->tc_sin, 362 &fromlen); 363 if (newtctx->tc_fd < 0) { 364 ret = errno; 365 free(newtctx); 366 return (ret); 367 } 368 369 newtctx->tc_side = TCP4_SIDE_SERVER_WORK; 370 newtctx->tc_magic = TCP4_CTX_MAGIC; 371 *newctxp = newtctx; 372 373 return (0); 374} 375 376static int 377tcp4_send(void *ctx, const unsigned char *data, size_t size) 378{ 379 struct tcp4_ctx *tctx = ctx; 380 381 PJDLOG_ASSERT(tctx != NULL); 382 PJDLOG_ASSERT(tctx->tc_magic == TCP4_CTX_MAGIC); 383 PJDLOG_ASSERT(tctx->tc_fd >= 0); 384 385 return (proto_common_send(tctx->tc_fd, data, size)); 386} 387 388static int 389tcp4_recv(void *ctx, unsigned char *data, size_t size) 390{ 391 struct tcp4_ctx *tctx = ctx; 392 393 PJDLOG_ASSERT(tctx != NULL); 394 PJDLOG_ASSERT(tctx->tc_magic == TCP4_CTX_MAGIC); 395 PJDLOG_ASSERT(tctx->tc_fd >= 0); 396 397 return (proto_common_recv(tctx->tc_fd, data, size)); 398} 399 400static int 401tcp4_descriptor(const void *ctx) 402{ 403 const struct tcp4_ctx *tctx = ctx; 404 405 PJDLOG_ASSERT(tctx != NULL); 406 PJDLOG_ASSERT(tctx->tc_magic == TCP4_CTX_MAGIC); 407 408 return (tctx->tc_fd); 409} 410 411static void 412sin2str(struct sockaddr_in *sinp, char *addr, size_t size) 413{ 414 in_addr_t ip; 415 unsigned int port; 416 417 PJDLOG_ASSERT(addr != NULL); 418 PJDLOG_ASSERT(sinp->sin_family == AF_INET); 419 420 ip = ntohl(sinp->sin_addr.s_addr); 421 port = ntohs(sinp->sin_port); 422 PJDLOG_VERIFY(snprintf(addr, size, "tcp4://%u.%u.%u.%u:%u", 423 ((ip >> 24) & 0xff), ((ip >> 16) & 0xff), ((ip >> 8) & 0xff), 424 (ip & 0xff), port) < (ssize_t)size); 425} 426 427static bool 428tcp4_address_match(const void *ctx, const char *addr) 429{ 430 const struct tcp4_ctx *tctx = ctx; 431 struct sockaddr_in sin; 432 socklen_t sinlen; 433 in_addr_t ip1, ip2; 434 435 PJDLOG_ASSERT(tctx != NULL); 436 PJDLOG_ASSERT(tctx->tc_magic == TCP4_CTX_MAGIC); 437 438 if (tcp4_addr(addr, &sin) != 0) 439 return (false); 440 ip1 = sin.sin_addr.s_addr; 441 442 sinlen = sizeof(sin); 443 if (getpeername(tctx->tc_fd, (struct sockaddr *)&sin, &sinlen) < 0) 444 return (false); 445 ip2 = sin.sin_addr.s_addr; 446 447 return (ip1 == ip2); 448} 449 450static void 451tcp4_local_address(const void *ctx, char *addr, size_t size) 452{ 453 const struct tcp4_ctx *tctx = ctx; 454 struct sockaddr_in sin; 455 socklen_t sinlen; 456 457 PJDLOG_ASSERT(tctx != NULL); 458 PJDLOG_ASSERT(tctx->tc_magic == TCP4_CTX_MAGIC); 459 460 sinlen = sizeof(sin); 461 if (getsockname(tctx->tc_fd, (struct sockaddr *)&sin, &sinlen) < 0) { 462 PJDLOG_VERIFY(strlcpy(addr, "N/A", size) < size); 463 return; 464 } 465 sin2str(&sin, addr, size); 466} 467 468static void 469tcp4_remote_address(const void *ctx, char *addr, size_t size) 470{ 471 const struct tcp4_ctx *tctx = ctx; 472 struct sockaddr_in sin; 473 socklen_t sinlen; 474 475 PJDLOG_ASSERT(tctx != NULL); 476 PJDLOG_ASSERT(tctx->tc_magic == TCP4_CTX_MAGIC); 477 478 sinlen = sizeof(sin); 479 if (getpeername(tctx->tc_fd, (struct sockaddr *)&sin, &sinlen) < 0) { 480 PJDLOG_VERIFY(strlcpy(addr, "N/A", size) < size); 481 return; 482 } 483 sin2str(&sin, addr, size); 484} 485 486static void 487tcp4_close(void *ctx) 488{ 489 struct tcp4_ctx *tctx = ctx; 490 491 PJDLOG_ASSERT(tctx != NULL); 492 PJDLOG_ASSERT(tctx->tc_magic == TCP4_CTX_MAGIC); 493 494 if (tctx->tc_fd >= 0) 495 close(tctx->tc_fd); 496 tctx->tc_magic = 0; 497 free(tctx); 498} 499 500static struct hast_proto tcp4_proto = { 501 .hp_name = "tcp4", 502 .hp_client = tcp4_client, 503 .hp_connect = tcp4_connect, 504 .hp_server = tcp4_server, 505 .hp_accept = tcp4_accept, 506 .hp_send = tcp4_send, 507 .hp_recv = tcp4_recv, 508 .hp_descriptor = tcp4_descriptor, 509 .hp_address_match = tcp4_address_match, 510 .hp_local_address = tcp4_local_address, 511 .hp_remote_address = tcp4_remote_address, 512 .hp_close = tcp4_close 513}; 514 515static __constructor void 516tcp4_ctor(void) 517{ 518 519 proto_register(&tcp4_proto, true); 520} 521