[API-NEXT] pool: clarify use of odp_pool_destroy()

Message ID 1433941264-12098-1-git-send-email-stuart.haslam@linaro.org
State New
Headers show

Commit Message

Stuart Haslam June 10, 2015, 1:01 p.m.
The intended use of odp_pool_destroy() is during a controlled
termination of an application, rather than to support pools being
dynamically created and destroyed.

Signed-off-by: Stuart Haslam <stuart.haslam@linaro.org>
---
 include/odp/api/pool.h | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Bill Fischofer June 11, 2015, 2:49 p.m. | #1
This should be coordinated with Bug
https://bugs.linaro.org/show_bug.cgi?id=1608 to include a note about
potential memory leakage on some platforms.

On Wed, Jun 10, 2015 at 8:01 AM, Stuart Haslam <stuart.haslam@linaro.org>
wrote:

> The intended use of odp_pool_destroy() is during a controlled
> termination of an application, rather than to support pools being
> dynamically created and destroyed.
>
> Signed-off-by: Stuart Haslam <stuart.haslam@linaro.org>
> ---
>  include/odp/api/pool.h | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/include/odp/api/pool.h b/include/odp/api/pool.h
> index 0bcfb98..02e9d21 100644
> --- a/include/odp/api/pool.h
> +++ b/include/odp/api/pool.h
> @@ -119,6 +119,10 @@ odp_pool_t odp_pool_create(const char *name,
> odp_pool_param_t *params);
>  /**
>   * Destroy a pool previously created by odp_pool_create()
>   *
> + * This routine is intended to be used only during graceful termination
> of an
> + * application, to free resources so that they may be used by a
> subsequent ODP
> + * instance.
> + *
>   * @param pool    Handle of the pool to be destroyed
>   *
>   * @retval 0 Success
> --
> 2.1.1
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> https://lists.linaro.org/mailman/listinfo/lng-odp
>

Patch

diff --git a/include/odp/api/pool.h b/include/odp/api/pool.h
index 0bcfb98..02e9d21 100644
--- a/include/odp/api/pool.h
+++ b/include/odp/api/pool.h
@@ -119,6 +119,10 @@  odp_pool_t odp_pool_create(const char *name, odp_pool_param_t *params);
 /**
  * Destroy a pool previously created by odp_pool_create()
  *
+ * This routine is intended to be used only during graceful termination of an
+ * application, to free resources so that they may be used by a subsequent ODP
+ * instance.
+ *
  * @param pool    Handle of the pool to be destroyed
  *
  * @retval 0 Success