summaryrefslogtreecommitdiff
path: root/include/tpax/tpax.h
blob: e89076d2517fd73964be3ae6b1890a1c075554b7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
#ifndef TPAX_H
#define TPAX_H

#include <stdint.h>
#include <stddef.h>

#include "tpax_api.h"

#ifdef __cplusplus
extern "C" {
#endif

/* pre-alpha */
#ifndef TPAX_APP
#ifndef TPAX_PRE_ALPHA
#error  libtpax: pre-alpha: ABI is not final!
#error  to use the library, compile with -DTPAX_PRE_ALPHA.
#endif
#endif

/* status codes */
#define TPAX_OK				0x00
#define TPAX_USAGE			0x01
#define TPAX_ERROR			0x02

/* driver flags */
#define TPAX_DRIVER_VERBOSITY_NONE	0x0000
#define TPAX_DRIVER_VERBOSITY_ERRORS	0x0001
#define TPAX_DRIVER_VERBOSITY_STATUS	0x0002
#define TPAX_DRIVER_VERBOSITY_USAGE	0x0004
#define TPAX_DRIVER_CLONE_VECTOR	0x0008

#define TPAX_DRIVER_VERSION		0x0010
#define TPAX_DRIVER_DRY_RUN		0x0020

#define TPAX_DRIVER_ANNOTATE_ALWAYS	0x1000
#define TPAX_DRIVER_ANNOTATE_NEVER	0x2000
#define TPAX_DRIVER_ANNOTATE_FULL	0x4000

/* error flags */
#define TPAX_ERROR_TOP_LEVEL		0x0001
#define TPAX_ERROR_NESTED		0x0002
#define TPAX_ERROR_CHILD		0x0004
#define TPAX_ERROR_CUSTOM		0x0008

enum tpax_custom_error {
	TPAX_ERR_FLOW_ERROR,
	TPAX_ERR_FLEE_ERROR,
	TPAX_ERR_NULL_CONTEXT,
	TPAX_ERR_BAD_DATA,
	TPAX_ERR_CAP,
};

enum tpax_warning_level {
	TPAX_WARNING_LEVEL_UNKNOWN,
	TPAX_WARNING_LEVEL_ALL,
	TPAX_WARNING_LEVEL_ERROR,
	TPAX_WARNING_LEVEL_NONE,
};

struct tpax_source_version {
	int		major;
	int		minor;
	int		revision;
	const char *	commit;
};

struct tpax_fd_ctx {
	int		fdin;
	int		fdout;
	int		fderr;
	int		fdlog;
	int		fdcwd;
	int		fddst;
};

struct tpax_error_info {
	const struct tpax_driver_ctx *	edctx;
	const struct tpax_unit_ctx *	euctx;
	const char *			eunit;
	int				esyscode;
	int				elibcode;
	const char *			efunction;
	int				eline;
	unsigned			eflags;
	void *				eany;
};

struct tpax_common_ctx {
	uint64_t			drvflags;
	uint64_t			actflags;
	uint64_t			fmtflags;
};

struct tpax_driver_ctx {
	const char **                   units;
	const char *			program;
	const char *			module;
	const struct tpax_common_ctx *	cctx;
	struct tpax_error_info **	errv;
	void *				any;
};

struct tpax_unit_ctx {
	const char * const *		path;
	void *				any;
};

/* driver api */
tpax_api int  tpax_get_driver_ctx       (char ** argv, char ** envp, uint32_t flags,
                                         const struct tpax_fd_ctx *,
                                         struct tpax_driver_ctx **);

tpax_api void tpax_free_driver_ctx      (struct tpax_driver_ctx *);

tpax_api int  tpax_get_unit_ctx         (const struct tpax_driver_ctx *, const char * path,
                                         struct tpax_unit_ctx **);

tpax_api void tpax_free_unit_ctx        (struct tpax_unit_ctx *);

tpax_api int  tpax_get_driver_fdctx     (const struct tpax_driver_ctx *, struct tpax_fd_ctx *);
tpax_api int  tpax_set_driver_fdctx     (struct tpax_driver_ctx *, const struct tpax_fd_ctx *);

/* core api */

/* helper api */

/* utility api */
tpax_api int  tpax_main                 (char **, char **,
                                         const struct tpax_fd_ctx *);
/* error trace api */
tpax_api int  tpax_output_error_record  (const struct tpax_driver_ctx *, const struct tpax_error_info *);
tpax_api int  tpax_output_error_vector  (const struct tpax_driver_ctx *);

/* package info */
tpax_api const struct tpax_source_version * tpax_source_version(void);

#ifdef __cplusplus
}
#endif

#endif