Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Unix Domain Socket creation/handling #1852

Merged
merged 1 commit into from
Mar 14, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
102 changes: 92 additions & 10 deletions src/ipc_listener.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
#include <sys/socket.h>
#include <fcntl.h>
#include <sys/un.h>
#include <sys/stat.h>

#ifdef ZMQ_HAVE_LOCAL_PEERCRED
# include <sys/types.h>
Expand All @@ -63,6 +64,58 @@
# endif
#endif

const char *zmq::ipc_listener_t::tmp_env_vars[] = {
"TMPDIR",
"TEMPDIR",
"TMP",
0 // Sentinel
};

int zmq::ipc_listener_t::create_wildcard_address(std::string& path_)
{
std::string tmp_path;

// If TMPDIR, TEMPDIR, or TMP are available and are directories, create
// the socket directory there.
const char **tmp_env = tmp_env_vars;
while ( tmp_path.empty() && *tmp_env != 0 ) {
char *tmpdir = getenv(*tmp_env);
struct stat statbuf;

// Confirm it is actually a directory before trying to use
if ( tmpdir != 0 && ::stat(tmpdir, &statbuf) == 0 && S_ISDIR(statbuf.st_mode) ) {
tmp_path.assign(tmpdir);
if ( *(tmp_path.rbegin()) != '/' ) {
tmp_path.push_back('/');
}
}

// Try the next environment variable
++tmp_env;
}

// Append a directory name
tmp_path.append("tmpXXXXXX");

// We need room for tmp_path + trailing NUL
std::vector<char> buffer(tmp_path.length()+1);
strcpy(buffer.data(), tmp_path.c_str());

// Create the directory. POSIX requires that mkdtemp() creates the
// directory with 0700 permissions, meaning the only possible race
// with socket creation could be the same user. However, since
// each socket is created in a directory created by mkdtemp(), and
// mkdtemp() guarantees a unique directory name, there will be no
// collision.
if ( mkdtemp(buffer.data()) == 0 ) {
return -1;
}

path_.assign(buffer.data());

return 0;
}

zmq::ipc_listener_t::ipc_listener_t (io_thread_t *io_thread_,
socket_base_t *socket_, const options_t &options_) :
own_t (io_thread_, options_),
Expand Down Expand Up @@ -113,7 +166,7 @@ void zmq::ipc_listener_t::in_event ()
io_thread_t *io_thread = choose_io_thread (options.affinity);
zmq_assert (io_thread);

// Create and launch a session object.
// Create and launch a session object.
session_base_t *session = session_base_t::create (io_thread, false, socket,
options, NULL);
errno_assert (session);
Expand Down Expand Up @@ -148,12 +201,15 @@ int zmq::ipc_listener_t::set_address (const char *addr_)

// Allow wildcard file
if (addr [0] == '*') {
char buffer [12] = "2134XXXXXX";
int fd = mkstemp (buffer);
if (fd == -1)
std::string tmp_path;

if ( create_wildcard_address(tmp_path) < 0 ) {
return -1;
addr.assign (buffer);
::close (fd);
}

tmp_socket_dirname.assign(tmp_path);

addr.assign (tmp_path + "/socket");
}

// Get rid of the file associated with the UNIX domain socket that
Expand All @@ -169,8 +225,16 @@ int zmq::ipc_listener_t::set_address (const char *addr_)
// Initialise the address structure.
ipc_address_t address;
int rc = address.resolve (addr.c_str());
if (rc != 0)
if (rc != 0) {
if ( !tmp_socket_dirname.empty() ) {
// We need to preserve errno to return to the user
int errno_ = errno;
::rmdir(tmp_socket_dirname.c_str ());
tmp_socket_dirname.clear();
errno = errno_;
}
return -1;
}

address.to_string (endpoint);

Expand All @@ -179,8 +243,16 @@ int zmq::ipc_listener_t::set_address (const char *addr_)
} else {
// Create a listening socket.
s = open_socket (AF_UNIX, SOCK_STREAM, 0);
if (s == -1)
if (s == -1) {
if ( !tmp_socket_dirname.empty() ) {
// We need to preserve errno to return to the user
int errno_ = errno;
::rmdir(tmp_socket_dirname.c_str ());
tmp_socket_dirname.clear();
errno = errno_;
}
return -1;
}

// Bind the socket to the file path.
rc = bind (s, address.addr (), address.addrlen ());
Expand Down Expand Up @@ -219,8 +291,18 @@ int zmq::ipc_listener_t::close ()
// MUST NOT unlink if the FD is managed by the user, or it will stop
// working after the first client connects. The user will take care of
// cleaning up the file after the service is stopped.
if (has_file && !filename.empty () && options.use_fd == -1) {
rc = ::unlink(filename.c_str ());
if (has_file && options.use_fd == -1) {
rc = 0;

if ( !filename.empty () ) {
rc = ::unlink(filename.c_str ());
}

if ( rc == 0 && !tmp_socket_dirname.empty() ) {
rc = ::rmdir(tmp_socket_dirname.c_str ());
tmp_socket_dirname.clear();
}

if (rc != 0) {
socket->event_close_failed (endpoint, zmq_errno());
return -1;
Expand Down
12 changes: 11 additions & 1 deletion src/ipc_listener.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ namespace zmq
// Close the listening socket.
int close ();

// Create wildcard path address
static int create_wildcard_address(std::string& path_);

// Filter new connections if the OS provides a mechanism to get
// the credentials of the peer process. Called from accept().
# if defined ZMQ_HAVE_SO_PEERCRED || defined ZMQ_HAVE_LOCAL_PEERCRED
Expand All @@ -87,6 +90,10 @@ namespace zmq
// True, if the underlying file for UNIX domain socket exists.
bool has_file;

// Name of the temporary directory (if any) that has the
// the UNIX domain socket
std::string tmp_socket_dirname;

// Name of the file associated with the UNIX domain address.
std::string filename;

Expand All @@ -99,9 +106,12 @@ namespace zmq
// Socket the listener belongs to.
zmq::socket_base_t *socket;

// String representation of endpoint to bind to
// String representation of endpoint to bind to
std::string endpoint;

// Acceptable temporary directory environment variables
static const char *tmp_env_vars[];

ipc_listener_t (const ipc_listener_t&);
const ipc_listener_t &operator = (const ipc_listener_t&);
};
Expand Down
15 changes: 10 additions & 5 deletions tests/test_term_endpoint.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,14 @@

#include "testutil.hpp"

#define BUF_SIZE 32

int main (void)
{
setup_test_environment();
int rc;
const size_t buf_size = 32;
char buf[buf_size];
char buf[BUF_SIZE];
size_t buf_size;
const char *ep = "tcp://127.0.0.1:5560";
const char *ep_wc_tcp = "tcp://127.0.0.1:*";
#if !defined ZMQ_HAVE_WINDOWS && !defined ZMQ_HAVE_OPENVMS
Expand Down Expand Up @@ -139,18 +141,21 @@ int main (void)
#endif

// Unbind sockets binded by wild-card address
rc = zmq_getsockopt (push, ZMQ_LAST_ENDPOINT, buf, (size_t *)&buf_size);
buf_size = sizeof(buf);
rc = zmq_getsockopt (push, ZMQ_LAST_ENDPOINT, buf, &buf_size);
assert (rc == 0);
rc = zmq_unbind (push, buf);
assert (rc == 0);
#if !defined ZMQ_HAVE_WINDOWS && !defined ZMQ_HAVE_OPENVMS
rc = zmq_getsockopt (pull, ZMQ_LAST_ENDPOINT, buf, (size_t *)&buf_size);
buf_size = sizeof(buf);
rc = zmq_getsockopt (pull, ZMQ_LAST_ENDPOINT, buf, &buf_size);
assert (rc == 0);
rc = zmq_unbind (pull, buf);
assert (rc == 0);
#endif
#if defined ZMQ_HAVE_VMCI
rc = zmq_getsockopt (req, ZMQ_LAST_ENDPOINT, buf, (size_t *)&buf_size);
buf_size = sizeof(buf);
rc = zmq_getsockopt (req, ZMQ_LAST_ENDPOINT, buf, &buf_size);
assert (rc == 0);
rc = zmq_unbind(req, buf);
assert (rc == 0);
Expand Down