Cryptsetup logging

Macros
#define	CRYPT_LOG_NORMAL   0
#define	CRYPT_LOG_ERROR   1
#define	CRYPT_LOG_VERBOSE   2
#define	CRYPT_LOG_DEBUG   -1
#define	CRYPT_LOG_DEBUG_JSON   -2

Functions
void	crypt_set_log_callback (struct crypt_device *cd, void(*log)(int level, const char *msg, void *usrptr), void *usrptr)
void	crypt_log (struct crypt_device *cd, int level, const char *msg)
void	crypt_logf (struct crypt_device *cd, int level, const char *format,...)

Detailed Description

Set of functions and defines used in cryptsetup for logging purposes

Macro Definition Documentation

CRYPT_LOG_DEBUG

#define CRYPT_LOG_DEBUG   -1

debug log level - always on stdout

Examples

crypt_log_usage.c.

CRYPT_LOG_DEBUG_JSON

#define CRYPT_LOG_DEBUG_JSON   -2

debug log level - additional JSON output (for LUKS2)

CRYPT_LOG_ERROR

#define CRYPT_LOG_ERROR   1

error log level

Examples

crypt_log_usage.c.

CRYPT_LOG_NORMAL

#define CRYPT_LOG_NORMAL   0

normal log level

Examples

crypt_log_usage.c.

CRYPT_LOG_VERBOSE

#define CRYPT_LOG_VERBOSE   2

verbose log level

Examples

crypt_log_usage.c.

Function Documentation

crypt_log()

void crypt_log	(	struct crypt_device *	cd,
		int	level,
		const char *	msg
	)

Defines log function or use the default one otherwise.

See also

crypt_set_log_callback

Parameters

cd	crypt device handle
level	log level
msg	log message

Examples

crypt_log_usage.c.

crypt_logf()

void crypt_logf	(	struct crypt_device *	cd,
		int	level,
		const char *	format,
			...
	)

Log function with variable arguments.

Parameters

cd	crypt device handle
level	log level
format	formatted log message

crypt_set_log_callback()

void crypt_set_log_callback	(	struct crypt_device *	cd,
		void(*)(int level, const char *msg, void *usrptr)	log,
		void *	usrptr
	)

Set log function.

Parameters

cd	crypt device handle (can be NULL to set default log function)
log	user defined log function reference; use level for log level, msg for message, and usrptr for identification in callback
usrptr	provided identification in callback

Examples

crypt_log_usage.c.