2 * IRC - Internet Relay Chat, ircd/os_generic.c
3 * Copyright (C) 1999 Thomas Helvey
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 1, or (at your option)
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 * @brief Implementation of OS-dependent operations.
26 /* Solaris requires C99 support for SUSv3, but C99 support breaks other
27 * parts of the build. So fall back to SUSv2, but request IPv6 support
28 * by defining __EXTENSIONS__.
30 #define _XOPEN_SOURCE 500
31 #define __EXTENSIONS__ 1
33 /* FreeBSD 6.0 requires SUSv3 to support IPv6. Apparently some other
34 * OS requires SUSv3 to define IOV_MAX, but its identity is lost for
37 #define _XOPEN_SOURCE 600
40 #include "ircd_osdep.h"
47 /* Include file dependency notes:
48 * FreeBSD requires struct timeval from sys/time.h before struct
49 * rusage in sys/resource.h.
50 * Solaris requires sys/time.h before struct rusage (indirectly) in
53 /* #include <assert.h> -- Now using assert in ircd_log.h */
59 #include <sys/ioctl.h>
60 #include <sys/types.h>
62 #include <netinet/in.h>
63 #include <sys/resource.h>
64 #include <sys/socket.h>
68 #include <sys/param.h>
76 #define IOV_MAX 16 /**< minimum required length of an iovec array */
80 #include <sys/syscall.h>
81 #define getrusage(a,b) syscall(SYS_GETRUSAGE, a, b)
84 static int is_blocked(int error)
86 return EWOULDBLOCK == error
96 static void sockaddr_in_to_irc(const struct sockaddr_in *v4,
97 struct irc_sockaddr *irc)
99 memset(&irc->addr, 0, 5*sizeof(int16_t));
100 irc->addr.in6_16[5] = 0xffff;
101 memcpy(&irc->addr.in6_16[6], &v4->sin_addr, sizeof(v4->sin_addr));
102 irc->port = ntohs(v4->sin_port);
107 /** Native socket address type. */
108 #define sockaddr_native sockaddr_in6
109 /** Field name inside sockaddr_native to find address family. */
110 #define sn_family sin6_family
112 /** Convert native socket address to IRC format.
113 * @param[in] v6 Native socket address.
114 * @param[out] irc IRC format socket address.
116 void sockaddr_to_irc(const struct sockaddr_in6 *v6, struct irc_sockaddr *irc)
118 if (v6->sin6_family == AF_INET6) {
119 memcpy(&irc->addr.in6_16[0], &v6->sin6_addr, sizeof(v6->sin6_addr));
120 irc->port = ntohs(v6->sin6_port);
122 else if (v6->sin6_family == AF_INET) {
123 sockaddr_in_to_irc((struct sockaddr_in *)v6, irc);
125 else assert(0 && "Unhandled native address family");
128 /** Convert IRC socket address to native format.
129 * @param[out] v6 Native socket address.
130 * @param[in] irc IRC socket address.
131 * @param[in] compat_fd If non-negative, an FD specifying address family.
132 * @return Length of address written to \a v6.
134 int sockaddr_from_irc(struct sockaddr_in6 *v6, const struct irc_sockaddr *irc, int compat_fd)
136 struct sockaddr_in6 sin6;
143 && (0 == getsockname(compat_fd, (struct sockaddr*)&sin6, &slen)))
144 family = sin6.sin6_family;
145 else if ((irc == &VirtualHost_v4) || irc_in_addr_is_ipv4(&irc->addr))
150 memset(v6, 0, sizeof(*v6));
151 if (family == AF_INET) {
152 struct sockaddr_in *v4 = (struct sockaddr_in*)v6;
153 v4->sin_family = AF_INET;
154 memcpy(&v4->sin_addr, &irc->addr.in6_16[6], sizeof(v4->sin_addr));
155 v4->sin_port = htons(irc->port);
159 v6->sin6_family = AF_INET6;
160 memcpy(&v6->sin6_addr, &irc->addr.in6_16[0], sizeof(v6->sin6_addr));
161 v6->sin6_port = htons(irc->port);
167 #define sockaddr_native sockaddr_in
168 #define sn_family sin_family
169 #define sockaddr_to_irc sockaddr_in_to_irc
171 int sockaddr_from_irc(struct sockaddr_in *v4, const struct irc_sockaddr *irc, int compat_fd)
174 v4->sin_family = AF_INET;
176 assert(!irc->addr.in6_16[0] && !irc->addr.in6_16[1] && !irc->addr.in6_16[2] && !irc->addr.in6_16[3] && !irc->addr.in6_16[4] && (!irc->addr.in6_16[5] || irc->addr.in6_16[5] == 0xffff));
177 memcpy(&v4->sin_addr, &irc->addr.in6_16[6], sizeof(v4->sin_addr));
178 v4->sin_port = htons(irc->port);
180 memset(&v4, 0, sizeof(v4));
189 /** Send resource usage information to an enumerator function.
190 * @param[in] cptr Client requesting information.
191 * @param[in] uptime Wall time in seconds since the server started.
192 * @param[in] enumerator Function to call to send a line to \a cptr.
193 * @return Zero if some usage reports could not be sent, non-zero on success.
195 int os_get_rusage(struct Client *cptr, int uptime, EnumFn enumerator)
197 #ifdef HAVE_GETRUSAGE
210 hzz = sysconf(_SC_CLK_TCK);
215 assert(0 != enumerator);
216 if (getrusage(RUSAGE_SELF, &rus) == -1)
219 secs = rus.ru_utime.tv_sec + rus.ru_stime.tv_sec;
223 sprintf(buf, "CPU Secs %ld:%ld User %ld:%ld System %ld:%ld",
224 (long)(secs / 60), (long)(secs % 60),
225 rus.ru_utime.tv_sec / 60, rus.ru_utime.tv_sec % 60,
226 rus.ru_stime.tv_sec / 60, rus.ru_stime.tv_sec % 60);
227 (*enumerator)(cptr, buf);
229 sprintf(buf, "RSS %ld ShMem %ld Data %ld Stack %ld",
231 rus.ru_ixrss / (uptime * hzz), rus.ru_idrss / (uptime * hzz),
232 rus.ru_isrss / (uptime * hzz));
233 (*enumerator)(cptr, buf);
235 sprintf(buf, "Swaps %ld Reclaims %ld Faults %ld",
236 rus.ru_nswap, rus.ru_minflt, rus.ru_majflt);
237 (*enumerator)(cptr, buf);
239 sprintf(buf, "Block in %ld out %ld", rus.ru_inblock, rus.ru_oublock);
240 (*enumerator)(cptr, buf);
242 sprintf(buf, "Msg Rcv %ld Send %ld", rus.ru_msgrcv, rus.ru_msgsnd);
243 (*enumerator)(cptr, buf);
245 sprintf(buf, "Signals %ld Context Vol. %ld Invol %ld",
246 rus.ru_nsignals, rus.ru_nvcsw, rus.ru_nivcsw);
247 (*enumerator)(cptr, buf);
249 #else /* HAVE_GETRUSAGE */
254 int hzz = 1, ticpermin;
255 int umin, smin, usec, ssec;
257 assert(0 != enumerator);
259 hzz = sysconf(_SC_CLK_TCK);
261 ticpermin = hzz * 60;
263 umin = tmsbuf.tms_utime / ticpermin;
264 usec = (tmsbuf.tms_utime % ticpermin) / (float)hzz;
265 smin = tmsbuf.tms_stime / ticpermin;
266 ssec = (tmsbuf.tms_stime % ticpermin) / (float)hzz;
268 mins = (secs / 60) + umin + smin;
271 if (times(&tmsbuf) == -1)
273 secs = tmsbuf.tms_utime + tmsbuf.tms_stime;
275 sprintf(buf, "CPU Secs %d:%d User %d:%d System %d:%d",
276 mins, secs, umin, usec, smin, ssec);
277 (*enumerator)(cptr, buf);
278 #endif /* HAVE_TIMES */
279 #endif /* HAVE_GETRUSAGE */
284 /** Look up the most recent socket error for a socket file descriptor.
285 * @param[in] fd File descriptor to check.
286 * @return Error code from the socket, or 0 if the OS does not support this.
288 int os_get_sockerr(int fd)
291 #if defined(SO_ERROR)
292 unsigned int len = sizeof(err);
293 getsockopt(fd, SOL_SOCKET, SO_ERROR, &err, &len);
298 /** Set a file descriptor to non-blocking mode.
299 * @param[in] fd %Socket file descriptor.
300 * @return Non-zero on success, or zero on failure.
302 int os_set_nonblocking(int fd)
310 * NOTE: consult ALL your relevant manual pages *BEFORE* changing
311 * these ioctl's. There are quite a few variations on them,
312 * as can be seen by the PCS one. They are *NOT* all the same.
313 * Heed this well. - Avalon.
322 /* This portion of code might also apply to NeXT. -LynX */
325 if (ioctl(fd, FIONBIO, &res) == -1)
328 if ((res = fcntl(fd, F_GETFL, 0)) == -1)
330 else if (fcntl(fd, F_SETFL, res | nonb) == -1)
336 /** Mark a socket's address as reusable.
337 * @param[in] fd %Socket file descriptor to manipulate.
338 * @return Non-zero on success, or zero on failure.
340 int os_set_reuseaddr(int fd)
342 unsigned int opt = 1;
343 return (0 == setsockopt(fd, SOL_SOCKET, SO_REUSEADDR,
344 (const char*) &opt, sizeof(opt)));
347 /** Set a socket's send and receive buffer sizes.
348 * @param[in] fd %Socket file descriptor to manipulate.
349 * @param[in] ssize New send buffer size.
350 * @param[in] rsize New receive buffer size.
351 * @return Non-zero on success, or zero on failure.
353 int os_set_sockbufs(int fd, unsigned int ssize, unsigned int rsize)
355 unsigned int sopt = ssize;
356 unsigned int ropt = rsize;
357 return (0 == setsockopt(fd, SOL_SOCKET, SO_RCVBUF,
358 (const char*) &ropt, sizeof(ropt)) &&
359 0 == setsockopt(fd, SOL_SOCKET, SO_SNDBUF,
360 (const char*) &sopt, sizeof(sopt)));
363 /** Set a socket's "type of service" value.
364 * @param[in] fd %Socket file descriptor to manipulate.
365 * @param[in] tos New type of service value to use.
366 * @return Non-zero on success, or zero on failure.
368 int os_set_tos(int fd,int tos)
370 #if defined(IP_TOS) && defined(IPPROTO_IP)
371 unsigned int opt = tos;
372 return (0 == setsockopt(fd, IPPROTO_IP, IP_TOS, &opt, sizeof(opt)));
378 /** Disable IP options on a socket.
379 * @param[in] fd %Socket file descriptor to manipulate.
380 * @return Non-zero on success, or zero on failure.
382 int os_disable_options(int fd)
384 #if defined(IP_OPTIONS) && defined(IPPROTO_IP)
385 return (0 == setsockopt(fd, IPPROTO_IP, IP_OPTIONS, NULL, 0));
392 * Try and find the correct name to use with getrlimit() for setting the max.
393 * number of files allowed to be open by this process.
396 #define RLIMIT_FD_MAX RLIMIT_FDMAX
399 #define RLIMIT_FD_MAX RLIMIT_NOFILE
401 #ifdef RLIMIT_OPEN_MAX
402 #define RLIMIT_FD_MAX RLIMIT_OPEN_MAX
409 /** Set file descriptor limit for the process.
410 * @param[in] max_descriptors Ideal number of file descriptors.
411 * @return Zero on success; -1 on error; positive number of possible
412 * file descriptors if \a max_descriptors is too high.
414 int os_set_fdlimit(unsigned int max_descriptors)
416 #if defined(HAVE_SETRLIMIT) && defined(RLIMIT_FD_MAX)
419 if (!getrlimit(RLIMIT_FD_MAX, &limit)) {
420 if (limit.rlim_max < max_descriptors)
421 return limit.rlim_max;
422 limit.rlim_cur = limit.rlim_max; /* make soft limit the max */
423 return setrlimit(RLIMIT_FD_MAX, &limit);
425 #endif /* defined(HAVE_SETRLIMIT) && defined(RLIMIT_FD_MAX) */
429 /** Attempt to read from a non-blocking socket.
430 * @param[in] fd File descriptor to read from.
431 * @param[out] buf Output buffer to read into.
432 * @param[in] length Number of bytes to read.
433 * @param[out] count_out Receives number of bytes actually read.
434 * @return An IOResult value indicating status.
436 IOResult os_recv_nonb(int fd, char* buf, unsigned int length,
437 unsigned int* count_out)
441 assert(0 != count_out);
443 if (0 < (res = recv(fd, buf, length, 0))) {
444 *count_out = (unsigned) res;
448 return (res < 0) && is_blocked(errno) ? IO_BLOCKED : IO_FAILURE;
452 /** Attempt to read from a non-blocking UDP socket.
453 * @param[in] fd File descriptor to read from.
454 * @param[out] buf Output buffer to read into.
455 * @param[in] length Number of bytes to read.
456 * @param[out] length_out Receives number of bytes actually read.
457 * @param[out] addr_out Peer address that sent the message.
458 * @return An IOResult value indicating status.
460 IOResult os_recvfrom_nonb(int fd, char* buf, unsigned int length,
461 unsigned int* length_out,
462 struct irc_sockaddr* addr_out)
464 struct sockaddr_native addr;
465 unsigned int len = sizeof(addr);
468 assert(0 != length_out);
469 assert(0 != addr_out);
471 res = recvfrom(fd, buf, length, 0, (struct sockaddr*) &addr, &len);
473 sockaddr_to_irc(&addr, addr_out);
478 return is_blocked(errno) ? IO_BLOCKED : IO_FAILURE;
482 /** Attempt to write on a non-blocking UDP socket.
483 * @param[in] fd File descriptor to write to.
484 * @param[in] buf Output buffer to send from.
485 * @param[in] length Number of bytes to write.
486 * @param[out] count_out Receives number of bytes actually written.
487 * @param[in] flags Flags for call to sendto().
488 * @param[in] peer Destination address of the message.
489 * @return An IOResult value indicating status.
491 IOResult os_sendto_nonb(int fd, const char* buf, unsigned int length,
492 unsigned int* count_out, unsigned int flags,
493 const struct irc_sockaddr* peer)
495 struct sockaddr_native addr;
499 size = sockaddr_from_irc(&addr, peer, fd);
500 assert((addr.sn_family == AF_INET) == irc_in_addr_is_ipv4(&peer->addr));
501 if (-1 < (res = sendto(fd, buf, length, flags, (struct sockaddr*)&addr, size))) {
503 *count_out = (unsigned) res;
508 return is_blocked(errno) ? IO_BLOCKED : IO_FAILURE;
512 /** Attempt to write on a connected socket.
513 * @param[in] fd File descriptor to write to.
514 * @param[in] buf Output buffer to send from.
515 * @param[in] length Number of bytes to write.
516 * @param[out] count_out Receives number of bytes actually written.
517 * @return An IOResult value indicating status.
519 IOResult os_send_nonb(int fd, const char* buf, unsigned int length,
520 unsigned int* count_out)
524 assert(0 != count_out);
526 if (-1 < (res = send(fd, buf, length, 0))) {
527 *count_out = (unsigned) res;
531 return is_blocked(errno) ? IO_BLOCKED : IO_FAILURE;
535 /** Attempt a vectored write on a connected socket.
536 * @param[in] fd File descriptor to write to.
537 * @param[in] buf Message queue to send from.
538 * @param[out] count_in Number of bytes mapped from \a buf.
539 * @param[out] count_out Receives number of bytes actually written.
540 * @return An IOResult value indicating status.
542 IOResult os_sendv_nonb(int fd, struct MsgQ* buf, unsigned int* count_in,
543 unsigned int* count_out)
547 struct iovec iov[IOV_MAX];
550 assert(0 != count_in);
551 assert(0 != count_out);
554 count = msgq_mapiov(buf, iov, IOV_MAX, count_in);
556 if (-1 < (res = writev(fd, iov, count))) {
557 *count_out = (unsigned) res;
561 return is_blocked(errno) ? IO_BLOCKED : IO_FAILURE;
565 /** Open a TCP or UDP socket on a particular address.
566 * @param[in] local Local address to bind to.
567 * @param[in] type SOCK_STREAM or SOCK_DGRAM.
568 * @param[in] port_name Port name (used in error diagnostics).
569 * @return Bound descriptor, or -1 on error.
571 int os_socket(const struct irc_sockaddr* local, int type, const char* port_name)
573 struct sockaddr_native addr;
577 size = sockaddr_from_irc(&addr, local, -1);
578 fd = socket(addr.sn_family, type, 0);
580 report_error(SOCKET_ERROR_MSG, port_name, errno);
583 if (fd > MAXCLIENTS - 1) {
584 report_error(CONNLIMIT_ERROR_MSG, port_name, 0);
588 if (!os_set_reuseaddr(fd)) {
589 report_error(REUSEADDR_ERROR_MSG, port_name, errno);
593 if (!os_set_nonblocking(fd)) {
594 report_error(NONB_ERROR_MSG, port_name, errno);
599 if (bind(fd, (struct sockaddr*)&addr, size)) {
600 report_error(BIND_ERROR_MSG, port_name, errno);
608 /** Accept a connection on a socket.
609 * @param[in] fd Listening file descriptor.
610 * @param[out] peer Peer address of connection.
611 * @return File descriptor for accepted connection.
613 int os_accept(int fd, struct irc_sockaddr* peer)
615 struct sockaddr_native addr;
619 addrlen = sizeof(addr);
620 new_fd = accept(fd, (struct sockaddr*)&addr, &addrlen);
622 memset(peer, 0, sizeof(*peer));
624 sockaddr_to_irc(&addr, peer);
628 /** Start a non-blocking connection.
629 * @param[in] fd Disconnected file descriptor.
630 * @param[in] sin Target address for connection.
631 * @return IOResult code indicating status.
633 IOResult os_connect_nonb(int fd, const struct irc_sockaddr* sin)
635 struct sockaddr_native addr;
638 size = sockaddr_from_irc(&addr, sin, fd);
639 if (0 == connect(fd, (struct sockaddr*) &addr, size))
641 else if (errno == EINPROGRESS)
647 /** Get local address of a socket.
648 * @param[in] fd File descriptor to operate on.
649 * @param[out] sin_out Receives local socket address.
650 * @return Non-zero on success; zero on error.
652 int os_get_sockname(int fd, struct irc_sockaddr* sin_out)
654 struct sockaddr_native addr;
655 unsigned int len = sizeof(addr);
657 assert(0 != sin_out);
658 if (getsockname(fd, (struct sockaddr*) &addr, &len))
660 sockaddr_to_irc(&addr, sin_out);
664 /** Get remote address of a socket.
665 * @param[in] fd File descriptor to operate on.
666 * @param[out] sin_out Receives remote socket address.
667 * @return Non-zero on success; zero on error.
669 int os_get_peername(int fd, struct irc_sockaddr* sin_out)
671 struct sockaddr_native addr;
672 unsigned int len = sizeof(addr);
674 assert(0 != sin_out);
675 if (getpeername(fd, (struct sockaddr*) &addr, &len))
677 sockaddr_to_irc(&addr, sin_out);
681 /** Start listening on a socket.
682 * @param[in] fd Disconnected file descriptor.
683 * @param[in] backlog Maximum number of un-accept()ed connections to keep.
684 * @return Non-zero on success; zero on error.
686 int os_set_listen(int fd, int backlog)
688 return (0 == listen(fd, backlog));
691 /** Allocate a connected pair of local sockets.
692 * @param[out] sv Array of two file descriptors.
693 * @return Zero on success; non-zero number on error.
695 int os_socketpair(int sv[2])
697 return socketpair(AF_UNIX, SOCK_STREAM, 0, sv);