summaryrefslogtreecommitdiff
path: root/lib/talloc
diff options
context:
space:
mode:
authorVolker Lendecke <vl@samba.org>2009-03-21 23:49:30 +0100
committerVolker Lendecke <vl@samba.org>2009-03-21 23:50:33 +0100
commit986c2e01cca0be993f1e52d3a27819f4044bfe4b (patch)
treee7166c1f36be3204ba831bfca2ddbce742e049cf /lib/talloc
parent3f81649b8dcadb3bd424f41d803dbd59f770b9ba (diff)
downloadsamba-986c2e01cca0be993f1e52d3a27819f4044bfe4b.tar.gz
samba-986c2e01cca0be993f1e52d3a27819f4044bfe4b.tar.bz2
samba-986c2e01cca0be993f1e52d3a27819f4044bfe4b.zip
Document talloc_parent, talloc_parent_name and talloc_is_parent
Diffstat (limited to 'lib/talloc')
-rw-r--r--lib/talloc/talloc.h29
1 files changed, 29 insertions, 0 deletions
diff --git a/lib/talloc/talloc.h b/lib/talloc/talloc.h
index d103d6f4f2..9806bdd3ad 100644
--- a/lib/talloc/talloc.h
+++ b/lib/talloc/talloc.h
@@ -849,7 +849,25 @@ const char *talloc_get_name(const void *ptr);
void *talloc_check_name(const void *ptr, const char *name);
void *_talloc_get_type_abort(const void *ptr, const char *name, const char *location);
+
+/**
+ * \brief Return the parent chunk of a pointer
+ * \param ptr The talloc pointer to inspect
+ * \return The talloc parent of "ptr"
+ * \ingroup talloc_basic
+ *
+ * Return the parent chunk of a pointer
+ */
void *talloc_parent(const void *ptr);
+
+/**
+ * \brief Return a talloc chunk's parent name
+ * \param ptr The talloc pointer to inspect
+ * \return The name of ptr's parent chunk
+ * \ingroup talloc_basic
+ *
+ * Return a talloc chunk's parent name
+ */
const char *talloc_parent_name(const void *ptr);
/**
@@ -1149,6 +1167,17 @@ size_t talloc_get_size(const void *ctx);
*/
void *talloc_find_parent_byname(const void *ctx, const char *name);
void talloc_show_parents(const void *context, FILE *file);
+
+/**
+ * \brief Check if a context is parent of a talloc chunk
+ * \param context The assumed talloc context
+ * \param ptr The talloc chunk to check
+ * \return Is context an anchestor of ptr
+ * \ingroup talloc_basic
+ *
+ * talloc_is_parent() checks if context is referenced in the talloc
+ * hierarchy above ptr. Return 1 if this is the case, 0 if not.
+ */
int talloc_is_parent(const void *context, const void *ptr);
/**