#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
+#include <ccan/typesafe_cb/typesafe_cb.h>
+#include <ccan/compiler/compiler.h>
#include "config.h"
-#include "ccan/typesafe_cb/typesafe_cb.h"
/*
this uses a little trick to allow __LINE__ to be stringified
#define __location__ __FILE__ ":" __TALLOC_STRING_LINE3__
#endif
-#if HAVE_ATTRIBUTE_PRINTF
-/** Use gcc attribute to check printf fns. a1 is the 1-based index of
- * the parameter containing the format, and a2 the index of the first
- * argument. Note that some gcc 2.x versions don't handle this
- * properly **/
-#define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
-#else
-#define PRINTF_ATTRIBUTE(a1, a2)
-#endif
-
/* try to make talloc_set_destructor() and talloc_steal() type safe,
if we have a recent gcc */
#if HAVE_TYPEOF
*/
#define talloc(ctx, type) (type *)talloc_named_const(ctx, sizeof(type), #type)
+/**
+ * talloc_set - allocate dynamic memory for a type, into a pointer
+ * @ptr: pointer to the pointer to assign.
+ * @ctx: context to be parent of this allocation, or NULL.
+ *
+ * talloc_set() does a talloc, but also adds a destructor which will make the
+ * pointer invalid when it is freed. This can find many use-after-free bugs.
+ *
+ * Note that the destructor is chained off a zero-length allocation, and so
+ * is not affected by talloc_set_destructor().
+ *
+ * Example:
+ * unsigned int *b, *a;
+ * a = talloc(NULL, unsigned int);
+ * talloc_set(&b, a);
+ * talloc_free(a);
+ * *b = 1; // This will crash!
+ *
+ * See Also:
+ * talloc.
+ */
+#define talloc_set(pptr, ctx) \
+ _talloc_set((pptr), (ctx), sizeof(&**(pptr)), __location__)
+
/**
* talloc_free - free talloc'ed memory and its children
* @ptr: the talloced pointer to free
* See Also:
* talloc_set_destructor, talloc_unlink
*/
-int talloc_free(void *ptr);
+int talloc_free(const void *ptr);
/**
- * talloc_set_destructor: set a destructor for when this pointer is freed
+ * talloc_set_destructor - set a destructor for when this pointer is freed
* @ptr: the talloc pointer to set the destructor on
* @destructor: the function to be called
*
* return 0;
* }
*
- * int *open_file(const char *filename)
+ * static int *open_file(const char *filename)
* {
* int *fd = talloc(NULL, int);
* *fd = open(filename, O_RDONLY);
* talloc, talloc_free
*/
#define talloc_set_destructor(ptr, function) \
- _talloc_set_destructor((ptr), typesafe_cb(int, (function), (ptr)))
+ _talloc_set_destructor((ptr), typesafe_cb_def(int, (function), (ptr)))
/**
* talloc_zero - allocate zeroed dynamic memory for a type
*
* Example:
* void *mem = talloc_size(NULL, 100);
+ * memset(mem, 0xFF, 100);
*
* See Also:
* talloc, talloc_array, talloc_zero_size
* a = talloc(NULL, unsigned int);
* b = talloc(NULL, unsigned int);
* c = talloc(a, unsigned int);
- * // b also serves as a parent of c.
- * talloc_reference(b, c);
+ * // b also serves as a parent of c (don't care about errors)
+ * (void)talloc_reference(b, c);
*/
#define talloc_reference(ctx, ptr) (_TALLOC_TYPEOF(ptr))_talloc_reference((ctx),(ptr))
/**
- * talloc_unlink: remove a specific parent from a talloc pointer.
+ * talloc_unlink - remove a specific parent from a talloc pointer.
* @context: the parent to remove
* @ptr: the talloc pointer
*
* Usually you can just use talloc_free() instead of talloc_unlink(), but
* sometimes it is useful to have the additional control on which parent is
* removed.
+ *
* Example:
* unsigned int *a, *b, *c;
* a = talloc(NULL, unsigned int);
* b = talloc(NULL, unsigned int);
* c = talloc(a, unsigned int);
* // b also serves as a parent of c.
- * talloc_reference(b, c);
+ * (void)talloc_reference(b, c);
* talloc_unlink(b, c);
*/
int talloc_unlink(const void *context, void *ptr);
*/
#define talloc_ptrtype(ctx, ptr) (_TALLOC_TYPEOF(ptr))talloc_size(ctx, sizeof(*(ptr)))
-/**
- * talloc_free_children - free talloc'ed memory's children only
- * @ptr: the talloced pointer whose children we want to free
- *
- * talloc_free_children() walks along the list of all children of a talloc
- * context @ptr and talloc_free()s only the children, not the context itself.
- * Example:
- * unsigned int *a, *b;
- * a = talloc(NULL, unsigned int);
- * b = talloc(a, unsigned int);
- * // Frees b
- * talloc_free_children(a);
- */
-void talloc_free_children(void *ptr);
-
/**
* talloc_new - create a new context
* @ctx: the context to use as a parent.
#define talloc_zero_array(ctx, type, count) (type *)_talloc_zero_array(ctx, sizeof(type), count, #type)
/**
- * talloc_zero_array - allocate an array of zeroed types
+ * talloc_array_size - allocate an array of elements of the given size
* @ctx: context to be parent of this allocation, or NULL.
- * @type: the type to be allocated.
+ * @size: the size of each element
* @count: the number of elements to be allocated.
*
- * Just like talloc_array, but zeroes the memory.
+ * Typeless form of talloc_array.
*/
#define talloc_array_size(ctx, size, count) _talloc_array(ctx, size, count, __location__)
*/
void *talloc_find_parent_byname(const void *ctx, const char *name);
+/**
+ * talloc_add_external - create an externally allocated node
+ * @ctx: the parent
+ * @realloc: the realloc() equivalent
+ * @lock: the call to lock before manipulation of external nodes
+ * @unlock: the call to unlock after manipulation of external nodes
+ *
+ * talloc_add_external() creates a node which uses a separate allocator. All
+ * children allocated from that node will also use that allocator.
+ *
+ * Note: Currently there is only one external allocator, not per-node,
+ * and it is set with this function.
+ *
+ * @lock is handed a pointer which was previous returned from your realloc
+ * function; you should use that to figure out which lock to get if you have
+ * multiple external pools.
+ *
+ * The parent pointers in realloc is the talloc pointer of the parent, if any.
+ */
+void *talloc_add_external(const void *ctx,
+ void *(*realloc)(const void *parent,
+ void *ptr, size_t),
+ void (*lock)(const void *p),
+ void (*unlock)(void));
+
/* The following definitions come from talloc.c */
void *_talloc(const void *context, size_t size);
+void _talloc_set(void *ptr, const void *ctx, size_t size, const char *name);
void _talloc_set_destructor(const void *ptr, int (*destructor)(void *));
size_t talloc_reference_count(const void *ptr);
void *_talloc_reference(const void *context, const void *ptr);
projects / ccan / blobdiff