[PATCHv3,05/18] api: odp_buffer.h: undefined behavior description

Message ID 1422891740-5347-6-git-send-email-ola.liljedahl@linaro.org
State New
Headers show

Commit Message

Ola Liljedahl Feb. 2, 2015, 3:42 p.m.
Documented API calls which are guaranteed to handle invalid/stale handles.

Signed-off-by: Ola Liljedahl <ola.liljedahl@linaro.org>
---
(This document/code contribution attached is provided under the terms of
agreement LES-LTM-21309)

 include/odp/api/buffer.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Patch

diff --git a/include/odp/api/buffer.h b/include/odp/api/buffer.h
index 12b2f5a..1eb2e5a 100644
--- a/include/odp/api/buffer.h
+++ b/include/odp/api/buffer.h
@@ -88,7 +88,9 @@  uint32_t odp_buffer_size(odp_buffer_t buf);
 /**
  * Tests if buffer is valid
  *
- * @param buf      Buffer handle
+ * @param buf      Buffer handle (possibly invalid)
+ * @note This is the only buffer API function which accepts invalid buffer
+ * handles (any bit value) without causing undefined behavior.
  *
  * @retval 1 Buffer handle represents a valid buffer.
  * @retval 0 Buffer handle does not represent a valid buffer.