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.
25 #define _XOPEN_SOURCE 500 /**< make limits.h #define IOV_MAX */
26 #define __EXTENSIONS__ 1 /**< make Solaris netinet/in.h know IPv6 */
28 #include "ircd_osdep.h"
34 /* Include file dependency notes:
35 * FreeBSD requires struct timeval from sys/time.h before struct
36 * rusage in sys/resource.h.
37 * Solaris requires sys/time.h before struct rusage (indirectly) in
46 #include <sys/ioctl.h>
47 #include <sys/types.h>
49 #include <netinet/in.h>
50 #include <sys/resource.h>
51 #include <sys/socket.h>
55 #include <sys/param.h>
63 #define IOV_MAX 16 /**< minimum required length of an iovec array */
67 #include <sys/syscall.h>
68 #define getrusage(a,b) syscall(SYS_GETRUSAGE, a, b)
72 /** Native socket address type. */
73 #define sockaddr_native sockaddr_in6
74 /** Field name inside sockaddr_native to find address family. */
75 #define sn_family sin6_family
77 /** Convert native socket address to IRC format.
78 * @param[in] v6 Native socket address.
79 * @param[out] irc IRC format socket address.
81 void sockaddr_to_irc(const struct sockaddr_in6 *v6, struct irc_sockaddr *irc)
83 if (v6->sin6_family == AF_INET6) {
84 memcpy(&irc->addr.in6_16[0], &v6->sin6_addr, sizeof(v6->sin6_addr));
85 irc->port = ntohs(v6->sin6_port);
87 else if (v6->sin6_family == AF_INET) {
88 const struct sockaddr_in *v4 = (const struct sockaddr_in*)v6;
89 memset(&irc->addr, 0, 5*sizeof(int16_t));
90 irc->addr.in6_16[5] = 0xffff;
91 memcpy(&irc->addr.in6_16[6], &v4->sin_addr, sizeof(v4->sin_addr));
92 irc->port = ntohs(v4->sin_port);
94 else assert(0 && "Unhandled native address family");
97 /** Convert IRC socket address to native format.
98 * @param[out] v6 Native socket address.
99 * @param[in] irc IRC socket address.
100 * @param[in] compat_fd If non-negative, an FD specifying address family.
101 * @return Length of address written to \a v6.
103 int sockaddr_from_irc(struct sockaddr_in6 *v6, const struct irc_sockaddr *irc, int compat_fd)
105 struct sockaddr_in6 sin6;
110 if ((0 <= compat_fd) && (0 == getsockname(compat_fd, (struct sockaddr*)&sin6, &slen)))
111 family = sin6.sin6_family;
112 else if (irc_in_addr_is_ipv4(&VirtualHost.addr))
117 memset(v6, 0, sizeof(*v6));
119 memset(v6, 0, sizeof(v6));
120 v6->sin6_family = AF_INET6;
123 else if ((family == AF_INET) && irc_in_addr_is_ipv4(&irc->addr)) {
124 struct sockaddr_in *v4 = (struct sockaddr_in*)v6;
125 v4->sin_family = AF_INET;
126 memcpy(&v4->sin_addr, &irc->addr.in6_16[6], sizeof(v4->sin_addr));
127 v4->sin_port = htons(irc->port);
131 v6->sin6_family = AF_INET6;
132 memcpy(&v6->sin6_addr, &irc->addr.in6_16[0], sizeof(v6->sin6_addr));
133 v6->sin6_port = htons(irc->port);
139 #define sockaddr_native sockaddr_in
140 #define sn_family sin_family
142 void sockaddr_to_irc(const struct sockaddr_in *v4, struct irc_sockaddr *irc)
144 assert(v4->sin_family == AF_INET);
145 memset(&irc->addr, 0, 6*sizeof(irc->addr.in6_16[0]));
146 memcpy(&irc->addr.in6_16[6], &v4->sin_addr, sizeof(v4->sin_addr));
147 irc->port = ntohs(v4->sin_port);
150 int sockaddr_from_irc(struct sockaddr_in *v4, const struct irc_sockaddr *irc, int compat_fd)
152 v4->sin_family = AF_INET;
154 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));
155 memcpy(&v4->sin_addr, &irc->addr.in6_16[6], sizeof(v4->sin_addr));
156 v4->sin_port = htons(irc->port);
158 memset(&v4, 0, sizeof(v4));
167 * This is part of the STATS replies. There is no offical numeric for this
168 * since this isnt an official command, in much the same way as HASH isnt.
169 * It is also possible that some systems wont support this call or have
170 * different field names for "struct rusage".
173 /** Send resource usage information to a client.
174 * @param[in] cptr Client requesting information.
175 * @param[in] uptime Wall time in seconds since the server started.
176 * @param[in] enumerator Function to call to send a line to \a cptr.
177 * @return Zero if some usage reports could not be sent, non-zero on success.
179 int os_get_rusage(struct Client *cptr, int uptime, EnumFn enumerator)
181 #ifdef HAVE_GETRUSAGE
194 hzz = sysconf(_SC_CLK_TCK);
199 assert(0 != enumerator);
200 if (getrusage(RUSAGE_SELF, &rus) == -1)
203 secs = rus.ru_utime.tv_sec + rus.ru_stime.tv_sec;
207 sprintf(buf, "CPU Secs %ld:%ld User %ld:%ld System %ld:%ld",
208 (long)(secs / 60), (long)(secs % 60),
209 rus.ru_utime.tv_sec / 60, rus.ru_utime.tv_sec % 60,
210 rus.ru_stime.tv_sec / 60, rus.ru_stime.tv_sec % 60);
211 (*enumerator)(cptr, buf);
213 sprintf(buf, "RSS %ld ShMem %ld Data %ld Stack %ld",
215 rus.ru_ixrss / (uptime * hzz), rus.ru_idrss / (uptime * hzz),
216 rus.ru_isrss / (uptime * hzz));
217 (*enumerator)(cptr, buf);
219 sprintf(buf, "Swaps %ld Reclaims %ld Faults %ld",
220 rus.ru_nswap, rus.ru_minflt, rus.ru_majflt);
221 (*enumerator)(cptr, buf);
223 sprintf(buf, "Block in %ld out %ld", rus.ru_inblock, rus.ru_oublock);
224 (*enumerator)(cptr, buf);
226 sprintf(buf, "Msg Rcv %ld Send %ld", rus.ru_msgrcv, rus.ru_msgsnd);
227 (*enumerator)(cptr, buf);
229 sprintf(buf, "Signals %ld Context Vol. %ld Invol %ld",
230 rus.ru_nsignals, rus.ru_nvcsw, rus.ru_nivcsw);
231 (*enumerator)(cptr, buf);
233 #else /* HAVE_GETRUSAGE */
238 int hzz = 1, ticpermin;
239 int umin, smin, usec, ssec;
241 assert(0 != enumerator);
243 hzz = sysconf(_SC_CLK_TCK);
245 ticpermin = hzz * 60;
247 umin = tmsbuf.tms_utime / ticpermin;
248 usec = (tmsbuf.tms_utime % ticpermin) / (float)hzz;
249 smin = tmsbuf.tms_stime / ticpermin;
250 ssec = (tmsbuf.tms_stime % ticpermin) / (float)hzz;
252 mins = (secs / 60) + umin + smin;
255 if (times(&tmsbuf) == -1)
257 secs = tmsbuf.tms_utime + tmsbuf.tms_stime;
259 sprintf(buf, "CPU Secs %d:%d User %d:%d System %d:%d",
260 mins, secs, umin, usec, smin, ssec);
261 (*enumerator)(cptr, buf);
262 #endif /* HAVE_TIMES */
263 #endif /* HAVE_GETRUSAGE */
267 /** Look up the most recent socket error for a socket file descriptor.
268 * @param[in] fd File descriptor to check.
269 * @return Error code from the socket, or 0 if the OS does not support this.
271 int os_get_sockerr(int fd)
274 #if defined(SO_ERROR)
275 unsigned int len = sizeof(err);
276 getsockopt(fd, SOL_SOCKET, SO_ERROR, &err, &len);
281 /** Set a file descriptor to non-blocking mode.
282 * @param[in] fd %Socket file descriptor.
283 * @return Non-zero on success, or zero on failure.
285 int os_set_nonblocking(int fd)
293 * NOTE: consult ALL your relevant manual pages *BEFORE* changing
294 * these ioctl's. There are quite a few variations on them,
295 * as can be seen by the PCS one. They are *NOT* all the same.
296 * Heed this well. - Avalon.
305 /* This portion of code might also apply to NeXT. -LynX */
308 if (ioctl(fd, FIONBIO, &res) == -1)
311 if ((res = fcntl(fd, F_GETFL, 0)) == -1)
313 else if (fcntl(fd, F_SETFL, res | nonb) == -1)
319 /** Mark a socket's address as reusable.
320 * @param[in] fd %Socket file descriptor to manipulate.
321 * @return Non-zero on success, or zero on failure.
323 int os_set_reuseaddr(int fd)
325 unsigned int opt = 1;
326 return (0 == setsockopt(fd, SOL_SOCKET, SO_REUSEADDR,
327 (const char*) &opt, sizeof(opt)));
330 /** Set a socket's send and receive buffer sizes.
331 * @param[in] fd %Socket file descriptor to manipulate.
332 * @param[in] ssize New send buffer size.
333 * @param[in] rsize New receive buffer size.
334 * @return Non-zero on success, or zero on failure.
336 int os_set_sockbufs(int fd, unsigned int ssize, unsigned int rsize)
338 unsigned int sopt = ssize;
339 unsigned int ropt = rsize;
340 return (0 == setsockopt(fd, SOL_SOCKET, SO_RCVBUF,
341 (const char*) &ropt, sizeof(ropt)) &&
342 0 == setsockopt(fd, SOL_SOCKET, SO_SNDBUF,
343 (const char*) &sopt, sizeof(sopt)));
346 /** Set a socket's "type of service" value.
347 * @param[in] fd %Socket file descriptor to manipulate.
348 * @param[in] tos New type of service value to use.
349 * @return Non-zero on success, or zero on failure.
351 int os_set_tos(int fd,int tos)
353 #if defined(IP_TOS) && defined(IPPROTO_IP)
354 unsigned int opt = tos;
355 return (0 == setsockopt(fd, IPPROTO_IP, IP_TOS, &opt, sizeof(opt)));
361 /** Disable IP options on a socket.
362 * @param[in] fd %Socket file descriptor to manipulate.
363 * @return Non-zero on success, or zero on failure.
365 int os_disable_options(int fd)
367 #if defined(IP_OPTIONS) && defined(IPPROTO_IP)
368 return (0 == setsockopt(fd, IPPROTO_IP, IP_OPTIONS, NULL, 0));
375 * Try and find the correct name to use with getrlimit() for setting the max.
376 * number of files allowed to be open by this process.
379 #define RLIMIT_FD_MAX RLIMIT_FDMAX
382 #define RLIMIT_FD_MAX RLIMIT_NOFILE
384 #ifdef RLIMIT_OPEN_MAX
385 #define RLIMIT_FD_MAX RLIMIT_OPEN_MAX
392 /** Set file descriptor limit for the process.
393 * @param[in] max_descriptors Ideal number of file descriptors.
394 * @return Zero on success; -1 on error; positive number of possible
395 * file descriptors if \a max_descriptors is too high.
397 int os_set_fdlimit(unsigned int max_descriptors)
399 #if defined(HAVE_SETRLIMIT) && defined(RLIMIT_FD_MAX)
402 if (!getrlimit(RLIMIT_FD_MAX, &limit)) {
403 if (limit.rlim_max < max_descriptors)
404 return limit.rlim_max;
405 limit.rlim_cur = limit.rlim_max; /* make soft limit the max */
406 return setrlimit(RLIMIT_FD_MAX, &limit);
408 #endif /* defined(HAVE_SETRLIMIT) && defined(RLIMIT_FD_MAX) */
412 /** Attempt to read from a non-blocking socket.
413 * @param[in] fd File descriptor to read from.
414 * @param[out] buf Output buffer to read into.
415 * @param[in] length Number of bytes to read.
416 * @param[out] count_out Receives number of bytes actually read.
417 * @return An IOResult value indicating status.
419 IOResult os_recv_nonb(int fd, char* buf, unsigned int length,
420 unsigned int* count_out)
424 assert(0 != count_out);
428 if (0 < (res = recv(fd, buf, length, 0))) {
429 *count_out = (unsigned) res;
433 if (EWOULDBLOCK == errno || EAGAIN == errno
446 * 0 == client closed the connection
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);
473 res = recvfrom(fd, buf, length, 0, (struct sockaddr*) &addr, &len);
475 if (EWOULDBLOCK == errno || ENOMEM == errno
486 sockaddr_to_irc(&addr, addr_out);
491 /** Attempt to write on a non-blocking UDP socket.
492 * @param[in] fd File descriptor to write to.
493 * @param[in] buf Output buffer to send from.
494 * @param[in] length Number of bytes to write.
495 * @param[out] count_out Receives number of bytes actually written.
496 * @param[in] flags Flags for call to sendto().
497 * @param[in] peer Destination address of the message.
498 * @return An IOResult value indicating status.
500 IOResult os_sendto_nonb(int fd, const char* buf, unsigned int length,
501 unsigned int* count_out, unsigned int flags,
502 const struct irc_sockaddr* peer)
504 struct sockaddr_native addr;
511 size = sockaddr_from_irc(&addr, peer, fd);
512 if (-1 < (res = sendto(fd, buf, length, flags, (struct sockaddr*)&addr, size))) {
514 *count_out = (unsigned) res;
517 else if (EWOULDBLOCK == errno || EAGAIN == errno
529 /** Attempt to write on a connected socket.
530 * @param[in] fd File descriptor to write to.
531 * @param[in] buf Output buffer to send from.
532 * @param[in] length Number of bytes to write.
533 * @param[out] count_out Receives number of bytes actually written.
534 * @return An IOResult value indicating status.
536 IOResult os_send_nonb(int fd, const char* buf, unsigned int length,
537 unsigned int* count_out)
541 assert(0 != count_out);
545 if (-1 < (res = send(fd, buf, length, 0))) {
546 *count_out = (unsigned) res;
549 else if (EWOULDBLOCK == errno || EAGAIN == errno
561 /** Attempt a vectored write on a connected socket.
562 * @param[in] fd File descriptor to write to.
563 * @param[in] buf Message queue to send from.
564 * @param[out] count_in Number of bytes mapped from \a buf.
565 * @param[out] count_out Receives number of bytes actually written.
566 * @return An IOResult value indicating status.
568 IOResult os_sendv_nonb(int fd, struct MsgQ* buf, unsigned int* count_in,
569 unsigned int* count_out)
573 struct iovec iov[IOV_MAX];
576 assert(0 != count_in);
577 assert(0 != count_out);
583 count = msgq_mapiov(buf, iov, IOV_MAX, count_in);
585 if (-1 < (res = writev(fd, iov, count))) {
586 *count_out = (unsigned) res;
589 else if (EWOULDBLOCK == errno || EAGAIN == errno
602 /** Open a TCP or UDP socket on a particular address.
603 * @param[in] local Local address to bind to.
604 * @param[in] type SOCK_STREAM or SOCK_DGRAM.
605 * @param[in] port_name Port name (used in error diagnostics).
606 * @return Bound descriptor, or -1 on error.
608 int os_socket(const struct irc_sockaddr* local, int type, const char* port_name)
610 struct sockaddr_native addr;
613 size = sockaddr_from_irc(&addr, local, -1);
614 fd = socket(addr.sn_family, type, 0);
616 report_error(SOCKET_ERROR_MSG, port_name, errno);
619 if (fd > MAXCLIENTS - 1) {
620 report_error(CONNLIMIT_ERROR_MSG, port_name, 0);
624 if (!os_set_reuseaddr(fd)) {
625 report_error(REUSEADDR_ERROR_MSG, port_name, errno);
629 if (!os_set_nonblocking(fd)) {
630 report_error(NONB_ERROR_MSG, port_name, errno);
635 if (bind(fd, (struct sockaddr*)&addr, size)) {
636 report_error(BIND_ERROR_MSG, port_name, errno);
644 /** Accept a connection on a socket.
645 * @param[in] fd Listening file descriptor.
646 * @param[out] peer Peer address of connection.
647 * @return File descriptor for accepted connection.
649 int os_accept(int fd, struct irc_sockaddr* peer)
651 struct sockaddr_native addr;
655 addrlen = sizeof(addr);
656 new_fd = accept(fd, (struct sockaddr*)&addr, &addrlen);
658 memset(peer, 0, sizeof(*peer));
660 sockaddr_to_irc(&addr, peer);
664 /** Start a non-blocking connection.
665 * @param[in] fd Disconnected file descriptor.
666 * @param[in] sin Target address for connection.
667 * @return IOResult code indicating status.
669 IOResult os_connect_nonb(int fd, const struct irc_sockaddr* sin)
671 struct sockaddr_native addr;
674 size = sockaddr_from_irc(&addr, sin, fd);
675 if (connect(fd, (struct sockaddr*) &addr, size))
676 return (errno == EINPROGRESS) ? IO_BLOCKED : IO_FAILURE;
680 /** Get local address of a socket.
681 * @param[in] fd File descriptor to operate on.
682 * @param[out] sin_out Receives local socket address.
683 * @return Non-zero on success; zero on error.
685 int os_get_sockname(int fd, struct irc_sockaddr* sin_out)
687 struct sockaddr_native addr;
688 unsigned int len = sizeof(addr);
690 assert(0 != sin_out);
691 if (getsockname(fd, (struct sockaddr*) &addr, &len))
693 sockaddr_to_irc(&addr, sin_out);
697 /** Get remote address of a socket.
698 * @param[in] fd File descriptor to operate on.
699 * @param[out] sin_out Receives remote socket address.
700 * @return Non-zero on success; zero on error.
702 int os_get_peername(int fd, struct irc_sockaddr* sin_out)
704 struct sockaddr_native addr;
705 unsigned int len = sizeof(addr);
707 assert(0 != sin_out);
708 if (getpeername(fd, (struct sockaddr*) &addr, &len))
710 sockaddr_to_irc(&addr, sin_out);
714 /** Start listening on a socket.
715 * @param[in] fd Disconnected file descriptor.
716 * @param[in] backlog Maximum number of un-accept()ed connections to keep.
717 * @return Non-zero on success; zero on error.
719 int os_set_listen(int fd, int backlog)
721 return (0 == listen(fd, backlog));