]>
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.1 2005/10/12 01:48:33 entrope Exp $
25 #define _XOPEN_SOURCE 600 /**< make limits.h #define IOV_MAX */
26 #define __EXTENSIONS__ 1 /**< make Solaris netinet/in.h know IPv6 */
28 #include "ircd_osdep.h"
35 /* Include file dependency notes:
36 * FreeBSD requires struct timeval from sys/time.h before struct
37 * rusage in sys/resource.h.
38 * Solaris requires sys/time.h before struct rusage (indirectly) in
41 /* #include <assert.h> -- Now using assert in ircd_log.h */
47 #include <sys/ioctl.h>
48 #include <sys/types.h>
50 #include <netinet/in.h>
51 #include <sys/resource.h>
52 #include <sys/socket.h>
56 #include <sys/param.h>
64 #define IOV_MAX 16 /**< minimum required length of an iovec array */
68 #include <sys/syscall.h>
69 #define getrusage(a,b) syscall(SYS_GETRUSAGE, a, b)
73 static void sockaddr_in_to_irc(const struct sockaddr_in
*v4
,
74 struct irc_sockaddr
*irc
)
76 memset(&irc
->addr
, 0, 5*sizeof(int16_t));
77 irc
->addr
.in6_16
[5] = 0xffff;
78 memcpy(&irc
->addr
.in6_16
[6], &v4
->sin_addr
, sizeof(v4
->sin_addr
));
79 irc
->port
= ntohs(v4
->sin_port
);
84 /** Native socket address type. */
85 #define sockaddr_native sockaddr_in6
86 /** Field name inside sockaddr_native to find address family. */
87 #define sn_family sin6_family
89 /** Convert native socket address to IRC format.
90 * @param[in] v6 Native socket address.
91 * @param[out] irc IRC format socket address.
93 void sockaddr_to_irc(const struct sockaddr_in6
*v6
, struct irc_sockaddr
*irc
)
95 if (v6
->sin6_family
== AF_INET6
) {
96 memcpy(&irc
->addr
.in6_16
[0], &v6
->sin6_addr
, sizeof(v6
->sin6_addr
));
97 irc
->port
= ntohs(v6
->sin6_port
);
99 else if (v6
->sin6_family
== AF_INET
) {
100 sockaddr_in_to_irc((struct sockaddr_in
*)v6
, irc
);
102 else assert(0 && "Unhandled native address family");
105 /** Convert IRC socket address to native format.
106 * @param[out] v6 Native socket address.
107 * @param[in] irc IRC socket address.
108 * @param[in] compat_fd If non-negative, an FD specifying address family.
109 * @return Length of address written to \a v6.
111 int sockaddr_from_irc(struct sockaddr_in6
*v6
, const struct irc_sockaddr
*irc
, int compat_fd
)
113 struct sockaddr_in6 sin6
;
120 && (0 == getsockname(compat_fd
, (struct sockaddr
*)&sin6
, &slen
)))
121 family
= sin6
.sin6_family
;
122 else if ((irc
== &VirtualHost_v4
) || irc_in_addr_is_ipv4(&irc
->addr
))
127 memset(v6
, 0, sizeof(*v6
));
128 if (family
== AF_INET
) {
129 struct sockaddr_in
*v4
= (struct sockaddr_in
*)v6
;
130 v4
->sin_family
= AF_INET
;
131 memcpy(&v4
->sin_addr
, &irc
->addr
.in6_16
[6], sizeof(v4
->sin_addr
));
132 v4
->sin_port
= htons(irc
->port
);
136 v6
->sin6_family
= AF_INET6
;
137 memcpy(&v6
->sin6_addr
, &irc
->addr
.in6_16
[0], sizeof(v6
->sin6_addr
));
138 v6
->sin6_port
= htons(irc
->port
);
144 #define sockaddr_native sockaddr_in
145 #define sn_family sin_family
146 #define sockaddr_to_irc sockaddr_in_to_irc
148 int sockaddr_from_irc(struct sockaddr_in
*v4
, const struct irc_sockaddr
*irc
, int compat_fd
)
151 v4
->sin_family
= AF_INET
;
153 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));
154 memcpy(&v4
->sin_addr
, &irc
->addr
.in6_16
[6], sizeof(v4
->sin_addr
));
155 v4
->sin_port
= htons(irc
->port
);
157 memset(&v4
, 0, sizeof(v4
));
166 /** Send resource usage information to an enumerator function.
167 * @param[in] cptr Client requesting information.
168 * @param[in] uptime Wall time in seconds since the server started.
169 * @param[in] enumerator Function to call to send a line to \a cptr.
170 * @return Zero if some usage reports could not be sent, non-zero on success.
172 int os_get_rusage(struct Client
*cptr
, int uptime
, EnumFn enumerator
)
174 #ifdef HAVE_GETRUSAGE
187 hzz
= sysconf(_SC_CLK_TCK
);
192 assert(0 != enumerator
);
193 if (getrusage(RUSAGE_SELF
, &rus
) == -1)
196 secs
= rus
.ru_utime
.tv_sec
+ rus
.ru_stime
.tv_sec
;
200 sprintf(buf
, "CPU Secs %ld:%ld User %ld:%ld System %ld:%ld",
201 (long)(secs
/ 60), (long)(secs
% 60),
202 rus
.ru_utime
.tv_sec
/ 60, rus
.ru_utime
.tv_sec
% 60,
203 rus
.ru_stime
.tv_sec
/ 60, rus
.ru_stime
.tv_sec
% 60);
204 (*enumerator
)(cptr
, buf
);
206 sprintf(buf
, "RSS %ld ShMem %ld Data %ld Stack %ld",
208 rus
.ru_ixrss
/ (uptime
* hzz
), rus
.ru_idrss
/ (uptime
* hzz
),
209 rus
.ru_isrss
/ (uptime
* hzz
));
210 (*enumerator
)(cptr
, buf
);
212 sprintf(buf
, "Swaps %ld Reclaims %ld Faults %ld",
213 rus
.ru_nswap
, rus
.ru_minflt
, rus
.ru_majflt
);
214 (*enumerator
)(cptr
, buf
);
216 sprintf(buf
, "Block in %ld out %ld", rus
.ru_inblock
, rus
.ru_oublock
);
217 (*enumerator
)(cptr
, buf
);
219 sprintf(buf
, "Msg Rcv %ld Send %ld", rus
.ru_msgrcv
, rus
.ru_msgsnd
);
220 (*enumerator
)(cptr
, buf
);
222 sprintf(buf
, "Signals %ld Context Vol. %ld Invol %ld",
223 rus
.ru_nsignals
, rus
.ru_nvcsw
, rus
.ru_nivcsw
);
224 (*enumerator
)(cptr
, buf
);
226 #else /* HAVE_GETRUSAGE */
231 int hzz
= 1, ticpermin
;
232 int umin
, smin
, usec
, ssec
;
234 assert(0 != enumerator
);
236 hzz
= sysconf(_SC_CLK_TCK
);
238 ticpermin
= hzz
* 60;
240 umin
= tmsbuf
.tms_utime
/ ticpermin
;
241 usec
= (tmsbuf
.tms_utime
% ticpermin
) / (float)hzz
;
242 smin
= tmsbuf
.tms_stime
/ ticpermin
;
243 ssec
= (tmsbuf
.tms_stime
% ticpermin
) / (float)hzz
;
245 mins
= (secs
/ 60) + umin
+ smin
;
248 if (times(&tmsbuf
) == -1)
250 secs
= tmsbuf
.tms_utime
+ tmsbuf
.tms_stime
;
252 sprintf(buf
, "CPU Secs %d:%d User %d:%d System %d:%d",
253 mins
, secs
, umin
, usec
, smin
, ssec
);
254 (*enumerator
)(cptr
, buf
);
255 #endif /* HAVE_TIMES */
256 #endif /* HAVE_GETRUSAGE */
261 /** Look up the most recent socket error for a socket file descriptor.
262 * @param[in] fd File descriptor to check.
263 * @return Error code from the socket, or 0 if the OS does not support this.
265 int os_get_sockerr(int fd
)
268 #if defined(SO_ERROR)
269 unsigned int len
= sizeof(err
);
270 getsockopt(fd
, SOL_SOCKET
, SO_ERROR
, &err
, &len
);
275 /** Set a file descriptor to non-blocking mode.
276 * @param[in] fd %Socket file descriptor.
277 * @return Non-zero on success, or zero on failure.
279 int os_set_nonblocking(int fd
)
287 * NOTE: consult ALL your relevant manual pages *BEFORE* changing
288 * these ioctl's. There are quite a few variations on them,
289 * as can be seen by the PCS one. They are *NOT* all the same.
290 * Heed this well. - Avalon.
299 /* This portion of code might also apply to NeXT. -LynX */
302 if (ioctl(fd
, FIONBIO
, &res
) == -1)
305 if ((res
= fcntl(fd
, F_GETFL
, 0)) == -1)
307 else if (fcntl(fd
, F_SETFL
, res
| nonb
) == -1)
313 /** Mark a socket's address as reusable.
314 * @param[in] fd %Socket file descriptor to manipulate.
315 * @return Non-zero on success, or zero on failure.
317 int os_set_reuseaddr(int fd
)
319 unsigned int opt
= 1;
320 return (0 == setsockopt(fd
, SOL_SOCKET
, SO_REUSEADDR
,
321 (const char*) &opt
, sizeof(opt
)));
324 /** Set a socket's send and receive buffer sizes.
325 * @param[in] fd %Socket file descriptor to manipulate.
326 * @param[in] ssize New send buffer size.
327 * @param[in] rsize New receive buffer size.
328 * @return Non-zero on success, or zero on failure.
330 int os_set_sockbufs(int fd
, unsigned int ssize
, unsigned int rsize
)
332 unsigned int sopt
= ssize
;
333 unsigned int ropt
= rsize
;
334 return (0 == setsockopt(fd
, SOL_SOCKET
, SO_RCVBUF
,
335 (const char*) &ropt
, sizeof(ropt
)) &&
336 0 == setsockopt(fd
, SOL_SOCKET
, SO_SNDBUF
,
337 (const char*) &sopt
, sizeof(sopt
)));
340 /** Set a socket's "type of service" value.
341 * @param[in] fd %Socket file descriptor to manipulate.
342 * @param[in] tos New type of service value to use.
343 * @return Non-zero on success, or zero on failure.
345 int os_set_tos(int fd
,int tos
)
347 #if defined(IP_TOS) && defined(IPPROTO_IP)
348 unsigned int opt
= tos
;
349 return (0 == setsockopt(fd
, IPPROTO_IP
, IP_TOS
, &opt
, sizeof(opt
)));
355 /** Disable IP options on a socket.
356 * @param[in] fd %Socket file descriptor to manipulate.
357 * @return Non-zero on success, or zero on failure.
359 int os_disable_options(int fd
)
361 #if defined(IP_OPTIONS) && defined(IPPROTO_IP)
362 return (0 == setsockopt(fd
, IPPROTO_IP
, IP_OPTIONS
, NULL
, 0));
369 * Try and find the correct name to use with getrlimit() for setting the max.
370 * number of files allowed to be open by this process.
373 #define RLIMIT_FD_MAX RLIMIT_FDMAX
376 #define RLIMIT_FD_MAX RLIMIT_NOFILE
378 #ifdef RLIMIT_OPEN_MAX
379 #define RLIMIT_FD_MAX RLIMIT_OPEN_MAX
386 /** Set file descriptor limit for the process.
387 * @param[in] max_descriptors Ideal number of file descriptors.
388 * @return Zero on success; -1 on error; positive number of possible
389 * file descriptors if \a max_descriptors is too high.
391 int os_set_fdlimit(unsigned int max_descriptors
)
393 #if defined(HAVE_SETRLIMIT) && defined(RLIMIT_FD_MAX)
396 if (!getrlimit(RLIMIT_FD_MAX
, &limit
)) {
397 if (limit
.rlim_max
< max_descriptors
)
398 return limit
.rlim_max
;
399 limit
.rlim_cur
= limit
.rlim_max
; /* make soft limit the max */
400 return setrlimit(RLIMIT_FD_MAX
, &limit
);
402 #endif /* defined(HAVE_SETRLIMIT) && defined(RLIMIT_FD_MAX) */
406 /** Attempt to read from a non-blocking socket.
407 * @param[in] fd File descriptor to read from.
408 * @param[out] buf Output buffer to read into.
409 * @param[in] length Number of bytes to read.
410 * @param[out] count_out Receives number of bytes actually read.
411 * @return An IOResult value indicating status.
413 IOResult
os_recv_nonb(int fd
, char* buf
, unsigned int length
,
414 unsigned int* count_out
)
418 assert(0 != count_out
);
422 if (0 < (res
= recv(fd
, buf
, length
, 0))) {
423 *count_out
= (unsigned) res
;
427 if (EWOULDBLOCK
== errno
|| EAGAIN
== errno
440 * 0 == client closed the connection
446 /** Attempt to read from a non-blocking UDP socket.
447 * @param[in] fd File descriptor to read from.
448 * @param[out] buf Output buffer to read into.
449 * @param[in] length Number of bytes to read.
450 * @param[out] length_out Receives number of bytes actually read.
451 * @param[out] addr_out Peer address that sent the message.
452 * @return An IOResult value indicating status.
454 IOResult
os_recvfrom_nonb(int fd
, char* buf
, unsigned int length
,
455 unsigned int* length_out
,
456 struct irc_sockaddr
* addr_out
)
458 struct sockaddr_native addr
;
459 unsigned int len
= sizeof(addr
);
462 assert(0 != length_out
);
463 assert(0 != addr_out
);
467 res
= recvfrom(fd
, buf
, length
, 0, (struct sockaddr
*) &addr
, &len
);
469 if (EWOULDBLOCK
== errno
|| ENOMEM
== errno
480 sockaddr_to_irc(&addr
, addr_out
);
485 /** Attempt to write on a non-blocking UDP socket.
486 * @param[in] fd File descriptor to write to.
487 * @param[in] buf Output buffer to send from.
488 * @param[in] length Number of bytes to write.
489 * @param[out] count_out Receives number of bytes actually written.
490 * @param[in] flags Flags for call to sendto().
491 * @param[in] peer Destination address of the message.
492 * @return An IOResult value indicating status.
494 IOResult
os_sendto_nonb(int fd
, const char* buf
, unsigned int length
,
495 unsigned int* count_out
, unsigned int flags
,
496 const struct irc_sockaddr
* peer
)
498 struct sockaddr_native addr
;
505 size
= sockaddr_from_irc(&addr
, peer
, fd
);
506 assert((addr
.sn_family
== AF_INET
) == irc_in_addr_is_ipv4(&peer
->addr
));
507 if (-1 < (res
= sendto(fd
, buf
, length
, flags
, (struct sockaddr
*)&addr
, size
))) {
509 *count_out
= (unsigned) res
;
512 else if (EWOULDBLOCK
== errno
|| EAGAIN
== errno
524 /** Attempt to write on a connected socket.
525 * @param[in] fd File descriptor to write to.
526 * @param[in] buf Output buffer to send from.
527 * @param[in] length Number of bytes to write.
528 * @param[out] count_out Receives number of bytes actually written.
529 * @return An IOResult value indicating status.
531 IOResult
os_send_nonb(int fd
, const char* buf
, unsigned int length
,
532 unsigned int* count_out
)
536 assert(0 != count_out
);
540 if (-1 < (res
= send(fd
, buf
, length
, 0))) {
541 *count_out
= (unsigned) res
;
544 else if (EWOULDBLOCK
== errno
|| EAGAIN
== errno
556 /** Attempt a vectored write on a connected socket.
557 * @param[in] fd File descriptor to write to.
558 * @param[in] buf Message queue to send from.
559 * @param[out] count_in Number of bytes mapped from \a buf.
560 * @param[out] count_out Receives number of bytes actually written.
561 * @return An IOResult value indicating status.
563 IOResult
os_sendv_nonb(int fd
, struct MsgQ
* buf
, unsigned int* count_in
,
564 unsigned int* count_out
)
568 struct iovec iov
[IOV_MAX
];
571 assert(0 != count_in
);
572 assert(0 != count_out
);
578 count
= msgq_mapiov(buf
, iov
, IOV_MAX
, count_in
);
580 if (-1 < (res
= writev(fd
, iov
, count
))) {
581 *count_out
= (unsigned) res
;
584 else if (EWOULDBLOCK
== errno
|| EAGAIN
== errno
597 /** Open a TCP or UDP socket on a particular address.
598 * @param[in] local Local address to bind to.
599 * @param[in] type SOCK_STREAM or SOCK_DGRAM.
600 * @param[in] port_name Port name (used in error diagnostics).
601 * @return Bound descriptor, or -1 on error.
603 int os_socket(const struct irc_sockaddr
* local
, int type
, const char* port_name
)
605 struct sockaddr_native addr
;
609 size
= sockaddr_from_irc(&addr
, local
, -1);
610 fd
= socket(addr
.sn_family
, type
, 0);
612 report_error(SOCKET_ERROR_MSG
, port_name
, errno
);
615 if (fd
> MAXCLIENTS
- 1) {
616 report_error(CONNLIMIT_ERROR_MSG
, port_name
, 0);
620 if (!os_set_reuseaddr(fd
)) {
621 report_error(REUSEADDR_ERROR_MSG
, port_name
, errno
);
625 if (!os_set_nonblocking(fd
)) {
626 report_error(NONB_ERROR_MSG
, port_name
, errno
);
631 if (bind(fd
, (struct sockaddr
*)&addr
, size
)) {
632 report_error(BIND_ERROR_MSG
, port_name
, errno
);
640 /** Accept a connection on a socket.
641 * @param[in] fd Listening file descriptor.
642 * @param[out] peer Peer address of connection.
643 * @return File descriptor for accepted connection.
645 int os_accept(int fd
, struct irc_sockaddr
* peer
)
647 struct sockaddr_native addr
;
651 addrlen
= sizeof(addr
);
652 new_fd
= accept(fd
, (struct sockaddr
*)&addr
, &addrlen
);
654 memset(peer
, 0, sizeof(*peer
));
656 sockaddr_to_irc(&addr
, peer
);
660 /** Start a non-blocking connection.
661 * @param[in] fd Disconnected file descriptor.
662 * @param[in] sin Target address for connection.
663 * @return IOResult code indicating status.
665 IOResult
os_connect_nonb(int fd
, const struct irc_sockaddr
* sin
)
667 struct sockaddr_native addr
;
670 size
= sockaddr_from_irc(&addr
, sin
, fd
);
671 if (connect(fd
, (struct sockaddr
*) &addr
, size
))
672 return (errno
== EINPROGRESS
) ? IO_BLOCKED
: IO_FAILURE
;
676 /** Get local address of a socket.
677 * @param[in] fd File descriptor to operate on.
678 * @param[out] sin_out Receives local socket address.
679 * @return Non-zero on success; zero on error.
681 int os_get_sockname(int fd
, struct irc_sockaddr
* sin_out
)
683 struct sockaddr_native addr
;
684 unsigned int len
= sizeof(addr
);
686 assert(0 != sin_out
);
687 if (getsockname(fd
, (struct sockaddr
*) &addr
, &len
))
689 sockaddr_to_irc(&addr
, sin_out
);
693 /** Get remote address of a socket.
694 * @param[in] fd File descriptor to operate on.
695 * @param[out] sin_out Receives remote socket address.
696 * @return Non-zero on success; zero on error.
698 int os_get_peername(int fd
, struct irc_sockaddr
* sin_out
)
700 struct sockaddr_native addr
;
701 unsigned int len
= sizeof(addr
);
703 assert(0 != sin_out
);
704 if (getpeername(fd
, (struct sockaddr
*) &addr
, &len
))
706 sockaddr_to_irc(&addr
, sin_out
);
710 /** Start listening on a socket.
711 * @param[in] fd Disconnected file descriptor.
712 * @param[in] backlog Maximum number of un-accept()ed connections to keep.
713 * @return Non-zero on success; zero on error.
715 int os_set_listen(int fd
, int backlog
)
717 return (0 == listen(fd
, backlog
));