source: mainline/uspace/lib/c/include/io/log.h@ 207e8880

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 207e8880 was e0c836e8, checked in by Vojtech Horky <vojtechhorky@…>, 13 years ago

Add comments to logging interface in libc

  • Property mode set to 100644
File size: 2.7 KB
RevLine 
[9b415c9]1/*
2 * Copyright (c) 2011 Vojtech Horky
3 * Copyright (c) 2011 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
34#ifndef LIBC_IO_LOG_H_
35#define LIBC_IO_LOG_H_
36
[fc51296]37#include <stdarg.h>
[793cce15]38#include <inttypes.h>
[aa492fe]39#include <io/verify.h>
[fc51296]40
[e0c836e8]41/** Log message level. */
[9b415c9]42typedef enum {
[e0c836e8]43 /** Fatal error, program is not able to recover at all. */
[9b415c9]44 LVL_FATAL,
[e0c836e8]45 /** Serious error but the program can recover from it. */
[9b415c9]46 LVL_ERROR,
[e0c836e8]47 /** Easily recoverable problem. */
[9b415c9]48 LVL_WARN,
[e0c836e8]49 /** Information message that ought to be printed by default. */
[9b415c9]50 LVL_NOTE,
[e0c836e8]51 /** Debugging purpose message. */
[9b415c9]52 LVL_DEBUG,
[e0c836e8]53 /** More detailed debugging message. */
[9b415c9]54 LVL_DEBUG2,
[aa492fe]55
[9b415c9]56 /** For checking range of values */
57 LVL_LIMIT
58} log_level_t;
59
[e0c836e8]60/** Log itself (logging target). */
[d6ddeb7]61typedef sysarg_t log_t;
[e0c836e8]62/** Formatting directive for printing log_t. */
[793cce15]63#define PRIlogctx PRIxn
[e0c836e8]64
65/** Default log (target). */
[f039dba]66#define LOG_DEFAULT ((log_t) -1)
[e0c836e8]67
68/** Use when creating new top-level log. */
[f039dba]69#define LOG_NO_PARENT ((log_t) 0)
[793cce15]70
[1c67b41]71extern const char *log_level_str(log_level_t);
[eab3d04]72extern int log_level_from_str(const char *, log_level_t *);
[1c67b41]73
[267f235]74extern int log_init(const char *);
[2bf781a]75extern log_t log_create(const char *, log_t);
[793cce15]76
[70253688]77extern void log_msg(log_t, log_level_t, const char *, ...)
78 PRINTF_ATTRIBUTE(3, 4);
[a1a101d]79extern void log_msgv(log_t, log_level_t, const char *, va_list);
[9b415c9]80
81#endif
82
83/** @}
84 */
Note: See TracBrowser for help on using the repository browser.