Commit d618bf95 authored by Christopher Dykes's avatar Christopher Dykes Committed by Facebook Github Bot 0

Add a compatibility shim for working with libevent on MSVC

Summary:
MSVC builds of libevent expect `evutil_socket_t` to be `HANDLE` values, but Folly, HHVM, and Thrift all use them as file descriptors.
This adds a `folly_event_set` function that always expects a file descriptor rather than a socket. This also changes the places in Folly that use it.

Reviewed By: mzlee, yfeldblum

Differential Revision: D2874655

fbshipit-source-id: 66cfd86fd69a9fbac30d150445e4814cd5ca799e
parent 75ed8035
...@@ -278,6 +278,7 @@ nobase_follyinclude_HEADERS = \ ...@@ -278,6 +278,7 @@ nobase_follyinclude_HEADERS = \
portability/Constexpr.h \ portability/Constexpr.h \
portability/Dirent.h \ portability/Dirent.h \
portability/Environment.h \ portability/Environment.h \
portability/Event.h \
portability/Fcntl.h \ portability/Fcntl.h \
portability/GFlags.h \ portability/GFlags.h \
portability/IOVec.h \ portability/IOVec.h \
......
...@@ -80,7 +80,7 @@ void AsyncSignalHandler::unregisterSignalHandler(int signum) { ...@@ -80,7 +80,7 @@ void AsyncSignalHandler::unregisterSignalHandler(int signum) {
signalEvents_.erase(it); signalEvents_.erase(it);
} }
void AsyncSignalHandler::libeventCallback(int signum, void AsyncSignalHandler::libeventCallback(libevent_fd_t signum,
short /* events */, short /* events */,
void* arg) { void* arg) {
AsyncSignalHandler* handler = static_cast<AsyncSignalHandler*>(arg); AsyncSignalHandler* handler = static_cast<AsyncSignalHandler*>(arg);
......
...@@ -83,7 +83,7 @@ class AsyncSignalHandler { ...@@ -83,7 +83,7 @@ class AsyncSignalHandler {
AsyncSignalHandler(AsyncSignalHandler const &); AsyncSignalHandler(AsyncSignalHandler const &);
AsyncSignalHandler& operator=(AsyncSignalHandler const &); AsyncSignalHandler& operator=(AsyncSignalHandler const &);
static void libeventCallback(int signum, short events, void* arg); static void libeventCallback(libevent_fd_t signum, short events, void* arg);
EventBase* eventBase_; EventBase* eventBase_;
SignalEventMap signalEvents_; SignalEventMap signalEvents_;
......
...@@ -31,7 +31,8 @@ namespace folly { ...@@ -31,7 +31,8 @@ namespace folly {
AsyncTimeout::AsyncTimeout(TimeoutManager* timeoutManager) AsyncTimeout::AsyncTimeout(TimeoutManager* timeoutManager)
: timeoutManager_(timeoutManager) { : timeoutManager_(timeoutManager) {
event_set(&event_, -1, EV_TIMEOUT, &AsyncTimeout::libeventCallback, this); folly_event_set(
&event_, -1, EV_TIMEOUT, &AsyncTimeout::libeventCallback, this);
event_.ev_base = nullptr; event_.ev_base = nullptr;
timeoutManager_->attachTimeoutManager( timeoutManager_->attachTimeoutManager(
this, this,
...@@ -42,7 +43,8 @@ AsyncTimeout::AsyncTimeout(TimeoutManager* timeoutManager) ...@@ -42,7 +43,8 @@ AsyncTimeout::AsyncTimeout(TimeoutManager* timeoutManager)
AsyncTimeout::AsyncTimeout(EventBase* eventBase) AsyncTimeout::AsyncTimeout(EventBase* eventBase)
: timeoutManager_(eventBase) { : timeoutManager_(eventBase) {
event_set(&event_, -1, EV_TIMEOUT, &AsyncTimeout::libeventCallback, this); folly_event_set(
&event_, -1, EV_TIMEOUT, &AsyncTimeout::libeventCallback, this);
event_.ev_base = nullptr; event_.ev_base = nullptr;
if (eventBase) { if (eventBase) {
timeoutManager_->attachTimeoutManager( timeoutManager_->attachTimeoutManager(
...@@ -56,7 +58,8 @@ AsyncTimeout::AsyncTimeout(TimeoutManager* timeoutManager, ...@@ -56,7 +58,8 @@ AsyncTimeout::AsyncTimeout(TimeoutManager* timeoutManager,
InternalEnum internal) InternalEnum internal)
: timeoutManager_(timeoutManager) { : timeoutManager_(timeoutManager) {
event_set(&event_, -1, EV_TIMEOUT, &AsyncTimeout::libeventCallback, this); folly_event_set(
&event_, -1, EV_TIMEOUT, &AsyncTimeout::libeventCallback, this);
event_.ev_base = nullptr; event_.ev_base = nullptr;
timeoutManager_->attachTimeoutManager(this, internal); timeoutManager_->attachTimeoutManager(this, internal);
RequestContext::saveContext(); RequestContext::saveContext();
...@@ -65,14 +68,16 @@ AsyncTimeout::AsyncTimeout(TimeoutManager* timeoutManager, ...@@ -65,14 +68,16 @@ AsyncTimeout::AsyncTimeout(TimeoutManager* timeoutManager,
AsyncTimeout::AsyncTimeout(EventBase* eventBase, InternalEnum internal) AsyncTimeout::AsyncTimeout(EventBase* eventBase, InternalEnum internal)
: timeoutManager_(eventBase) { : timeoutManager_(eventBase) {
event_set(&event_, -1, EV_TIMEOUT, &AsyncTimeout::libeventCallback, this); folly_event_set(
&event_, -1, EV_TIMEOUT, &AsyncTimeout::libeventCallback, this);
event_.ev_base = nullptr; event_.ev_base = nullptr;
timeoutManager_->attachTimeoutManager(this, internal); timeoutManager_->attachTimeoutManager(this, internal);
RequestContext::saveContext(); RequestContext::saveContext();
} }
AsyncTimeout::AsyncTimeout(): timeoutManager_(nullptr) { AsyncTimeout::AsyncTimeout(): timeoutManager_(nullptr) {
event_set(&event_, -1, EV_TIMEOUT, &AsyncTimeout::libeventCallback, this); folly_event_set(
&event_, -1, EV_TIMEOUT, &AsyncTimeout::libeventCallback, this);
event_.ev_base = nullptr; event_.ev_base = nullptr;
RequestContext::saveContext(); RequestContext::saveContext();
} }
...@@ -138,9 +143,9 @@ void AsyncTimeout::detachEventBase() { ...@@ -138,9 +143,9 @@ void AsyncTimeout::detachEventBase() {
detachTimeoutManager(); detachTimeoutManager();
} }
void AsyncTimeout::libeventCallback(int fd, short events, void* arg) { void AsyncTimeout::libeventCallback(libevent_fd_t fd, short events, void* arg) {
AsyncTimeout* timeout = reinterpret_cast<AsyncTimeout*>(arg); AsyncTimeout* timeout = reinterpret_cast<AsyncTimeout*>(arg);
assert(fd == -1); assert(libeventFdToFd(fd) == -1);
assert(events == EV_TIMEOUT); assert(events == EV_TIMEOUT);
// prevent unused variable warnings // prevent unused variable warnings
(void)fd; (void)fd;
......
...@@ -22,6 +22,8 @@ ...@@ -22,6 +22,8 @@
#include <folly/io/async/TimeoutManager.h> #include <folly/io/async/TimeoutManager.h>
#include <folly/portability/Event.h>
#include <boost/noncopyable.hpp> #include <boost/noncopyable.hpp>
#include <event.h> #include <event.h>
#include <memory> #include <memory>
...@@ -219,7 +221,7 @@ class AsyncTimeout : private boost::noncopyable { ...@@ -219,7 +221,7 @@ class AsyncTimeout : private boost::noncopyable {
); );
private: private:
static void libeventCallback(int fd, short events, void* arg); static void libeventCallback(libevent_fd_t fd, short events, void* arg);
struct event event_; struct event event_;
......
...@@ -26,7 +26,7 @@ ...@@ -26,7 +26,7 @@
namespace folly { namespace folly {
EventHandler::EventHandler(EventBase* eventBase, int fd) { EventHandler::EventHandler(EventBase* eventBase, int fd) {
event_set(&event_, fd, 0, &EventHandler::libeventCallback, this); folly_event_set(&event_, fd, 0, &EventHandler::libeventCallback, this);
if (eventBase != nullptr) { if (eventBase != nullptr) {
setEventBase(eventBase); setEventBase(eventBase);
} else { } else {
...@@ -124,13 +124,13 @@ void EventHandler::changeHandlerFD(int fd) { ...@@ -124,13 +124,13 @@ void EventHandler::changeHandlerFD(int fd) {
ensureNotRegistered(__func__); ensureNotRegistered(__func__);
// event_set() resets event_base.ev_base, so manually restore it afterwards // event_set() resets event_base.ev_base, so manually restore it afterwards
struct event_base* evb = event_.ev_base; struct event_base* evb = event_.ev_base;
event_set(&event_, fd, 0, &EventHandler::libeventCallback, this); folly_event_set(&event_, fd, 0, &EventHandler::libeventCallback, this);
event_.ev_base = evb; // don't use event_base_set(), since evb may be nullptr event_.ev_base = evb; // don't use event_base_set(), since evb may be nullptr
} }
void EventHandler::initHandler(EventBase* eventBase, int fd) { void EventHandler::initHandler(EventBase* eventBase, int fd) {
ensureNotRegistered(__func__); ensureNotRegistered(__func__);
event_set(&event_, fd, 0, &EventHandler::libeventCallback, this); folly_event_set(&event_, fd, 0, &EventHandler::libeventCallback, this);
setEventBase(eventBase); setEventBase(eventBase);
} }
...@@ -144,7 +144,7 @@ void EventHandler::ensureNotRegistered(const char* fn) { ...@@ -144,7 +144,7 @@ void EventHandler::ensureNotRegistered(const char* fn) {
} }
} }
void EventHandler::libeventCallback(int fd, short events, void* arg) { void EventHandler::libeventCallback(libevent_fd_t fd, short events, void* arg) {
EventHandler* handler = reinterpret_cast<EventHandler*>(arg); EventHandler* handler = reinterpret_cast<EventHandler*>(arg);
assert(fd == handler->event_.ev_fd); assert(fd == handler->event_.ev_fd);
(void)fd; // prevent unused variable warnings (void)fd; // prevent unused variable warnings
......
...@@ -22,6 +22,7 @@ ...@@ -22,6 +22,7 @@
#include <glog/logging.h> #include <glog/logging.h>
#include <folly/io/async/EventUtil.h> #include <folly/io/async/EventUtil.h>
#include <folly/portability/Event.h>
#include <boost/noncopyable.hpp> #include <boost/noncopyable.hpp>
#include <stddef.h> #include <stddef.h>
...@@ -177,7 +178,7 @@ class EventHandler : private boost::noncopyable { ...@@ -177,7 +178,7 @@ class EventHandler : private boost::noncopyable {
void setEventBase(EventBase* eventBase); void setEventBase(EventBase* eventBase);
static void libeventCallback(int fd, short events, void* arg); static void libeventCallback(libevent_fd_t fd, short events, void* arg);
struct event event_; struct event event_;
EventBase* eventBase_; EventBase* eventBase_;
......
/*
* Copyright 2016 Facebook, Inc.
*
* 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.
*/
#pragma once
#include <event.h>
#ifdef _MSC_VER
# include <event2/event_compat.h>
# include <folly/portability/Fcntl.h>
# include <folly/portability/Windows.h>
#endif
namespace folly {
#ifdef _MSC_VER
using libevent_fd_t = evutil_socket_t;
#else
using libevent_fd_t = int;
#endif
inline libevent_fd_t getLibeventFd(int fd) {
#ifdef _MSC_VER
if (fd == -1) {
return (libevent_fd_t)INVALID_HANDLE_VALUE;
}
return _get_osfhandle(fd);
#else
return fd;
#endif
}
inline int libeventFdToFd(libevent_fd_t fd) {
#ifdef _MSC_VER
if (fd == (libevent_fd_t)INVALID_HANDLE_VALUE) {
return -1;
}
return _open_osfhandle((intptr_t)fd, O_RDWR | O_BINARY);
#else
return fd;
#endif
}
using EventSetCallback = void (*)(libevent_fd_t, short, void*);
inline void
folly_event_set(event* e, int fd, short s, EventSetCallback f, void* arg) {
auto lfd = getLibeventFd(fd);
event_set(e, lfd, s, f, arg);
}
}
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment