Upgrade optional implementation to https://github.com/martinmoene/optional-lite. (microsoft#5563)

Author: edgchen1

.gitmodules

@@ -65,3 +65,6 @@
 [submodule "cmake/external/onnx-tensorrt"]
 	path = cmake/external/onnx-tensorrt
 	url = https://github.com/onnx/onnx-tensorrt.git
+[submodule "cmake/external/optional-lite"]
+	path = cmake/external/optional-lite
+	url = https://github.com/martinmoene/optional-lite.git

ThirdPartyNotices.txt

@@ -848,22 +848,16 @@ THE POSSIBILITY OF SUCH DAMAGE.
 
 _____
 
-Microsoft/GSL
+gsl-lite
 
+gsl-lite is based on GSL: Guidelines Support Library.
+For more information see https://github.com/martinmoene/gsl-lite
+
+Copyright (c) 2015 Martin Moene
 Copyright (c) 2015 Microsoft Corporation. All rights reserved.
 
 This code is licensed under the MIT License (MIT).
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -1657,7 +1651,7 @@ COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-____
+_____
 
 Distributed Machine Learning Common Codebase
 
@@ -1881,7 +1875,7 @@ DLPack: Open In Memory Tensor Structure
    See the License for the specific language governing permissions and
    limitations under the License.
 
-____
+_____
 
 HowardHinnant/date
 
@@ -1917,7 +1911,7 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
-____
+_____
 
 TVM Open Deep Learning Compiler Stack
 
@@ -2204,7 +2198,7 @@ OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 --------------------------------------------------------------------------------
 
-____
+_____
 
 FreeBSD: getopt.c file
 
@@ -3048,7 +3042,7 @@ ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 
 
------
+_____
 
 JDAI-CV/DNNLibrary
 
@@ -3255,7 +3249,7 @@ JDAI-CV/DNNLibrary
    limitations under the License.
 
 
------
+_____
 
 google/flatbuffers
 
@@ -3463,7 +3457,7 @@ google/flatbuffers
    limitations under the License.
 
 
------
+_____
 
 google/glog
 
@@ -3533,7 +3527,7 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-----
+_____
 
 abseil-cpp
 https://github.com/abseil/abseil-cpp
@@ -3741,7 +3735,7 @@ https://github.com/abseil/abseil-cpp
    limitations under the License.
 
 
------
+_____
 
 NVlabs/cub
 
@@ -3770,7 +3764,7 @@ ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
------
+_____
 
 microsoft/wil
 
@@ -3796,7 +3790,7 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE
 
------
+_____
 
 nlohmann/json
 
@@ -3822,7 +3816,7 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
------
+_____
 
 dcleblanc/SafeInt
 
@@ -3848,7 +3842,7 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
------
+_____
 Open MPI
 
 3-Clause BSD License
@@ -3954,7 +3948,7 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
------
+_____
 
 The Android Open Source Project
 
@@ -4293,7 +4287,7 @@ libprotobuf-mutator
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.
 
---
+_____
 
    mpi4py
    https://github.com/mpi4py/mpi4py/
@@ -4805,7 +4799,7 @@ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 
------
+_____
 
 MurmurHash3
 
@@ -4820,7 +4814,7 @@ SMHasher test suite used to verify them.
 SMHasher is released under the MIT license. 
 All MurmurHash versions are public domain software, and the author disclaims all copyright to their code.
 
------
+_____
 
 gtest-ios-framework
 
@@ -4847,4 +4841,38 @@ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
------
+_____
+
+optional-lite
+
+Copyright (c) 2014-2018 Martin Moene
+
+https://github.com/martinmoene/optional-lite
+
+Distributed under the Boost Software License, Version 1.0.
+
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+_____

cgmanifests/submodules/cgmanifest.json

@@ -431,6 +431,16 @@
         "comments": "git submodule at cmake/external/onnx-tensorrt/third_party/onnx/third_party/pybind11/tools/clang"
       }
     },
+    {
+      "component": {
+        "type": "git",
+        "git": {
+          "commitHash": "4acf4553baa886e10e6613fe1452b706b0250e78",
+          "repositoryUrl": "https://github.com/martinmoene/optional-lite.git"
+        },
+        "comments": "git submodule at cmake/external/optional-lite"
+      }
+    },
     {
       "component": {
         "type": "git",

cmake/CMakeLists.txt

@@ -621,6 +621,11 @@ set(SAFEINT_INCLUDE_DIR ${REPO_ROOT}/cmake/external/SafeInt)
 add_library(safeint_interface INTERFACE)
 target_include_directories(safeint_interface INTERFACE ${SAFEINT_INCLUDE_DIR})
 
+set(OPTIONAL_LITE_INCLUDE_DIR ${REPO_ROOT}/cmake/external/optional-lite/include)
+if(onnxruntime_DISABLE_EXCEPTIONS)
+  add_compile_definitions(optional_CONFIG_NO_EXCEPTIONS=1)
+endif()
+
 if(NOT TARGET re2::re2)
   add_subdirectory(external/re2 EXCLUDE_FROM_ALL)
   set_target_properties(re2 PROPERTIES FOLDER "External/re2")

cmake/external/optional-lite

@@ -100,8 +100,10 @@ endif()
 onnxruntime_add_include_to_target(onnxruntime_common date_interface wil)
 target_include_directories(onnxruntime_common
     PRIVATE ${CMAKE_CURRENT_BINARY_DIR} ${ONNXRUNTIME_ROOT} ${eigen_INCLUDE_DIRS}
-    # safeint is part of onnxruntime_common public interface, so we want to propagate its includes
-    PUBLIC $<TARGET_PROPERTY:safeint_interface,INTERFACE_INCLUDE_DIRECTORIES>)
+    # propagate include directories of dependencies that are part of public interface
+    PUBLIC
+        $<TARGET_PROPERTY:safeint_interface,INTERFACE_INCLUDE_DIRECTORIES>
+        ${OPTIONAL_LITE_INCLUDE_DIR})
 
 if(NOT WIN32)
   target_include_directories(onnxruntime_common PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/external/nsync/public")

cmake/onnxruntime_common.cmake

@@ -3,40 +3,22 @@
 
 #pragma once
 
-#include "core/common/common.h"
+#include <nonstd/optional.hpp>
 
 namespace onnxruntime {
-// This is a version of std::optional with limited functionality and plenty of
-// room to improve. We should use std::optional when we move to C++17.
-template <typename T>
-class optional {
- public:
-  optional() : has_value_{false}, value_{} {}
-
-  optional(const optional&) = default;
-  optional& operator=(const optional&) = default;
-  optional(optional&&) = default;
-  optional& operator=(optional&&) = default;
-
-  optional(T value) : has_value_{true}, value_{value} {}
-  optional& operator=(T value) {
-    has_value_ = true;
-    value_ = value;
-    return *this;
-  }
-
-  bool has_value() const { return has_value_; }
-  const T& value() const {
-    ORT_ENFORCE(has_value_);
-    return value_;
-  }
-  T& value() {
-    ORT_ENFORCE(has_value_);
-    return value_;
-  }
-
- private:
-  bool has_value_;
-  T value_;
-};
+
+using nonstd::optional;
+
+#ifndef ORT_NO_EXCEPTIONS
+using nonstd::bad_optional_access;
+#endif
+
+using nonstd::nullopt;
+using nonstd::nullopt_t;
+
+using nonstd::in_place;
+using nonstd::in_place_t;
+
+using nonstd::make_optional;
+
 }  // namespace onnxruntime

include/onnxruntime/core/common/optional.h

@@ -22,7 +22,6 @@ limitations under the License.
 #include <memory>
 #include "core/common/common.h"
 #include "core/platform/env.h"
-#include "core/common/optional.h"
 
 #include <functional>
 #include <memory>
@@ -81,7 +80,7 @@ class ThreadPool {
   // synchronously if it cannot be enqueued.  This will occur if the thread pool's
   // degree-of-parallelism is 1, but it may also occur for implementation-dependent
   // reasons such as if queues used for buffering work are full.
-  static void Schedule(ThreadPool *tp,
+  static void Schedule(ThreadPool* tp,
                        std::function<void()> fn) {
     if (tp) {
       tp->Schedule(fn);
@@ -108,7 +107,7 @@ class ThreadPool {
   }
 
   static void TryParallelFor(ThreadPool* tp, std::ptrdiff_t total, const TensorOpCost& cost_per_unit,
-                             const std::function<void(std::ptrdiff_t first, std::ptrdiff_t last)>& fn); 
+                             const std::function<void(std::ptrdiff_t first, std::ptrdiff_t last)>& fn);
 
   // Directly schedule the 'total' tasks to the underlying threadpool, without
   // cutting them by halves
@@ -221,8 +220,8 @@ class ThreadPool {
   // Provide a hint to the caller for whether or not to parallelize
   // work.  This lets a caller switch to a sequential version of an
   // algorithm rather than using calls via the ParallelFor functions.
-  
-  static bool ShouldParallelize(const ThreadPool *tp);
+
+  static bool ShouldParallelize(const ThreadPool* tp);
 
   // Return the degree of parallelism that code should assume when using the thread pool.
   // It decouples the degree of parallelism for use with the thread pool from
@@ -262,7 +261,6 @@ class ThreadPool {
   void ParallelForFixedBlockSizeScheduling(std::ptrdiff_t total, std::ptrdiff_t block_size,
                                            const std::function<void(std::ptrdiff_t, std::ptrdiff_t)>& fn);
 
-
   // Return whether or not the calling thread should run a loop of
   // num_iterations divided in chunks of block_size in parallel.  If not,
   // the caller should run the loop sequentially.