From f7dedc90029cc0647b203a3407e2dee0be862e65 Mon Sep 17 00:00:00 2001
From: Hariharan Seshadri <shariharan91@gmail.com>
Date: Mon, 20 Sep 2021 20:58:13 -0700
Subject: [PATCH] Fix default initialization value in C API header (#9126)

* fix default initialization value in C API header

* Fix conflicts

* Nits
---
 .../core/session/onnxruntime_c_api.h          | 52 ++++++++++++++-----
 1 file changed, 40 insertions(+), 12 deletions(-)

diff --git a/include/onnxruntime/core/session/onnxruntime_c_api.h b/include/onnxruntime/core/session/onnxruntime_c_api.h
index 5ee6240289..504bd1e021 100644
--- a/include/onnxruntime/core/session/onnxruntime_c_api.h
+++ b/include/onnxruntime/core/session/onnxruntime_c_api.h
@@ -268,10 +268,10 @@ typedef OrtStatus* OrtStatusPtr;
 * When an allocator is passed to any function, be sure that the allocator object is not destroyed until the last allocated object using it is freed.
 */
 typedef struct OrtAllocator {
-  uint32_t version; ///< Must be initialized to ORT_API_VERSION
-  void*(ORT_API_CALL* Alloc)(struct OrtAllocator* this_, size_t size); ///< Returns a pointer to an allocated block of `size` bytes
-  void(ORT_API_CALL* Free)(struct OrtAllocator* this_, void* p); ///< Free a block of memory previously allocated with OrtAllocator::Alloc
-  const struct OrtMemoryInfo*(ORT_API_CALL* Info)(const struct OrtAllocator* this_); ///< Return a pointer to an ::OrtMemoryInfo that describes this allocator
+  uint32_t version;                                                                   ///< Must be initialized to ORT_API_VERSION
+  void*(ORT_API_CALL* Alloc)(struct OrtAllocator* this_, size_t size);                ///< Returns a pointer to an allocated block of `size` bytes
+  void(ORT_API_CALL* Free)(struct OrtAllocator* this_, void* p);                      ///< Free a block of memory previously allocated with OrtAllocator::Alloc
+  const struct OrtMemoryInfo*(ORT_API_CALL* Info)(const struct OrtAllocator* this_);  ///< Return a pointer to an ::OrtMemoryInfo that describes this allocator
 } OrtAllocator;
 
 typedef void(ORT_API_CALL* OrtLoggingFunction)(
@@ -345,29 +345,57 @@ typedef enum OrtCudnnConvAlgoSearch {
 */
 typedef struct OrtCUDAProviderOptions {
 #ifdef __cplusplus
-  OrtCUDAProviderOptions() : device_id{}, cudnn_conv_algo_search{OrtCudnnConvAlgoSearchExhaustive}, gpu_mem_limit{SIZE_MAX}, arena_extend_strategy{}, do_copy_in_default_stream{}, has_user_compute_stream{}, user_compute_stream{}, default_memory_arena_cfg{} {}
+  OrtCUDAProviderOptions() : device_id{}, cudnn_conv_algo_search{OrtCudnnConvAlgoSearchExhaustive}, gpu_mem_limit{SIZE_MAX}, arena_extend_strategy{}, do_copy_in_default_stream{1}, has_user_compute_stream{}, user_compute_stream{}, default_memory_arena_cfg{} {}
 #endif
 
-  int device_id;  ///< CUDA device id (0 = default device)
+  /** \brief CUDA device Id
+  *   Defaults to 0.
+  */
+  int device_id;
+
+  /** \brief CUDA Convolution algorithm search configuration.
+  *   See enum OrtCudnnConvAlgoSearch for more details.
+  *   Defaults to OrtCudnnConvAlgoSearchExhaustive.
+  */
   OrtCudnnConvAlgoSearch cudnn_conv_algo_search;
 
   /** \brief CUDA memory limit (To use all possible memory pass in maximum size_t)
-  *
-  * \note If a ::OrtArenaCfg has been applied, it will override this field
+  *   Defaults to SIZE_MAX.
+  *   \note If a ::OrtArenaCfg has been applied, it will override this field
   */
   size_t gpu_mem_limit;
 
   /** \brief Strategy used to grow the memory arena
-  *
-  * 0 = kNextPowerOfTwo<br>
-  * 1 = kSameAsRequested<br>
-  * \note If a ::OrtArenaCfg has been applied, it will override this field
+  *   0 = kNextPowerOfTwo<br>
+  *   1 = kSameAsRequested<br>
+  *   Defaults to 0.
+  *   \note If a ::OrtArenaCfg has been applied, it will override this field
   */
   int arena_extend_strategy;
+
+  /** \brief Flag indicating if copying needs to take place on the same stream as the compute stream in the CUDA EP   
+  *   0 = Use separate streams for copying and compute.
+  *   1 = Use the same stream for copying and compute.
+  *   Defaults to 1.
+  *   WARNING: Setting this to 0 may result in data races for some models.
+  *   Please see issue #4829 for more details.
+  */
   int do_copy_in_default_stream;
+
+  /** \brief Flag indicating if there is a user provided compute stream
+  *   Defaults to 0.
+  */
   int has_user_compute_stream;
+
+  /** \brief User provided compute stream. 
+  *   If provided, please set `has_user_compute_stream` to 1.
+  */
   void* user_compute_stream;
+
+  /** \brief CUDA memory arena configuration parameters
+  */
   OrtArenaCfg* default_memory_arena_cfg;
+
 } OrtCUDAProviderOptions;
 
 /** \brief ROCM Provider Options