123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590 |
- // Module: Log4CPLUS
- // File: socket-unix.cxx
- // Created: 4/2003
- // Author: Tad E. Smith
- //
- //
- // Copyright 2003-2013 Tad E. Smith
- //
- // Licensed under the Apache License, Version 2.0 (the "License");
- // you may not use this file except in compliance with the License.
- // You may obtain a copy of the License at
- //
- // http://www.apache.org/licenses/LICENSE-2.0
- //
- // Unless required by applicable law or agreed to in writing, software
- // distributed under the License is distributed on an "AS IS" BASIS,
- // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- // See the License for the specific language governing permissions and
- // limitations under the License.
- #include <log4cplus/config.hxx>
- #if defined (LOG4CPLUS_USE_BSD_SOCKETS)
- #include <cstring>
- #include <vector>
- #include <algorithm>
- #include <cerrno>
- #include <log4cplus/internal/socket.h>
- #include <log4cplus/helpers/loglog.h>
- #include <log4cplus/thread/syncprims-pub-impl.h>
- #include <log4cplus/spi/loggingevent.h>
- #include <log4cplus/helpers/stringhelper.h>
- #ifdef LOG4CPLUS_HAVE_SYS_TYPES_H
- #include <sys/types.h>
- #endif
- #ifdef LOG4CPLUS_HAVE_SYS_SOCKET_H
- #include <sys/socket.h>
- #endif
- #if defined (LOG4CPLUS_HAVE_NETINET_IN_H)
- #include <netinet/in.h>
- #endif
- #if defined (LOG4CPLUS_HAVE_NETINET_TCP_H)
- #include <netinet/tcp.h>
- #endif
- #if defined (LOG4CPLUS_HAVE_ARPA_INET_H)
- #include <arpa/inet.h>
- #endif
- #if defined (LOG4CPLUS_HAVE_ERRNO_H)
- #include <errno.h>
- #endif
- #ifdef LOG4CPLUS_HAVE_NETDB_H
- #include <netdb.h>
- #endif
- #ifdef LOG4CPLUS_HAVE_FCNTL_H
- #include <fcntl.h>
- #endif
- #ifdef LOG4CPLUS_HAVE_UNISTD_H
- #include <unistd.h>
- #endif
- #ifdef LOG4CPLUS_HAVE_POLL_H
- #include <poll.h>
- #endif
- namespace log4cplus { namespace helpers {
- // from lockfile.cxx
- LOG4CPLUS_PRIVATE bool trySetCloseOnExec (int fd,
- helpers::LogLog & loglog = helpers::getLogLog ());
- namespace
- {
- #if ! defined (LOG4CPLUS_SINGLE_THREADED)
- // We need to use log4cplus::thread here to work around compilation
- // problem on AIX.
- static log4cplus::thread::Mutex ghbn_mutex;
- #endif
- static
- int
- get_host_by_name (char const * hostname, std::string * name,
- struct sockaddr_in * addr)
- {
- #if defined (LOG4CPLUS_HAVE_GETADDRINFO)
- struct addrinfo hints;
- std::memset (&hints, 0, sizeof (hints));
- hints.ai_family = AF_INET;
- hints.ai_socktype = SOCK_STREAM;
- hints.ai_protocol = IPPROTO_TCP;
- hints.ai_flags = AI_CANONNAME;
- if (inet_addr (hostname) != static_cast<in_addr_t>(-1))
- hints.ai_flags |= AI_NUMERICHOST;
- struct addrinfo * res = 0;
- int ret = getaddrinfo (hostname, 0, &hints, &res);
- if (ret != 0)
- return ret;
- struct addrinfo const & ai = *res;
- assert (ai.ai_family == AF_INET);
- if (name)
- *name = ai.ai_canonname;
- if (addr)
- std::memcpy (addr, ai.ai_addr, ai.ai_addrlen);
- freeaddrinfo (res);
- #else
- #if ! defined (LOG4CPLUS_SINGLE_THREADED)
- // We need to use log4cplus::thread here to work around
- // compilation problem on AIX.
- log4cplus::thread::MutexGuard guard (ghbn_mutex);
- #endif
- struct ::hostent * hp = gethostbyname (hostname);
- if (! hp)
- return 1;
- assert (hp->h_addrtype == AF_INET);
- if (name)
- *name = hp->h_name;
- if (addr)
- {
- assert (hp->h_length <= sizeof (addr->sin_addr));
- std::memcpy (&addr->sin_addr, hp->h_addr_list[0], hp->h_length);
- }
- #endif
- return 0;
- }
- } // namespace
- /////////////////////////////////////////////////////////////////////////////
- // Global Methods
- /////////////////////////////////////////////////////////////////////////////
- SOCKET_TYPE
- openSocket(unsigned short port, SocketState& state)
- {
- socket_holder sock_holder (::socket(AF_INET, SOCK_STREAM, 0));
- if(sock_holder.sock < 0) {
- return INVALID_SOCKET_VALUE;
- }
- struct sockaddr_in server = sockaddr_in ();
- server.sin_family = AF_INET;
- server.sin_addr.s_addr = INADDR_ANY;
- server.sin_port = htons(port);
- int optval = 1;
- socklen_t optlen = sizeof (optval);
- int ret = setsockopt (sock_holder.sock, SOL_SOCKET, SO_REUSEADDR, &optval,
- optlen);
- if (ret != 0)
- {
- int const eno = errno;
- helpers::getLogLog ().warn (LOG4CPLUS_TEXT ("setsockopt() failed: ")
- + helpers::convertIntegerToString (eno));
- }
- int retval = bind(sock_holder.sock,
- reinterpret_cast<struct sockaddr*>(&server), sizeof(server));
- if (retval < 0)
- return INVALID_SOCKET_VALUE;
- if (::listen(sock_holder.sock, 10))
- return INVALID_SOCKET_VALUE;
- state = ok;
- return to_log4cplus_socket (sock_holder.detach ());
- }
- SOCKET_TYPE
- connectSocket(const tstring& hostn, unsigned short port, bool udp, SocketState& state)
- {
- struct sockaddr_in server;
- int retval;
- std::memset (&server, 0, sizeof (server));
- retval = get_host_by_name (LOG4CPLUS_TSTRING_TO_STRING(hostn).c_str(),
- 0, &server);
- if (retval != 0)
- return INVALID_SOCKET_VALUE;
- server.sin_port = htons(port);
- server.sin_family = AF_INET;
- socket_holder sock_holder (
- ::socket(AF_INET, (udp ? SOCK_DGRAM : SOCK_STREAM), 0));
- if (sock_holder.sock < 0)
- return INVALID_SOCKET_VALUE;
- socklen_t namelen = sizeof (server);
- while (
- (retval = ::connect(sock_holder.sock,
- reinterpret_cast<struct sockaddr*>(&server), namelen))
- == -1
- && (errno == EINTR))
- ;
- if (retval == INVALID_OS_SOCKET_VALUE)
- return INVALID_SOCKET_VALUE;
- state = ok;
- return to_log4cplus_socket (sock_holder.detach ());
- }
- namespace
- {
- //! Helper for accept_wrap().
- template <typename T, typename U>
- struct socklen_var
- {
- typedef T type;
- };
- template <typename U>
- struct socklen_var<void, U>
- {
- typedef U type;
- };
- // Some systems like HP-UX have socklen_t but accept() does not use it
- // as type of its 3rd parameter. This wrapper works around this
- // incompatibility.
- template <typename accept_sockaddr_ptr_type, typename accept_socklen_type>
- static
- SOCKET_TYPE
- accept_wrap (
- int (* accept_func) (int, accept_sockaddr_ptr_type, accept_socklen_type *),
- SOCKET_TYPE sock, struct sockaddr * sa, socklen_t * len)
- {
- typedef typename socklen_var<accept_socklen_type, socklen_t>::type
- socklen_var_type;
- socklen_var_type l = static_cast<socklen_var_type>(*len);
- SOCKET_TYPE result
- = static_cast<SOCKET_TYPE>(
- accept_func (sock, sa,
- reinterpret_cast<accept_socklen_type *>(&l)));
- *len = static_cast<socklen_t>(l);
- return result;
- }
- } // namespace
- SOCKET_TYPE
- acceptSocket(SOCKET_TYPE sock, SocketState& state)
- {
- struct sockaddr_in net_client;
- socklen_t len = sizeof(struct sockaddr);
- int clientSock;
- while(
- (clientSock = accept_wrap (accept, to_os_socket (sock),
- reinterpret_cast<struct sockaddr*>(&net_client), &len))
- == -1
- && (errno == EINTR))
- ;
- if(clientSock != INVALID_OS_SOCKET_VALUE) {
- state = ok;
- }
- return to_log4cplus_socket (clientSock);
- }
- int
- closeSocket(SOCKET_TYPE sock)
- {
- return ::close(to_os_socket (sock));
- }
- int
- shutdownSocket(SOCKET_TYPE sock)
- {
- return ::shutdown(to_os_socket (sock), SHUT_RDWR);
- }
- long
- read(SOCKET_TYPE sock, SocketBuffer& buffer)
- {
- long res, readbytes = 0;
- do
- {
- res = ::read(to_os_socket (sock), buffer.getBuffer() + readbytes,
- buffer.getMaxSize() - readbytes);
- if( res <= 0 ) {
- return res;
- }
- readbytes += res;
- } while( readbytes < static_cast<long>(buffer.getMaxSize()) );
- return readbytes;
- }
- long
- write(SOCKET_TYPE sock, const SocketBuffer& buffer)
- {
- #if defined(MSG_NOSIGNAL)
- int flags = MSG_NOSIGNAL;
- #else
- int flags = 0;
- #endif
- return ::send( to_os_socket (sock), buffer.getBuffer(), buffer.getSize(),
- flags );
- }
- long
- write(SOCKET_TYPE sock, const std::string & buffer)
- {
- #if defined(MSG_NOSIGNAL)
- int flags = MSG_NOSIGNAL;
- #else
- int flags = 0;
- #endif
- return ::send (to_os_socket (sock), buffer.c_str (), buffer.size (),
- flags);
- }
- tstring
- getHostname (bool fqdn)
- {
- char const * hostname = "unknown";
- int ret;
- std::vector<char> hn (1024, 0);
- while (true)
- {
- ret = ::gethostname (&hn[0], static_cast<int>(hn.size ()) - 1);
- if (ret == 0)
- {
- hostname = &hn[0];
- break;
- }
- #if defined (LOG4CPLUS_HAVE_ENAMETOOLONG)
- else if (ret != 0 && errno == ENAMETOOLONG)
- // Out buffer was too short. Retry with buffer twice the size.
- hn.resize (hn.size () * 2, 0);
- #endif
- else
- break;
- }
- if (ret != 0 || (ret == 0 && ! fqdn))
- return LOG4CPLUS_STRING_TO_TSTRING (hostname);
- std::string full_hostname;
- ret = get_host_by_name (hostname, &full_hostname, 0);
- if (ret == 0)
- hostname = full_hostname.c_str ();
- return LOG4CPLUS_STRING_TO_TSTRING (hostname);
- }
- int
- setTCPNoDelay (SOCKET_TYPE sock, bool val)
- {
- #if (defined (SOL_TCP) || defined (IPPROTO_TCP)) && defined (TCP_NODELAY)
- #if defined (SOL_TCP)
- int level = SOL_TCP;
- #elif defined (IPPROTO_TCP)
- int level = IPPROTO_TCP;
- #endif
- int result;
- int enabled = static_cast<int>(val);
- if ((result = setsockopt(sock, level, TCP_NODELAY, &enabled,
- sizeof(enabled))) != 0)
- set_last_socket_error (errno);
- return result;
- #else
- // No recognizable TCP_NODELAY option.
- return 0;
- #endif
- }
- //
- // ServerSocket OS dependent stuff
- //
- ServerSocket::ServerSocket(unsigned short port)
- {
- int fds[2] = {-1, -1};
- int ret;
- sock = openSocket (port, state);
- if (sock == INVALID_SOCKET_VALUE)
- goto error;
- #if defined (LOG4CPLUS_HAVE_PIPE2) && defined (O_CLOEXEC)
- ret = pipe2 (fds, O_CLOEXEC);
- if (ret != 0)
- goto error;
- #elif defined (LOG4CPLUS_HAVE_PIPE)
- ret = pipe (fds);
- if (ret != 0)
- goto error;
- trySetCloseOnExec (fds[0]);
- trySetCloseOnExec (fds[1]);
- #else
- # error You are missing both pipe() or pipe2().
- #endif
- interruptHandles[0] = fds[0];
- interruptHandles[1] = fds[1];
- return;
- error:;
- err = get_last_socket_error ();
- state = not_opened;
- if (sock != INVALID_SOCKET_VALUE)
- closeSocket (sock);
- if (fds[0] != -1)
- ::close (fds[0]);
- if (fds[1] != -1)
- ::close (fds[1]);
- }
- Socket
- ServerSocket::accept ()
- {
- struct pollfd pollfds[2];
- struct pollfd & interrupt_pipe = pollfds[0];
- interrupt_pipe.fd = interruptHandles[0];
- interrupt_pipe.events = POLLIN;
- interrupt_pipe.revents = 0;
- struct pollfd & accept_fd = pollfds[1];
- accept_fd.fd = to_os_socket (sock);
- accept_fd.events = POLLIN;
- accept_fd.revents = 0;
- do
- {
- interrupt_pipe.revents = 0;
- accept_fd.revents = 0;
- int ret = poll (pollfds, 2, -1);
- switch (ret)
- {
- // Error.
- case -1:
- if (errno == EINTR)
- // Signal has interrupted the call. Just re-run it.
- continue;
- set_last_socket_error (errno);
- return Socket (INVALID_SOCKET_VALUE, not_opened, errno);
- // Timeout. This should not happen though.
- case 0:
- continue;
- default:
- // Some descriptor is ready.
- if ((interrupt_pipe.revents & POLLIN) == POLLIN)
- {
- // Read byte from interruption pipe.
- helpers::getLogLog ().debug (
- LOG4CPLUS_TEXT ("ServerSocket::accept- ")
- LOG4CPLUS_TEXT ("accept() interrupted by other thread"));
- char ch;
- ret = ::read (interrupt_pipe.fd, &ch, 1);
- if (ret == -1)
- {
- int const eno = errno;
- helpers::getLogLog ().warn (
- LOG4CPLUS_TEXT ("ServerSocket::accept- read() failed: ")
- + helpers::convertIntegerToString (eno));
- set_last_socket_error (eno);
- return Socket (INVALID_SOCKET_VALUE, not_opened, eno);
- }
- // Return Socket with state set to accept_interrupted.
- return Socket (INVALID_SOCKET_VALUE, accept_interrupted, 0);
- }
- else if ((accept_fd.revents & POLLIN) == POLLIN)
- {
- helpers::getLogLog ().debug (
- LOG4CPLUS_TEXT ("ServerSocket::accept- ")
- LOG4CPLUS_TEXT ("accepting connection"));
- SocketState st = not_opened;
- SOCKET_TYPE clientSock = acceptSocket (sock, st);
- int eno = 0;
- if (clientSock == INVALID_SOCKET_VALUE)
- eno = get_last_socket_error ();
- return Socket (clientSock, st, eno);
- }
- else
- return Socket (INVALID_SOCKET_VALUE, not_opened, 0);
- }
- }
- while (true);
- }
- void
- ServerSocket::interruptAccept ()
- {
- char ch = 'I';
- int ret;
- do
- {
- ret = ::write (interruptHandles[1], &ch, 1);
- }
- while (ret == -1 && errno == EINTR);
- if (ret == -1)
- {
- int const eno = errno;
- helpers::getLogLog ().warn (
- LOG4CPLUS_TEXT ("ServerSocket::interruptAccept- write() failed: ")
- + helpers::convertIntegerToString (eno));
- }
- }
- ServerSocket::~ServerSocket()
- {
- if (interruptHandles[0] != -1)
- ::close (interruptHandles[0]);
- if (interruptHandles[1] != -1)
- ::close (interruptHandles[1]);
- }
- } } // namespace log4cplus
- #endif // LOG4CPLUS_USE_BSD_SOCKETS
|