]>
jfr.im git - irc/quakenet/snircd.git/blob - ircd/os_generic.c
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.
21 * @version $Id: os_generic.c,v 1.23.2.4 2006/03/14 03:45:52 entrope Exp $
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
32 #elif defined(__FreeBSD__) && __FreeBSD__ >= 5
33 /* FreeBSD 6.0 requires SUSv3 to support IPv6 -- but if you ask for
34 * that specifically (by defining _XOPEN_SOURCE to anything at all),
35 * they cleverly hide IPPROTO_IPV6. If you don't ask for anything,
36 * they give you everything.
39 #define _XOPEN_SOURCE 600
42 #include "ircd_osdep.h"
49 /* Include file dependency notes:
50 * FreeBSD requires struct timeval from sys/time.h before struct
51 * rusage in sys/resource.h.
52 * Solaris requires sys/time.h before struct rusage (indirectly) in
55 /* #include <assert.h> -- Now using assert in ircd_log.h */
61 #include <sys/ioctl.h>
62 #include <sys/types.h>
64 #include <netinet/in.h>
65 #include <sys/resource.h>
66 #include <sys/socket.h>
70 #include <sys/param.h>
77 #if defined(IPV6_BINDV6ONLY) &&!defined(IPV6_V6ONLY)
78 # define IPV6_V6ONLY IPV6_BINDV6ONLY
82 #define IOV_MAX 16 /**< minimum required length of an iovec array */
86 #include <sys/syscall.h>
87 #define getrusage(a,b) syscall(SYS_GETRUSAGE, a, b)
90 static int is_blocked(int error
)
92 return EWOULDBLOCK
== error
102 static void sockaddr_in_to_irc(const struct sockaddr_in
*v4
,
103 struct irc_sockaddr
*irc
)
105 memset(&irc
->addr
, 0, 5*sizeof(int16_t));
106 irc
->addr
.in6_16
[5] = 0xffff;
107 memcpy(&irc
->addr
.in6_16
[6], &v4
->sin_addr
, sizeof(v4
->sin_addr
));
108 irc
->port
= ntohs(v4
->sin_port
);
113 /** Native socket address type. */
114 #define sockaddr_native sockaddr_in6
115 /** Field name inside sockaddr_native to find address family. */
116 #define sn_family sin6_family
118 /** Convert native socket address to IRC format.
119 * @param[in] v6 Native socket address.
120 * @param[out] irc IRC format socket address.
122 void sockaddr_to_irc(const struct sockaddr_in6
*v6
, struct irc_sockaddr
*irc
)
124 if (v6
->sin6_family
== AF_INET6
) {
125 memcpy(&irc
->addr
.in6_16
[0], &v6
->sin6_addr
, sizeof(v6
->sin6_addr
));
126 irc
->port
= ntohs(v6
->sin6_port
);
128 else if (v6
->sin6_family
== AF_INET
) {
129 sockaddr_in_to_irc((struct sockaddr_in
*)v6
, irc
);
131 else assert(0 && "Unhandled native address family");
134 /** Convert IRC socket address to native format.
135 * @param[out] v6 Native socket address.
136 * @param[in] irc IRC socket address.
137 * @param[in] compat_fd If non-negative, an FD specifying address family.
138 * @return Length of address written to \a v6.
140 int sockaddr_from_irc(struct sockaddr_in6
*v6
, const struct irc_sockaddr
*irc
, int compat_fd
, int family
)
142 struct sockaddr_in6 sin6
;
148 /* accept whatever user specified */
149 } else if ((0 <= compat_fd
)
150 && (0 == getsockname(compat_fd
, (struct sockaddr
*)&sin6
, &slen
)))
151 family
= sin6
.sin6_family
;
152 else if ((irc
== &VirtualHost_v4
) || irc_in_addr_is_ipv4(&irc
->addr
))
157 memset(v6
, 0, sizeof(*v6
));
158 if (family
== AF_INET
) {
159 struct sockaddr_in
*v4
= (struct sockaddr_in
*)v6
;
160 v4
->sin_family
= AF_INET
;
161 memcpy(&v4
->sin_addr
, &irc
->addr
.in6_16
[6], sizeof(v4
->sin_addr
));
162 v4
->sin_port
= htons(irc
->port
);
166 v6
->sin6_family
= AF_INET6
;
167 memcpy(&v6
->sin6_addr
, &irc
->addr
.in6_16
[0], sizeof(v6
->sin6_addr
));
168 v6
->sin6_port
= htons(irc
->port
);
174 #define sockaddr_native sockaddr_in
175 #define sn_family sin_family
176 #define sockaddr_to_irc sockaddr_in_to_irc
178 int sockaddr_from_irc(struct sockaddr_in
*v4
, const struct irc_sockaddr
*irc
, int compat_fd
, int family
)
181 v4
->sin_family
= AF_INET
;
183 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));
184 memcpy(&v4
->sin_addr
, &irc
->addr
.in6_16
[6], sizeof(v4
->sin_addr
));
185 v4
->sin_port
= htons(irc
->port
);
187 memset(&v4
, 0, sizeof(v4
));
189 (void)compat_fd
; (void)family
;
196 /** Send resource usage information to an enumerator function.
197 * @param[in] cptr Client requesting information.
198 * @param[in] uptime Wall time in seconds since the server started.
199 * @param[in] enumerator Function to call to send a line to \a cptr.
200 * @return Zero if some usage reports could not be sent, non-zero on success.
202 int os_get_rusage(struct Client
*cptr
, int uptime
, EnumFn enumerator
)
204 #ifdef HAVE_GETRUSAGE
217 hzz
= sysconf(_SC_CLK_TCK
);
222 assert(0 != enumerator
);
223 if (getrusage(RUSAGE_SELF
, &rus
) == -1)
226 secs
= rus
.ru_utime
.tv_sec
+ rus
.ru_stime
.tv_sec
;
230 sprintf(buf
, "CPU Secs %ld:%ld User %ld:%ld System %ld:%ld",
231 (long)(secs
/ 60), (long)(secs
% 60),
232 rus
.ru_utime
.tv_sec
/ 60, rus
.ru_utime
.tv_sec
% 60,
233 rus
.ru_stime
.tv_sec
/ 60, rus
.ru_stime
.tv_sec
% 60);
234 (*enumerator
)(cptr
, buf
);
236 sprintf(buf
, "RSS %ld ShMem %ld Data %ld Stack %ld",
238 rus
.ru_ixrss
/ (uptime
* hzz
), rus
.ru_idrss
/ (uptime
* hzz
),
239 rus
.ru_isrss
/ (uptime
* hzz
));
240 (*enumerator
)(cptr
, buf
);
242 sprintf(buf
, "Swaps %ld Reclaims %ld Faults %ld",
243 rus
.ru_nswap
, rus
.ru_minflt
, rus
.ru_majflt
);
244 (*enumerator
)(cptr
, buf
);
246 sprintf(buf
, "Block in %ld out %ld", rus
.ru_inblock
, rus
.ru_oublock
);
247 (*enumerator
)(cptr
, buf
);
249 sprintf(buf
, "Msg Rcv %ld Send %ld", rus
.ru_msgrcv
, rus
.ru_msgsnd
);
250 (*enumerator
)(cptr
, buf
);
252 sprintf(buf
, "Signals %ld Context Vol. %ld Invol %ld",
253 rus
.ru_nsignals
, rus
.ru_nvcsw
, rus
.ru_nivcsw
);
254 (*enumerator
)(cptr
, buf
);
256 #else /* HAVE_GETRUSAGE */
261 int hzz
= 1, ticpermin
;
262 int umin
, smin
, usec
, ssec
;
264 assert(0 != enumerator
);
266 hzz
= sysconf(_SC_CLK_TCK
);
268 ticpermin
= hzz
* 60;
270 umin
= tmsbuf
.tms_utime
/ ticpermin
;
271 usec
= (tmsbuf
.tms_utime
% ticpermin
) / (float)hzz
;
272 smin
= tmsbuf
.tms_stime
/ ticpermin
;
273 ssec
= (tmsbuf
.tms_stime
% ticpermin
) / (float)hzz
;
275 mins
= (secs
/ 60) + umin
+ smin
;
278 if (times(&tmsbuf
) == -1)
280 secs
= tmsbuf
.tms_utime
+ tmsbuf
.tms_stime
;
282 sprintf(buf
, "CPU Secs %d:%d User %d:%d System %d:%d",
283 mins
, secs
, umin
, usec
, smin
, ssec
);
284 (*enumerator
)(cptr
, buf
);
285 #endif /* HAVE_TIMES */
286 #endif /* HAVE_GETRUSAGE */
291 /** Look up the most recent socket error for a socket file descriptor.
292 * @param[in] fd File descriptor to check.
293 * @return Error code from the socket, or 0 if the OS does not support this.
295 int os_get_sockerr(int fd
)
298 #if defined(SO_ERROR)
299 unsigned int len
= sizeof(err
);
300 getsockopt(fd
, SOL_SOCKET
, SO_ERROR
, &err
, &len
);
305 /** Set a file descriptor to non-blocking mode.
306 * @param[in] fd %Socket file descriptor.
307 * @return Non-zero on success, or zero on failure.
309 int os_set_nonblocking(int fd
)
317 * NOTE: consult ALL your relevant manual pages *BEFORE* changing
318 * these ioctl's. There are quite a few variations on them,
319 * as can be seen by the PCS one. They are *NOT* all the same.
320 * Heed this well. - Avalon.
329 /* This portion of code might also apply to NeXT. -LynX */
332 if (ioctl(fd
, FIONBIO
, &res
) == -1)
335 if ((res
= fcntl(fd
, F_GETFL
, 0)) == -1)
337 else if (fcntl(fd
, F_SETFL
, res
| nonb
) == -1)
343 /** Mark a socket's address as reusable.
344 * @param[in] fd %Socket file descriptor to manipulate.
345 * @return Non-zero on success, or zero on failure.
347 int os_set_reuseaddr(int fd
)
349 unsigned int opt
= 1;
350 return (0 == setsockopt(fd
, SOL_SOCKET
, SO_REUSEADDR
,
351 (const char*) &opt
, sizeof(opt
)));
354 /** Set a socket's send and receive buffer sizes.
355 * @param[in] fd %Socket file descriptor to manipulate.
356 * @param[in] ssize New send buffer size.
357 * @param[in] rsize New receive buffer size.
358 * @return Non-zero on success, or zero on failure.
360 int os_set_sockbufs(int fd
, unsigned int ssize
, unsigned int rsize
)
362 unsigned int sopt
= ssize
;
363 unsigned int ropt
= rsize
;
364 return (0 == setsockopt(fd
, SOL_SOCKET
, SO_RCVBUF
,
365 (const char*) &ropt
, sizeof(ropt
)) &&
366 0 == setsockopt(fd
, SOL_SOCKET
, SO_SNDBUF
,
367 (const char*) &sopt
, sizeof(sopt
)));
370 /** Set a socket's "type of service" value.
371 * @param[in] fd %Socket file descriptor to manipulate.
372 * @param[in] tos New type of service value to use.
373 * @return Non-zero on success, or zero on failure.
375 int os_set_tos(int fd
,int tos
)
377 #if defined(IP_TOS) && defined(IPPROTO_IP)
378 unsigned int opt
= tos
;
379 return (0 == setsockopt(fd
, IPPROTO_IP
, IP_TOS
, &opt
, sizeof(opt
)));
385 /** Disable IP options on a socket.
386 * @param[in] fd %Socket file descriptor to manipulate.
387 * @return Non-zero on success, or zero on failure.
389 int os_disable_options(int fd
)
391 #if defined(IP_OPTIONS) && defined(IPPROTO_IP)
392 return (0 == setsockopt(fd
, IPPROTO_IP
, IP_OPTIONS
, NULL
, 0));
399 * Try and find the correct name to use with getrlimit() for setting the max.
400 * number of files allowed to be open by this process.
403 #define RLIMIT_FD_MAX RLIMIT_FDMAX
406 #define RLIMIT_FD_MAX RLIMIT_NOFILE
408 #ifdef RLIMIT_OPEN_MAX
409 #define RLIMIT_FD_MAX RLIMIT_OPEN_MAX
416 /** Set file descriptor limit for the process.
417 * @param[in] max_descriptors Ideal number of file descriptors.
418 * @return Zero on success; -1 on error; positive number of possible
419 * file descriptors if \a max_descriptors is too high.
421 int os_set_fdlimit(unsigned int max_descriptors
)
423 #if defined(HAVE_SETRLIMIT) && defined(RLIMIT_FD_MAX)
426 if (!getrlimit(RLIMIT_FD_MAX
, &limit
)) {
427 if (limit
.rlim_max
< max_descriptors
)
428 return limit
.rlim_max
;
429 limit
.rlim_cur
= limit
.rlim_max
; /* make soft limit the max */
430 return setrlimit(RLIMIT_FD_MAX
, &limit
);
432 #endif /* defined(HAVE_SETRLIMIT) && defined(RLIMIT_FD_MAX) */
436 /** Attempt to read from a non-blocking socket.
437 * @param[in] fd File descriptor to read from.
438 * @param[out] buf Output buffer to read into.
439 * @param[in] length Number of bytes to read.
440 * @param[out] count_out Receives number of bytes actually read.
441 * @return An IOResult value indicating status.
443 IOResult
os_recv_nonb(int fd
, char* buf
, unsigned int length
,
444 unsigned int* count_out
)
448 assert(0 != count_out
);
450 if (0 < (res
= recv(fd
, buf
, length
, 0))) {
451 *count_out
= (unsigned) res
;
455 return (res
< 0) && is_blocked(errno
) ? IO_BLOCKED
: IO_FAILURE
;
459 /** Attempt to read from a non-blocking UDP socket.
460 * @param[in] fd File descriptor to read from.
461 * @param[out] buf Output buffer to read into.
462 * @param[in] length Number of bytes to read.
463 * @param[out] length_out Receives number of bytes actually read.
464 * @param[out] addr_out Peer address that sent the message.
465 * @return An IOResult value indicating status.
467 IOResult
os_recvfrom_nonb(int fd
, char* buf
, unsigned int length
,
468 unsigned int* length_out
,
469 struct irc_sockaddr
* addr_out
)
471 struct sockaddr_native addr
;
472 unsigned int len
= sizeof(addr
);
475 assert(0 != length_out
);
476 assert(0 != addr_out
);
478 res
= recvfrom(fd
, buf
, length
, 0, (struct sockaddr
*) &addr
, &len
);
480 sockaddr_to_irc(&addr
, addr_out
);
485 return is_blocked(errno
) ? IO_BLOCKED
: IO_FAILURE
;
489 /** Attempt to write on a non-blocking UDP socket.
490 * @param[in] fd File descriptor to write to.
491 * @param[in] buf Output buffer to send from.
492 * @param[in] length Number of bytes to write.
493 * @param[out] count_out Receives number of bytes actually written.
494 * @param[in] flags Flags for call to sendto().
495 * @param[in] peer Destination address of the message.
496 * @return An IOResult value indicating status.
498 IOResult
os_sendto_nonb(int fd
, const char* buf
, unsigned int length
,
499 unsigned int* count_out
, unsigned int flags
,
500 const struct irc_sockaddr
* peer
)
502 struct sockaddr_native addr
;
506 size
= sockaddr_from_irc(&addr
, peer
, fd
, 0);
507 assert((addr
.sn_family
== AF_INET
) == irc_in_addr_is_ipv4(&peer
->addr
));
508 if (-1 < (res
= sendto(fd
, buf
, length
, flags
, (struct sockaddr
*)&addr
, size
))) {
510 *count_out
= (unsigned) res
;
515 return is_blocked(errno
) ? IO_BLOCKED
: IO_FAILURE
;
519 /** Attempt to write on a connected socket.
520 * @param[in] fd File descriptor to write to.
521 * @param[in] buf Output buffer to send from.
522 * @param[in] length Number of bytes to write.
523 * @param[out] count_out Receives number of bytes actually written.
524 * @return An IOResult value indicating status.
526 IOResult
os_send_nonb(int fd
, const char* buf
, unsigned int length
,
527 unsigned int* count_out
)
531 assert(0 != count_out
);
533 if (-1 < (res
= send(fd
, buf
, length
, 0))) {
534 *count_out
= (unsigned) res
;
538 return is_blocked(errno
) ? IO_BLOCKED
: IO_FAILURE
;
542 /** Attempt a vectored write on a connected socket.
543 * @param[in] fd File descriptor to write to.
544 * @param[in] buf Message queue to send from.
545 * @param[out] count_in Number of bytes mapped from \a buf.
546 * @param[out] count_out Receives number of bytes actually written.
547 * @return An IOResult value indicating status.
549 IOResult
os_sendv_nonb(int fd
, struct MsgQ
* buf
, unsigned int* count_in
,
550 unsigned int* count_out
)
554 struct iovec iov
[IOV_MAX
];
557 assert(0 != count_in
);
558 assert(0 != count_out
);
561 count
= msgq_mapiov(buf
, iov
, IOV_MAX
, count_in
);
563 if (-1 < (res
= writev(fd
, iov
, count
))) {
564 *count_out
= (unsigned) res
;
568 return is_blocked(errno
) ? IO_BLOCKED
: IO_FAILURE
;
572 /** Open a TCP or UDP socket on a particular address.
573 * @param[in] local Local address to bind to.
574 * @param[in] type SOCK_STREAM or SOCK_DGRAM.
575 * @param[in] port_name Port name (used in error diagnostics).
576 * @param[in] family A specific address family to use, or 0 for automatic.
577 * @return Bound descriptor, or -1 on error.
579 int os_socket(const struct irc_sockaddr
* local
, int type
, const char* port_name
, int family
)
581 struct sockaddr_native addr
;
585 size
= sockaddr_from_irc(&addr
, local
, -1, family
);
586 fd
= socket(addr
.sn_family
, type
, 0);
588 report_error(SOCKET_ERROR_MSG
, port_name
, errno
);
591 if (fd
> MAXCLIENTS
- 1) {
592 report_error(CONNLIMIT_ERROR_MSG
, port_name
, 0);
596 if (!os_set_reuseaddr(fd
)) {
597 report_error(REUSEADDR_ERROR_MSG
, port_name
, errno
);
601 if (!os_set_nonblocking(fd
)) {
602 report_error(NONB_ERROR_MSG
, port_name
, errno
);
607 #if defined(IPV6_V6ONLY)
609 if (family
== 0 && irc_in_addr_unspec(&local
->addr
))
610 setsockopt(fd
, IPPROTO_IPV6
, IPV6_V6ONLY
, &on
, sizeof(on
));
612 if (bind(fd
, (struct sockaddr
*)&addr
, size
)) {
613 report_error(BIND_ERROR_MSG
, port_name
, errno
);
621 /** Accept a connection on a socket.
622 * @param[in] fd Listening file descriptor.
623 * @param[out] peer Peer address of connection.
624 * @return File descriptor for accepted connection.
626 int os_accept(int fd
, struct irc_sockaddr
* peer
)
628 struct sockaddr_native addr
;
632 addrlen
= sizeof(addr
);
633 new_fd
= accept(fd
, (struct sockaddr
*)&addr
, &addrlen
);
635 memset(peer
, 0, sizeof(*peer
));
637 sockaddr_to_irc(&addr
, peer
);
641 /** Start a non-blocking connection.
642 * @param[in] fd Disconnected file descriptor.
643 * @param[in] sin Target address for connection.
644 * @return IOResult code indicating status.
646 IOResult
os_connect_nonb(int fd
, const struct irc_sockaddr
* sin
)
648 struct sockaddr_native addr
;
651 size
= sockaddr_from_irc(&addr
, sin
, fd
, 0);
652 if (0 == connect(fd
, (struct sockaddr
*) &addr
, size
))
654 else if (errno
== EINPROGRESS
)
660 /** Get local address of a socket.
661 * @param[in] fd File descriptor to operate on.
662 * @param[out] sin_out Receives local socket address.
663 * @return Non-zero on success; zero on error.
665 int os_get_sockname(int fd
, struct irc_sockaddr
* sin_out
)
667 struct sockaddr_native addr
;
668 unsigned int len
= sizeof(addr
);
670 assert(0 != sin_out
);
671 if (getsockname(fd
, (struct sockaddr
*) &addr
, &len
))
673 sockaddr_to_irc(&addr
, sin_out
);
677 /** Get remote address of a socket.
678 * @param[in] fd File descriptor to operate on.
679 * @param[out] sin_out Receives remote socket address.
680 * @return Non-zero on success; zero on error.
682 int os_get_peername(int fd
, struct irc_sockaddr
* sin_out
)
684 struct sockaddr_native addr
;
685 unsigned int len
= sizeof(addr
);
687 assert(0 != sin_out
);
688 if (getpeername(fd
, (struct sockaddr
*) &addr
, &len
))
690 sockaddr_to_irc(&addr
, sin_out
);
694 /** Start listening on a socket.
695 * @param[in] fd Disconnected file descriptor.
696 * @param[in] backlog Maximum number of un-accept()ed connections to keep.
697 * @return Non-zero on success; zero on error.
699 int os_set_listen(int fd
, int backlog
)
701 return (0 == listen(fd
, backlog
));
704 /** Allocate a connected pair of local sockets.
705 * @param[out] sv Array of two file descriptors.
706 * @return Zero on success; non-zero number on error.
708 int os_socketpair(int sv
[2])
710 return socketpair(AF_UNIX
, SOCK_STREAM
, 0, sv
);