From cf659fa4fe7369ac58ef547f744c0ff3f9fb137a Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Thu, 23 Oct 2008 17:27:30 +0200 Subject: Import talloc_stack into util library. --- lib/util/config.mk | 1 + lib/util/talloc_stack.c | 130 +++++++++++++++++++++++++++++++++++++++++ lib/util/talloc_stack.h | 56 ++++++++++++++++++ lib/util/util.h | 1 + source3/Makefile.in | 4 +- source3/include/includes.h | 2 +- source3/include/talloc_stack.h | 56 ------------------ source3/lib/talloc_stack.c | 130 ----------------------------------------- 8 files changed, 191 insertions(+), 189 deletions(-) create mode 100644 lib/util/talloc_stack.c create mode 100644 lib/util/talloc_stack.h delete mode 100644 source3/include/talloc_stack.h delete mode 100644 source3/lib/talloc_stack.c diff --git a/lib/util/config.mk b/lib/util/config.mk index 5488534f26..0eaabbf86b 100644 --- a/lib/util/config.mk +++ b/lib/util/config.mk @@ -26,6 +26,7 @@ LIBSAMBA-UTIL_OBJ_FILES = $(addprefix $(libutilsrcdir)/, \ idtree.o \ become_daemon.o \ rbtree.o \ + talloc_stack.o \ params.o) PUBLIC_HEADERS += $(addprefix $(libutilsrcdir)/, util.h \ diff --git a/lib/util/talloc_stack.c b/lib/util/talloc_stack.c new file mode 100644 index 0000000000..2722fb9676 --- /dev/null +++ b/lib/util/talloc_stack.c @@ -0,0 +1,130 @@ +/* + Unix SMB/CIFS implementation. + Implement a stack of talloc contexts + Copyright (C) Volker Lendecke 2007 + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +*/ + +/* + * Implement a stack of talloc frames. + * + * When a new talloc stackframe is allocated with talloc_stackframe(), then + * the TALLOC_CTX returned with talloc_tos() is reset to that new + * frame. Whenever that stack frame is TALLOC_FREE()'ed, then the reverse + * happens: The previous talloc_tos() is restored. + * + * This API is designed to be robust in the sense that if someone forgets to + * TALLOC_FREE() a stackframe, then the next outer one correctly cleans up and + * resets the talloc_tos(). + * + * This robustness feature means that we can't rely on a linked list with + * talloc destructors because in a hierarchy of talloc destructors the parent + * destructor is called before its children destructors. The child destructor + * called after the parent would set the talloc_tos() to the wrong value. + */ + +#include "includes.h" + +static int talloc_stacksize; +static int talloc_stack_arraysize; +static TALLOC_CTX **talloc_stack; + +static int talloc_pop(TALLOC_CTX *frame) +{ + int i; + + for (i=talloc_stacksize-1; i>0; i--) { + if (frame == talloc_stack[i]) { + break; + } + talloc_free(talloc_stack[i]); + } + + talloc_stacksize = i; + return 0; +} + +/* + * Create a new talloc stack frame. + * + * When free'd, it frees all stack frames that were created after this one and + * not explicitly freed. + */ + +static TALLOC_CTX *talloc_stackframe_internal(size_t poolsize) +{ + TALLOC_CTX **tmp, *top, *parent; + + if (talloc_stack_arraysize < talloc_stacksize + 1) { + tmp = TALLOC_REALLOC_ARRAY(NULL, talloc_stack, TALLOC_CTX *, + talloc_stacksize + 1); + if (tmp == NULL) { + goto fail; + } + talloc_stack = tmp; + talloc_stack_arraysize = talloc_stacksize + 1; + } + + if (talloc_stacksize == 0) { + parent = talloc_stack; + } + else { + parent = talloc_stack[talloc_stacksize-1]; + } + + if (poolsize) { + top = talloc_pool(parent, poolsize); + } else { + top = talloc_new(parent); + } + + if (top == NULL) { + goto fail; + } + + talloc_set_destructor(top, talloc_pop); + + talloc_stack[talloc_stacksize++] = top; + return top; + + fail: + smb_panic("talloc_stackframe failed"); + return NULL; +} + +TALLOC_CTX *talloc_stackframe(void) +{ + return talloc_stackframe_internal(0); +} + +TALLOC_CTX *talloc_stackframe_pool(size_t poolsize) +{ + return talloc_stackframe_internal(poolsize); +} + +/* + * Get us the current top of the talloc stack. + */ + +TALLOC_CTX *talloc_tos(void) +{ + if (talloc_stacksize == 0) { + talloc_stackframe(); + DEBUG(0, ("no talloc stackframe around, leaking memory\n")); + } + + return talloc_stack[talloc_stacksize-1]; +} diff --git a/lib/util/talloc_stack.h b/lib/util/talloc_stack.h new file mode 100644 index 0000000000..bb22b8a029 --- /dev/null +++ b/lib/util/talloc_stack.h @@ -0,0 +1,56 @@ +/* + Unix SMB/CIFS implementation. + Implement a stack of talloc contexts + Copyright (C) Volker Lendecke 2007 + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +*/ + +/* + * Implement a stack of talloc frames. + * + * When a new talloc stackframe is allocated with talloc_stackframe(), then + * the TALLOC_CTX returned with talloc_tos() is reset to that new + * frame. Whenever that stack frame is TALLOC_FREE()'ed, then the reverse + * happens: The previous talloc_tos() is restored. + * + * This API is designed to be robust in the sense that if someone forgets to + * TALLOC_FREE() a stackframe, then the next outer one correctly cleans up and + * resets the talloc_tos(). + * + */ + +#ifndef _TALLOC_STACK_H +#define _TALLOC_STACK_H + +#include "../talloc/talloc.h" + +/* + * Create a new talloc stack frame. + * + * When free'd, it frees all stack frames that were created after this one and + * not explicitly freed. + */ + +TALLOC_CTX *talloc_stackframe(void); +TALLOC_CTX *talloc_stackframe_pool(size_t poolsize); + +/* + * Get us the current top of the talloc stack. + */ + +TALLOC_CTX *talloc_tos(void); + +#endif diff --git a/lib/util/util.h b/lib/util/util.h index fc651d58af..e72df023a9 100644 --- a/lib/util/util.h +++ b/lib/util/util.h @@ -44,6 +44,7 @@ extern const char *panic_action; #include "../lib/util/xfile.h" #include "../lib/util/mutex.h" #include "../lib/util/byteorder.h" +#include "../lib/util/talloc_stack.h" /** * assert macros diff --git a/source3/Makefile.in b/source3/Makefile.in index eee03dbaa8..120b98064e 100644 --- a/source3/Makefile.in +++ b/source3/Makefile.in @@ -320,7 +320,7 @@ UTIL_OBJ = ../lib/util/rbtree.o ../lib/util/signal.o ../lib/util/time.o \ ../lib/util/xfile.o ../lib/util/util_strlist.o \ ../lib/util/util_file.o ../lib/util/data_blob.o \ ../lib/util/util.o ../lib/util/fsusage.o \ - ../lib/util/params.o + ../lib/util/params.o ../lib/util/talloc_stack.o CRYPTO_OBJ = ../lib/crypto/crc32.o ../lib/crypto/md5.o \ ../lib/crypto/hmacmd5.o ../lib/crypto/arcfour.o \ @@ -328,7 +328,7 @@ CRYPTO_OBJ = ../lib/crypto/crc32.o ../lib/crypto/md5.o \ LIB_OBJ = $(LIBSAMBAUTIL_OBJ) $(UTIL_OBJ) $(CRYPTO_OBJ) \ lib/messages.o librpc/gen_ndr/ndr_messaging.o lib/messages_local.o \ - lib/messages_ctdbd.o lib/packet.o lib/ctdbd_conn.o lib/talloc_stack.o \ + lib/messages_ctdbd.o lib/packet.o lib/ctdbd_conn.o \ lib/interfaces.o lib/memcache.o \ lib/util_transfer_file.o lib/async_req.o \ lib/async_sock.o \ diff --git a/source3/include/includes.h b/source3/include/includes.h index 6b25982ff7..035d46fe0a 100644 --- a/source3/include/includes.h +++ b/source3/include/includes.h @@ -654,7 +654,7 @@ struct smb_iconv_convenience *lp_iconv_convenience(void *lp_ctx); #include "dbwrap.h" #include "packet.h" #include "ctdbd_conn.h" -#include "talloc_stack.h" +#include "../lib/util/talloc_stack.h" #include "memcache.h" #include "async_req.h" #include "async_smb.h" diff --git a/source3/include/talloc_stack.h b/source3/include/talloc_stack.h deleted file mode 100644 index bb22b8a029..0000000000 --- a/source3/include/talloc_stack.h +++ /dev/null @@ -1,56 +0,0 @@ -/* - Unix SMB/CIFS implementation. - Implement a stack of talloc contexts - Copyright (C) Volker Lendecke 2007 - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. -*/ - -/* - * Implement a stack of talloc frames. - * - * When a new talloc stackframe is allocated with talloc_stackframe(), then - * the TALLOC_CTX returned with talloc_tos() is reset to that new - * frame. Whenever that stack frame is TALLOC_FREE()'ed, then the reverse - * happens: The previous talloc_tos() is restored. - * - * This API is designed to be robust in the sense that if someone forgets to - * TALLOC_FREE() a stackframe, then the next outer one correctly cleans up and - * resets the talloc_tos(). - * - */ - -#ifndef _TALLOC_STACK_H -#define _TALLOC_STACK_H - -#include "../talloc/talloc.h" - -/* - * Create a new talloc stack frame. - * - * When free'd, it frees all stack frames that were created after this one and - * not explicitly freed. - */ - -TALLOC_CTX *talloc_stackframe(void); -TALLOC_CTX *talloc_stackframe_pool(size_t poolsize); - -/* - * Get us the current top of the talloc stack. - */ - -TALLOC_CTX *talloc_tos(void); - -#endif diff --git a/source3/lib/talloc_stack.c b/source3/lib/talloc_stack.c deleted file mode 100644 index 2722fb9676..0000000000 --- a/source3/lib/talloc_stack.c +++ /dev/null @@ -1,130 +0,0 @@ -/* - Unix SMB/CIFS implementation. - Implement a stack of talloc contexts - Copyright (C) Volker Lendecke 2007 - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. -*/ - -/* - * Implement a stack of talloc frames. - * - * When a new talloc stackframe is allocated with talloc_stackframe(), then - * the TALLOC_CTX returned with talloc_tos() is reset to that new - * frame. Whenever that stack frame is TALLOC_FREE()'ed, then the reverse - * happens: The previous talloc_tos() is restored. - * - * This API is designed to be robust in the sense that if someone forgets to - * TALLOC_FREE() a stackframe, then the next outer one correctly cleans up and - * resets the talloc_tos(). - * - * This robustness feature means that we can't rely on a linked list with - * talloc destructors because in a hierarchy of talloc destructors the parent - * destructor is called before its children destructors. The child destructor - * called after the parent would set the talloc_tos() to the wrong value. - */ - -#include "includes.h" - -static int talloc_stacksize; -static int talloc_stack_arraysize; -static TALLOC_CTX **talloc_stack; - -static int talloc_pop(TALLOC_CTX *frame) -{ - int i; - - for (i=talloc_stacksize-1; i>0; i--) { - if (frame == talloc_stack[i]) { - break; - } - talloc_free(talloc_stack[i]); - } - - talloc_stacksize = i; - return 0; -} - -/* - * Create a new talloc stack frame. - * - * When free'd, it frees all stack frames that were created after this one and - * not explicitly freed. - */ - -static TALLOC_CTX *talloc_stackframe_internal(size_t poolsize) -{ - TALLOC_CTX **tmp, *top, *parent; - - if (talloc_stack_arraysize < talloc_stacksize + 1) { - tmp = TALLOC_REALLOC_ARRAY(NULL, talloc_stack, TALLOC_CTX *, - talloc_stacksize + 1); - if (tmp == NULL) { - goto fail; - } - talloc_stack = tmp; - talloc_stack_arraysize = talloc_stacksize + 1; - } - - if (talloc_stacksize == 0) { - parent = talloc_stack; - } - else { - parent = talloc_stack[talloc_stacksize-1]; - } - - if (poolsize) { - top = talloc_pool(parent, poolsize); - } else { - top = talloc_new(parent); - } - - if (top == NULL) { - goto fail; - } - - talloc_set_destructor(top, talloc_pop); - - talloc_stack[talloc_stacksize++] = top; - return top; - - fail: - smb_panic("talloc_stackframe failed"); - return NULL; -} - -TALLOC_CTX *talloc_stackframe(void) -{ - return talloc_stackframe_internal(0); -} - -TALLOC_CTX *talloc_stackframe_pool(size_t poolsize) -{ - return talloc_stackframe_internal(poolsize); -} - -/* - * Get us the current top of the talloc stack. - */ - -TALLOC_CTX *talloc_tos(void) -{ - if (talloc_stacksize == 0) { - talloc_stackframe(); - DEBUG(0, ("no talloc stackframe around, leaking memory\n")); - } - - return talloc_stack[talloc_stacksize-1]; -} -- cgit