MySQL 8.0.30
Source Code Documentation
log_sink_buffer.h File Reference

This file contains. More...

#include "log_builtins_internal.h"
#include "my_sys.h"

Go to the source code of this file.

Enumerations

enum  log_sink_buffer_flush_mode { LOG_BUFFER_DISCARD_ONLY , LOG_BUFFER_PROCESS_AND_DISCARD }
 
enum  log_error_stage { LOG_ERROR_STAGE_BUFFERING , LOG_ERROR_STAGE_COMPONENTS , LOG_ERROR_STAGE_COMPONENTS_AND_PFS , LOG_ERROR_STAGE_SHUTTING_DOWN }
 

Functions

void log_error_stage_set (enum log_error_stage les)
 Set error-logging stage hint (e.g. are loadable services available yet?). More...
 
enum log_error_stage log_error_stage_get (void)
 What mode is error-logging in (e.g. are loadable services available yet)? More...
 
int log_sink_buffer (void *instance, log_line *ll)
 Write a log-event to the buffer sink. More...
 
void log_sink_buffer_flush (enum log_sink_buffer_flush_mode mode)
 Release all buffered log-events (discard_error_log_messages()), optionally after running them through the error log stack first (flush_error_log_messages()). More...
 

Variables

mysql_mutex_t THR_LOCK_log_buffered
 Make sure only one instance of the buffered "writer" runs at a time. More...
 

Detailed Description

This file contains.

a) the API for the log-sink that buffers errors logged during start-up so they can be flushed once all configured log-components have become available;

b) the API for querying and setting the phase the server is in with regard to logging (buffering, normal operation, and so forth);

c) the API for flushing the buffered information (to force writing out this information in cases of early shutdowns and so on).

Enumeration Type Documentation

◆ log_error_stage

Enumerator
LOG_ERROR_STAGE_BUFFERING 

no log-destination yet

LOG_ERROR_STAGE_COMPONENTS 

external services available

LOG_ERROR_STAGE_COMPONENTS_AND_PFS 

full logging incl. to pfs

LOG_ERROR_STAGE_SHUTTING_DOWN 

no external components

◆ log_sink_buffer_flush_mode

Enumerator
LOG_BUFFER_DISCARD_ONLY 

discard all buffered log-events

LOG_BUFFER_PROCESS_AND_DISCARD 

process+discard buffered log-events

Function Documentation

◆ log_error_stage_get()

enum log_error_stage log_error_stage_get ( void  )

What mode is error-logging in (e.g. are loadable services available yet)?

◆ log_error_stage_set()

void log_error_stage_set ( enum log_error_stage  les)

Set error-logging stage hint (e.g. are loadable services available yet?).

◆ log_sink_buffer()

int log_sink_buffer ( void *  instance,
log_line ll 
)

Write a log-event to the buffer sink.

Write a log-event to the buffer sink.

During start-up, we buffer log-info until a) we have basic info for the built-in logger (what file to log to, verbosity, and so on), and b) advanced info (any logging components to load, any configuration for them, etc.).

As a failsafe, if start-up takes very, very long, and a time-out is reached before reaching b) and we actually have something worth reporting (e.g. errors, as opposed to info), we try to keep the user informed by using the basic logger configured in a), while going on buffering all info and flushing it to any advanced loggers when b) is reached.

1) This function checks and, if needed, updates the time-out, and calls the flush functions as needed. It is internal to the logger and should not be called from elsewhere.

2) Function will save log-event (if given) for later filtering and output.

3) Function acquires/releases THR_LOCK_log_buffered if initialized.

Parameters
instanceinstance handle Not currently used in this writer; if this changes later, keep in mind that nullptr will be passed if this is called before the structured logger's locks are initialized, so that must remain a valid argument!
llThe log line to write, or nullptr to not add a new logline, but to just check whether the time-out has been reached and if so, flush as needed.
Return values
-1can not add event to buffer (OOM?)
>0number of added fields

< log-line buffer

◆ log_sink_buffer_flush()

void log_sink_buffer_flush ( enum log_sink_buffer_flush_mode  mode)

Release all buffered log-events (discard_error_log_messages()), optionally after running them through the error log stack first (flush_error_log_messages()).

Safe to call repeatedly (though subsequent calls will only output anything if further events occurred after the previous flush).

Parameters
modeLOG_BUFFER_DISCARD_ONLY (to just throw away the buffered events), or LOG_BUFFER_PROCESS_AND_DISCARD to filter/print them first

Variable Documentation

◆ THR_LOCK_log_buffered

mysql_mutex_t THR_LOCK_log_buffered
extern

Make sure only one instance of the buffered "writer" runs at a time.

In normal operation, the log-event will be created dynamically, then it will be fed through the pipeline, and then it will be released. Since the event is allocated in the caller, we can be sure it won't go away wholesale during processing, and since the event is local to the caller, no other thread will tangle with it. It is therefore safe in those cases not to wrap a lock around the event. (The log-pipeline will still grab a shared lock, THR_LOCK_log_stack, to protect the pipeline (not the event) and the log-services cache from being changed while the pipeline is being applied. Likewise, log-services may protect their resources (file-writers will usually take a lock to serialize their writes; the built-in filter will take a lock on its rule-set as that is shared between concurrent threads running the filter, and so on). None of these are intended to protect the event itself though.

In buffered mode on the other hand, we copy each log-event (the original of which, see above, is owned by the caller and local to the thread, and therefore safe without locking) to a global buffer / backlog. As this backlog can be added to by all threads, it must be protected by a lock (once we have fully initialized the subsystem with log_builtins_init() and support multi-threaded mode anyway, as indicated by log_builtins_inited being true, see below). This is that lock.