Commit 519fa1a3 authored by Nick Mathewson's avatar Nick Mathewson 🦀
Browse files

Document the alignment limitation of tor_free()

parent f71bbd20
Loading
Loading
Loading
Loading
+5 −0
Original line number Diff line number Diff line
@@ -79,6 +79,11 @@ extern int dmalloc_free(const char *file, const int line, void *pnt,
 *
 * This is a macro.  If you need a function pointer to release memory from
 * tor_malloc(), use tor_free_().
 *
 * Note that this macro takes the address of the pointer it is going to
 * free and clear.  If that pointer is stored with a nonstandard
 * alignment (eg because of a "packed" pragma) it is not correct to use
 * tor_free().
 */
#ifdef __GNUC__
#define tor_free(p) STMT_BEGIN                                 \