log_builtins_imp.h

Go to the documentation of this file.

/* Copyright (c) 2017, 2025, Oracle and/or its affiliates.
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2.0,
as published by the Free Software Foundation.
 
This program is designed to work with certain software (including
but not limited to OpenSSL) that is licensed under separate terms,
as designated in a particular file or component or in included license
documentation.  The authors of MySQL hereby grant you an additional
permission to link the program and your derivative works with the
separately licensed software that they have either included with
the program or referenced in the documentation.
 
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, version 2.0, for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 
#ifndef LOG_BUILTINS_IMP_H
#define LOG_BUILTINS_IMP_H
 
#include <stdarg.h>
 
#include "log_builtins_internal.h"
#include "mysql/attribute.h"
 
#ifdef IN_DOXYGEN
#include <mysql/components/services/log_builtins.h>
#else
#include <mysql/components/services/log_service.h>
#endif
 
/**
  This defines built-in functions for use by logging services.
  These helpers are organized into a number of APIs grouping
  related functionality.
 
  This file defines internals; to use the logger from a service,
  include log_builtins.h instead.
 
  For documentation of the individual functions, see log_builtins.cc
*/
 
#include <mysql/components/services/log_shared.h>
 
/**
  Name of internal filtering engine (so we may recognize it when the
  user refers to it by name in log_error_services).
*/
#define LOG_BUILTINS_FILTER "log_filter_internal"
 
/**
  Name of internal log writer (so we may recognize it when the user
  refers to it by name in log_error_services).
*/
#define LOG_BUILTINS_SINK "log_sink_internal"
 
/**
  Default services pipeline for log_builtins_error_stack().
*/
#define LOG_ERROR_SERVICES_DEFAULT LOG_BUILTINS_FILTER "; " LOG_BUILTINS_SINK
 
// see include/mysql/components/services/log_builtins.h
 
/**
  Primitives for services to interact with the structured logger:
  functions pertaining to log_line and log_item data
*/
class log_builtins_imp {
 public: /* Service Implementations */
  static DEFINE_METHOD(int, wellknown_by_type, (log_item_type t));
  static DEFINE_METHOD(int, wellknown_by_name,
                       (const char *key, size_t length));
  static DEFINE_METHOD(log_item_type, wellknown_get_type, (uint i));
  static DEFINE_METHOD(const char *, wellknown_get_name, (uint i));
 
  static DEFINE_METHOD(int, item_inconsistent, (log_item * li));
  static DEFINE_METHOD(bool, item_generic_type, (log_item_type t));
  static DEFINE_METHOD(bool, item_string_class, (log_item_class c));
  static DEFINE_METHOD(bool, item_numeric_class, (log_item_class c));
 
  static DEFINE_METHOD(bool, item_set_int, (log_item_data * lid, longlong i));
  static DEFINE_METHOD(bool, item_set_float, (log_item_data * lid, double f));
  static DEFINE_METHOD(bool, item_set_lexstring,
                       (log_item_data * lid, const char *s, size_t s_len));
  static DEFINE_METHOD(bool, item_set_cstring,
                       (log_item_data * lid, const char *s));
  static DEFINE_METHOD(void, line_set_flag,
                       (log_line * ll, log_line_flags_mask mask,
                        log_line_flags_mask value));
 
  static DEFINE_METHOD(log_item_data *, item_set_with_key,
                       (log_item * li, log_item_type t, const char *key,
                        uint32 alloc));
  static DEFINE_METHOD(log_item_data *, item_set,
                       (log_item * li, log_item_type t));
 
  static DEFINE_METHOD(log_item_data *, line_item_set_with_key,
                       (log_line * ll, log_item_type t, const char *key,
                        uint32 alloc));
  static DEFINE_METHOD(log_item_data *, line_item_set,
                       (log_line * ll, log_item_type t));
 
  static DEFINE_METHOD(log_line *, line_init, ());
  static DEFINE_METHOD(void, line_exit, (log_line * ll));
  static DEFINE_METHOD(int, line_item_count, (log_line * ll));
 
  static DEFINE_METHOD(log_item_type_mask, line_item_types_seen,
                       (log_line * ll, log_item_type_mask m));
 
  static DEFINE_METHOD(log_item *, line_get_output_buffer, (log_line * ll));
 
  static DEFINE_METHOD(log_item_iter *, line_item_iter_acquire,
                       (log_line * ll));
  static DEFINE_METHOD(void, line_item_iter_release, (log_item_iter * it));
  static DEFINE_METHOD(log_item *, line_item_iter_first, (log_item_iter * it));
  static DEFINE_METHOD(log_item *, line_item_iter_next, (log_item_iter * it));
  static DEFINE_METHOD(log_item *, line_item_iter_current,
                       (log_item_iter * it));
 
  static DEFINE_METHOD(int, line_submit, (log_line * ll));
 
  static DEFINE_METHOD(int, message, (int log_type, ...));
 
  static DEFINE_METHOD(int, sanitize, (log_item * li));
 
  static DEFINE_METHOD(const char *, errmsg_by_errcode, (int mysql_errcode));
 
  static DEFINE_METHOD(longlong, errcode_by_errsymbol, (const char *sym));
 
  static DEFINE_METHOD(const char *, label_from_prio, (int prio));
 
  static DEFINE_METHOD(ulonglong, parse_iso8601_timestamp,
                       (const char *timestamp, size_t len));
 
  static DEFINE_METHOD(log_service_error, open_errstream,
                       (const char *file, void **my_errstream));
 
  static DEFINE_METHOD(log_service_error, write_errstream,
                       (void *my_errstream, const char *buffer, size_t length));
 
  static DEFINE_METHOD(int, dedicated_errstream, (void *my_errstream));
 
  static DEFINE_METHOD(log_service_error, close_errstream,
                       (void **my_errstream));
 
  static DEFINE_METHOD(log_service_error, reopen_errstream,
                       (const char *file, void **my_errstream));
};
 
/**
  String primitives for logging services.
*/
class log_builtins_string_imp {
 public: /* Service Implementations */
  static DEFINE_METHOD(void *, malloc, (size_t len));
  static DEFINE_METHOD(char *, strndup, (const char *fm, size_t len));
  static DEFINE_METHOD(void, free, (void *ptr));
  static DEFINE_METHOD(size_t, length, (const char *s));
  static DEFINE_METHOD(char *, find_first, (const char *s, int c));
  static DEFINE_METHOD(char *, find_last, (const char *s, int c));
 
  static DEFINE_METHOD(int, compare,
                       (const char *a, const char *b, size_t len,
                        bool case_insensitive));
 
  static DEFINE_METHOD(size_t, substitutev,
                       (char *to, size_t n, const char *fmt, va_list ap))
      MY_ATTRIBUTE((format(printf, 3, 0)));
 
  static DEFINE_METHOD(size_t, substitute,
                       (char *to, size_t n, const char *fmt, ...))
      MY_ATTRIBUTE((format(printf, 3, 4)));
};
 
/**
  Temporary primitives for logging services.
*/
class log_builtins_tmp_imp {
 public: /* Service Implementations */
  static DEFINE_METHOD(size_t, notify_client,
                       (void *thd, uint severity, uint code, char *to, size_t n,
                        const char *format, ...))
      MY_ATTRIBUTE((format(printf, 6, 7)));
};
 
/**
  Syslog/Eventlog functions for logging services.
*/
class log_builtins_syseventlog_imp {
 public: /* Service Implementations */
  static DEFINE_METHOD(log_service_error, open,
                       (const char *name, int option, int facility));
  static DEFINE_METHOD(log_service_error, write,
                       (enum loglevel level, const char *msg));
  static DEFINE_METHOD(log_service_error, close, (void));
};
 
#endif /* LOG_BUILTINS_IMP_H */