Willy Tarreau c12bf9af0b BUG/MEDIUM: errors: include missing obj_type file
A tiny change in commit 6af81f80f ("MEDIUM: errors: implement parsing
context type") triggered an awful bug in gcc 5 and below (4.7.4 to 5.5
confirmed affected, at least on aarch64/mips/x86_64) causing the startup
to loop forever in acl_find_target().

This was tracked down to the acl.c file seeing a different definition
of the struct proxy than other files. The reason for this is that it
sees an unpacked "enum obj_type" (4 bytes) while others see it packed
(1 byte), thus all fields in the struct are having a different
alignment, and the "acl" list is shifted one pointer to the next struct
and seems to loop onto itself.

The commit above did nothing more than adding "enum obj_type *obj" in a
new struct without including obj_type.h, and that was apparently enough
for the compiler to internally declare obj_type as a regular enum and
silently ignore the packed attribute that it discovers later, so depending
on the order of includes, some files would see it as 1 byte and others as
4.

This patch simply adds the missing include but due to the nature of the
bug, probably that creating a special "packed_enum" definition to disable
the packed attribute on such compilers could be a safer option.

No backport is needed as this is only in -dev.
2021-06-11 07:43:07 +02:00

133 lines
4.6 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 <stdarg.h>
#include <stdio.h>
#include <haproxy/buf-t.h>
#include <haproxy/obj_type-t.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 */
};
void usermsgs_clr(const char *prefix);
int usermsgs_empty(void);
const char *usermsgs_str(void);
/************ Error reporting functions ***********/
struct usermsgs_ctx {
struct buffer str;
const char *prefix; /* prefix of every output */
const char *file; /* related filename for config parsing */
int line; /* related line number for config parsing */
enum obj_type *obj; /* related proxy, server, ... */
};
void set_usermsgs_ctx(const char *file, int line, enum obj_type *obj);
void register_parsing_obj(enum obj_type *obj);
void reset_usermsgs_ctx(void);
/*
* 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)));
/*
* These functions are reserved to output diagnostics on MODE_DIAG.
* Use the underscore variants only if MODE_DIAG has already been checked.
*/
void _ha_vdiag_warning(const char *fmt, va_list argp);
void _ha_diag_warning(const char *fmt, ...);
void ha_diag_warning(const char *fmt, ...)
__attribute__ ((format(printf, 1 ,2)));
/* Check for both MODE_DIAG and <cond> before outputting a diagnostic warning */
#define HA_DIAG_WARNING_COND(cond, fmt, ...) \
do { \
if ((global.mode & MODE_DIAG) && (cond)) \
_ha_diag_warning((fmt), ##__VA_ARGS__); \
} while (0)
/*
* 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:
*/