source: mainline/uspace/lib/c/include/stacktrace.h@ fb0ec570

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since fb0ec570 was b7fd2a0, checked in by Jiří Zárevúcky <zarevucky.jiri@…>, 7 years ago

Use errno_t in all uspace and kernel code.

Change type of every variable, parameter and return value that holds an
<errno.h> constant to either errno_t (the usual case), or sys_errno_t
(some places in kernel). This is for the purpose of self-documentation,
as well as for type-checking with a bit of type definition hackery.

Although this is a massive commit, it is a simple text replacement, and thus
is very easy to verify. Simply do the following:

`
git checkout <this commit's hash>
git reset HEAD
git add .
tools/srepl '\berrno_t\b' int
git add .
tools/srepl '\bsys_errno_t\b' sysarg_t
git reset
git diff
`

While this doesn't ensure that the replacements are correct, it does ensure
that the commit doesn't do anything except those replacements. Since errno_t
is typedef'd to int in the usual case (and sys_errno_t to sysarg_t), even if
incorrect, this commit cannot change behavior.
  • Property mode set to 100644
File size: 2.4 KB
Line 
1/*
2 * Copyright (c) 2009 Jakub Jermar
3 * Copyright (c) 2010 Jiri Svoboda
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * - Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * - The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/** @addtogroup libc
31 * @{
32 */
33/** @file
34 */
35
36#ifndef LIBC_STACKTRACE_H_
37#define LIBC_STACKTRACE_H_
38
39#include <errno.h>
40#include <stdint.h>
41#include <stdbool.h>
42
43typedef struct {
44 errno_t (*read_uintptr)(void *, uintptr_t, uintptr_t *);
45} stacktrace_ops_t;
46
47typedef struct {
48 void *op_arg;
49 stacktrace_ops_t *ops;
50} stacktrace_t;
51
52extern void stacktrace_print(void);
53extern void stacktrace_print_fp_pc(uintptr_t, uintptr_t);
54extern void stacktrace_print_generic(stacktrace_ops_t *, void *, uintptr_t,
55 uintptr_t);
56
57/*
58 * The following interface is to be implemented by each architecture.
59 */
60extern bool stacktrace_fp_valid(stacktrace_t *, uintptr_t);
61extern errno_t stacktrace_fp_prev(stacktrace_t *, uintptr_t, uintptr_t *);
62extern errno_t stacktrace_ra_get(stacktrace_t *, uintptr_t, uintptr_t *);
63
64extern void stacktrace_prepare(void);
65extern uintptr_t stacktrace_fp_get(void);
66extern uintptr_t stacktrace_pc_get(void);
67
68#endif
69
70/** @}
71 */
Note: See TracBrowser for help on using the repository browser.