X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=folly%2FMemory.h;h=d24422190250cf4bdf7c05426a185f9d159ca4e5;hb=d216a9bd40ed48bf9f6060895287624b90fc677c;hp=62490f90b80abf2f1ee8c1d842880d636b4e20cc;hpb=ff92b6ea53d4db75691784b0febfd3070913d2b6;p=folly.git diff --git a/folly/Memory.h b/folly/Memory.h index 62490f90..d2442219 100644 --- a/folly/Memory.h +++ b/folly/Memory.h @@ -1,5 +1,5 @@ /* - * Copyright 2016 Facebook, Inc. + * Copyright 2017 Facebook, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,7 +17,6 @@ #pragma once #include -#include #include #include @@ -37,9 +36,8 @@ namespace folly { * @author Xu Ning (xning@fb.com) */ -#if __cplusplus >= 201402L || \ - (defined __cpp_lib_make_unique && __cpp_lib_make_unique >= 201304L) || \ - (defined(_MSC_VER) && _MSC_VER >= 1900) +#if __cplusplus >= 201402L || __cpp_lib_make_unique >= 201304L || \ + (__ANDROID__ && __cplusplus >= 201300L) || _MSC_VER >= 1900 /* using override */ using std::make_unique; @@ -109,13 +107,36 @@ struct static_function_deleter { * * Useful when `T` is long, such as: * - * using T = foobar::cpp2::FooBarServiceAsyncClient; + * using T = foobar::FooBarAsyncClient; */ template std::shared_ptr to_shared_ptr(std::unique_ptr&& ptr) { return std::shared_ptr(std::move(ptr)); } +/** + * to_weak_ptr + * + * Make a weak_ptr and return it from a shared_ptr without specifying the + * template type parameter and letting the compiler deduce it. + * + * So you can write this: + * + * auto wptr = to_weak_ptr(getSomethingShared()); + * + * Instead of this: + * + * auto wptr = weak_ptr(getSomethingShared()); + * + * Useful when `T` is long, such as: + * + * using T = foobar::FooBarAsyncClient; + */ +template +std::weak_ptr to_weak_ptr(const std::shared_ptr& ptr) { + return std::weak_ptr(ptr); +} + using SysBufferDeleter = static_function_deleter; using SysBufferUniquePtr = std::unique_ptr; inline SysBufferUniquePtr allocate_sys_buffer(size_t size) { @@ -425,4 +446,93 @@ std::shared_ptr allocate_shared(Allocator&& allocator, Args&&... args) { */ template struct IsArenaAllocator : std::false_type { }; +/* + * folly::enable_shared_from_this + * + * To be removed once C++17 becomes a minimum requirement for folly. + */ +#if __cplusplus >= 201700L || \ + __cpp_lib_enable_shared_from_this >= 201603L + +// Guaranteed to have std::enable_shared_from_this::weak_from_this(). Prefer +// type alias over our own class. +/* using override */ using std::enable_shared_from_this; + +#else + +/** + * Extends std::enabled_shared_from_this. Offers weak_from_this() to pre-C++17 + * code. Use as drop-in replacement for std::enable_shared_from_this. + * + * C++14 has no direct means of creating a std::weak_ptr, one must always + * create a (temporary) std::shared_ptr first. C++17 adds weak_from_this() to + * std::enable_shared_from_this to avoid that overhead. Alas code that must + * compile under different language versions cannot call + * std::enable_shared_from_this::weak_from_this() directly. Hence this class. + * + * @example + * class MyClass : public folly::enable_shared_from_this {}; + * + * int main() { + * std::shared_ptr sp = std::make_shared(); + * std::weak_ptr wp = sp->weak_from_this(); + * } + */ +template +class enable_shared_from_this : public std::enable_shared_from_this { +public: + constexpr enable_shared_from_this() noexcept = default; + + std::weak_ptr weak_from_this() noexcept { + return weak_from_this_(this); + } + + std::weak_ptr weak_from_this() const noexcept { + return weak_from_this_(this); + } + +private: + // Uses SFINAE to detect and call + // std::enable_shared_from_this::weak_from_this() if available. Falls + // back to std::enable_shared_from_this::shared_from_this() otherwise. + template + auto weak_from_this_(std::enable_shared_from_this* base_ptr) + noexcept -> decltype(base_ptr->weak_from_this()) { + return base_ptr->weak_from_this(); + } + + template + auto weak_from_this_(std::enable_shared_from_this const* base_ptr) + const noexcept -> decltype(base_ptr->weak_from_this()) { + return base_ptr->weak_from_this(); + } + + template + std::weak_ptr weak_from_this_(...) noexcept { + try { + return this->shared_from_this(); + } catch (std::bad_weak_ptr const&) { + // C++17 requires that weak_from_this() on an object not owned by a + // shared_ptr returns an empty weak_ptr. Sadly, in C++14, + // shared_from_this() on such an object is undefined behavior, and there + // is nothing we can do to detect and handle the situation in a portable + // manner. But in case a compiler is nice enough to implement C++17 + // semantics of shared_from_this() and throws a bad_weak_ptr, we catch it + // and return an empty weak_ptr. + return std::weak_ptr{}; + } + } + + template + std::weak_ptr weak_from_this_(...) const noexcept { + try { + return this->shared_from_this(); + } catch (std::bad_weak_ptr const&) { + return std::weak_ptr{}; + } + } +}; + +#endif + } // namespace folly