Gecko [ armaneco.co.uk ]

Name	Size	Permission	Date
aes.h	1.05 KB	-rw-r--r--	2025-03-04 13:53
app.h	10.23 KB	-rw-r--r--	2025-03-04 13:53
assertions.h	2.78 KB	-rw-r--r--	2025-03-04 13:53
atomic.h	4.15 KB	-rw-r--r--	2025-03-04 13:53
backtrace.h	3.8 KB	-rw-r--r--	2025-03-04 13:53
base32.h	3.94 KB	-rw-r--r--	2025-03-04 13:53
base64.h	2.39 KB	-rw-r--r--	2025-03-04 13:53
bind9.h	849 B	-rw-r--r--	2025-03-04 13:53
boolean.h	746 B	-rw-r--r--	2025-03-04 13:53
buffer.h	25.69 KB	-rw-r--r--	2025-03-04 13:53
bufferlist.h	1.42 KB	-rw-r--r--	2025-03-04 13:53
commandline.h	1.69 KB	-rw-r--r--	2025-03-04 13:53
condition.h	1.44 KB	-rw-r--r--	2025-03-04 13:53
counter.h	1.88 KB	-rw-r--r--	2025-03-04 13:53
crc64.h	986 B	-rw-r--r--	2025-03-04 13:53
deprecated.h	622 B	-rw-r--r--	2025-03-04 13:53
dir.h	1.96 KB	-rw-r--r--	2025-03-04 13:53
entropy.h	8.76 KB	-rw-r--r--	2025-03-04 13:53
errno.h	658 B	-rw-r--r--	2025-03-04 13:53
errno2result.h	893 B	-rw-r--r--	2025-03-04 13:53
error.h	1.4 KB	-rw-r--r--	2025-03-04 13:53
event.h	2.98 KB	-rw-r--r--	2025-03-04 13:53
eventclass.h	1.35 KB	-rw-r--r--	2025-03-04 13:53
file.h	11.43 KB	-rw-r--r--	2025-03-04 13:53
formatcheck.h	892 B	-rw-r--r--	2025-03-04 13:53
fsaccess.h	7.25 KB	-rw-r--r--	2025-03-04 13:53
hash.h	7.52 KB	-rw-r--r--	2025-03-04 13:53
heap.h	5.14 KB	-rw-r--r--	2025-03-04 13:53
hex.h	2.33 KB	-rw-r--r--	2025-03-04 13:53
hmacmd5.h	1.75 KB	-rw-r--r--	2025-03-04 13:53
hmacsha.h	4.44 KB	-rw-r--r--	2025-03-04 13:53
ht.h	4.29 KB	-rw-r--r--	2025-03-04 13:53
httpd.h	2.26 KB	-rw-r--r--	2025-03-04 13:53
int.h	1.37 KB	-rw-r--r--	2025-03-04 13:53
interfaceiter.h	3.03 KB	-rw-r--r--	2025-03-04 13:53
iterated_hash.h	1.02 KB	-rw-r--r--	2025-03-04 13:53
json.h	1.42 KB	-rw-r--r--	2025-03-04 13:53
keyboard.h	976 B	-rw-r--r--	2025-03-04 13:53
lang.h	636 B	-rw-r--r--	2025-03-04 13:53
lex.h	9.42 KB	-rw-r--r--	2025-03-04 13:53
lfsr.h	2.88 KB	-rw-r--r--	2025-03-04 13:53
lib.h	1.04 KB	-rw-r--r--	2025-03-04 13:53
likely.h	718 B	-rw-r--r--	2025-03-04 13:53
list.h	5.65 KB	-rw-r--r--	2025-03-04 13:53
log.h	28.06 KB	-rw-r--r--	2025-03-04 13:53
magic.h	993 B	-rw-r--r--	2025-03-04 13:53
md5.h	2.34 KB	-rw-r--r--	2025-03-04 13:53
mem.h	20.63 KB	-rw-r--r--	2025-03-04 13:53
meminfo.h	690 B	-rw-r--r--	2025-03-04 13:53
msgcat.h	2.66 KB	-rw-r--r--	2025-03-04 13:53
msgs.h	8.22 KB	-rw-r--r--	2025-03-04 13:53
mutex.h	3.44 KB	-rw-r--r--	2025-03-04 13:53
mutexblock.h	1.34 KB	-rw-r--r--	2025-03-04 13:53
net.h	10.32 KB	-rw-r--r--	2025-03-04 13:53
netaddr.h	4.56 KB	-rw-r--r--	2025-03-04 13:53
netdb.h	862 B	-rw-r--r--	2025-03-04 13:53
netscope.h	947 B	-rw-r--r--	2025-03-04 13:53
offset.h	699 B	-rw-r--r--	2025-03-04 13:53
once.h	981 B	-rw-r--r--	2025-03-04 13:53
ondestroy.h	2.79 KB	-rw-r--r--	2025-03-04 13:53
os.h	670 B	-rw-r--r--	2025-03-04 13:53
parseint.h	1.49 KB	-rw-r--r--	2025-03-04 13:53
platform.h	9.31 KB	-rw-r--r--	2025-03-04 13:53
pool.h	3.42 KB	-rw-r--r--	2025-03-04 13:53
portset.h	3.21 KB	-rw-r--r--	2025-03-04 13:53
print.h	2.49 KB	-rw-r--r--	2025-03-04 13:53
queue.h	4.66 KB	-rw-r--r--	2025-03-04 13:53
quota.h	2.29 KB	-rw-r--r--	2025-03-04 13:53
radix.h	6.37 KB	-rw-r--r--	2025-03-04 13:53
random.h	2.99 KB	-rw-r--r--	2025-03-04 13:53
ratelimiter.h	3.38 KB	-rw-r--r--	2025-03-04 13:53
refcount.h	7.89 KB	-rw-r--r--	2025-03-04 13:53
regex.h	766 B	-rw-r--r--	2025-03-04 13:53
region.h	1.99 KB	-rw-r--r--	2025-03-04 13:53
resource.h	2.8 KB	-rw-r--r--	2025-03-04 13:53
result.h	4.62 KB	-rw-r--r--	2025-03-04 13:53
resultclass.h	1.56 KB	-rw-r--r--	2025-03-04 13:53
rwlock.h	3.6 KB	-rw-r--r--	2025-03-04 13:53
safe.h	1.21 KB	-rw-r--r--	2025-03-04 13:53
serial.h	1.4 KB	-rw-r--r--	2025-03-04 13:53
sha1.h	1.52 KB	-rw-r--r--	2025-03-04 13:53
sha2.h	5.65 KB	-rw-r--r--	2025-03-04 13:53
sockaddr.h	6 KB	-rw-r--r--	2025-03-04 13:53
socket.h	35.81 KB	-rw-r--r--	2025-03-04 13:53
stat.h	805 B	-rw-r--r--	2025-03-04 13:53
stats.h	3.02 KB	-rw-r--r--	2025-03-04 13:53
stdio.h	1.74 KB	-rw-r--r--	2025-03-04 13:53
stdlib.h	703 B	-rw-r--r--	2025-03-04 13:53
stdtime.h	1.3 KB	-rw-r--r--	2025-03-04 13:53
strerror.h	776 B	-rw-r--r--	2025-03-04 13:53
string.h	5.94 KB	-rw-r--r--	2025-03-04 13:53
symtab.h	4.21 KB	-rw-r--r--	2025-03-04 13:53
syslog.h	843 B	-rw-r--r--	2025-03-04 13:53
task.h	21.08 KB	-rw-r--r--	2025-03-04 13:53
taskpool.h	3.61 KB	-rw-r--r--	2025-03-04 13:53
thread.h	1.47 KB	-rw-r--r--	2025-03-04 13:53
time.h	8.66 KB	-rw-r--r--	2025-03-04 13:53
timer.h	10.54 KB	-rw-r--r--	2025-03-04 13:53
tm.h	894 B	-rw-r--r--	2025-03-04 13:53
types.h	5.54 KB	-rw-r--r--	2025-03-04 13:53
util.h	7.49 KB	-rw-r--r--	2025-03-04 13:53
version.h	688 B	-rw-r--r--	2025-03-04 13:53
xml.h	1.07 KB	-rw-r--r--	2025-03-04 13:53

Rename

/*
 * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * See the COPYRIGHT file distributed with this work for additional
 * information regarding copyright ownership.
 */

/*! \file isc/backtrace.h
 * \brief provide a back trace of the running process to help debug problems.
 *
 * This module tries to get a back trace of the process using some platform
 * dependent way when available.  It also manages an internal symbol table
 * that maps function addresses used in the process to their textual symbols.
 * This module is expected to be used to help debug when some fatal error
 * happens.
 *
 * IMPORTANT NOTE: since the (major) intended use case of this module is
 * dumping a back trace on a fatal error, normally followed by self termination,
 * functions defined in this module generally doesn't employ assertion checks
 * (if it did, a program bug could cause infinite recursive calls to a
 * backtrace function).  These functions still perform minimal checks and return
 * ISC_R_FAILURE if they detect an error, but the caller should therefore be
 * very careful about the use of these functions, and generally discouraged to
 * use them except in an exit path.  The exception is
 * isc_backtrace_getsymbolfromindex(), which is expected to be used in a
 * non-error-handling context and validates arguments with assertion checks.
 */

#ifndef ISC_BACKTRACE_H
#define ISC_BACKTRACE_H 1

/***
 ***	Imports
 ***/

#include <isc/types.h>

/***
 *** Types
 ***/
struct isc_backtrace_symmap {
	void		*addr;
	const char	*symbol;
};

LIBISC_EXTERNAL_DATA extern const int isc__backtrace_nsymbols;
LIBISC_EXTERNAL_DATA extern const
	isc_backtrace_symmap_t isc__backtrace_symtable[];

/***
 *** Functions
 ***/

ISC_LANG_BEGINDECLS
isc_result_t
isc_backtrace_gettrace(void **addrs, int maxaddrs, int *nframes);
/*%<
 * Get a back trace of the running process above this function itself.  On
 * success, addrs[i] will store the address of the call point of the i-th
 * stack frame (addrs[0] is the caller of this function).  *nframes will store
 * the total number of frames.
 *
 * Requires (note that these are not ensured by assertion checks, see above):
 *
 *\li	'addrs' is a valid array containing at least 'maxaddrs' void * entries.
 *
 *\li	'nframes' must be non NULL.
 *
 * Returns:
 *
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_FAILURE
 *\li	#ISC_R_NOTFOUND
 *\li	#ISC_R_NOTIMPLEMENTED
 */

isc_result_t
isc_backtrace_getsymbolfromindex(int index, const void **addrp,
				 const char **symbolp);
/*%<
 * Returns the content of the internal symbol table of the given index.
 * On success, *addrsp and *symbolp point to the address and the symbol of
 * the 'index'th entry of the table, respectively.  If 'index' is not in the
 * range of the symbol table, ISC_R_RANGE will be returned.
 *
 * Requires
 *
 *\li	'addrp' must be non NULL && '*addrp' == NULL.
 *
 *\li	'symbolp' must be non NULL && '*symbolp' == NULL.
 *
 * Returns:
 *
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_RANGE
 */

isc_result_t
isc_backtrace_getsymbol(const void *addr, const char **symbolp,
			unsigned long *offsetp);
/*%<
 * Searches the internal symbol table for the symbol that most matches the
 * given 'addr'.  On success, '*symbolp' will point to the name of function
 * to which the address 'addr' belong, and '*offsetp' will store the offset
 * from the function's entry address to 'addr'.
 *
 * Requires (note that these are not ensured by assertion checks, see above):
 *
 *\li	'symbolp' must be non NULL && '*symbolp' == NULL.
 *
 *\li	'offsetp' must be non NULL.
 *
 * Returns:
 *
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_FAILURE
 *\li	#ISC_R_NOTFOUND
 */
ISC_LANG_ENDDECLS

#endif	/* ISC_BACKTRACE_H */