CDRIVER-2680 ignore NULL argument to destroy funcs

Author: ajdavis

NEWS

@@ -1,3 +1,10 @@
+Next Release
+============
+
+  * All "destroy" functions such as bson_destroy or mongoc_collection_destroy
+    now ignore a NULL argument.
+
+
 mongo-c-driver 1.10.1
 =====================
 

src/libbson/doc/bson_context_destroy.rst

@@ -19,7 +19,7 @@ Parameters
 Description
 -----------
 
-The ``bson_context_destroy()`` function shall release all resources associated with ``context``.
+The ``bson_context_destroy()`` function shall release all resources associated with ``context``. Does nothing if ``context`` is NULL.
 
 This should be called when you are no longer using a :symbol:`bson_context_t` that you have allocated with :symbol:`bson_context_new()`.
 

src/libbson/doc/bson_destroy.rst

@@ -19,7 +19,7 @@ Parameters
 Description
 -----------
 
-The :symbol:`bson_destroy()` function shall free an allocated :symbol:`bson_t` structure.
+The :symbol:`bson_destroy()` function shall free an allocated :symbol:`bson_t` structure. Does nothing if ``bson`` is NULL.
 
 This function should always be called when you are done with a :symbol:`bson_t` unless otherwise specified.
 

src/libbson/doc/bson_json_reader_destroy.rst

@@ -19,5 +19,4 @@ Parameters
 Description
 -----------
 
-Frees a bson_json_reader_t.
-
+Frees a bson_json_reader_t. Does nothing if ``reader`` is NULL.

src/libbson/doc/bson_reader_destroy.rst

@@ -19,5 +19,4 @@ Parameters
 Description
 -----------
 
-Destroys and releases all resources associated with ``reader``.
-
+Destroys and releases all resources associated with ``reader``. Does nothing if ``reader`` is NULL.

src/libbson/doc/bson_value_destroy.rst

@@ -19,5 +19,4 @@ Parameters
 Description
 -----------
 
-Releases any resources associated with ``value``.
-
+Releases any resources associated with ``value``. Does nothing if ``value`` is NULL.

src/libbson/doc/bson_writer_destroy.rst

@@ -19,5 +19,4 @@ Parameters
 Description
 -----------
 
-Cleanup after ``writer`` and release any allocated memory. Note that the buffer supplied to :symbol:`bson_writer_new()` is *NOT* freed from this method.  The caller is responsible for that.
-
+Cleanup after ``writer`` and release any allocated memory. Does nothing if ``writer`` is NULL. Note that the buffer supplied to :symbol:`bson_writer_new()` is *NOT* freed from this method. The caller is responsible for that.

src/libbson/src/bson/bson-context.c

@@ -463,10 +463,7 @@ bson_context_new (bson_context_flags_t flags)
 void
 bson_context_destroy (bson_context_t *context) /* IN */
 {
-   if (context != &gContextDefault) {
-      memset (context, 0, sizeof *context);
-      bson_free (context);
-   }
+   bson_free (context);
 }
 
 

src/libbson/src/bson/bson-json.c

@@ -2145,8 +2145,15 @@ void
 bson_json_reader_destroy (bson_json_reader_t *reader) /* IN */
 {
    int i;
-   bson_json_reader_producer_t *p = &reader->producer;
-   bson_json_reader_bson_t *b = &reader->bson;
+   bson_json_reader_producer_t *p;
+   bson_json_reader_bson_t *b;
+
+   if (!reader) {
+      return;
+   }
+
+   p = &reader->producer;
+   b = &reader->bson;
 
    if (reader->producer.dcb) {
       reader->producer.dcb (reader->producer.data);

src/libbson/src/bson/bson-reader.c

@@ -644,7 +644,9 @@ _bson_reader_data_tell (bson_reader_data_t *reader) /* IN */
 void
 bson_reader_destroy (bson_reader_t *reader) /* IN */
 {
-   BSON_ASSERT (reader);
+   if (!reader) {
+      return;
+   }
 
    switch (reader->type) {
    case 0:

src/libbson/src/bson/bson-value.c

@@ -142,6 +142,10 @@ bson_value_copy (const bson_value_t *src, /* IN */
 void
 bson_value_destroy (bson_value_t *value) /* IN */
 {
+   if (!value) {
+      return;
+   }
+
    switch (value->value_type) {
    case BSON_TYPE_UTF8:
       bson_free (value->value.v_utf8.str);

src/libbson/src/bson/bson.c

@@ -2311,7 +2311,9 @@ bson_copy_to_excluding_noinit (const bson_t *src,
 void
 bson_destroy (bson_t *bson)
 {
-   BSON_ASSERT (bson);
+   if (!bson) {
+      return;
+   }
 
    if (!(bson->flags &
          (BSON_FLAG_RDONLY | BSON_FLAG_INLINE | BSON_FLAG_NO_FREE))) {

src/libmongoc/doc/mongoc_apm_callbacks_destroy.rst

@@ -11,7 +11,7 @@ Synopsis
   void
   mongoc_apm_callbacks_destroy (mongoc_apm_callbacks_t *callbacks);
 
-Free a :symbol:`mongoc_apm_callbacks_t`.
+Free a :symbol:`mongoc_apm_callbacks_t`. Does nothing if ``callbacks`` is NULL.
 
 See Also
 --------

src/libmongoc/doc/mongoc_bulk_operation_destroy.rst

@@ -11,7 +11,7 @@ Synopsis
   void
   mongoc_bulk_operation_destroy (mongoc_bulk_operation_t *bulk);
 
-Destroys a :symbol:`mongoc_bulk_operation_t` and frees the structure.
+Destroys a :symbol:`mongoc_bulk_operation_t` and frees the structure. Does nothing if ``bulk`` is NULL.
 
 Parameters
 ----------

src/libmongoc/doc/mongoc_client_destroy.rst

@@ -11,7 +11,7 @@ Synopsis
   void
   mongoc_client_destroy (mongoc_client_t *client);
 
-Release all resources associated with ``client`` and free the structure.
+Release all resources associated with ``client`` and free the structure. Does nothing if ``client`` is NULL.
 
 Parameters
 ----------

src/libmongoc/doc/mongoc_client_session_destroy.rst

@@ -11,7 +11,7 @@ Synopsis
   void
   mongoc_client_session_destroy (mongoc_client_session_t *session);
 
-End a session, returning its session id to the pool, and free all client resources associated with the session. If a multi-document transaction is in progress, abort it.
+End a session, returning its session id to the pool, and free all client resources associated with the session. If a multi-document transaction is in progress, abort it. Does nothing if ``session`` is NULL.
 
 See the example code for :symbol:`mongoc_client_session_t`.
 

src/libmongoc/doc/mongoc_collection_destroy.rst

@@ -19,7 +19,7 @@ Parameters
 Description
 -----------
 
-This function shall destroy a :symbol:`mongoc_collection_t` and its associated resources.
+This function shall destroy a :symbol:`mongoc_collection_t` and its associated resources. Does nothing if ``collection`` is NULL.
 
 .. warning::
 

src/libmongoc/doc/mongoc_cursor_destroy.rst

@@ -19,5 +19,4 @@ Parameters
 Description
 -----------
 
-Frees a :symbol:`mongoc_cursor_t` and releases all associated resources. If a server-side cursor has been allocated, it will be released as well.
-
+Frees a :symbol:`mongoc_cursor_t` and releases all associated resources. If a server-side cursor has been allocated, it will be released as well. Does nothing if ``cursor`` is NULL.

src/libmongoc/doc/mongoc_database_destroy.rst

@@ -11,7 +11,7 @@ Synopsis
   void
   mongoc_database_destroy (mongoc_database_t *database);
 
-Releases all resources associated with ``database``, including freeing the structure.
+Releases all resources associated with ``database``, including freeing the structure. Does nothing if ``database`` is NULL.
 
 Parameters
 ----------

src/libmongoc/doc/mongoc_find_and_modify_opts_destroy.rst

@@ -20,5 +20,5 @@ Parameters
 Description
 -----------
 
-Frees all resources associated with the find and modify builder structure.
+Frees all resources associated with the find and modify builder structure. Does nothing if ``find_and_modify_opts`` is NULL.
 

src/libmongoc/doc/mongoc_gridfs_destroy.rst

@@ -19,5 +19,4 @@ Parameters
 Description
 -----------
 
-This function shall destroy the gridfs structure referenced by ``gridfs`` and any resources associated with the gridfs.
-
+This function shall destroy the gridfs structure referenced by ``gridfs`` and any resources associated with the gridfs. Does nothing if ``gridfs`` is NULL.

src/libmongoc/doc/mongoc_gridfs_file_destroy.rst

@@ -19,5 +19,4 @@ Parameters
 Description
 -----------
 
-Destroys the :symbol:`mongoc_gridfs_file_t` instance and any resources associated with it.
-
+Destroys the :symbol:`mongoc_gridfs_file_t` instance and any resources associated with it. Does nothing if ``file`` is NULL.

src/libmongoc/doc/mongoc_gridfs_file_list_destroy.rst

@@ -19,5 +19,4 @@ Parameters
 Description
 -----------
 
-Frees a ``mongoc_gridfs_file_list_t`` and releases any associated resources.
-
+Frees a ``mongoc_gridfs_file_list_t`` and releases any associated resources. Does nothing if ``list`` is NULL.

src/libmongoc/doc/mongoc_read_concern_destroy.rst

@@ -19,5 +19,4 @@ Parameters
 Description
 -----------
 
-Frees all resources associated with the read concern structure.
-
+Frees all resources associated with the read concern structure. Does nothing if ``read_concern`` is NULL.

src/libmongoc/doc/mongoc_read_prefs_destroy.rst

@@ -19,5 +19,4 @@ Parameters
 Description
 -----------
 
-Frees a read preference and all associated resources.
-
+Frees a read preference and all associated resources. Does nothing if ``read_prefs`` is NULL.

src/libmongoc/doc/mongoc_server_description_destroy.rst

@@ -19,5 +19,4 @@ Parameters
 Description
 -----------
 
-Clean up all memory associated with the server description.
-
+Clean up all memory associated with the server description. Does nothing if ``description`` is NULL.

src/libmongoc/doc/mongoc_session_opts_destroy.rst

@@ -11,7 +11,15 @@ Synopsis
   void
   mongoc_session_opts_destroy (mongoc_session_opt_t *opts);
 
-Free a :symbol:`mongoc_session_opt_t`.
+Free a :symbol:`mongoc_session_opt_t`. Does nothing if ``opts`` is NULL.
+
+Parameters
+----------
+
+* ``opts``: A :symbol:`mongoc_session_opt_t`.
+
+Example
+-------
 
 See the example code for :symbol:`mongoc_session_opts_set_causal_consistency`.
 

src/libmongoc/doc/mongoc_socket_destroy.rst

@@ -19,5 +19,4 @@ Parameters
 Description
 -----------
 
-This function releases all resources associated with a :symbol:`mongoc_socket_t`. This should be called when you are no longer using the socket.
-
+This function releases all resources associated with a :symbol:`mongoc_socket_t`. This should be called when you are no longer using the socket. Does nothing if ``sock`` is NULL.

src/libmongoc/doc/mongoc_stream_destroy.rst

@@ -16,5 +16,4 @@ Parameters
 
 * ``stream``: A :symbol:`mongoc_stream_t`.
 
-This function shall release all resources associated with a :symbol:`mongoc_stream_t`, including freeing the structure. It is invalid to use ``stream`` after calling this function.
-
+This function shall release all resources associated with a :symbol:`mongoc_stream_t`, including freeing the structure. It is invalid to use ``stream`` after calling this function. Does nothing if ``stream`` is NULL.

src/libmongoc/doc/mongoc_transaction_opts_destroy.rst

@@ -11,7 +11,12 @@ Synopsis
   void
   mongoc_transaction_opts_destroy (mongoc_transaction_opt_t *opts);
 
-Free a :symbol:`mongoc_transaction_opt_t`.
+Free a :symbol:`mongoc_transaction_opt_t`. Does nothing if ``opts`` is NULL.
+
+Parameters
+----------
+
+* ``opts``: A :symbol:`mongoc_transaction_opt_t`.
 
 .. only:: html
 

src/libmongoc/doc/mongoc_uri_destroy.rst

@@ -19,5 +19,4 @@ Parameters
 Description
 -----------
 
-Frees all resources associated with a uri.
-
+Frees all resources associated with a uri. Does nothing if ``uri`` is NULL.

src/libmongoc/doc/mongoc_write_concern_destroy.rst

@@ -19,5 +19,4 @@ Parameters
 Description
 -----------
 
-Frees all resources associated with the write concern structure.
-
+Frees all resources associated with the write concern structure. Does nothing if ``write_concern`` is NULL.

src/libmongoc/src/mongoc/mongoc-change-stream.c

@@ -439,7 +439,10 @@ mongoc_change_stream_error_document (const mongoc_change_stream_t *stream,
 void
 mongoc_change_stream_destroy (mongoc_change_stream_t *stream)
 {
-   BSON_ASSERT (stream);
+   if (!stream) {
+      return;
+   }
+
    bson_destroy (&stream->pipeline_to_append);
    bson_destroy (&stream->full_document);
    bson_destroy (&stream->opts);

src/libmongoc/src/mongoc/mongoc-client-pool.c

@@ -160,7 +160,9 @@ mongoc_client_pool_destroy (mongoc_client_pool_t *pool)
 
    ENTRY;
 
-   BSON_ASSERT (pool);
+   if (!pool) {
+      EXIT;
+   }
 
    if (pool->topology->session_pool) {
       client = mongoc_client_pool_pop (pool);

src/libmongoc/src/mongoc/mongoc-client-session.c

@@ -168,7 +168,9 @@ mongoc_transaction_opts_destroy (mongoc_transaction_opt_t *opts)
 {
    ENTRY;
 
-   BSON_ASSERT (opts);
+   if (!opts) {
+      EXIT;
+   }
 
    txn_opts_cleanup (opts);
    bson_free (opts);
@@ -331,7 +333,9 @@ mongoc_session_opts_destroy (mongoc_session_opt_t *opts)
 {
    ENTRY;
 
-   BSON_ASSERT (opts);
+   if (!opts) {
+      EXIT;
+   }
 
    txn_opts_cleanup (&opts->default_txn_opts);
    bson_free (opts);
@@ -1008,7 +1012,9 @@ mongoc_client_session_destroy (mongoc_client_session_t *session)
 {
    ENTRY;
 
-   BSON_ASSERT (session);
+   if (!session) {
+      EXIT;
+   }
 
    if (_mongoc_client_session_in_txn (session)) {
       mongoc_client_session_abort_transaction (session, NULL);

src/libmongoc/src/mongoc/mongoc-client.c

@@ -1572,7 +1572,7 @@ _mongoc_client_retryable_write_command_with_stream (
       if (retry_server_stream && retry_server_stream->sd->max_wire_version >=
                                     WIRE_VERSION_RETRY_WRITES) {
          parts->assembled.server_stream = retry_server_stream;
-         _mongoc_bson_destroy_if_set (reply);
+         bson_destroy (reply);
          GOTO (retry);
       }
    }

src/libmongoc/src/mongoc/mongoc-collection.c

@@ -186,7 +186,7 @@ _mongoc_collection_new (mongoc_client_t *client,
  *       None.
  *
  * Side effects:
- *       Everything.
+ *       None.
  *
  *--------------------------------------------------------------------------
  */
@@ -196,7 +196,9 @@ mongoc_collection_destroy (mongoc_collection_t *collection) /* IN */
 {
    ENTRY;
 
-   BSON_ASSERT (collection);
+   if (!collection) {
+      EXIT;
+   }
 
    bson_clear (&collection->gle);
 

src/libmongoc/src/mongoc/mongoc-cursor.c

@@ -539,7 +539,9 @@ mongoc_cursor_destroy (mongoc_cursor_t *cursor)
    char db[MONGOC_NAMESPACE_MAX];
    ENTRY;
 
-   BSON_ASSERT (cursor);
+   if (!cursor) {
+      EXIT;
+   }
 
    if (cursor->impl.destroy) {
       cursor->impl.destroy (&cursor->impl);

src/libmongoc/src/mongoc/mongoc-database.c

@@ -103,7 +103,9 @@ mongoc_database_destroy (mongoc_database_t *database)
 {
    ENTRY;
 
-   BSON_ASSERT (database);
+   if (!database) {
+      EXIT;
+   }
 
    if (database->read_prefs) {
       mongoc_read_prefs_destroy (database->read_prefs);