path: root/dbug/dbug.c

/******************************************************************************
 *									      *
 *				   N O T I C E				      *
 *									      *
 *		      Copyright Abandoned, 1987, Fred Fish		      *
 *									      *
 *									      *
 *	This previously copyrighted work has been placed into the  public     *
 *	domain	by  the  author  and  may be freely used for any purpose,     *
 *	private or commercial.						      *
 *									      *
 *	Because of the number of inquiries I was receiving about the  use     *
 *	of this product in commercially developed works I have decided to     *
 *	simply make it public domain to further its unrestricted use.	I     *
 *	specifically  would  be  most happy to see this material become a     *
 *	part of the standard Unix distributions by AT&T and the  Berkeley     *
 *	Computer  Science  Research Group, and a standard part of the GNU     *
 *	system from the Free Software Foundation.			      *
 *									      *
 *	I would appreciate it, as a courtesy, if this notice is  left  in     *
 *	all copies and derivative works.  Thank you.			      *
 *									      *
 *	The author makes no warranty of any kind  with	respect  to  this     *
 *      product  and  explicitly disclaims any implied warranties of mer-     *
 *	chantability or fitness for any particular purpose.		      *
 *									      *
 ******************************************************************************
 */


/*
 *  FILE
 *
 *	dbug.c	 runtime support routines for dbug package
 *
 *  SCCS
 *
 *	@(#)dbug.c	1.25	7/25/89
 *
 *  DESCRIPTION
 *
 *	These are the runtime support routines for the dbug package.
 *	The dbug package has two main components; the user include
 *	file containing various macro definitions, and the runtime
 *	support routines which are called from the macro expansions.
 *
 *	Externally visible functions in the runtime support module
 *	use the naming convention pattern "_db_xx...xx_", thus
 *	they are unlikely to collide with user defined function names.
 *
 *  AUTHOR(S)
 *
 *	Fred Fish		(base code)
 *	Enhanced Software Technologies, Tempe, AZ
 *	asuvax!mcdphx!estinc!fnf
 *
 *	Binayak Banerjee	(profiling enhancements)
 *	seismo!bpa!sjuvax!bbanerje
 *
 *	Michael Widenius:
 *	DBUG_DUMP	- To dump a block of memory.
 *      PUSH_FLAG "O"   - To be used insted of "o" if we
 *                        want flushing after each write
 *	PUSH_FLAG "A"	- as 'O', but we will append to the out file instead
 *			  of creating a new one.
 *	Check of malloc on entry/exit (option "S")
 */

#ifdef DBUG_OFF
#undef DBUG_OFF
#endif
#include <my_global.h>
#include <m_string.h>
#include <errno.h>
#if defined(MSDOS) || defined(__WIN__)
#include <process.h>
#endif

#ifdef	_DBUG_CONDITION_
#define _DBUG_START_CONDITION_	"d:t"
#else
#define _DBUG_START_CONDITION_	""
#endif

/*
 *	      Manifest constants that should not require any changes.
 */

#define EOS		      '\000'  /* End Of String marker */

/*
 *	      Manifest constants which may be "tuned" if desired.
 */

#define PRINTBUF	      1024    /* Print buffer size */
#define INDENT		      2       /* Indentation per trace level */
#define MAXDEPTH	      200     /* Maximum trace depth default */

/*
 *	The following flags are used to determine which
 *	capabilities the user has enabled with the state
 *	push macro.
 */

#define TRACE_ON	000001	/* Trace enabled */
#define DEBUG_ON	000002	/* Debug enabled */
#define FILE_ON		000004	/* File name print enabled */
#define LINE_ON		000010	/* Line number print enabled */
#define DEPTH_ON	000020	/* Function nest level print enabled */
#define PROCESS_ON	000040	/* Process name print enabled */
#define NUMBER_ON	000100	/* Number each line of output */
#define PROFILE_ON	000200	/* Print out profiling code */
#define PID_ON		000400	/* Identify each line with process id */
#define SANITY_CHECK_ON 001000	/* Check safemalloc on DBUG_ENTER */
#define FLUSH_ON_WRITE	002000	/* Flush on every write */

#define TRACING (stack -> flags & TRACE_ON)
#define DEBUGGING (stack -> flags & DEBUG_ON)
#define PROFILING (stack -> flags & PROFILE_ON)
#define STREQ(a,b) (strcmp(a,b) == 0)

/*
 *	Typedefs to make things more obvious.
 */

#ifndef __WIN__
typedef int BOOLEAN;
#else
#define BOOLEAN BOOL
#endif

/*
 *	Make it easy to change storage classes if necessary.
 */

#define IMPORT extern		/* Names defined externally */
#define EXPORT			/* Allocated here, available globally */
#define AUTO auto		/* Names to be allocated on stack */
#define REGISTER register	/* Names to be placed in registers */

/*
 * The default file for profiling.  Could also add another flag
 * (G?) which allowed the user to specify this.
 *
 * If the automatic variables get allocated on the stack in
 * reverse order from their declarations, then define AUTOS_REVERSE.
 * This is used by the code that keeps track of stack usage.  For
 * forward allocation, the difference in the dbug frame pointers
 * represents stack used by the callee function.  For reverse allocation,
 * the difference represents stack used by the caller function.
 *
 */

#define PROF_FILE	"dbugmon.out"
#define PROF_EFMT	"E\t%ld\t%s\n"
#define PROF_SFMT	"S\t%lx\t%lx\t%s\n"
#define PROF_XFMT	"X\t%ld\t%s\n"

#ifdef M_I386		/* predefined by xenix 386 compiler */
#define AUTOS_REVERSE 1
#endif

/*
 *	Variables which are available externally but should only
 *	be accessed via the macro package facilities.
 */

EXPORT FILE *_db_fp_ = (FILE *) 0;	/* Output stream, default stderr */
EXPORT char *_db_process_ = (char*) "dbug"; /* Pointer to process name; argv[0] */
EXPORT FILE *_db_pfp_ = (FILE *)0;	/* Profile stream, 'dbugmon.out' */
EXPORT BOOLEAN _db_on_ = FALSE;		/* TRUE if debugging currently on */
EXPORT BOOLEAN _db_pon_ = FALSE;	/* TRUE if profile currently on */
EXPORT BOOLEAN _no_db_ = FALSE;		/* TRUE if no debugging at all */

/*
 *	Externally supplied functions.
 */

#ifndef HAVE_PERROR
static void perror ();		/* Fake system/library error print routine */
#endif

IMPORT int _sanity(const char *file,uint line);

/*
 *	The user may specify a list of functions to trace or
 *	debug.	These lists are kept in a linear linked list,
 *	a very simple implementation.
 */

struct link {
    char *str;	      /* Pointer to link's contents */
    struct link *next_link;   /* Pointer to the next link */
};

/*
 *	Debugging states can be pushed or popped off of a
 *	stack which is implemented as a linked list.  Note
 *	that the head of the list is the current state and the
 *	stack is pushed by adding a new state to the head of the
 *	list or popped by removing the first link.
 */

struct state {
  int flags;			/* Current state flags */
  int maxdepth;			/* Current maximum trace depth */
  uint delay;			/* Delay after each output line */
  int sub_level;		/* Sub this from code_state->level */
  FILE *out_file;		/* Current output stream */
  FILE *prof_file;		/* Current profiling stream */
  char name[FN_REFLEN];		/* Name of output file */
  struct link *functions;	/* List of functions */
  struct link *p_functions;	/* List of profiled functions */
  struct link *keywords;	/* List of debug keywords */
  struct link *processes;	/* List of process names */
  struct state *next_state;	/* Next state in the list */
};


/*
 *	Local variables not seen by user.
 */


static my_bool init_done = FALSE; /* Set to TRUE when initialization done */
static struct state *stack=0;

typedef struct st_code_state {
  const char *func;		/* Name of current user function */
  const char *file;		/* Name of current user file */
  char **framep;		/* Pointer to current frame */
  const char *jmpfunc;		/* Remember current function for setjmp */
  const char *jmpfile;		/* Remember current file for setjmp */
  int lineno;			/* Current debugger output line number */
  int level;			/* Current function nesting level */
  int disable_output;		/* Set to it if output is disabled */
  int jmplevel;			/* Remember nesting level at setjmp () */

/*
 *	The following variables are used to hold the state information
 *	between the call to _db_pargs_() and _db_doprnt_(), during
 *	expansion of the DBUG_PRINT macro.  This is the only macro
 *	that currently uses these variables.
 *
 *	These variables are currently used only by _db_pargs_() and
 *	_db_doprnt_().
 */

  uint u_line;			/* User source code line number */
  int  locked;			/* If locked with _db_lock_file */
  const char *u_keyword;	/* Keyword for current macro */
} CODE_STATE;

	/* Parse a debug command string */
static struct link *ListParse(char *ctlp);
	/* Make a fresh copy of a string */
static char *StrDup(const char *str);
	/* Open debug output stream */
static void DBUGOpenFile(const char *name, int append);
#ifndef THREAD
	/* Open profile output stream */
static FILE *OpenProfile(const char *name);
	/* Profile if asked for it */
static BOOLEAN DoProfile(void);
#endif
	/* Return current user time (ms) */
#ifndef THREAD
static unsigned long Clock (void);
#endif
	/* Close debug output stream */
static void CloseFile(FILE *fp);
	/* Push current debug state */
static void PushState(void);
	/* Free memory associated with debug state. */
static void FreeState (struct state *state);
	/* Test for tracing enabled */
static BOOLEAN DoTrace(CODE_STATE *state);
	/* Test to see if file is writable */
#if !(!defined(HAVE_ACCESS) || defined(MSDOS))
static BOOLEAN Writable(char *pathname);
	/* Change file owner and group */
static void ChangeOwner(char *pathname);
	/* Allocate memory for runtime support */
#endif
static char *DbugMalloc(size_t size);
	/* Remove leading pathname components */
static char *BaseName(const char *pathname);
static void DoPrefix(uint line);
static void FreeList(struct link *linkp);
static void Indent(int indent);
static BOOLEAN InList(struct link *linkp,const char *cp);
static void dbug_flush(CODE_STATE *);
static void DbugExit(const char *why);
static int DelayArg(int value);
	/* Supplied in Sys V runtime environ */
	/* Break string into tokens */
static char *static_strtok(char *s1,pchar chr);

/*
 *	Miscellaneous printf format strings.
 */

#define ERR_MISSING_RETURN "%s: missing DBUG_RETURN or DBUG_VOID_RETURN macro in function \"%s\"\n"
#define ERR_OPEN "%s: can't open debug output stream \"%s\": "
#define ERR_CLOSE "%s: can't close debug file: "
#define ERR_ABORT "%s: debugger aborting because %s\n"
#define ERR_CHOWN "%s: can't change owner/group of \"%s\": "

/*
 *	Macros and defines for testing file accessibility under UNIX and MSDOS.
 */

#undef EXISTS
#if !defined(HAVE_ACCESS) || defined(MSDOS)
#define EXISTS(pathname) (FALSE)	/* Assume no existance */
#define Writable(name) (TRUE)
#else
#define EXISTS(pathname)	 (access (pathname, F_OK) == 0)
#define WRITABLE(pathname)	 (access (pathname, W_OK) == 0)
#endif
#ifndef MSDOS
#define ChangeOwner(name)
#endif

/*
 *	Translate some calls among different systems.
 */

#if defined(unix) || defined(xenix) || defined(VMS) || defined(__NetBSD__)
# define Delay(A) sleep((uint) A)
#elif defined(AMIGA)
IMPORT int Delay ();			/* Pause for given number of ticks */
#else
static int Delay(int ticks);
#endif


/*
** Macros to allow dbugging with threads
*/

#ifdef THREAD
#include <my_pthread.h>
pthread_mutex_t THR_LOCK_dbug;

static void init_dbug_state(void)
{
  pthread_mutex_init(&THR_LOCK_dbug,MY_MUTEX_INIT_FAST);
}

static CODE_STATE *code_state(void)
{
  CODE_STATE *state=0;
  struct st_my_thread_var *tmp=my_thread_var;
  if (tmp)
  {
    if (!(state=(CODE_STATE *) tmp->dbug))
    {
      state=(CODE_STATE*) DbugMalloc(sizeof(*state));
      bzero((char*) state,sizeof(*state));
      state->func="?func";
      state->file="?file";
      tmp->dbug=(gptr) state;
    }
  }
  return state;
}

#else /* !THREAD */

#define init_dbug_state()
#define code_state() (&static_code_state)
#define pthread_mutex_lock(A) {}
#define pthread_mutex_unlock(A) {}
static CODE_STATE static_code_state=
{
  "?func", "?file", NULL, NullS, NullS, 0,0,0,0,0,0, NullS
};
#endif


/*
 *  FUNCTION
 *
 *	_db_push_	push current debugger state and set up new one
 *
 *  SYNOPSIS
 *
 *	VOID _db_push_ (control)
 *	char *control;
 *
 *  DESCRIPTION
 *
 *	Given pointer to a debug control string in "control", pushes
 *	the current debug state, parses the control string, and sets
 *	up a new debug state.
 *
 *	The only attribute of the new state inherited from the previous
 *	state is the current function nesting level.  This can be
 *	overridden by using the "r" flag in the control string.
 *
 *	The debug control string is a sequence of colon separated fields
 *	as follows:
 *
 *		<field_1>:<field_2>:...:<field_N>
 *
 *	Each field consists of a mandatory flag character followed by
 *	an optional "," and comma separated list of modifiers:
 *
 *		flag[,modifier,modifier,...,modifier]
 *
 *	The currently recognized flag characters are:
 *
 *		d	Enable output from DBUG_<N> macros for
 *			for the current state.	May be followed
 *			by a list of keywords which selects output
 *			only for the DBUG macros with that keyword.
 *			A null list of keywords implies output for
 *			all macros.
 *
 *		D	Delay after each debugger output line.
 *			The argument is the number of tenths of seconds
 *			to delay, subject to machine capabilities.
 *			I.E.  -#D,20 is delay two seconds.
 *
 *		f	Limit debugging and/or tracing, and profiling to the
 *			list of named functions.  Note that a null list will
 *			disable all functions.	The appropriate "d" or "t"
 *			flags must still be given, this flag only limits their
 *			actions if they are enabled.
 *
 *		F	Identify the source file name for each
 *			line of debug or trace output.
 *
 *		i	Identify the process with the pid for each line of
 *			debug or trace output.
 *
 *		g	Enable profiling.  Create a file called 'dbugmon.out'
 *			containing information that can be used to profile
 *			the program.  May be followed by a list of keywords
 *			that select profiling only for the functions in that
 *			list.  A null list implies that all functions are
 *			considered.
 *
 *		L	Identify the source file line number for
 *			each line of debug or trace output.
 *
 *		n	Print the current function nesting depth for
 *			each line of debug or trace output.
 *
 *		N	Number each line of dbug output.
 *
 *		o	Redirect the debugger output stream to the
 *			specified file.  The default output is stderr.
 *
 *		O	As O but the file is really flushed between each
 *			write. When neaded the file is closed and reopened
 *			between each write.
 *
 *		p	Limit debugger actions to specified processes.
 *			A process must be identified with the
 *			DBUG_PROCESS macro and match one in the list
 *			for debugger actions to occur.
 *
 *		P	Print the current process name for each
 *			line of debug or trace output.
 *
 *		r	When pushing a new state, do not inherit
 *			the previous state's function nesting level.
 *			Useful when the output is to start at the
 *			left margin.
 *
 *		S	Do function _sanity(_file_,_line_) at each
 *			debugged function until _sanity() returns
 *			something that differs from 0.
 *			(Moustly used with safemalloc)
 *
 *		t	Enable function call/exit trace lines.
 *			May be followed by a list (containing only
 *			one modifier) giving a numeric maximum
 *			trace level, beyond which no output will
 *			occur for either debugging or tracing
 *			macros.  The default is a compile time
 *			option.
 *
 *	Some examples of debug control strings which might appear
 *	on a shell command line (the "-#" is typically used to
 *	introduce a control string to an application program) are:
 *
 *		-#d:t
 *		-#d:f,main,subr1:F:L:t,20
 *		-#d,input,output,files:n
 *
 *	For convenience, any leading "-#" is stripped off.
 *
 */

void _db_push_ (const char *control)
{
  reg1 char *scan;
  reg2 struct link *temp;
  CODE_STATE *state;
  char *new_str;

  if (! _db_fp_)
    _db_fp_= stderr;		/* Output stream, default stderr */

  if (*control == '-')
  {
    if (*++control == '#')
      control++;
  }
  if (*control)
    _no_db_=0;			/* We are using dbug after all */

  new_str = StrDup (control);
  PushState ();
  state=code_state();

  scan = static_strtok (new_str, ':');
  for (; scan != NULL; scan = static_strtok ((char *)NULL, ':')) {
    switch (*scan++) {
    case 'd':
      _db_on_ = TRUE;
      stack -> flags |= DEBUG_ON;
      if (*scan++ == ',') {
	stack -> keywords = ListParse (scan);
      }
      break;
    case 'D':
      stack -> delay = 0;
      if (*scan++ == ',') {
	temp = ListParse (scan);
	stack -> delay = DelayArg (atoi (temp -> str));
	FreeList (temp);
      }
      break;
    case 'f':
      if (*scan++ == ',') {
	stack -> functions = ListParse (scan);
      }
      break;
    case 'F':
      stack -> flags |= FILE_ON;
      break;
    case 'i':
      stack -> flags |= PID_ON;
      break;
#ifndef THREAD
    case 'g':
      _db_pon_ = TRUE;
      if (OpenProfile(PROF_FILE))
      {
	stack -> flags |= PROFILE_ON;
	if (*scan++ == ',')
	  stack -> p_functions = ListParse (scan);
      }
      break;
#endif
    case 'L':
      stack -> flags |= LINE_ON;
      break;
    case 'n':
      stack -> flags |= DEPTH_ON;
      break;
    case 'N':
      stack -> flags |= NUMBER_ON;
      break;
    case 'A':
    case 'O':
      stack -> flags |= FLUSH_ON_WRITE;
    case 'a':
    case 'o':
      if (*scan++ == ',') {
	temp = ListParse (scan);
	DBUGOpenFile(temp -> str, (int) (scan[-2] == 'A' || scan[-2] == 'a'));
	FreeList (temp);
      } else {
	DBUGOpenFile ("-",0);
      }
      break;
    case 'p':
      if (*scan++ == ',') {
	stack -> processes = ListParse (scan);
      }
      break;
    case 'P':
      stack -> flags |= PROCESS_ON;
      break;
    case 'r':
      stack->sub_level= state->level;
      break;
    case 't':
      stack -> flags |= TRACE_ON;
      if (*scan++ == ',') {
	temp = ListParse (scan);
	stack -> maxdepth = atoi (temp -> str);
	FreeList (temp);
      }
      break;
    case 'S':
      stack -> flags |= SANITY_CHECK_ON;
      break;
    }
  }
  free (new_str);
}


/*
 *  FUNCTION
 *
 *	_db_pop_    pop the debug stack
 *
 *  DESCRIPTION
 *
 *	Pops the debug stack, returning the debug state to its
 *	condition prior to the most recent _db_push_ invocation.
 *	Note that the pop will fail if it would remove the last
 *	valid state from the stack.  This prevents user errors
 *	in the push/pop sequence from screwing up the debugger.
 *	Maybe there should be some kind of warning printed if the
 *	user tries to pop too many states.
 *
 */

void _db_pop_ ()
{
  reg1 struct state *discard;
  discard = stack;
  if (discard != NULL && discard -> next_state != NULL) {
    stack = discard -> next_state;
    _db_fp_ = stack -> out_file;
    _db_pfp_ = stack -> prof_file;
    FreeState(discard);
    if (!(stack->flags & DEBUG_ON))
      _db_on_=0;
  }
  else
  {
    _db_on_=0;
  }
}


/*
 *  FUNCTION
 *
 *	_db_enter_    process entry point to user function
 *
 *  SYNOPSIS
 *
 *	VOID _db_enter_ (_func_, _file_, _line_,
 *			 _sfunc_, _sfile_, _slevel_, _sframep_)
 *	char *_func_;		points to current function name
 *	char *_file_;		points to current file name
 *	int _line_;		called from source line number
 *	char **_sfunc_;		save previous _func_
 *	char **_sfile_;		save previous _file_
 *	int *_slevel_;		save previous nesting level
 *	char ***_sframep_;	save previous frame pointer
 *
 *  DESCRIPTION
 *
 *	Called at the beginning of each user function to tell
 *	the debugger that a new function has been entered.
 *	Note that the pointers to the previous user function
 *	name and previous user file name are stored on the
 *	caller's stack (this is why the ENTER macro must be
 *	the first "executable" code in a function, since it
 *	allocates these storage locations).  The previous nesting
 *	level is also stored on the callers stack for internal
 *	self consistency checks.
 *
 *	Also prints a trace line if tracing is enabled and
 *	increments the current function nesting depth.
 *
 *	Note that this mechanism allows the debugger to know
 *	what the current user function is at all times, without
 *	maintaining an internal stack for the function names.
 *
 */

void _db_enter_ (
const char *_func_,
const char *_file_,
uint _line_,
const char **_sfunc_,
const char **_sfile_,
uint *_slevel_,
char ***_sframep_ __attribute__((unused)))
{
  reg1 CODE_STATE *state;

  if (!_no_db_)
  {
    int save_errno=errno;
    /*
      Sasha: the test below is so we could call functions with DBUG_ENTER
      before my_thread_init(). I needed this because I suspected corruption
      of a block allocated by my_thread_init() itself, so I wanted to use
      my_malloc()/my_free() in my_thread_init()/my_thread_end()
    */
    if (!(state=code_state()))
      return;
    if (!init_done)
      _db_push_ (_DBUG_START_CONDITION_);

    *_sfunc_ = state->func;
    *_sfile_ = state->file;
    state->func =(char*)  _func_;
    state->file = (char*) _file_;		/* BaseName takes time !! */
    *_slevel_ =  ++state->level;
#ifndef THREAD
    *_sframep_ = state->framep;
    state->framep = (char **) _sframep_;
    if (DoProfile ())
    {
      long stackused;
      if (*state->framep == NULL)
      {
	stackused = 0;
      }
      else
      {
	stackused = ((long)(*state->framep)) - ((long)(state->framep));
	stackused = stackused > 0 ? stackused : -stackused;
      }
      (void) fprintf (_db_pfp_, PROF_EFMT , Clock (), state->func);
#ifdef AUTOS_REVERSE
      (void) fprintf (_db_pfp_, PROF_SFMT, state->framep, stackused, *_sfunc_);
#else
      (void) fprintf (_db_pfp_, PROF_SFMT, (ulong) state->framep, stackused,
		      state->func);
#endif
      (void) fflush (_db_pfp_);
    }
#endif
    if (DoTrace(state))
    {
      if (!state->locked)
	pthread_mutex_lock(&THR_LOCK_dbug);
      DoPrefix (_line_);
      Indent (state -> level);
      (void) fprintf (_db_fp_, ">%s\n", state->func);
      dbug_flush (state);			/* This does a unlock */
    }
#ifdef SAFEMALLOC
    if (stack->flags & SANITY_CHECK_ON && !state->disable_output)
      if (_sanity(_file_,_line_))		/* Check of safemalloc */
	stack -> flags &= ~SANITY_CHECK_ON;
#endif
    errno=save_errno;
  }
}

/*
 *  FUNCTION
 *
 *	_db_return_    process exit from user function
 *
 *  SYNOPSIS
 *
 *	VOID _db_return_ (_line_, _sfunc_, _sfile_, _slevel_)
 *	int _line_;		current source line number
 *	char **_sfunc_;		where previous _func_ is to be retrieved
 *	char **_sfile_;		where previous _file_ is to be retrieved
 *	int *_slevel_;		where previous level was stashed
 *
 *  DESCRIPTION
 *
 *	Called just before user function executes an explicit or implicit
 *	return.  Prints a trace line if trace is enabled, decrements
 *	the current nesting level, and restores the current function and
 *	file names from the defunct function's stack.
 *
 */

void _db_return_ (
uint _line_,
const char **_sfunc_,
const char **_sfile_,
uint *_slevel_)
{
  CODE_STATE *state;

  if (!_no_db_)
  {
    int save_errno=errno;
    if (!(state=code_state()))
      return;				
    if (!init_done)
      _db_push_ ("");
    if (stack->flags & (TRACE_ON | DEBUG_ON | PROFILE_ON))
    {
      if (!state->locked)
	pthread_mutex_lock(&THR_LOCK_dbug);
      if (state->level != (int) *_slevel_)
	(void) fprintf (_db_fp_, ERR_MISSING_RETURN, _db_process_,
			state->func);
      else
      {
#ifdef SAFEMALLOC
	if (stack->flags & SANITY_CHECK_ON && !state->disable_output)
        {
	  if (_sanity(*_sfile_,_line_))
	    stack->flags &= ~SANITY_CHECK_ON;
        }
#endif
#ifndef THREAD
	if (DoProfile ())
	  (void) fprintf (_db_pfp_, PROF_XFMT, Clock(), state->func);
#endif
	if (DoTrace (state))
	{
	  DoPrefix (_line_);
	  Indent (state->level);
	  (void) fprintf (_db_fp_, "<%s\n", state->func);
	}
      }
      dbug_flush(state);
    }
    state->level = *_slevel_-1;
    state->func = *_sfunc_;
    state->file = *_sfile_;
#ifndef THREAD
    if (state->framep != NULL)
      state->framep = (char **) *state->framep;
#endif
    errno=save_errno;
  }
}


/*
 *  FUNCTION
 *
 *	_db_pargs_    log arguments for subsequent use by _db_doprnt_()
 *
 *  SYNOPSIS
 *
 *	VOID _db_pargs_ (_line_, keyword)
 *	int _line_;
 *	char *keyword;
 *
 *  DESCRIPTION
 *
 *	The new universal printing macro DBUG_PRINT, which replaces
 *	all forms of the DBUG_N macros, needs two calls to runtime
 *	support routines.  The first, this function, remembers arguments
 *	that are used by the subsequent call to _db_doprnt_().
 *
 */

void _db_pargs_ (
uint _line_,
const char *keyword)
{
  CODE_STATE *state=code_state();
  /* Sasha: pre-my_thread_init() safety */
  if (!state)
    return;
  state->u_line = _line_;
  state->u_keyword = (char*) keyword;
}


/*
 *  FUNCTION
 *
 *	_db_doprnt_    handle print of debug lines
 *
 *  SYNOPSIS
 *
 *	VOID _db_doprnt_ (format, va_alist)
 *	char *format;
 *	va_dcl;
 *
 *  DESCRIPTION
 *
 *	When invoked via one of the DBUG macros, tests the current keyword
 *	set by calling _db_pargs_() to see if that macro has been selected
 *	for processing via the debugger control string, and if so, handles
 *	printing of the arguments via the format string.  The line number
 *	of the DBUG macro in the source is found in u_line.
 *
 *	Note that the format string SHOULD NOT include a terminating
 *	newline, this is supplied automatically.
 *
 */

#include <stdarg.h>

void _db_doprnt_ (const char *format,...)
{
  va_list args;
  CODE_STATE *state;
  /* Sasha: pre-my_thread_init() safety */
  if (!(state=code_state()))
    return;

  va_start(args,format);

  if (_db_keyword_ (state->u_keyword)) {
    int save_errno=errno;
    if (!state->locked)
      pthread_mutex_lock(&THR_LOCK_dbug);
    DoPrefix (state->u_line);
    if (TRACING) {
      Indent (state->level + 1);
    } else {
      (void) fprintf (_db_fp_, "%s: ", state->func);
    }
    (void) fprintf (_db_fp_, "%s: ", state->u_keyword);
    (void) vfprintf (_db_fp_, format, args);
    (void) fputc('\n',_db_fp_);
    dbug_flush(state);
    errno=save_errno;
  }
  va_end(args);
}


/*
 *  FUNCTION
 *
 *            _db_dump_    dump a string in hex
 *
 *  SYNOPSIS
 *
 *	      void _db_dump_ (_line_,keyword,memory,length)
 *	      int _line_;		current source line number
 *	      char *keyword;
 *	      char *memory;		Memory to print
 *	      int length;		Bytes to print
 *
 *  DESCRIPTION
 *  Dump N characters in a binary array.
 *  Is used to examine corrputed memory or arrays.
 */

void _db_dump_(
uint _line_,
const char *keyword,
const char *memory,
uint length)
{
  int pos;
  char dbuff[90];
  CODE_STATE *state;
  if (!(state=code_state()))
    return;

  if (_db_keyword_ ((char*) keyword))
  {
    if (!state->locked)
      pthread_mutex_lock(&THR_LOCK_dbug);
    DoPrefix (_line_);
    if (TRACING)
    {
      Indent (state->level + 1);
      pos= min(max(state->level-stack->sub_level,0)*INDENT,80);
    }
    else
    {
      fprintf(_db_fp_, "%s: ", state->func);
    }
    sprintf(dbuff,"%s: Memory: 0x%lx  Bytes: (%d)\n",
	    keyword,(ulong) memory, length);
    (void) fputs(dbuff,_db_fp_);

    pos=0;
    while (length-- > 0)
    {
      uint tmp= *((unsigned char*) memory++);
      if ((pos+=3) >= 80)
      {
	fputc('\n',_db_fp_);
	pos=3;
      }
      fputc(_dig_vec_upper[((tmp >> 4) & 15)], _db_fp_);
      fputc(_dig_vec_upper[tmp & 15], _db_fp_);
      fputc(' ',_db_fp_);
    }
    (void) fputc('\n',_db_fp_);
    dbug_flush(state);
  }
}


/*
  Enable/Disable output for this thread

  SYNOPSIS
    _db_output_()
    flag		1 = enable output, 0 = disable_output

*/

void _db_output_(uint flag)
{
  CODE_STATE *state;
  if (!(state=code_state()))
    return;
  state->disable_output= !flag;
}


/*
 *  FUNCTION
 *
 *	ListParse    parse list of modifiers in debug control string
 *
 *  SYNOPSIS
 *
 *	static struct link *ListParse (ctlp)
 *	char *ctlp;
 *
 *  DESCRIPTION
 *
 *	Given pointer to a comma separated list of strings in "cltp",
 *	parses the list, building a list and returning a pointer to it.
 *	The original comma separated list is destroyed in the process of
 *	building the linked list, thus it had better be a duplicate
 *	if it is important.
 *
 *	Note that since each link is added at the head of the list,
 *	the final list will be in "reverse order", which is not
 *	significant for our usage here.
 *
 */

static struct link *ListParse (
char *ctlp)
{
  REGISTER char *start;
  REGISTER struct link *new_malloc;
  REGISTER struct link *head;

  head = NULL;
  while (*ctlp != EOS) {
    start = ctlp;
    while (*ctlp != EOS && *ctlp != ',') {
      ctlp++;
    }
    if (*ctlp == ',') {
      *ctlp++ = EOS;
    }
    new_malloc = (struct link *) DbugMalloc (sizeof (struct link));
    new_malloc -> str = StrDup (start);
    new_malloc -> next_link = head;
    head = new_malloc;
  }
  return (head);
}

/*
 *  FUNCTION
 *
 *	InList	  test a given string for member of a given list
 *
 *  SYNOPSIS
 *
 *	static BOOLEAN InList (linkp, cp)
 *	struct link *linkp;
 *	char *cp;
 *
 *  DESCRIPTION
 *
 *	Tests the string pointed to by "cp" to determine if it is in
 *	the list pointed to by "linkp".  Linkp points to the first
 *	link in the list.  If linkp is NULL then the string is treated
 *	as if it is in the list (I.E all strings are in the null list).
 *	This may seem rather strange at first but leads to the desired
 *	operation if no list is given.	The net effect is that all
 *	strings will be accepted when there is no list, and when there
 *	is a list, only those strings in the list will be accepted.
 *
 */

static BOOLEAN InList (
struct link *linkp,
const char *cp)
{
  REGISTER struct link *scan;
  REGISTER BOOLEAN result;

  if (linkp == NULL) {
    result = TRUE;
  } else {
    result = FALSE;
    for (scan = linkp; scan != NULL; scan = scan -> next_link) {
      if (STREQ (scan -> str, cp)) {
	result = TRUE;
	break;
      }
    }
  }
  return (result);
}


/*
 *  FUNCTION
 *
 *	PushState    push current state onto stack and set up new one
 *
 *  SYNOPSIS
 *
 *	static VOID PushState ()
 *
 *  DESCRIPTION
 *
 *	Pushes the current state on the state stack, and initializes
 *	a new state.  The only parameter inherited from the previous
 *	state is the function nesting level.  This action can be
 *	inhibited if desired, via the "r" flag.
 *
 *	The state stack is a linked list of states, with the new
 *	state added at the head.  This allows the stack to grow
 *	to the limits of memory if necessary.
 *
 */

static void PushState ()
{
  REGISTER struct state *new_malloc;

  if (!init_done)
  {
    init_dbug_state();
    init_done=TRUE;
  }
  (void) code_state();				/* Alloc memory */
  new_malloc = (struct state *) DbugMalloc(sizeof (struct state));
  new_malloc -> flags = 0;
  new_malloc -> delay = 0;
  new_malloc -> maxdepth = MAXDEPTH;
  new_malloc -> sub_level=0;
  new_malloc -> out_file = stderr;
  new_malloc -> prof_file = (FILE*) 0;
  new_malloc -> functions = NULL;
  new_malloc -> p_functions = NULL;
  new_malloc -> keywords = NULL;
  new_malloc -> processes = NULL;
  new_malloc -> next_state = stack;
  stack=new_malloc;
}

/*
 *  FUNCTION
 *
 *	FreeState    Free memory associated with a struct state.
 *
 *  SYNOPSIS
 *
 *	static void FreeState (state)
 *	struct state *state;
 *
 *  DESCRIPTION
 *
 *	Deallocates the memory allocated for various information in a
 *	state.
 *
 */
static void FreeState (
struct state *state)
{
  if (state -> keywords != NULL) {
    FreeList (state -> keywords);
  }
  if (state -> functions != NULL) {
    FreeList (state -> functions);
  }
  if (state -> processes != NULL) {
    FreeList (state -> processes);
  }
  if (state -> p_functions != NULL) {
    FreeList (state -> p_functions);
  }
  CloseFile (state -> out_file);
  if (state -> prof_file)
    CloseFile (state -> prof_file);
  free ((char *) state);
}


/*
 *  FUNCTION
 *
 *	_db_end_    End debugging, freeing state stack memory.
 *
 *  SYNOPSIS
 *
 *	static VOID _db_end_ ()
 *
 *  DESCRIPTION
 *
 *	Ends debugging, de-allocating the memory allocated to the
 *	state stack.
 *
 *	To be called at the very end of the program.
 *
 */
void _db_end_ ()
{
  reg1 struct state *discard;
  while((discard= stack) != NULL) {
    stack= discard -> next_state;
    FreeState (discard);
  }
  _db_on_=0;
}


/*
 *  FUNCTION
 *
 *	DoTrace    check to see if tracing is current enabled
 *
 *  SYNOPSIS
 *
 *	static BOOLEAN DoTrace (stack)
 *
 *  DESCRIPTION
 *
 *	Checks to see if tracing is enabled based on whether the
 *	user has specified tracing, the maximum trace depth has
 *	not yet been reached, the current function is selected,
 *	and the current process is selected.  Returns TRUE if
 *	tracing is enabled, FALSE otherwise.
 *
 */

static BOOLEAN DoTrace (CODE_STATE *state)
{
  reg2 BOOLEAN trace=FALSE;

  if (TRACING && !state->disable_output &&
      state->level <= stack -> maxdepth &&
      InList (stack -> functions, state->func) &&
      InList (stack -> processes, _db_process_))
      trace = TRUE;
  return (trace);
}


/*
 *  FUNCTION
 *
 *	DoProfile    check to see if profiling is current enabled
 *
 *  SYNOPSIS
 *
 *	static BOOLEAN DoProfile ()
 *
 *  DESCRIPTION
 *
 *	Checks to see if profiling is enabled based on whether the
 *	user has specified profiling, the maximum trace depth has
 *	not yet been reached, the current function is selected,
 *	and the current process is selected.  Returns TRUE if
 *	profiling is enabled, FALSE otherwise.
 *
 */

#ifndef THREAD
static BOOLEAN DoProfile ()
{
  REGISTER BOOLEAN profile;
  CODE_STATE *state;
  state=code_state();

  profile = FALSE;
  if (PROFILING && !state->disable_output &&
      state->level <= stack -> maxdepth &&
      InList (stack -> p_functions, state->func) &&
      InList (stack -> processes, _db_process_))
    profile = TRUE;
  return (profile);
}
#endif

/*
 *  FUNCTION
 *
 *      _db_strict_keyword_     test keyword for member of keyword list
 *
 *  SYNOPSIS
 *
 *      BOOLEAN _db_strict_keyword_ (keyword)
 *      char *keyword;
 *
 *  DESCRIPTION
 *
 *      Similar to _db_keyword_, but keyword is NOT accepted if keyword list
 *      is empty. Used in DBUG_EXECUTE_IF() - for actions that must not be
 *      executed by default.
 *
 *      Returns TRUE if keyword accepted, FALSE otherwise.
 *
 */

BOOLEAN _db_strict_keyword_ (
const char *keyword)
{
  if (stack -> keywords == NULL)
    return FALSE;
  return _db_keyword_ (keyword);
}

/*
 *  FUNCTION
 *
 *	_db_keyword_	test keyword for member of keyword list
 *
 *  SYNOPSIS
 *
 *	BOOLEAN _db_keyword_ (keyword)
 *	char *keyword;
 *
 *  DESCRIPTION
 *
 *	Test a keyword to determine if it is in the currently active
 *	keyword list.  As with the function list, a keyword is accepted
 *	if the list is null, otherwise it must match one of the list
 *	members.  When debugging is not on, no keywords are accepted.
 *	After the maximum trace level is exceeded, no keywords are
 *	accepted (this behavior subject to change).  Additionally,
 *	the current function and process must be accepted based on
 *	their respective lists.
 *
 *	Returns TRUE if keyword accepted, FALSE otherwise.
 *
 */

BOOLEAN _db_keyword_ (
const char *keyword)
{
  REGISTER BOOLEAN result;
  CODE_STATE *state;

  if (!init_done)
    _db_push_ ("");
  /* Sasha: pre-my_thread_init() safety */
  if (!(state=code_state()))
    return FALSE;
  result = FALSE;
  if (DEBUGGING && !state->disable_output &&
      state->level <= stack -> maxdepth &&
      InList (stack -> functions, state->func) &&
      InList (stack -> keywords, keyword) &&
      InList (stack -> processes, _db_process_))
    result = TRUE;
  return (result);
}

/*
 *  FUNCTION
 *
 *	Indent	  indent a line to the given indentation level
 *
 *  SYNOPSIS
 *
 *	static VOID Indent (indent)
 *	int indent;
 *
 *  DESCRIPTION
 *
 *	Indent a line to the given level.  Note that this is
 *	a simple minded but portable implementation.
 *	There are better ways.
 *
 *	Also, the indent must be scaled by the compile time option
 *	of character positions per nesting level.
 *
 */

static void Indent (
int indent)
{
  REGISTER int count;

  indent= max(indent-1-stack->sub_level,0)*INDENT;
  for (count = 0; count < indent ; count++)
  {
    if ((count % INDENT) == 0)
      fputc('|',_db_fp_);
    else
      fputc(' ',_db_fp_);
  }
}


/*
 *  FUNCTION
 *
 *	FreeList    free all memory associated with a linked list
 *
 *  SYNOPSIS
 *
 *	static VOID FreeList (linkp)
 *	struct link *linkp;
 *
 *  DESCRIPTION
 *
 *	Given pointer to the head of a linked list, frees all
 *	memory held by the list and the members of the list.
 *
 */

static void FreeList (
struct link *linkp)
{
  REGISTER struct link *old;

  while (linkp != NULL) {
    old = linkp;
    linkp = linkp -> next_link;
    if (old -> str != NULL) {
      free (old -> str);
    }
    free ((char *) old);
  }
}


/*
 *  FUNCTION
 *
 *	StrDup	 make a duplicate of a string in new memory
 *
 *  SYNOPSIS
 *
 *	static char *StrDup (my_string)
 *	char *string;
 *
 *  DESCRIPTION
 *
 *	Given pointer to a string, allocates sufficient memory to make
 *	a duplicate copy, and copies the string to the newly allocated
 *	memory.  Failure to allocated sufficient memory is immediately
 *	fatal.
 *
 */


static char *StrDup (const char *str)
{
    reg1 char *new_malloc;
    new_malloc = DbugMalloc((size_t) strlen (str) + 1);
    (void) strcpy (new_malloc, str);
    return (new_malloc);
}


/*
 *  FUNCTION
 *
 *	DoPrefix    print debugger line prefix prior to indentation
 *
 *  SYNOPSIS
 *
 *	static VOID DoPrefix (_line_)
 *	int _line_;
 *
 *  DESCRIPTION
 *
 *	Print prefix common to all debugger output lines, prior to
 *	doing indentation if necessary.  Print such information as
 *	current process name, current source file name and line number,
 *	and current function nesting depth.
 *
 */

static void DoPrefix (
uint _line_)
{
  CODE_STATE *state;
  state=code_state();

  state->lineno++;
  if (stack -> flags & PID_ON) {
#ifdef THREAD
    (void) fprintf (_db_fp_, "%-7s: ", my_thread_name());
#else
    (void) fprintf (_db_fp_, "%5d: ", (int) getpid ());
#endif
  }
  if (stack -> flags & NUMBER_ON) {
    (void) fprintf (_db_fp_, "%5d: ", state->lineno);
  }
  if (stack -> flags & PROCESS_ON) {
    (void) fprintf (_db_fp_, "%s: ", _db_process_);
  }
  if (stack -> flags & FILE_ON) {
    (void) fprintf (_db_fp_, "%14s: ", BaseName(state->file));
  }
  if (stack -> flags & LINE_ON) {
    (void) fprintf (_db_fp_, "%5d: ", _line_);
  }
  if (stack -> flags & DEPTH_ON) {
    (void) fprintf (_db_fp_, "%4d: ", state->level);
  }
}


/*
 *  FUNCTION
 *
 *	DBUGOpenFile	open new output stream for debugger output
 *
 *  SYNOPSIS
 *
 *	static VOID DBUGOpenFile (name)
 *	char *name;
 *
 *  DESCRIPTION
 *
 *	Given name of a new file (or "-" for stdout) opens the file
 *	and sets the output stream to the new file.
 *
 */

static void DBUGOpenFile (const char *name,int append)
{
  REGISTER FILE *fp;
  REGISTER BOOLEAN newfile;

  if (name != NULL)
  {
    strmov(stack->name,name);
    if (strcmp (name, "-") == 0)
    {
      _db_fp_ = stdout;
      stack -> out_file = _db_fp_;
      stack -> flags |= FLUSH_ON_WRITE;
    }
    else
    {
      if (!Writable((char*)name))
      {
	(void) fprintf (stderr, ERR_OPEN, _db_process_, name);
	perror ("");
	fflush(stderr);
      }
      else
      {
	newfile= !EXISTS (name);
	if (!(fp = fopen(name, append ? "a+" : "w")))
	{
	  (void) fprintf (stderr, ERR_OPEN, _db_process_, name);
	  perror ("");
	  fflush(stderr);
	}
	else
	{
	  _db_fp_ = fp;
	  stack -> out_file = fp;
	  if (newfile) {
	    ChangeOwner (name);
	  }
	}
      }
    }
  }
}


/*
 *  FUNCTION
 *
 *	OpenProfile    open new output stream for profiler output
 *
 *  SYNOPSIS
 *
 *	static FILE *OpenProfile (name)
 *	char *name;
 *
 *  DESCRIPTION
 *
 *	Given name of a new file, opens the file
 *	and sets the profiler output stream to the new file.
 *
 *	It is currently unclear whether the prefered behavior is
 *	to truncate any existing file, or simply append to it.
 *	The latter behavior would be desirable for collecting
 *	accumulated runtime history over a number of separate
 *	runs.  It might take some changes to the analyzer program
 *	though, and the notes that Binayak sent with the profiling
 *	diffs indicated that append was the normal mode, but this
 *	does not appear to agree with the actual code. I haven't
 *	investigated at this time [fnf; 24-Jul-87].
 */

#ifndef THREAD
static FILE *OpenProfile (const char *name)
{
  REGISTER FILE *fp;
  REGISTER BOOLEAN newfile;

  fp=0;
  if (!Writable (name))
  {
    (void) fprintf (_db_fp_, ERR_OPEN, _db_process_, name);
    perror ("");
    dbug_flush(0);
    (void) Delay (stack -> delay);
  }
  else
  {
    newfile= !EXISTS (name);
    if (!(fp = fopen (name, "w")))
    {
      (void) fprintf (_db_fp_, ERR_OPEN, _db_process_, name);
      perror ("");
      dbug_flush(0);
    }
    else
    {
      _db_pfp_ = fp;
      stack -> prof_file = fp;
      if (newfile)
      {
	ChangeOwner (name);
      }
    }
  }
  return fp;
}
#endif

/*
 *  FUNCTION
 *
 *	CloseFile    close the debug output stream
 *
 *  SYNOPSIS
 *
 *	static VOID CloseFile (fp)
 *	FILE *fp;
 *
 *  DESCRIPTION
 *
 *	Closes the debug output stream unless it is standard output
 *	or standard error.
 *
 */

static void CloseFile (
FILE *fp)
{
  if (fp != stderr && fp != stdout) {
    if (fclose (fp) == EOF) {
      pthread_mutex_lock(&THR_LOCK_dbug);
      (void) fprintf (_db_fp_, ERR_CLOSE, _db_process_);
      perror ("");
      dbug_flush(0);
    }
  }
}


/*
 *  FUNCTION
 *
 *	DbugExit    print error message and exit
 *
 *  SYNOPSIS
 *
 *	static VOID DbugExit (why)
 *	char *why;
 *
 *  DESCRIPTION
 *
 *	Prints error message using current process name, the reason for
 *	aborting (typically out of memory), and exits with status 1.
 *	This should probably be changed to use a status code
 *	defined in the user's debugger include file.
 *
 */

static void DbugExit (const char *why)
{
  (void) fprintf (stderr, ERR_ABORT, _db_process_, why);
  (void) fflush (stderr);
  exit (1);
}


/*
 *  FUNCTION
 *
 *	DbugMalloc    allocate memory for debugger runtime support
 *
 *  SYNOPSIS
 *
 *	static long *DbugMalloc (size)
 *	int size;
 *
 *  DESCRIPTION
 *
 *	Allocate more memory for debugger runtime support functions.
 *	Failure to to allocate the requested number of bytes is
 *	immediately fatal to the current process.  This may be
 *	rather unfriendly behavior.  It might be better to simply
 *	print a warning message, freeze the current debugger state,
 *	and continue execution.
 *
 */

static char *DbugMalloc (size_t size)
{
  register char *new_malloc;

  if (!(new_malloc = (char*) malloc((size_t) size)))
    DbugExit ("out of memory");
  return (new_malloc);
}


/*
 *		As strtok but two separators in a row are changed to one
 *		separator (to allow directory-paths in dos).
 */

static char *static_strtok (char *s1, pchar separator)
{
  static char *end = NULL;
  reg1 char *rtnval,*cpy;

  rtnval = NULL;
  if (s1 != NULL)
    end = s1;
  if (end != NULL && *end != EOS)
  {
    rtnval=cpy=end;
    do
    {
      if ((*cpy++ = *end++) == separator)
      {
	if (*end != separator)
	{
	  cpy--;		/* Point at separator */
	  break;
	}
	end++;			/* Two separators in a row, skip one */
      }
    } while (*end != EOS);
    *cpy=EOS;			/* Replace last separator */
  }
  return (rtnval);
}


/*
 *  FUNCTION
 *
 *	BaseName    strip leading pathname components from name
 *
 *  SYNOPSIS
 *
 *	static char *BaseName (pathname)
 *	char *pathname;
 *
 *  DESCRIPTION
 *
 *	Given pointer to a complete pathname, locates the base file
 *	name at the end of the pathname and returns a pointer to
 *	it.
 *
 */

static char *BaseName (const char *pathname)
{
  register const char *base;

  base = strrchr (pathname, FN_LIBCHAR);
  if (base++ == NullS)
    base = pathname;
  return ((char*) base);
}


/*
 *  FUNCTION
 *
 *	Writable    test to see if a pathname is writable/creatable
 *
 *  SYNOPSIS
 *
 *	static BOOLEAN Writable (pathname)
 *	char *pathname;
 *
 *  DESCRIPTION
 *
 *	Because the debugger might be linked in with a program that
 *	runs with the set-uid-bit (suid) set, we have to be careful
 *	about opening a user named file for debug output.  This consists
 *	of checking the file for write access with the real user id,
 *	or checking the directory where the file will be created.
 *
 *	Returns TRUE if the user would normally be allowed write or
 *	create access to the named file.  Returns FALSE otherwise.
 *
 */


#ifndef Writable

static BOOLEAN Writable (
char *pathname)
{
  REGISTER BOOLEAN granted;
  REGISTER char *lastslash;

  granted = FALSE;
  if (EXISTS (pathname)) {
    if (WRITABLE (pathname)) {
      granted = TRUE;
    }
  } else {
    lastslash = strrchr (pathname, '/');
    if (lastslash != NULL) {
      *lastslash = EOS;
    } else {
      pathname = ".";
    }
    if (WRITABLE (pathname)) {
      granted = TRUE;
    }
    if (lastslash != NULL) {
      *lastslash = '/';
    }
  }
  return (granted);
}
#endif


/*
 *  FUNCTION
 *
 *	ChangeOwner    change owner to real user for suid programs
 *
 *  SYNOPSIS
 *
 *	static VOID ChangeOwner (pathname)
 *
 *  DESCRIPTION
 *
 *	For unix systems, change the owner of the newly created debug
 *	file to the real owner.  This is strictly for the benefit of
 *	programs that are running with the set-user-id bit set.
 *
 *	Note that at this point, the fact that pathname represents
 *	a newly created file has already been established.  If the
 *	program that the debugger is linked to is not running with
 *	the suid bit set, then this operation is redundant (but
 *	harmless).
 *
 */

#ifndef ChangeOwner
static void ChangeOwner (
char *pathname)
{
  if (chown (pathname, getuid (), getgid ()) == -1)
  {
    (void) fprintf (stderr, ERR_CHOWN, _db_process_, pathname);
    perror ("");
    (void) fflush (stderr);
  }
}
#endif


/*
 *  FUNCTION
 *
 *	_db_setjmp_    save debugger environment
 *
 *  SYNOPSIS
 *
 *	VOID _db_setjmp_ ()
 *
 *  DESCRIPTION
 *
 *	Invoked as part of the user's DBUG_SETJMP macro to save
 *	the debugger environment in parallel with saving the user's
 *	environment.
 *
 */

#ifdef HAVE_LONGJMP

EXPORT void _db_setjmp_ ()
{
  CODE_STATE *state;
  state=code_state();

  state->jmplevel = state->level;
  state->jmpfunc = state->func;
  state->jmpfile = state->file;
}

/*
 *  FUNCTION
 *
 *	_db_longjmp_	restore previously saved debugger environment
 *
 *  SYNOPSIS
 *
 *	VOID _db_longjmp_ ()
 *
 *  DESCRIPTION
 *
 *	Invoked as part of the user's DBUG_LONGJMP macro to restore
 *	the debugger environment in parallel with restoring the user's
 *	previously saved environment.
 *
 */

EXPORT void _db_longjmp_ ()
{
  CODE_STATE *state;
  state=code_state();

  state->level = state->jmplevel;
  if (state->jmpfunc) {
    state->func = state->jmpfunc;
  }
  if (state->jmpfile) {
    state->file = state->jmpfile;
  }
}
#endif

/*
 *  FUNCTION
 *
 *	DelayArg   convert D flag argument to appropriate value
 *
 *  SYNOPSIS
 *
 *	static int DelayArg (value)
 *	int value;
 *
 *  DESCRIPTION
 *
 *	Converts delay argument, given in tenths of a second, to the
 *	appropriate numerical argument used by the system to delay
 *	that that many tenths of a second.  For example, on the
 *	amiga, there is a system call "Delay()" which takes an
 *	argument in ticks (50 per second).  On unix, the sleep
 *	command takes seconds.	Thus a value of "10", for one
 *	second of delay, gets converted to 50 on the amiga, and 1
 *	on unix.  Other systems will need to use a timing loop.
 *
 */

#ifdef AMIGA
#define HZ (50)			      /* Probably in some header somewhere */
#endif

static int DelayArg (
int value)
{
  uint delayarg = 0;

#if (unix || xenix)
  delayarg = value / 10;	/* Delay is in seconds for sleep () */
#endif
#ifdef AMIGA
  delayarg = (HZ * value) / 10; /* Delay in ticks for Delay () */
#endif
  return (delayarg);
}


/*
 *	A dummy delay stub for systems that do not support delays.
 *	With a little work, this can be turned into a timing loop.
 */

#if ! defined(Delay) && ! defined(AMIGA)
static int Delay (
int ticks)
{
  return ticks;
}
#endif


/*
 *  FUNCTION
 *
 *	perror	  perror simulation for systems that don't have it
 *
 *  SYNOPSIS
 *
 *	static VOID perror (s)
 *	char *s;
 *
 *  DESCRIPTION
 *
 *	Perror produces a message on the standard error stream which
 *	provides more information about the library or system error
 *	just encountered.  The argument string s is printed, followed
 *	by a ':', a blank, and then a message and a newline.
 *
 *	An undocumented feature of the unix perror is that if the string
 *	's' is a null string (NOT a NULL pointer!), then the ':' and
 *	blank are not printed.
 *
 *	This version just complains about an "unknown system error".
 *
 */

#ifndef HAVE_PERROR
static void perror (s)
char *s;
{
  if (s && *s != EOS) {
    (void) fprintf (stderr, "%s: ", s);
  }
  (void) fprintf (stderr, "<unknown system error>\n");
}
#endif /* HAVE_PERROR */


	/* flush dbug-stream, free mutex lock & wait delay */
	/* This is because some systems (MSDOS!!) dosn't flush fileheader */
	/* and dbug-file isn't readable after a system crash !! */

static void dbug_flush(CODE_STATE *state)
{
#ifndef THREAD
  if (stack->flags & FLUSH_ON_WRITE)
#endif
  {
#if defined(MSDOS) || defined(__WIN__)
    if (_db_fp_ != stdout && _db_fp_ != stderr)
    {
      if (!(freopen(stack->name,"a",_db_fp_)))
      {
	(void) fprintf(stderr, ERR_OPEN, _db_process_, stack->name);
	fflush(stderr);
	_db_fp_ = stdout;
	stack -> out_file = _db_fp_;
	stack -> flags|=FLUSH_ON_WRITE;
      }
    }
    else
#endif
    {
      (void) fflush (_db_fp_);
      if (stack->delay)
	(void) Delay (stack->delay);
    }
  }
  if (!state || !state->locked)
    pthread_mutex_unlock(&THR_LOCK_dbug);
} /* dbug_flush */


void _db_lock_file()
{
  CODE_STATE *state;
  state=code_state();
  pthread_mutex_lock(&THR_LOCK_dbug);
  state->locked=1;
}

void _db_unlock_file()
{
  CODE_STATE *state;
  state=code_state();
  state->locked=0;
  pthread_mutex_unlock(&THR_LOCK_dbug);
}

/*
 * Here we need the definitions of the clock routine.  Add your
 * own for whatever system that you have.
 */

#ifndef THREAD
#if defined(HAVE_GETRUSAGE)

#include <sys/param.h>
#include <sys/resource.h>

/* extern int getrusage(int, struct rusage *); */

/*
 * Returns the user time in milliseconds used by this process so
 * far.
 */

static unsigned long Clock ()
{
    struct rusage ru;

    (void) getrusage (RUSAGE_SELF, &ru);
    return ((ru.ru_utime.tv_sec * 1000) + (ru.ru_utime.tv_usec / 1000));
}

#elif defined(MSDOS) || defined(__WIN__) || defined(OS2)

static ulong Clock()
{
  return clock()*(1000/CLOCKS_PER_SEC);
}
#elif defined (amiga)

struct DateStamp {		/* Yes, this is a hack, but doing it right */
	long ds_Days;		/* is incredibly ugly without splitting this */
	long ds_Minute;		/* off into a separate file */
	long ds_Tick;
};

static int first_clock = TRUE;
static struct DateStamp begin;
static struct DateStamp elapsed;

static unsigned long Clock ()
{
    register struct DateStamp *now;
    register unsigned long millisec = 0;
    extern VOID *AllocMem ();

    now = (struct DateStamp *) AllocMem ((long) sizeof (struct DateStamp), 0L);
    if (now != NULL) {
	if (first_clock == TRUE) {
	    first_clock = FALSE;
	    (void) DateStamp (now);
	    begin = *now;
	}
	(void) DateStamp (now);
	millisec = 24 * 3600 * (1000 / HZ) * (now -> ds_Days - begin.ds_Days);
	millisec += 60 * (1000 / HZ) * (now -> ds_Minute - begin.ds_Minute);
	millisec += (1000 / HZ) * (now -> ds_Tick - begin.ds_Tick);
	(void) FreeMem (now, (long) sizeof (struct DateStamp));
    }
    return (millisec);
}
#else
static unsigned long Clock ()
{
    return (0);
}
#endif /* RUSAGE */
#endif /* THREADS */

#ifdef NO_VARARGS

/*
 *	Fake vfprintf for systems that don't support it.  If this
 *	doesn't work, you are probably SOL...
 */

static int vfprintf (stream, format, ap)
FILE *stream;
char *format;
va_list ap;
{
    int rtnval;
    ARGS_DCL;

    ARG0 =  va_arg (ap, ARGS_TYPE);
    ARG1 =  va_arg (ap, ARGS_TYPE);
    ARG2 =  va_arg (ap, ARGS_TYPE);
    ARG3 =  va_arg (ap, ARGS_TYPE);
    ARG4 =  va_arg (ap, ARGS_TYPE);
    ARG5 =  va_arg (ap, ARGS_TYPE);
    ARG6 =  va_arg (ap, ARGS_TYPE);
    ARG7 =  va_arg (ap, ARGS_TYPE);
    ARG8 =  va_arg (ap, ARGS_TYPE);
    ARG9 =  va_arg (ap, ARGS_TYPE);
    rtnval = fprintf (stream, format, ARGS_LIST);
    return (rtnval);
}

#endif	/* NO_VARARGS */