mirror of
https://git.haproxy.org/git/haproxy.git/
synced 2025-08-14 11:06:56 +02:00
36979d9ad5
Most of the files dealing with error reports have to include log.h in order to access ha_alert(), ha_warning() etc. But while these functions don't depend on anything, log.h depends on a lot of stuff because it deals with log-formats and samples. As a result it's impossible not to embark long dependencies when using ha_warning() or qfprintf(). This patch moves these low-level functions to errors.h, which already defines the error codes used at the same places. About half of the users of log.h could be adjusted, sometimes revealing other issues such as missing tools.h. Interestingly the total preprocessed size shrunk by 4%.
97 lines
3.4 KiB
C
97 lines
3.4 KiB
C
/*
|
|
* include/haproxy/errors.h
|
|
* Global error macros and constants
|
|
*
|
|
* Copyright (C) 2000-2020 Willy Tarreau - w@1wt.eu
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation, version 2.1
|
|
* exclusively.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef _HAPROXY_ERRORS_H
|
|
#define _HAPROXY_ERRORS_H
|
|
|
|
#include <stdio.h>
|
|
|
|
/* These flags may be used in various functions which are called from within
|
|
* loops (eg: to start all listeners from all proxies). They provide enough
|
|
* information to let the caller decide what to do. ERR_WARN and ERR_ALERT
|
|
* do not indicate any error, just that a message has been put in a shared
|
|
* buffer in order to be displayed by the caller.
|
|
*/
|
|
#define ERR_NONE 0x00 /* no error, no message returned */
|
|
#define ERR_RETRYABLE 0x01 /* retryable error, may be cumulated */
|
|
#define ERR_FATAL 0x02 /* fatal error, may be cumulated */
|
|
#define ERR_ABORT 0x04 /* it's preferable to end any possible loop */
|
|
#define ERR_WARN 0x08 /* a warning message has been returned */
|
|
#define ERR_ALERT 0x10 /* an alert message has been returned */
|
|
|
|
#define ERR_CODE (ERR_RETRYABLE|ERR_FATAL|ERR_ABORT) /* mask */
|
|
|
|
|
|
/* These codes may be used by config parsing functions which detect errors and
|
|
* which need to inform the upper layer about them. They are all prefixed with
|
|
* "PE_" for "Parse Error". These codes will probably be extended, and functions
|
|
* making use of them should be documented as such. Only code PE_NONE (zero) may
|
|
* indicate a valid condition, all other ones must be caught as errors, event if
|
|
* unknown by the caller. This must not be used to forward warnings.
|
|
*/
|
|
enum {
|
|
PE_NONE = 0, /* no error */
|
|
PE_ENUM_OOR, /* enum data out of allowed range */
|
|
PE_EXIST, /* trying to create something which already exists */
|
|
PE_ARG_MISSING, /* mandatory argument not provided */
|
|
PE_ARG_NOT_USED, /* argument provided cannot be used */
|
|
PE_ARG_INVC, /* invalid char in argument (pointer not provided) */
|
|
PE_ARG_INVC_PTR, /* invalid char in argument (pointer provided) */
|
|
PE_ARG_NOT_FOUND, /* argument references something not found */
|
|
};
|
|
|
|
|
|
/************ Error reporting functions from log.c ***********/
|
|
|
|
/*
|
|
* Displays the message on stderr with the date and pid. Overrides the quiet
|
|
* mode during startup.
|
|
*/
|
|
void ha_alert(const char *fmt, ...)
|
|
__attribute__ ((format(printf, 1, 2)));
|
|
|
|
/*
|
|
* Displays the message on stderr with the date and pid.
|
|
*/
|
|
void ha_warning(const char *fmt, ...)
|
|
__attribute__ ((format(printf, 1, 2)));
|
|
|
|
/*
|
|
* Displays the message on stderr with the date and pid.
|
|
*/
|
|
void ha_notice(const char *fmt, ...)
|
|
__attribute__ ((format(printf, 1, 2)));
|
|
|
|
/*
|
|
* Displays the message on <out> only if quiet mode is not set.
|
|
*/
|
|
void qfprintf(FILE *out, const char *fmt, ...)
|
|
__attribute__ ((format(printf, 2, 3)));
|
|
|
|
#endif /* _HAPROXY_ERRORS_H */
|
|
|
|
/*
|
|
* Local variables:
|
|
* c-indent-level: 8
|
|
* c-basic-offset: 8
|
|
* End:
|
|
*/
|