You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

explicitly_constructed.h 4.6 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. // Protocol Buffers - Google's data interchange format
  2. // Copyright 2008 Google Inc. All rights reserved.
  3. // https://developers.google.com/protocol-buffers/
  4. //
  5. // Redistribution and use in source and binary forms, with or without
  6. // modification, are permitted provided that the following conditions are
  7. // met:
  8. //
  9. // * Redistributions of source code must retain the above copyright
  10. // notice, this list of conditions and the following disclaimer.
  11. // * Redistributions in binary form must reproduce the above
  12. // copyright notice, this list of conditions and the following disclaimer
  13. // in the documentation and/or other materials provided with the
  14. // distribution.
  15. // * Neither the name of Google Inc. nor the names of its
  16. // contributors may be used to endorse or promote products derived from
  17. // this software without specific prior written permission.
  18. //
  19. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30. #ifndef GOOGLE_PROTOBUF_EXPLICITLY_CONSTRUCTED_H__
  31. #define GOOGLE_PROTOBUF_EXPLICITLY_CONSTRUCTED_H__
  32. #include <stdint.h>
  33. #include <utility>
  34. #include <google/protobuf/stubs/logging.h>
  35. #include <google/protobuf/stubs/common.h>
  36. // clang-format off
  37. #include <google/protobuf/port_def.inc>
  38. // clang-format on
  39. namespace google
  40. {
  41. namespace protobuf
  42. {
  43. namespace internal
  44. {
  45. // Wraps a variable whose constructor and destructor are explicitly
  46. // called. It is particularly useful for a global variable, without its
  47. // constructor and destructor run on start and end of the program lifetime.
  48. // This circumvents the initial construction order fiasco, while keeping
  49. // the address of the empty string a compile time constant.
  50. //
  51. // Pay special attention to the initialization state of the object.
  52. // 1. The object is "uninitialized" to begin with.
  53. // 2. Call Construct() or DefaultConstruct() only if the object is
  54. // uninitialized. After the call, the object becomes "initialized".
  55. // 3. Call get() and get_mutable() only if the object is initialized.
  56. // 4. Call Destruct() only if the object is initialized.
  57. // After the call, the object becomes uninitialized.
  58. template<typename T, size_t min_align = 1>
  59. class ExplicitlyConstructed
  60. {
  61. public:
  62. void DefaultConstruct()
  63. {
  64. new (&union_) T();
  65. }
  66. template<typename... Args>
  67. void Construct(Args&&... args)
  68. {
  69. new (&union_) T(std::forward<Args>(args)...);
  70. }
  71. void Destruct()
  72. {
  73. get_mutable()->~T();
  74. }
  75. constexpr const T& get() const
  76. {
  77. return reinterpret_cast<const T&>(union_);
  78. }
  79. T* get_mutable()
  80. {
  81. return reinterpret_cast<T*>(&union_);
  82. }
  83. private:
  84. union AlignedUnion
  85. {
  86. alignas(min_align > alignof(T) ? min_align : alignof(T)) char space[sizeof(T)];
  87. int64_t align_to_int64;
  88. void* align_to_ptr;
  89. } union_;
  90. };
  91. // ArenaStringPtr compatible explicitly constructed string type.
  92. // This empty string type is aligned with a minimum alignment of 8 bytes
  93. // which is the minimum requirement of ArenaStringPtr
  94. using ExplicitlyConstructedArenaString = ExplicitlyConstructed<std::string, 8>;
  95. } // namespace internal
  96. } // namespace protobuf
  97. } // namespace google
  98. #include <google/protobuf/port_undef.inc>
  99. #endif // GOOGLE_PROTOBUF_EXPLICITLY_CONSTRUCTED_H__