mirror of
https://github.com/amadvance/snapraid.git
synced 2026-10-26 19:01:57 -04:00
292 lines
7.3 KiB
C
292 lines
7.3 KiB
C
/*
|
|
* Copyright (C) 2011 Andrea Mazzoleni
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef __SUPPORT_H
|
|
#define __SUPPORT_H
|
|
|
|
/****************************************************************************/
|
|
/* log */
|
|
|
|
/**
|
|
* Fatal error messages.
|
|
*
|
|
* Messages printed before an early termination.
|
|
*
|
|
* These messages go in the log file and in stderr unconditionally.
|
|
*/
|
|
void log_fatal(const char* format, ...) __attribute__((format(attribute_printf, 1, 2)));
|
|
|
|
/**
|
|
* Unexpected error messages.
|
|
*
|
|
* Messages reporting error conditions that don't prevent the program to run.
|
|
*
|
|
* Some of them could be also serious errors, like "silent errors".
|
|
* In such case, the summary result is always printed as error,
|
|
* and we are sure to notify the user in some way.
|
|
*
|
|
* These messages go in the log file if specified, otherwise they go in stderr.
|
|
*/
|
|
void log_error(const char* format, ...) __attribute__((format(attribute_printf, 1, 2)));
|
|
|
|
/**
|
|
* Expected error messages, without fallback to stderr.
|
|
*
|
|
* These errors are "someway" expected, and then they never go to screen.
|
|
* For example, when undeleting missing files, the messages for missing files
|
|
* are not shown.
|
|
*
|
|
* These messages go in the log file if specified, otherwise they are lost.
|
|
*/
|
|
void log_expected(const char* format, ...) __attribute__((format(attribute_printf, 1, 2)));
|
|
|
|
/**
|
|
* Tag messages.
|
|
*
|
|
* Messages are in tag format, like "tag:entry:...".
|
|
*
|
|
* These messages never go on the screen, but only in the log file if specified.
|
|
*
|
|
* Note that this function, allows not \n terminated strings.
|
|
*
|
|
* These messages are buffered. Use msg_flush() to flush them.
|
|
*/
|
|
void log_tag(const char* format, ...) __attribute__((format(attribute_printf, 1, 2)));
|
|
|
|
/**
|
|
* Flush the log.
|
|
*/
|
|
void log_flush(void);
|
|
|
|
/**
|
|
* Pointer to log function.
|
|
*/
|
|
typedef void fptr(const char* format, ...);
|
|
|
|
/****************************************************************************/
|
|
/* message */
|
|
|
|
/**
|
|
* Message levels.
|
|
*
|
|
* The levels control the amount of information printed on the screen.
|
|
* Note that log_fatal(), log_error(), log_expected() and log_tag() are not affected by this option.
|
|
*
|
|
* From the most quiet to the most verbose.
|
|
*/
|
|
#define MSG_STATUS -3
|
|
#define MSG_INFO -2
|
|
#define MSG_PROGRESS -1
|
|
#define MSG_BAR 0
|
|
#define MSG_VERBOSE 1
|
|
|
|
/**
|
|
* Selected message level.
|
|
*/
|
|
extern int msg_level;
|
|
|
|
/**
|
|
* State messages.
|
|
*
|
|
* Messages that tell what the program is doing or did, but limited to few lines.
|
|
* They are status information, and summary results.
|
|
*/
|
|
void msg_status(const char* format, ...) __attribute__((format(attribute_printf, 1, 2)));
|
|
|
|
/**
|
|
* Info messages.
|
|
*
|
|
* Messages that tell what was done.
|
|
* Potentially a lot of messages are possible. They can still be on the screen,
|
|
* as losing them we don't lose information.
|
|
*
|
|
* These messages never go in the log file, becauae there is always a corresponding log_tag().
|
|
*/
|
|
void msg_info(const char* format, ...) __attribute__((format(attribute_printf, 1, 2)));
|
|
|
|
/**
|
|
* Progress messages.
|
|
*
|
|
* Message that tell the progress of program.
|
|
*
|
|
* These messages also go in the log file.
|
|
*/
|
|
void msg_progress(const char* format, ...) __attribute__((format(attribute_printf, 1, 2)));
|
|
|
|
/**
|
|
* Progress bar messages.
|
|
*
|
|
* Message that show the percentage of the progress.
|
|
*
|
|
* These messages never go in the log file.
|
|
*
|
|
* These messages are buffered. Use msg_flush() to flush them.
|
|
*/
|
|
void msg_bar(const char* format, ...) __attribute__((format(attribute_printf, 1, 2)));
|
|
|
|
/**
|
|
* Verbose messages.
|
|
*
|
|
* Message that tell what is already expected.
|
|
*
|
|
* These messages also go in the log file.
|
|
*/
|
|
void msg_verbose(const char* format, ...) __attribute__((format(attribute_printf, 1, 2)));
|
|
|
|
/**
|
|
* Flush the output.
|
|
*/
|
|
void msg_flush(void);
|
|
|
|
/****************************************************************************/
|
|
/* escape */
|
|
|
|
/**
|
|
* Escape a string.
|
|
*
|
|
* Chars ':', '\n', '\r' and '\' are escaped to '\d', '\\n', '\\r' and '\\'.
|
|
*/
|
|
const char* esc(const char* str);
|
|
|
|
/**
|
|
* Polish a string.
|
|
*
|
|
* Not printable chars are replaced by spaces.
|
|
*
|
|
* Note that the passed string is modified.
|
|
*/
|
|
char* polish(char* s);
|
|
|
|
/****************************************************************************/
|
|
/* path */
|
|
|
|
/**
|
|
* Copy a path limiting the size.
|
|
* Abort if too long.
|
|
*/
|
|
void pathcpy(char* dst, size_t size, const char* src);
|
|
|
|
/**
|
|
* Concatenate a path limiting the size.
|
|
* Abort if too long.
|
|
*/
|
|
void pathcat(char* dst, size_t size, const char* src);
|
|
|
|
/**
|
|
* Concatenate a path limiting the size.
|
|
* Abort if too long.
|
|
*/
|
|
void pathcatc(char* dst, size_t size, char c);
|
|
|
|
/**
|
|
* Import a path limiting the size.
|
|
* In Windows all the backslash are converted to the C standard of forward slash.
|
|
* Abort if too long.
|
|
*/
|
|
void pathimport(char* dst, size_t size, const char* src);
|
|
|
|
/**
|
|
* Export a path limiting the size.
|
|
* In Windows all the C slashes are converted to the Windows backslash.
|
|
* Abort if too long.
|
|
*/
|
|
void pathexport(char* dst, size_t size, const char* src);
|
|
|
|
/**
|
|
* Print a path.
|
|
* Abort if too long.
|
|
*/
|
|
void pathprint(char* dst, size_t size, const char* format, ...) __attribute__((format(attribute_printf, 3, 4)));
|
|
|
|
/**
|
|
* Ensure the presence of a terminating slash, if it isn't empty.
|
|
* Abort if too long.
|
|
*/
|
|
void pathslash(char* dst, size_t size);
|
|
|
|
/**
|
|
* Cut everything after the latest slash.
|
|
*/
|
|
void pathcut(char* dst);
|
|
|
|
/**
|
|
* Compare two paths.
|
|
* In Windows it's case insentive and assumes \ equal at /.
|
|
*/
|
|
int pathcmp(const char* a, const char* b);
|
|
|
|
/****************************************************************************/
|
|
/* filesystem */
|
|
|
|
/**
|
|
* Create all the ancestor directories if missing.
|
|
* The file name, after the last /, is ignored.
|
|
*/
|
|
int mkancestor(const char* file);
|
|
|
|
/**
|
|
* Change the modification time of an open file.
|
|
*/
|
|
int fmtime(int f, int64_t mtime_sec, int mtime_nsec);
|
|
|
|
/****************************************************************************/
|
|
/* memory */
|
|
|
|
/**
|
|
* Return the size of the allocated memory.
|
|
*/
|
|
size_t malloc_counter(void);
|
|
|
|
/**
|
|
* Safe malloc.
|
|
* If no memory is available, it aborts.
|
|
*/
|
|
void* malloc_nofail(size_t size);
|
|
|
|
/**
|
|
* Safe cmalloc.
|
|
* If no memory is available, it aborts.
|
|
*/
|
|
void* calloc_nofail(size_t count, size_t size);
|
|
|
|
/**
|
|
* Safe strdup.
|
|
* If no memory is available, it aborts.
|
|
*/
|
|
char* strdup_nofail(const char* str);
|
|
|
|
/**
|
|
* Helper for printing an error about a failed allocation.
|
|
*/
|
|
void malloc_fail(size_t size);
|
|
|
|
/****************************************************************************/
|
|
/* smartctl */
|
|
|
|
/**
|
|
* Read smartctl attributes from a stream.
|
|
* Return 0 on success.
|
|
*/
|
|
int smartctl_attribute(FILE* f, const char* file, const char* name, uint64_t* smart, char* serial);
|
|
|
|
/**
|
|
* Flush smartctl output from a stream.
|
|
*/
|
|
int smartctl_flush(FILE* f, const char* file, const char* name);
|
|
|
|
#endif
|
|
|