[thirdparty/openssl.git] / include / openssl / trace.h

/*
 * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#ifndef OPENSSL_TRACE_H
# define OPENSSL_TRACE_H

# include <stdarg.h>

# include <openssl/bio.h>

# ifdef  __cplusplus
extern "C" {
# endif

/*
 * TRACE CATEGORIES
 */

/*
 * The trace messages of the OpenSSL libraries are organized into different
 * categories. For every trace category, the application can register a separate
 * tracer callback. When a callback is registered, a so called trace channel is
 * created for this category. This channel consists essentially of an internal
 * BIO which sends all trace output it receives to the registered application
 * callback.
 *
 * The ALL category can be used as a fallback category to register a single
 * channel which receives the output from all categories. However, if the
 * application intends to print the trace channel name in the line prefix,
 * it is better to register channels for all categories separately.
 * (This is how the openssl application does it.)
 */
# define OSSL_TRACE_CATEGORY_ALL                 0 /* The fallback */
# define OSSL_TRACE_CATEGORY_TRACE               1
# define OSSL_TRACE_CATEGORY_INIT                2
# define OSSL_TRACE_CATEGORY_TLS                 3
# define OSSL_TRACE_CATEGORY_TLS_CIPHER          4
# define OSSL_TRACE_CATEGORY_CONF                5
# define OSSL_TRACE_CATEGORY_ENGINE_TABLE        6
# define OSSL_TRACE_CATEGORY_ENGINE_REF_COUNT    7
# define OSSL_TRACE_CATEGORY_PKCS5V2             8
# define OSSL_TRACE_CATEGORY_PKCS12_KEYGEN       9
# define OSSL_TRACE_CATEGORY_PKCS12_DECRYPT     10
# define OSSL_TRACE_CATEGORY_X509V3_POLICY      11
# define OSSL_TRACE_CATEGORY_BN_CTX             12
# define OSSL_TRACE_CATEGORY_CMP                13
# define OSSL_TRACE_CATEGORY_STORE              14
# define OSSL_TRACE_CATEGORY_NUM                15

/* Returns the trace category number for the given |name| */
int OSSL_trace_get_category_num(const char *name);

/* Returns the trace category name for the given |num| */
const char *OSSL_trace_get_category_name(int num);

/*
 * TRACE CONSUMERS
 */

/*
 * Enables tracing for the given |category| by providing a BIO sink
 * as |channel|. If a null pointer is passed as |channel|, an existing
 * trace channel is removed and tracing for the category is disabled.
 *
 * Returns 1 on success and 0 on failure
 */
int OSSL_trace_set_channel(int category, BIO* channel);

/*
 * Attach a prefix and a suffix to the given |category|, to be printed at the
 * beginning and at the end of each trace output group, i.e. when
 * OSSL_trace_begin() and OSSL_trace_end() are called.
 * If a null pointer is passed as argument, the existing prefix or suffix is
 * removed.
 *
 * They return 1 on success and 0 on failure
 */
int OSSL_trace_set_prefix(int category, const char *prefix);
int OSSL_trace_set_suffix(int category, const char *suffix);

/*
 * OSSL_trace_cb is the type tracing callback provided by the application.
 * It MUST return the number of bytes written, or 0 on error (in other words,
 * it can never write zero bytes).
 *
 * The |buffer| will always contain text, which may consist of several lines.
 * The |data| argument points to whatever data was provided by the application
 * when registering the tracer function.
 *
 * The |category| number is given, as well as a |cmd| number, described below.
 */
typedef size_t (*OSSL_trace_cb)(const char *buffer, size_t count,
                                int category, int cmd, void *data);
/*
 * Possible |cmd| numbers.
 */
# define OSSL_TRACE_CTRL_BEGIN  0
# define OSSL_TRACE_CTRL_WRITE  1
# define OSSL_TRACE_CTRL_END    2

/*
 * Enables tracing for the given |category| by creating an internal
 * trace channel which sends the output to the given |callback|.
 * If a null pointer is passed as callback, an existing trace channel
 * is removed and tracing for the category is disabled.
 *
 * NOTE: OSSL_trace_set_channel() and OSSL_trace_set_callback() are mutually
 *       exclusive.
 *
 * Returns 1 on success and 0 on failure
 */
int OSSL_trace_set_callback(int category, OSSL_trace_cb callback, void *data);

/*
 * TRACE PRODUCERS
 */

/*
 * Returns 1 if tracing for the specified category is enabled, otherwise 0
 */
int OSSL_trace_enabled(int category);

/*
 * Wrap a group of tracing output calls.  OSSL_trace_begin() locks tracing and
 * returns the trace channel associated with the given category, or NULL if no
 * channel is associated with the category.  OSSL_trace_end() unlocks tracing.
 *
 * Usage:
 *
 *    BIO *out;
 *    if ((out = OSSL_trace_begin(category)) != NULL) {
 *        ...
 *        BIO_fprintf(out, ...);
 *        ...
 *        OSSL_trace_end(category, out);
 *    }
 *
 * See also the convenience macros OSSL_TRACE_BEGIN and OSSL_TRACE_END below.
 */
BIO *OSSL_trace_begin(int category);
void OSSL_trace_end(int category, BIO *channel);

/*
 * OSSL_TRACE* Convenience Macros
 */

/*
 * When the tracing feature is disabled, these macros are defined to
 * produce dead code, which a good compiler should eliminate.
 */

/*
 * OSSL_TRACE_BEGIN, OSSL_TRACE_END - Define a Trace Group
 *
 * These two macros can be used to create a block which is executed only
 * if the corresponding trace category is enabled. Inside this block, a
 * local variable named |trc_out| is defined, which points to the channel
 * associated with the given trace category.
 *
 * Usage: (using 'TLS' as an example category)
 *
 *     OSSL_TRACE_BEGIN(TLS) {
 *
 *         BIO_fprintf(trc_out, ... );
 *
 *     } OSSL_TRACE_END(TLS);
 *
 *
 * This expands to the following code
 *
 *     do {
 *         BIO *trc_out = OSSL_trace_begin(OSSL_TRACE_CATEGORY_TLS);
 *         if (trc_out != NULL) {
 *             ...
 *             BIO_fprintf(trc_out, ...);
 *         }
 *         OSSL_trace_end(OSSL_TRACE_CATEGORY_TLS, trc_out);
 *     } while (0);
 *
 * The use of the inner '{...}' group and the trailing ';' is enforced
 * by the definition of the macros in order to make the code look as much
 * like C code as possible.
 *
 * Before returning from inside the trace block, it is necessary to
 * call OSSL_TRACE_CANCEL(category).
 */

# ifndef OPENSSL_NO_TRACE

#  define OSSL_TRACE_BEGIN(category) \
    do { \
        BIO *trc_out = OSSL_trace_begin(OSSL_TRACE_CATEGORY_##category); \
 \
        if (trc_out != NULL)

#  define OSSL_TRACE_END(category) \
        OSSL_trace_end(OSSL_TRACE_CATEGORY_##category, trc_out); \
    } while (0)

#  define OSSL_TRACE_CANCEL(category) \
        OSSL_trace_end(OSSL_TRACE_CATEGORY_##category, trc_out) \

# else

#  define OSSL_TRACE_BEGIN(category)           \
    do {                                        \
        BIO *trc_out = NULL;                    \
        if (0)

#  define OSSL_TRACE_END(category)             \
    } while(0)

#  define OSSL_TRACE_CANCEL(category)          \
    ((void)0)

# endif

/*
 * OSSL_TRACE_ENABLED() - Check whether tracing is enabled for |category|
 *
 * Usage:
 *
 *     if (OSSL_TRACE_ENABLED(TLS)) {
 *         ...
 *     }
 */
# ifndef OPENSSL_NO_TRACE

#  define OSSL_TRACE_ENABLED(category) \
    OSSL_trace_enabled(OSSL_TRACE_CATEGORY_##category)

# else

#  define OSSL_TRACE_ENABLED(category) (0)

# endif

/*
 * OSSL_TRACE*() - OneShot Trace Macros
 *
 * These macros are intended to produce a simple printf-style trace output.
 * Unfortunately, C90 macros don't support variable arguments, so the
 * "vararg" OSSL_TRACEV() macro has a rather weird usage pattern:
 *
 *    OSSL_TRACEV(category, (trc_out, "format string", ...args...));
 *
 * Where 'channel' is the literal symbol of this name, not a variable.
 * For that reason, it is currently not intended to be used directly,
 * but only as helper macro for the other oneshot trace macros
 * OSSL_TRACE(), OSSL_TRACE1(), OSSL_TRACE2(), ...
 *
 * Usage:
 *
 *    OSSL_TRACE(INIT, "Hello world!\n");
 *    OSSL_TRACE1(TLS, "The answer is %d\n", 42);
 *    OSSL_TRACE2(TLS, "The ultimate question to answer %d is '%s'\n",
 *                42, "What do you get when you multiply six by nine?");
 */

# define OSSL_TRACEV(category, args) \
    OSSL_TRACE_BEGIN(category) \
        BIO_printf args; \
    OSSL_TRACE_END(category)

# define OSSL_TRACE(category, text) \
    OSSL_TRACEV(category, (trc_out, "%s", text))

# define OSSL_TRACE1(category, format, arg1) \
    OSSL_TRACEV(category, (trc_out, format, arg1))
# define OSSL_TRACE2(category, format, arg1, arg2) \
    OSSL_TRACEV(category, (trc_out, format, arg1, arg2))
# define OSSL_TRACE3(category, format, arg1, arg2, arg3) \
    OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3))
# define OSSL_TRACE4(category, format, arg1, arg2, arg3, arg4) \
    OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4))
# define OSSL_TRACE5(category, format, arg1, arg2, arg3, arg4, arg5) \
    OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5))
# define OSSL_TRACE6(category, format, arg1, arg2, arg3, arg4, arg5, arg6) \
    OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5, arg6))
# define OSSL_TRACE7(category, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7) \
    OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7))
# define OSSL_TRACE8(category, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8) \
    OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8))
# define OSSL_TRACE9(category, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8) \
    OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9))

# ifdef  __cplusplus
}
# endif

#endif
Commit	Line	Data
2390c573 RL	1	/*
	2	* Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
	3	*
	4	* Licensed under the Apache License 2.0 (the "License"). You may not use
	5	* this file except in compliance with the License. You can obtain a copy
	6	* in the file LICENSE in the source distribution or at
	7	* https://www.openssl.org/source/license.html
	8	*/
	9
ae4186b0 DMSP	10	#ifndef OPENSSL_TRACE_H
ae4186b0 DMSP	11	# define OPENSSL_TRACE_H
2390c573 RL	12
	13	# include <stdarg.h>
	14
	15	# include <openssl/bio.h>
	16
	17	# ifdef __cplusplus
	18	extern "C" {
	19	# endif
	20
	21	/*
	22	* TRACE CATEGORIES
	23	*/
	24
	25	/*
	26	* The trace messages of the OpenSSL libraries are organized into different
	27	* categories. For every trace category, the application can register a separate
	28	* tracer callback. When a callback is registered, a so called trace channel is
	29	* created for this category. This channel consists essentially of an internal
	30	* BIO which sends all trace output it receives to the registered application
	31	* callback.
	32	*
3a8269b3	33	* The ALL category can be used as a fallback category to register a single
02bd2d7f DMSP	34	* channel which receives the output from all categories. However, if the
	35	* application intends to print the trace channel name in the line prefix,
	36	* it is better to register channels for all categories separately.
	37	* (This is how the openssl application does it.)
2390c573	38	*/
3a8269b3	39	# define OSSL_TRACE_CATEGORY_ALL 0 /* The fallback */
3b9e1a39 RL	40	# define OSSL_TRACE_CATEGORY_TRACE 1
	41	# define OSSL_TRACE_CATEGORY_INIT 2
	42	# define OSSL_TRACE_CATEGORY_TLS 3
	43	# define OSSL_TRACE_CATEGORY_TLS_CIPHER 4
bc362b9b	44	# define OSSL_TRACE_CATEGORY_CONF 5
3b9e1a39 RL	45	# define OSSL_TRACE_CATEGORY_ENGINE_TABLE 6
	46	# define OSSL_TRACE_CATEGORY_ENGINE_REF_COUNT 7
	47	# define OSSL_TRACE_CATEGORY_PKCS5V2 8
	48	# define OSSL_TRACE_CATEGORY_PKCS12_KEYGEN 9
	49	# define OSSL_TRACE_CATEGORY_PKCS12_DECRYPT 10
	50	# define OSSL_TRACE_CATEGORY_X509V3_POLICY 11
	51	# define OSSL_TRACE_CATEGORY_BN_CTX 12
7960dbec	52	# define OSSL_TRACE_CATEGORY_CMP 13
2897b009 RL	53	# define OSSL_TRACE_CATEGORY_STORE 14
2897b009 RL	54	# define OSSL_TRACE_CATEGORY_NUM 15
2390c573 RL	55
	56	/* Returns the trace category number for the given \|name\| */
	57	int OSSL_trace_get_category_num(const char *name);
	58
	59	/* Returns the trace category name for the given \|num\| */
	60	const char *OSSL_trace_get_category_name(int num);
	61
	62	/*
	63	* TRACE CONSUMERS
	64	*/
	65
	66	/*
	67	* Enables tracing for the given \|category\| by providing a BIO sink
	68	* as \|channel\|. If a null pointer is passed as \|channel\|, an existing
	69	* trace channel is removed and tracing for the category is disabled.
	70	*
	71	* Returns 1 on success and 0 on failure
	72	*/
	73	int OSSL_trace_set_channel(int category, BIO* channel);
	74
	75	/*
	76	* Attach a prefix and a suffix to the given \|category\|, to be printed at the
	77	* beginning and at the end of each trace output group, i.e. when
	78	* OSSL_trace_begin() and OSSL_trace_end() are called.
	79	* If a null pointer is passed as argument, the existing prefix or suffix is
	80	* removed.
	81	*
	82	* They return 1 on success and 0 on failure
	83	*/
	84	int OSSL_trace_set_prefix(int category, const char *prefix);
	85	int OSSL_trace_set_suffix(int category, const char *suffix);
	86
	87	/*
	88	* OSSL_trace_cb is the type tracing callback provided by the application.
	89	* It MUST return the number of bytes written, or 0 on error (in other words,
	90	* it can never write zero bytes).
	91	*
	92	* The \|buffer\| will always contain text, which may consist of several lines.
	93	* The \|data\| argument points to whatever data was provided by the application
	94	* when registering the tracer function.
	95	*
	96	* The \|category\| number is given, as well as a \|cmd\| number, described below.
	97	*/
	98	typedef size_t (OSSL_trace_cb)(const char buffer, size_t count,
	99	int category, int cmd, void *data);
	100	/*
	101	* Possible \|cmd\| numbers.
	102	*/
	103	# define OSSL_TRACE_CTRL_BEGIN 0
13d06925	104	# define OSSL_TRACE_CTRL_WRITE 1
2390c573 RL	105	# define OSSL_TRACE_CTRL_END 2
	106
	107	/*
	108	* Enables tracing for the given \|category\| by creating an internal
	109	* trace channel which sends the output to the given \|callback\|.
	110	* If a null pointer is passed as callback, an existing trace channel
	111	* is removed and tracing for the category is disabled.
	112	*
	113	* NOTE: OSSL_trace_set_channel() and OSSL_trace_set_callback() are mutually
	114	* exclusive.
	115	*
	116	* Returns 1 on success and 0 on failure
	117	*/
	118	int OSSL_trace_set_callback(int category, OSSL_trace_cb callback, void *data);
	119
	120	/*
	121	* TRACE PRODUCERS
	122	*/
	123
	124	/*
	125	* Returns 1 if tracing for the specified category is enabled, otherwise 0
	126	*/
	127	int OSSL_trace_enabled(int category);
	128
	129	/*
	130	* Wrap a group of tracing output calls. OSSL_trace_begin() locks tracing and
	131	* returns the trace channel associated with the given category, or NULL if no
	132	* channel is associated with the category. OSSL_trace_end() unlocks tracing.
	133	*
	134	* Usage:
	135	*
	136	* BIO *out;
	137	* if ((out = OSSL_trace_begin(category)) != NULL) {
	138	* ...
	139	* BIO_fprintf(out, ...);
	140	* ...
	141	* OSSL_trace_end(category, out);
	142	* }
	143	*
	144	* See also the convenience macros OSSL_TRACE_BEGIN and OSSL_TRACE_END below.
	145	*/
	146	BIO *OSSL_trace_begin(int category);
	147	void OSSL_trace_end(int category, BIO *channel);
	148
	149	/*
	150	* OSSL_TRACE* Convenience Macros
	151	*/
	152
	153	/*
	154	* When the tracing feature is disabled, these macros are defined to
	155	* produce dead code, which a good compiler should eliminate.
	156	*/
	157
	158	/*
	159	* OSSL_TRACE_BEGIN, OSSL_TRACE_END - Define a Trace Group
	160	*
	161	* These two macros can be used to create a block which is executed only
	162	* if the corresponding trace category is enabled. Inside this block, a
	163	* local variable named \|trc_out\| is defined, which points to the channel
	164	* associated with the given trace category.
	165	*
	166	* Usage: (using 'TLS' as an example category)
	167	*
	168	* OSSL_TRACE_BEGIN(TLS) {
169	*
170	* BIO_fprintf(trc_out, ... );
171	*
172	* } OSSL_TRACE_END(TLS);
173	*
174	*
175	* This expands to the following code
176	*
177	* do {
178	* BIO *trc_out = OSSL_trace_begin(OSSL_TRACE_CATEGORY_TLS);
179	* if (trc_out != NULL) {
180	* ...
181	* BIO_fprintf(trc_out, ...);
182	* }
183	* OSSL_trace_end(OSSL_TRACE_CATEGORY_TLS, trc_out);
184	* } while (0);
185	*
186	* The use of the inner '{...}' group and the trailing ';' is enforced
187	* by the definition of the macros in order to make the code look as much
188	* like C code as possible.
189	*
190	* Before returning from inside the trace block, it is necessary to
191	* call OSSL_TRACE_CANCEL(category).
192	*/
193
16a9d374 RL	194	# ifndef OPENSSL_NO_TRACE
	195
	196	# define OSSL_TRACE_BEGIN(category) \
2390c573 RL	197	do { \
	198	BIO *trc_out = OSSL_trace_begin(OSSL_TRACE_CATEGORY_##category); \
	199	\
	200	if (trc_out != NULL)
	201
16a9d374	202	# define OSSL_TRACE_END(category) \
2390c573 RL	203	OSSL_trace_end(OSSL_TRACE_CATEGORY_##category, trc_out); \
	204	} while (0)
	205
16a9d374	206	# define OSSL_TRACE_CANCEL(category) \
2390c573 RL	207	OSSL_trace_end(OSSL_TRACE_CATEGORY_##category, trc_out) \
2390c573 RL	208
16a9d374 RL	209	# else
	210
	211	# define OSSL_TRACE_BEGIN(category) \
	212	do { \
	213	BIO *trc_out = NULL; \
	214	if (0)
	215
	216	# define OSSL_TRACE_END(category) \
	217	} while(0)
	218
	219	# define OSSL_TRACE_CANCEL(category) \
	220	((void)0)
	221
	222	# endif
	223
2390c573 RL	224	/*
	225	* OSSL_TRACE_ENABLED() - Check whether tracing is enabled for \|category\|
	226	*
	227	* Usage:
	228	*
	229	* if (OSSL_TRACE_ENABLED(TLS)) {
	230	* ...
	231	* }
	232	*/
16a9d374	233	# ifndef OPENSSL_NO_TRACE
2390c573	234
16a9d374	235	# define OSSL_TRACE_ENABLED(category) \
2390c573 RL	236	OSSL_trace_enabled(OSSL_TRACE_CATEGORY_##category)
2390c573 RL	237
16a9d374 RL	238	# else
	239
	240	# define OSSL_TRACE_ENABLED(category) (0)
	241
	242	# endif
	243
2390c573 RL	244	/*
	245	* OSSL_TRACE*() - OneShot Trace Macros
	246	*
	247	* These macros are intended to produce a simple printf-style trace output.
	248	* Unfortunately, C90 macros don't support variable arguments, so the
	249	* "vararg" OSSL_TRACEV() macro has a rather weird usage pattern:
	250	*
	251	* OSSL_TRACEV(category, (trc_out, "format string", ...args...));
	252	*
	253	* Where 'channel' is the literal symbol of this name, not a variable.
	254	* For that reason, it is currently not intended to be used directly,
	255	* but only as helper macro for the other oneshot trace macros
	256	* OSSL_TRACE(), OSSL_TRACE1(), OSSL_TRACE2(), ...
	257	*
	258	* Usage:
	259	*
	260	* OSSL_TRACE(INIT, "Hello world!\n");
	261	* OSSL_TRACE1(TLS, "The answer is %d\n", 42);
	262	* OSSL_TRACE2(TLS, "The ultimate question to answer %d is '%s'\n",
	263	* 42, "What do you get when you multiply six by nine?");
	264	*/
	265
	266	# define OSSL_TRACEV(category, args) \
	267	OSSL_TRACE_BEGIN(category) \
	268	BIO_printf args; \
	269	OSSL_TRACE_END(category)
	270
	271	# define OSSL_TRACE(category, text) \
	272	OSSL_TRACEV(category, (trc_out, "%s", text))
	273
	274	# define OSSL_TRACE1(category, format, arg1) \
	275	OSSL_TRACEV(category, (trc_out, format, arg1))
	276	# define OSSL_TRACE2(category, format, arg1, arg2) \
	277	OSSL_TRACEV(category, (trc_out, format, arg1, arg2))
	278	# define OSSL_TRACE3(category, format, arg1, arg2, arg3) \
	279	OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3))
	280	# define OSSL_TRACE4(category, format, arg1, arg2, arg3, arg4) \
	281	OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4))
	282	# define OSSL_TRACE5(category, format, arg1, arg2, arg3, arg4, arg5) \
	283	OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5))
	284	# define OSSL_TRACE6(category, format, arg1, arg2, arg3, arg4, arg5, arg6) \
	285	OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5, arg6))
	286	# define OSSL_TRACE7(category, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7) \
	287	OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7))
	288	# define OSSL_TRACE8(category, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8) \
	289	OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8))
	290	# define OSSL_TRACE9(category, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8) \
	291	OSSL_TRACEV(category, (trc_out, format, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9))
	292
	293	# ifdef __cplusplus
	294	}
	295	# endif
	296
	297	#endif