include/openssl/trace.h

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