mirror of
https://github.com/YosysHQ/nextpnr.git
synced 2026-05-12 10:11:06 +00:00
33e1c9033b
Define open_(o|i)fstream_and_log_error in log.h to: - quote 'filename' - add error cause to easier troubleshoot - use existing consistent string style - easily allows OS specific message Introduce it when file are opened and add it where error message was missing.
102 lines
3.3 KiB
C++
102 lines
3.3 KiB
C++
/*
|
|
* nextpnr -- Next Generation Place and Route
|
|
*
|
|
* Copyright (C) 2018 Claire Xenia Wolf <claire@yosyshq.com>
|
|
*
|
|
* Permission to use, copy, modify, and/or distribute this software for any
|
|
* purpose with or without fee is hereby granted, provided that the above
|
|
* copyright notice and this permission notice appear in all copies.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*
|
|
*/
|
|
|
|
#ifndef LOG_H
|
|
#define LOG_H
|
|
|
|
#include <fstream>
|
|
#include <functional>
|
|
#include <set>
|
|
#include <stdarg.h>
|
|
#include <stdio.h>
|
|
#include <string>
|
|
#include <vector>
|
|
#include "hashlib.h"
|
|
#include "nextpnr_namespaces.h"
|
|
|
|
#include <fstream>
|
|
|
|
NEXTPNR_NAMESPACE_BEGIN
|
|
|
|
typedef std::function<void(std::string)> log_write_type;
|
|
|
|
struct log_cmd_error_exception
|
|
{
|
|
};
|
|
|
|
struct log_execution_error_exception
|
|
{
|
|
};
|
|
|
|
enum class LogLevel
|
|
{
|
|
LOG_MSG,
|
|
INFO_MSG,
|
|
WARNING_MSG,
|
|
ERROR_MSG,
|
|
ALWAYS_MSG
|
|
};
|
|
|
|
struct loglevel_hash_ops
|
|
{
|
|
static inline bool cmp(LogLevel a, LogLevel b) { return a == b; }
|
|
static inline unsigned int hash(LogLevel a) { return unsigned(a); }
|
|
};
|
|
|
|
extern std::vector<std::pair<std::ostream *, LogLevel>> log_streams;
|
|
extern log_write_type log_write_function;
|
|
|
|
extern std::string log_last_error;
|
|
extern void (*log_error_atexit)();
|
|
extern bool had_nonfatal_error;
|
|
extern bool log_warn_as_error;
|
|
extern dict<LogLevel, int, loglevel_hash_ops> message_count_by_level;
|
|
|
|
std::string stringf(const char *fmt, ...);
|
|
std::string vstringf(const char *fmt, va_list ap);
|
|
|
|
void log(const char *format, ...) NPNR_ATTRIBUTE(format(printf, 1, 2));
|
|
void log_always(const char *format, ...) NPNR_ATTRIBUTE(format(printf, 1, 2));
|
|
void log_info(const char *format, ...) NPNR_ATTRIBUTE(format(printf, 1, 2));
|
|
void log_warning(const char *format, ...) NPNR_ATTRIBUTE(format(printf, 1, 2));
|
|
NPNR_NORETURN void log_error(const char *format, ...) NPNR_ATTRIBUTE(format(printf, 1, 2), noreturn);
|
|
void log_nonfatal_error(const char *format, ...) NPNR_ATTRIBUTE(format(printf, 1, 2));
|
|
void log_break();
|
|
void log_flush();
|
|
|
|
static inline void log_assert_worker(bool cond, const char *expr, const char *file, int line)
|
|
{
|
|
if (!cond)
|
|
log_error("Assert `%s' failed in %s:%d.\n", expr, file, line);
|
|
}
|
|
#define log_assert(_assert_expr_) \
|
|
NEXTPNR_NAMESPACE_PREFIX log_assert_worker(_assert_expr_, #_assert_expr_, __FILE__, __LINE__)
|
|
|
|
#define log_abort() log_error("Abort in %s:%d.\n", __FILE__, __LINE__)
|
|
|
|
/// open `filename`, if error log "Failed to open {file_description} '{filename}'" with cause
|
|
std::ifstream open_ifstream_and_log_error(std::string filename, const char *file_description);
|
|
|
|
/// open `filename`, if error log "Failed to open {file_description} '{filename}' for writing" with cause
|
|
std::ofstream open_ofstream_and_log_error(std::string filename, const char *file_description);
|
|
|
|
NEXTPNR_NAMESPACE_END
|
|
|
|
#endif
|