From 714d90171466c84dfafad771b0b26a87a4b4ebff Mon Sep 17 00:00:00 2001 From: Quincey Koziol Date: Mon, 1 May 2006 21:03:35 -0500 Subject: [svn-r12319] Purpose: Rename feature Description: Rename the "function stack" debugging feature to "call stack", so the H5FS* prefix can be used for free space management code. Platforms tested: Not yet, but soon.. --- src/H5FS.c | 321 ------------------------------------------------------ src/H5FSprivate.h | 43 -------- 2 files changed, 364 deletions(-) delete mode 100644 src/H5FS.c delete mode 100644 src/H5FSprivate.h diff --git a/src/H5FS.c b/src/H5FS.c deleted file mode 100644 index ed7f8b6..0000000 --- a/src/H5FS.c +++ /dev/null @@ -1,321 +0,0 @@ -/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * - * Copyright by the Board of Trustees of the University of Illinois. * - * All rights reserved. * - * * - * This file is part of HDF5. The full HDF5 copyright notice, including * - * terms governing use, modification, and redistribution, is contained in * - * the files COPYING and Copyright.html. COPYING can be found at the root * - * of the source code distribution tree; Copyright.html can be found at the * - * root level of an installed copy of the electronic HDF5 document set and * - * is linked from the top-level documents page. It can also be found at * - * http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have * - * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. * - * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ - -/* - * Purpose: Provides internal function tracing in the form of a stack. - * The FUNC_ENTER() macro adds the function name to the function - * stack whenever a function is entered. - * As the functions return with FUNC_LEAVE, - * entries are removed from the stack. - * - * A function stack has a fixed maximum size. If this size is - * exceeded then the stack will be truncated and only the - * first called functions will have entries on the stack. This is - * expected to be a rare condition. - * - */ - - -#include "H5private.h" /* Generic Functions */ -#include "H5FSprivate.h" /* Function stack */ -#include "H5MMprivate.h" /* Memory management */ - -#ifdef H5_HAVE_FUNCSTACK - -#ifdef H5_HAVE_THREADSAFE -/* - * The per-thread function stack. pthread_once() initializes a special - * key that will be used by all threads to create a stack specific to - * each thread individually. The association of stacks to threads will - * be handled by the pthread library. - * - * In order for this macro to work, H5FS_get_my_stack() must be preceeded - * by "H5FS_t *fstack =". - */ -static H5FS_t *H5FS_get_stack(void); -#define H5FS_get_my_stack() H5FS_get_stack() -#else /* H5_HAVE_THREADSAFE */ -/* - * The function stack. Eventually we'll have some sort of global table so each - * thread has it's own stack. The stacks will be created on demand when the - * thread first calls H5FS_push(). */ -H5FS_t H5FS_stack_g[1]; -#define H5FS_get_my_stack() (H5FS_stack_g+0) -#endif /* H5_HAVE_THREADSAFE */ - - -#ifdef H5_HAVE_THREADSAFE -/*------------------------------------------------------------------------- - * Function: H5FS_get_stack - * - * Purpose: Support function for H5FS_get_my_stack() to initialize and - * acquire per-thread function stack. - * - * Return: Success: function stack (H5FS_t *) - * - * Failure: NULL - * - * Programmer: Quincey Koziol - * February 6, 2003 - * - * Modifications: - * - *------------------------------------------------------------------------- - */ -static H5FS_t * -H5FS_get_stack(void) -{ - H5FS_t *fstack; - - FUNC_ENTER_NOAPI_NOFUNC_NOFS(H5FS_get_stack); - - fstack = pthread_getspecific(H5TS_funcstk_key_g); - if (!fstack) { - /* no associated value with current thread - create one */ - fstack = (H5FS_t *)HDmalloc(sizeof(H5FS_t)); /* Don't use H5MM_malloc() here, it causes infinite recursion */ - HDassert(fstack); - - /* Set the thread-specific info */ - fstack->nused=0; - - /* (It's not necessary to release this in this API, it is - * released by the "key destructor" set up in the H5TS - * routines. See calls to pthread_key_create() in H5TS.c -QAK) - */ - pthread_setspecific(H5TS_funcstk_key_g, (void *)fstack); - } - - FUNC_LEAVE_NOAPI_NOFS(fstack); -} /* end H5FS_get_stack() */ -#endif /* H5_HAVE_THREADSAFE */ - - -/*------------------------------------------------------------------------- - * Function: H5FS_print_stack - * - * Purpose: Prints a function stack. - * - * Return: Non-negative on success/Negative on failure - * - * Programmer: Quincey Koziol - * Thursday, February 6, 2003 - * - * Modifications: - * - *------------------------------------------------------------------------- - */ -herr_t -H5FS_print_stack(const H5FS_t *fstack, FILE *stream) -{ - const int indent = 2; /* Indention level */ - int i; /* Local index ariable */ - - /* Don't push this function on the function stack... :-) */ - FUNC_ENTER_NOAPI_NOFUNC_NOFS(H5FS_print_stack); - - /* Sanity check */ - HDassert(fstack); - - /* Default to outputting information to stderr */ - if (!stream) - stream = stderr; - - HDfprintf (stream, "HDF5-DIAG: Function stack from %s ", H5_lib_vers_info_g); - /* try show the process or thread id in multiple processes cases*/ -#ifdef H5_HAVE_THREADSAFE - HDfprintf (stream, "thread %d.", (int)pthread_self()); -#else /* H5_HAVE_THREADSAFE */ - HDfprintf (stream, "thread 0."); -#endif /* H5_HAVE_THREADSAFE */ - if (fstack && fstack->nused>0) - HDfprintf (stream, " Back trace follows."); - HDfputc ('\n', stream); - - for (i=fstack->nused-1; i>=0; --i) - HDfprintf(stream, "%*s#%03d: Routine: %s\n", indent, "", i, fstack->slot[i]); - - FUNC_LEAVE_NOAPI_NOFS(SUCCEED); -} /* end H5FS_print_stack() */ - - -/*------------------------------------------------------------------------- - * Function: H5FS_print - * - * Purpose: Prints the default function stack in some default way. - * - * Return: Non-negative on success/Negative on failure - * - * Programmer: Quincey Koziol - * Thursday, February 6, 2003 - * - * Modifications: - * - *------------------------------------------------------------------------- - */ -herr_t -H5FS_print(FILE *stream) -{ - H5FS_t *fstack = H5FS_get_my_stack (); /* Get the correct function stack */ - - /* Don't push this function on the function stack... :-) */ - FUNC_ENTER_NOAPI_NOFUNC_NOFS(H5FS_print); - - /* Sanity check */ - assert(fstack); - - H5FS_print_stack(fstack, stream); - - FUNC_LEAVE_NOAPI_NOFS(SUCCEED); -} /* end H5FS_print() */ - - -/*------------------------------------------------------------------------- - * Function: H5FS_push - * - * Purpose: Pushes a new record onto function stack for the current - * thread. - * - * Return: Non-negative on success/Negative on failure - * - * Programmer: Quincey Koziol - * Thursday, February 6, 2003 - * - * Modifications: - * - *------------------------------------------------------------------------- - */ -herr_t -H5FS_push(const char *func_name) -{ - H5FS_t *fstack = H5FS_get_my_stack (); - - /* Don't push this function on the function stack... :-) */ - FUNC_ENTER_NOAPI_NOFUNC_NOFS(H5FS_push); - - /* Sanity check */ - assert (fstack); - assert (func_name); - - /* - * Push the function if there's room. Otherwise just increment count - */ - if (fstack->nusedslot[fstack->nused] = func_name; - fstack->nused++; - - FUNC_LEAVE_NOAPI_NOFS(SUCCEED); -} /* end H5FS_push() */ - - -/*------------------------------------------------------------------------- - * Function: H5FS_pop - * - * Purpose: Pops a record off function stack for the current thread. - * - * Return: Non-negative on success/Negative on failure - * - * Programmer: Quincey Koziol - * Thursday, February 6, 2003 - * - * Modifications: - * - *------------------------------------------------------------------------- - */ -herr_t -H5FS_pop(void) -{ - H5FS_t *fstack = H5FS_get_my_stack (); - - /* Don't push this function on the function stack... :-) */ - FUNC_ENTER_NOAPI_NOFUNC_NOFS(H5FS_pop); - - /* Sanity check */ - assert (fstack); - assert (fstack->nused>0); - - /* Pop the function. */ - fstack->nused--; - - FUNC_LEAVE_NOAPI_NOFS(SUCCEED); -} /* end H5FS_pop() */ - - -/*------------------------------------------------------------------------- - * Function: H5FS_copy_stack - * - * Purpose: Makes a copy of the current stack - * - * Return: Non-negative on success/Negative on failure - * - * Programmer: Quincey Koziol - * Tuesday, August 9, 2005 - * - * Modifications: - * - *------------------------------------------------------------------------- - */ -herr_t -H5FS_copy_stack(H5FS_t *new_stack) -{ - H5FS_t *old_stack = H5FS_get_my_stack (); - unsigned u; /* Local index variable */ - - /* Don't push this function on the function stack... :-) */ - FUNC_ENTER_NOAPI_NOFUNC_NOFS(H5FS_copy_stack); - - /* Sanity check */ - HDassert (old_stack); - - /* Copy old stack to new one, duplicating the strings */ - for(u = 0; u < old_stack->nused; u++) - new_stack->slot[u] = H5MM_strdup(old_stack->slot[u]); - new_stack->nused = old_stack->nused; - - FUNC_LEAVE_NOAPI_NOFS(SUCCEED); -} /* end H5FS_copy_stack() */ - - -/*------------------------------------------------------------------------- - * Function: H5FS_close_stack - * - * Purpose: Closes a copy of a stack - * - * Return: Non-negative on success/Negative on failure - * - * Programmer: Quincey Koziol - * Tuesday, August 9, 2005 - * - * Modifications: - * - *------------------------------------------------------------------------- - */ -herr_t -H5FS_close_stack(H5FS_t *stack) -{ - unsigned u; /* Local index variable */ - - /* Don't push this function on the function stack... :-) */ - FUNC_ENTER_NOAPI_NOFUNC_NOFS(H5FS_close_stack); - - /* Sanity check */ - HDassert (stack); - - /* Free strings on stack */ - for(u = 0; u < stack->nused; u++) - stack->slot[u] = H5MM_xfree((void *)stack->slot[u]); - - FUNC_LEAVE_NOAPI_NOFS(SUCCEED); -} /* end H5FS_close_stack() */ - -#endif /* H5_HAVE_FUNCSTACK */ diff --git a/src/H5FSprivate.h b/src/H5FSprivate.h deleted file mode 100644 index d75bbec..0000000 --- a/src/H5FSprivate.h +++ /dev/null @@ -1,43 +0,0 @@ -/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * - * Copyright by the Board of Trustees of the University of Illinois. * - * All rights reserved. * - * * - * This file is part of HDF5. The full HDF5 copyright notice, including * - * terms governing use, modification, and redistribution, is contained in * - * the files COPYING and Copyright.html. COPYING can be found at the root * - * of the source code distribution tree; Copyright.html can be found at the * - * root level of an installed copy of the electronic HDF5 document set and * - * is linked from the top-level documents page. It can also be found at * - * http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have * - * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. * - * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ - -/* - * Header file for function stacks, etc. - */ -#ifndef _H5FSprivate_H -#define _H5FSprivate_H - -#ifdef NOT_YET -#include "H5FSpublic.h" -#endif /* NOT_YET */ - -/* Private headers needed by this file */ -#include "H5private.h" - -#define H5FS_NSLOTS 32 /*number of slots in an function stack */ - -/* A function stack */ -typedef struct H5FS_t { - unsigned nused; /*num slots currently used in stack */ - const char *slot[H5FS_NSLOTS]; /*array of function records */ -} H5FS_t; - -H5_DLL herr_t H5FS_push (const char *func_name); -H5_DLL herr_t H5FS_pop (void); -H5_DLL herr_t H5FS_print (FILE *stream); -H5_DLL herr_t H5FS_print_stack (const H5FS_t *stack, FILE *stream); -H5_DLL herr_t H5FS_copy_stack (H5FS_t *stack); -H5_DLL herr_t H5FS_close_stack (H5FS_t *stack); - -#endif /* _H5FSprivate_H */ -- cgit v0.12