include/log.h: add comments for public APIs (ec7ef532) · Commits · Public Repositories / spdk

include/spdk/log.h

+54 −2

Original line number	Diff line number	Diff line
		@@ -66,13 +66,17 @@ enum spdk_log_level {
		};

		/**
		* Set the threshold to log messages. Messages with a higher
		* Set the log level threshold to log messages. Messages with a higher
		* level than this are ignored.
		*
		* \param level Log level threshold to set to log messages.
		*/
		void spdk_log_set_level(enum spdk_log_level level);

		/**
		* Get the current log threshold.
		* Get the current log level threshold.
		*
		* \return the current log level threshold.
		*/
		enum spdk_log_level spdk_log_get_level(void);

		@@ -80,11 +84,15 @@ enum spdk_log_level spdk_log_get_level(void);
		* Set the current log level threshold for printing to stderr.
		* Messages with a level less than or equal to this level
		* are also printed to stderr.
		*
		* \param level Log level threshold for printing to stderr.
		*/
		void spdk_log_set_print_level(enum spdk_log_level level);

		/**
		* Get the current log level print threshold.
		*
		* \return the current log level print threshold.
		*/
		enum spdk_log_level spdk_log_get_print_level(void);

		@@ -95,15 +103,59 @@ enum spdk_log_level spdk_log_get_print_level(void);
		#define SPDK_ERRLOG(...) \
		spdk_log(SPDK_LOG_ERROR, __FILE__, __LINE__, __func__, __VA_ARGS__)

		/**
		* Write messages to the log file.
		*
		* \param level Log level threshold.
		* \param file Name of the current source file.
		* \param line Current source line number.
		* \param func Current source function name.
		* \param format Format string to the message.
		*/
		void spdk_log(enum spdk_log_level level, const char file, const int line, const char func,
		const char *format, ...) __attribute__((__format__(__printf__, 5, 6)));

		/**
		* Dump the trace to a file.
		*
		* \param fp File to hold the trace.
		* \param label Label to print to the file.
		* \param buf Buffer that holds the trace information.
		* \param len Length of trace to dump.
		*/
		void spdk_trace_dump(FILE fp, const char label, const void *buf, size_t len);

		/**
		* Check whether the trace flag exists and is enabled.
		*
		* \return true if enabled, or false otherwise.
		*/
		bool spdk_log_get_trace_flag(const char *flag);

		/**
		* Enable the trace flag.
		*
		* \param flag Trace flag to be enabled.
		*
		* \return 0 on success, -1 on failure.
		*/
		int spdk_log_set_trace_flag(const char *flag);

		/**
		* Clear a trace flag.
		*
		* \flag Trace flag to clear.
		*
		* \return 0 on success, -1 on failure.
		*/
		int spdk_log_clear_trace_flag(const char *flag);

		/**
		* Show all the log trace flags and their usage.
		*
		* \param f File to hold all the flags' information.
		* \param trace_arg Command line option to set/enable the trace flag.
		*/
		void spdk_tracelog_usage(FILE f, const char trace_arg);

		#ifdef __cplusplus

Admin message