summaryrefslogtreecommitdiffstats
path: root/src/logsmanagement/helper.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/logsmanagement/helper.h')
-rw-r--r--src/logsmanagement/helper.h238
1 files changed, 0 insertions, 238 deletions
diff --git a/src/logsmanagement/helper.h b/src/logsmanagement/helper.h
deleted file mode 100644
index 6d1d51f76..000000000
--- a/src/logsmanagement/helper.h
+++ /dev/null
@@ -1,238 +0,0 @@
-// SPDX-License-Identifier: GPL-3.0-or-later
-
-/** @file helper.h
- * @brief Includes helper functions for the Logs Management project.
- */
-
-#ifndef HELPER_H_
-#define HELPER_H_
-
-#include "libnetdata/libnetdata.h"
-#include <assert.h>
-
-#define LOGS_MANAGEMENT_PLUGIN_STR "logs-management.plugin"
-
-#define LOGS_MANAG_STR_HELPER(x) #x
-#define LOGS_MANAG_STR(x) LOGS_MANAG_STR_HELPER(x)
-
-#ifndef m_assert
-#if defined(LOGS_MANAGEMENT_DEV_MODE)
-#define m_assert(expr, msg) assert(((void)(msg), (expr)))
-#else
-#define m_assert(expr, msg) do{} while(0)
-#endif // LOGS_MANAGEMENT_DEV_MODE
-#endif // m_assert
-
-/* Test if a timestamp is within a valid range
- * 1649175852000 equals Tuesday, 5 April 2022 16:24:12,
- * 2532788652000 equals Tuesday, 5 April 2050 16:24:12
- */
-#define TEST_MS_TIMESTAMP_VALID(x) (((x) > 1649175852000 && (x) < 2532788652000)? 1:0)
-
-#define TIMESTAMP_MS_STR_SIZE sizeof("1649175852000")
-
-#ifdef ENABLE_LOGSMANAGEMENT_TESTS
-#define UNIT_STATIC
-#else
-#define UNIT_STATIC static
-#endif // ENABLE_LOGSMANAGEMENT_TESTS
-
-#ifndef COMPILE_TIME_ASSERT // https://stackoverflow.com/questions/3385515/static-assert-in-c
-#define STATIC_ASSERT(COND,MSG) typedef char static_assertion_##MSG[(!!(COND))*2-1]
-// token pasting madness:
-#define COMPILE_TIME_ASSERT3(X,L) STATIC_ASSERT(X,static_assertion_at_line_##L)
-#define COMPILE_TIME_ASSERT2(X,L) COMPILE_TIME_ASSERT3(X,L)
-#define COMPILE_TIME_ASSERT(X) COMPILE_TIME_ASSERT2(X,__LINE__)
-#endif // COMPILE_TIME_ASSERT
-
-#if defined(NETDATA_INTERNAL_CHECKS) && defined(LOGS_MANAGEMENT_DEV_MODE)
-#define debug_log(args...) netdata_logger(NDLS_COLLECTORS, NDLP_DEBUG, __FILE__, __FUNCTION__, __LINE__, ##args)
-#else
-#define debug_log(fmt, args...) do {} while(0)
-#endif
-
-/**
- * @brief Extract file_basename from full file path
- * @param path String containing the full path.
- * @return Pointer to the file_basename string
- */
-static inline char *get_basename(const char *const path) {
- if(!path) return NULL;
- char *s = strrchr(path, '/');
- if (!s)
- return strdupz(path);
- else
- return strdupz(s + 1);
-}
-
-typedef enum {
- STR2XX_SUCCESS = 0,
- STR2XX_OVERFLOW,
- STR2XX_UNDERFLOW,
- STR2XX_INCONVERTIBLE
-} str2xx_errno;
-
-/* Convert string s to int out.
- * https://stackoverflow.com/questions/7021725/how-to-convert-a-string-to-integer-in-c
- *
- * @param[out] out The converted int. Cannot be NULL.
- * @param[in] s Input string to be converted.
- *
- * The format is the same as strtol,
- * except that the following are inconvertible:
- * - empty string
- * - leading whitespace
- * - any trailing characters that are not part of the number
- * Cannot be NULL.
- *
- * @param[in] base Base to interpret string in. Same range as strtol (2 to 36).
- * @return Indicates if the operation succeeded, or why it failed.
- */
-static inline str2xx_errno str2int(int *out, char *s, int base) {
- char *end;
- if (unlikely(s[0] == '\0' || isspace(s[0]))){
- // debug_log( "str2int error: STR2XX_INCONVERTIBLE 1");
- // m_assert(0, "str2int error: STR2XX_INCONVERTIBLE");
- return STR2XX_INCONVERTIBLE;
- }
- errno = 0;
- long l = strtol(s, &end, base);
- /* Both checks are needed because INT_MAX == LONG_MAX is possible. */
- if (unlikely(l > INT_MAX || (errno == ERANGE && l == LONG_MAX))){
- debug_log( "str2int error: STR2XX_OVERFLOW");
- // m_assert(0, "str2int error: STR2XX_OVERFLOW");
- return STR2XX_OVERFLOW;
- }
- if (unlikely(l < INT_MIN || (errno == ERANGE && l == LONG_MIN))){
- debug_log( "str2int error: STR2XX_UNDERFLOW");
- // m_assert(0, "str2int error: STR2XX_UNDERFLOW");
- return STR2XX_UNDERFLOW;
- }
- if (unlikely(*end != '\0')){
- debug_log( "str2int error: STR2XX_INCONVERTIBLE 2");
- // m_assert(0, "str2int error: STR2XX_INCONVERTIBLE 2");
- return STR2XX_INCONVERTIBLE;
- }
- *out = l;
- return STR2XX_SUCCESS;
-}
-
-static inline str2xx_errno str2float(float *out, char *s) {
- char *end;
- if (unlikely(s[0] == '\0' || isspace(s[0]))){
- // debug_log( "str2float error: STR2XX_INCONVERTIBLE 1\n");
- // m_assert(0, "str2float error: STR2XX_INCONVERTIBLE");
- return STR2XX_INCONVERTIBLE;
- }
- errno = 0;
- float f = strtof(s, &end);
- /* Both checks are needed because INT_MAX == LONG_MAX is possible. */
- if (unlikely((errno == ERANGE && f == HUGE_VALF))){
- debug_log( "str2float error: STR2XX_OVERFLOW\n");
- // m_assert(0, "str2float error: STR2XX_OVERFLOW");
- return STR2XX_OVERFLOW;
- }
- if (unlikely((errno == ERANGE && f == -HUGE_VALF))){
- debug_log( "str2float error: STR2XX_UNDERFLOW\n");
- // m_assert(0, "str2float error: STR2XX_UNDERFLOW");
- return STR2XX_UNDERFLOW;
- }
- if (unlikely((*end != '\0'))){
- debug_log( "str2float error: STR2XX_INCONVERTIBLE 2\n");
- // m_assert(0, "str2float error: STR2XX_INCONVERTIBLE");
- return STR2XX_INCONVERTIBLE;
- }
- *out = f;
- return STR2XX_SUCCESS;
-}
-
-/**
- * @brief Read last line of *filename, up to max_line_width characters.
- * @note This function should be used carefully as it is not the most
- * efficient one. But it is a quick-n-dirty way of reading the last line
- * of a file.
- * @param[in] filename File to be read.
- * @param[in] max_line_width Integer indicating the max line width to be read.
- * If a line is longer than that, it will be truncated. If zero or negative, a
- * default value will be used instead.
- * @return Pointer to a string holding the line that was read, or NULL if error.
- */
-static inline char *read_last_line(const char *filename, int max_line_width){
- uv_fs_t req;
- int64_t start_pos, end_pos;
- uv_file file_handle = -1;
- uv_buf_t uvBuf;
- char *buff = NULL;
- int rc, line_pos = -1, bytes_read;
-
- max_line_width = max_line_width > 0 ? max_line_width : 1024; // 1024 == default value
-
- rc = uv_fs_stat(NULL, &req, filename, NULL);
- end_pos = req.statbuf.st_size;
- uv_fs_req_cleanup(&req);
- if (unlikely(rc)) {
- collector_error("[%s]: uv_fs_stat() error: (%d) %s", filename, rc, uv_strerror(rc));
- m_assert(0, "uv_fs_stat() failed during read_last_line()");
- goto error;
- }
-
- if(end_pos == 0) goto error;
- start_pos = end_pos - max_line_width;
- if(start_pos < 0) start_pos = 0;
-
- rc = uv_fs_open(NULL, &req, filename, O_RDONLY, 0, NULL);
- uv_fs_req_cleanup(&req);
- if (unlikely(rc < 0)) {
- collector_error("[%s]: uv_fs_open() error: (%d) %s",filename, rc, uv_strerror(rc));
- m_assert(0, "uv_fs_open() failed during read_last_line()");
- goto error;
- }
- file_handle = rc;
-
- buff = callocz(1, (size_t) (end_pos - start_pos + 1) * sizeof(char));
- uvBuf = uv_buf_init(buff, (unsigned int) (end_pos - start_pos));
- rc = uv_fs_read(NULL, &req, file_handle, &uvBuf, 1, start_pos, NULL);
- uv_fs_req_cleanup(&req);
- if (unlikely(rc < 0)){
- collector_error("[%s]: uv_fs_read() error: (%d) %s", filename, rc, uv_strerror(rc));
- m_assert(0, "uv_fs_read() failed during read_last_line()");
- goto error;
- }
- bytes_read = rc;
-
- buff[bytes_read] = '\0';
-
- for(int i = bytes_read - 2; i >= 0; i--){ // -2 because -1 could be '\n'
- if (buff[i] == '\n'){
- line_pos = i;
- break;
- }
- }
-
- if(line_pos >= 0){
- char *line = callocz(1, (size_t) (bytes_read - line_pos) * sizeof(char));
- memcpy(line, &buff[line_pos + 1], (size_t) (bytes_read - line_pos));
- freez(buff);
- uv_fs_close(NULL, &req, file_handle, NULL);
- return line;
- }
-
- if(start_pos == 0){
- uv_fs_close(NULL, &req, file_handle, NULL);
- return buff;
- }
-
-error:
- if(buff) freez(buff);
- if(file_handle >= 0) uv_fs_close(NULL, &req, file_handle, NULL);
- return NULL;
-}
-
-static inline void memcpy_iscntrl_fix(char *dest, char *src, size_t num){
- while(num--){
- *dest++ = unlikely(!iscntrl(*src)) ? *src : ' ';
- src++;
- }
-}
-
-#endif // HELPER_H_