libaaruformat 1.0
Aaru Data Preservation Suite - Format Library
Loading...
Searching...
No Matches
log.h File Reference
#include <inttypes.h>
#include <stdarg.h>
#include <stdio.h>

Go to the source code of this file.

Macros

#define AARU_LOG_FATAL   0
#define AARU_LOG_TRACE   1
#define AARU_LOG_PRINTF_ATTR
#define AARU_LOG_VISIBILITY_ATTR
#define TRACE(fmt, ...)
#define FATAL(fmt, ...)

Functions

void aaru_log_write (int level, const char *file, int line, const char *func, const char *fmt,...)
 Writes one log line.
void aaru_log_reset (void)

Macro Definition Documentation

◆ AARU_LOG_FATAL

#define AARU_LOG_FATAL   0

Definition at line 37 of file log.h.

Referenced by aaru_log_write(), and log_init().

◆ AARU_LOG_PRINTF_ATTR

#define AARU_LOG_PRINTF_ATTR

Definition at line 48 of file log.h.

◆ AARU_LOG_TRACE

#define AARU_LOG_TRACE   1

Definition at line 38 of file log.h.

Referenced by aaru_log_reset(), and log_init().

◆ AARU_LOG_VISIBILITY_ATTR

#define AARU_LOG_VISIBILITY_ATTR

Definition at line 49 of file log.h.

◆ FATAL

#define FATAL ( fmt,
... )
Value:
((void)0)

Definition at line 75 of file log.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_dpm(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_flux_captures(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_close(), aaruf_close_current_block(), aaruf_create(), aaruf_get_aaru_json_metadata(), aaruf_get_all_tape_files(), aaruf_get_all_tape_partitions(), aaruf_get_cicm_metadata(), aaruf_get_comments(), aaruf_get_creator(), aaruf_get_dpm(), aaruf_get_drive_firmware_revision(), aaruf_get_drive_manufacturer(), aaruf_get_drive_model(), aaruf_get_drive_serial_number(), aaruf_get_dumphw(), aaruf_get_flux_captures(), aaruf_get_geometry(), aaruf_get_image_info(), aaruf_get_media_barcode(), aaruf_get_media_manufacturer(), aaruf_get_media_model(), aaruf_get_media_part_number(), aaruf_get_media_sequence(), aaruf_get_media_serial_number(), aaruf_get_media_title(), aaruf_get_negative_sectors(), aaruf_get_overflow_sectors(), aaruf_get_readable_media_tags(), aaruf_get_readable_sector_tags(), aaruf_get_tape_file(), aaruf_get_tape_partition(), aaruf_get_tracks(), aaruf_get_user_sectors(), aaruf_open(), aaruf_read_flux_capture(), aaruf_read_media_tag(), aaruf_read_sector(), aaruf_read_sector_long(), aaruf_read_sector_tag(), aaruf_read_track_sector(), aaruf_set_aaru_json_metadata(), aaruf_set_comments(), aaruf_set_creator(), aaruf_set_dpm(), aaruf_set_drive_firmware_revision(), aaruf_set_drive_manufacturer(), aaruf_set_drive_model(), aaruf_set_drive_serial_number(), aaruf_set_dumphw(), aaruf_set_geometry(), aaruf_set_media_barcode(), aaruf_set_media_manufacturer(), aaruf_set_media_model(), aaruf_set_media_part_number(), aaruf_set_media_sequence(), aaruf_set_media_serial_number(), aaruf_set_media_title(), aaruf_set_tape_file(), aaruf_set_tape_partition(), aaruf_set_tracks(), aaruf_verify_image(), aaruf_write_flux_capture(), aaruf_write_media_tag(), aaruf_write_sector(), aaruf_write_sector_long(), aaruf_write_sector_tag(), add_subindex_entries(), decode_ddt_entry_v1(), decode_ddt_entry_v2(), decode_ddt_multi_level_v2(), decode_ddt_single_level_v2(), extract_flux_data_buffers(), flux_map_rebuild_from_entries(), process_aaru_metadata_json_block(), process_checksum_block(), process_cicm_block(), process_data_block(), process_ddt_v1(), process_ddt_v2(), process_dpm_block(), process_dumphw_block(), process_flux_data_block(), process_geometry_block(), process_index_v1(), process_index_v2(), process_index_v3(), process_metadata_block(), process_tape_files_block(), process_tape_partitions_block(), process_tracks_block(), read_flux_payload_header(), read_lzma_compressed_payload(), read_uncompressed_payload(), read_zstd_compressed_payload(), set_ddt_entry_v2(), set_ddt_multi_level_v2(), set_ddt_single_level_v2(), set_ddt_tape(), update_crc64_from_stream(), validate_flux_payload_crcs(), verify_index_v1(), verify_index_v2(), verify_index_v3(), write_dumphw_block(), write_flux_blocks(), and write_flux_capture_payload().

◆ TRACE

#define TRACE ( fmt,
... )
Value:
((void)0)

Definition at line 69 of file log.h.

Referenced by aaruf_cd_lba_to_msf(), aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_dpm(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_flux_captures(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_close(), aaruf_close_current_block(), aaruf_crc64_init(), aaruf_crc64_update(), aaruf_create(), aaruf_ecc_cd_check(), aaruf_ecc_cd_init(), aaruf_ecc_cd_is_suffix_correct(), aaruf_ecc_cd_is_suffix_correct_mode2(), aaruf_ecc_cd_reconstruct(), aaruf_ecc_cd_reconstruct_prefix(), aaruf_ecc_cd_write(), aaruf_ecc_cd_write_sector(), aaruf_edc_cd_compute(), aaruf_finalize_write(), aaruf_get_aaru_json_metadata(), aaruf_get_all_tape_files(), aaruf_get_all_tape_partitions(), aaruf_get_cicm_metadata(), aaruf_get_comments(), aaruf_get_creator(), aaruf_get_dpm(), aaruf_get_drive_firmware_revision(), aaruf_get_drive_manufacturer(), aaruf_get_drive_model(), aaruf_get_drive_serial_number(), aaruf_get_dumphw(), aaruf_get_flux_captures(), aaruf_get_geometry(), aaruf_get_image_info(), aaruf_get_media_barcode(), aaruf_get_media_manufacturer(), aaruf_get_media_model(), aaruf_get_media_part_number(), aaruf_get_media_sequence(), aaruf_get_media_serial_number(), aaruf_get_media_title(), aaruf_get_negative_sectors(), aaruf_get_overflow_sectors(), aaruf_get_readable_media_tags(), aaruf_get_readable_sector_tags(), aaruf_get_tape_file(), aaruf_get_tape_partition(), aaruf_get_tracks(), aaruf_get_user_sectors(), aaruf_open(), aaruf_read_flux_capture(), aaruf_read_media_tag(), aaruf_read_sector(), aaruf_read_sector_long(), aaruf_read_sector_tag(), aaruf_read_track_sector(), aaruf_set_aaru_json_metadata(), aaruf_set_comments(), aaruf_set_creator(), aaruf_set_dpm(), aaruf_set_drive_firmware_revision(), aaruf_set_drive_manufacturer(), aaruf_set_drive_model(), aaruf_set_drive_serial_number(), aaruf_set_dumphw(), aaruf_set_erasure_coding(), aaruf_set_erasure_coding_auto(), aaruf_set_geometry(), aaruf_set_media_barcode(), aaruf_set_media_manufacturer(), aaruf_set_media_model(), aaruf_set_media_part_number(), aaruf_set_media_sequence(), aaruf_set_media_serial_number(), aaruf_set_media_title(), aaruf_set_tape_file(), aaruf_set_tape_partition(), aaruf_set_tracks(), aaruf_verify_image(), aaruf_write_flux_capture(), aaruf_write_media_tag(), aaruf_write_sector(), aaruf_write_sector_long(), aaruf_write_sector_tag(), add_subindex_entries(), decode_ddt_entry_v1(), decode_ddt_entry_v2(), decode_ddt_multi_level_v2(), decode_ddt_single_level_v2(), ec_accumulate_data_block(), ec_finalize(), ec_load_ecmb(), extract_flux_data_buffers(), parse_options(), process_aaru_metadata_json_block(), process_checksum_block(), process_cicm_block(), process_data_block(), process_ddt_v1(), process_ddt_v2(), process_dpm_block(), process_dumphw_block(), process_flux_data_block(), process_geometry_block(), process_index_v1(), process_index_v2(), process_index_v3(), process_metadata_block(), process_tape_files_block(), process_tape_partitions_block(), process_tracks_block(), read_dump_string(), read_flux_payload_header(), read_lzma_compressed_payload(), read_uncompressed_payload(), read_zstd_compressed_payload(), recover_dpm_block(), remove_dpm_index_entries(), set_ddt_entry_v2(), set_ddt_multi_level_v2(), set_ddt_single_level_v2(), set_ddt_tape(), validate_flux_payload_crcs(), verify_index_v1(), verify_index_v2(), verify_index_v3(), write_aaru_json_block(), write_bd_sector_edc_block(), write_cached_secondary_ddt(), write_checksum_block(), write_cicm_block(), write_dpm_block(), write_dumphw_block(), write_dvd_long_sector_blocks(), write_dvd_title_key_decrypted_block(), write_flux_blocks(), write_flux_capture_payload(), write_geometry_block(), write_index_block(), write_media_tags(), write_metadata_block(), write_mode2_subheaders_block(), write_primary_ddt(), write_sector_prefix(), write_sector_prefix_ddt(), write_sector_subchannel(), write_sector_suffix(), write_sector_suffix_ddt(), write_single_level_ddt(), write_tape_ddt(), write_tape_file_block(), write_tape_partition_block(), and write_tracks_block().

Function Documentation

◆ aaru_log_reset()

void aaru_log_reset ( void )

Definition at line 229 of file log.c.

References aaru_log_reset(), AARU_LOG_TRACE, log_level, log_state_load(), LOG_STATE_READY, log_state_store(), LOG_STATE_UNINITIALIZED, and log_stream.

Referenced by aaru_log_reset().

◆ aaru_log_write()

void aaru_log_write ( int level,
const char * file,
int line,
const char * func,
const char * fmt,
... )

Writes one log line.

Called through the TRACE and FATAL macros in log.h.

The whole line is formatted into a buffer and emitted with a single fwrite(), which stdio locks per call, so lines from concurrent threads do not interleave.

Definition at line 173 of file log.c.

References AARU_LOG_FATAL, aaru_log_write(), log_init(), log_level, log_short_path(), LOG_STACK_BUFFER_SIZE, log_stream, and log_timestamp().

Referenced by aaru_log_write().