2017-10-12 14:13:42 +03:00
|
|
|
/*
|
|
|
|
* Copyright © 2017 Pekka Paalanen <pq@iki.fi>
|
|
|
|
*
|
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
|
|
* a copy of this software and associated documentation files (the
|
|
|
|
* "Software"), to deal in the Software without restriction, including
|
|
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
|
|
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
|
|
* permit persons to whom the Software is furnished to do so, subject to
|
|
|
|
* the following conditions:
|
|
|
|
*
|
|
|
|
* The above copyright notice and this permission notice (including the
|
|
|
|
* next paragraph) shall be included in all copies or substantial
|
|
|
|
* portions of the Software.
|
|
|
|
*
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
|
|
|
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
|
|
|
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
|
|
* SOFTWARE.
|
|
|
|
*/
|
|
|
|
|
2019-06-21 22:49:18 +03:00
|
|
|
#ifndef WESTON_LOG_H
|
|
|
|
#define WESTON_LOG_H
|
2017-10-12 14:13:42 +03:00
|
|
|
|
|
|
|
#include <stdbool.h>
|
|
|
|
#include <stdlib.h>
|
|
|
|
#include <stdarg.h>
|
2019-06-22 20:12:24 +03:00
|
|
|
#include <stdint.h>
|
|
|
|
#include <stdio.h>
|
2017-10-12 14:13:42 +03:00
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
|
|
|
struct weston_compositor;
|
2019-04-17 12:35:38 +03:00
|
|
|
struct weston_log_context;
|
2019-04-07 19:07:16 +03:00
|
|
|
struct wl_display;
|
2019-06-22 00:29:31 +03:00
|
|
|
struct weston_log_subscriber;
|
2019-07-17 15:43:53 +03:00
|
|
|
struct weston_log_subscription;
|
2017-10-12 14:13:42 +03:00
|
|
|
|
|
|
|
void
|
|
|
|
weston_compositor_enable_debug_protocol(struct weston_compositor *);
|
|
|
|
|
2018-12-14 00:03:30 +03:00
|
|
|
bool
|
|
|
|
weston_compositor_is_debug_protocol_enabled(struct weston_compositor *);
|
|
|
|
|
2019-04-17 13:05:38 +03:00
|
|
|
struct weston_log_scope;
|
2017-10-12 14:13:42 +03:00
|
|
|
struct weston_debug_stream;
|
|
|
|
|
2019-04-17 13:05:38 +03:00
|
|
|
/** weston_log_scope callback
|
2017-10-12 14:13:42 +03:00
|
|
|
*
|
2019-07-24 11:38:46 +03:00
|
|
|
* @param sub The subscription.
|
2019-06-21 14:20:15 +03:00
|
|
|
* @param user_data The \c user_data argument given to
|
2019-12-26 22:03:04 +03:00
|
|
|
* weston_log_ctx_add_log_scope() or weston_compositor_add_log_scope().
|
2017-10-12 14:13:42 +03:00
|
|
|
*
|
2019-06-21 14:20:15 +03:00
|
|
|
* @memberof weston_log_scope
|
2017-10-12 14:13:42 +03:00
|
|
|
*/
|
2019-07-17 15:43:53 +03:00
|
|
|
typedef void (*weston_log_scope_cb)(struct weston_log_subscription *sub,
|
|
|
|
void *user_data);
|
2017-10-12 14:13:42 +03:00
|
|
|
|
2019-04-17 13:05:38 +03:00
|
|
|
struct weston_log_scope *
|
2019-12-18 21:21:03 +03:00
|
|
|
weston_log_ctx_add_log_scope(struct weston_log_context *log_ctx,
|
|
|
|
const char *name,
|
|
|
|
const char *description,
|
|
|
|
weston_log_scope_cb new_subscription,
|
|
|
|
weston_log_scope_cb destroy_subscription,
|
|
|
|
void *user_data);
|
2017-10-12 14:13:42 +03:00
|
|
|
|
2019-12-26 22:03:04 +03:00
|
|
|
struct weston_log_scope *
|
|
|
|
weston_compositor_add_log_scope(struct weston_compositor *compositor,
|
|
|
|
const char *name,
|
|
|
|
const char *description,
|
|
|
|
weston_log_scope_cb new_subscription,
|
|
|
|
weston_log_scope_cb destroy_subscription,
|
|
|
|
void *user_data);
|
|
|
|
|
2017-10-12 14:13:42 +03:00
|
|
|
void
|
2019-12-18 21:52:18 +03:00
|
|
|
weston_log_scope_destroy(struct weston_log_scope *scope);
|
2017-10-12 14:13:42 +03:00
|
|
|
|
|
|
|
bool
|
2019-04-17 13:47:06 +03:00
|
|
|
weston_log_scope_is_enabled(struct weston_log_scope *scope);
|
2017-10-12 14:13:42 +03:00
|
|
|
|
|
|
|
void
|
2019-04-17 13:47:06 +03:00
|
|
|
weston_log_scope_write(struct weston_log_scope *scope,
|
2017-10-12 14:13:42 +03:00
|
|
|
const char *data, size_t len);
|
|
|
|
|
2019-08-06 17:37:51 +03:00
|
|
|
int
|
2019-04-17 13:47:06 +03:00
|
|
|
weston_log_scope_vprintf(struct weston_log_scope *scope,
|
2017-10-12 14:13:42 +03:00
|
|
|
const char *fmt, va_list ap);
|
|
|
|
|
2019-08-06 17:37:51 +03:00
|
|
|
int
|
2019-04-17 13:47:06 +03:00
|
|
|
weston_log_scope_printf(struct weston_log_scope *scope,
|
2017-10-12 14:13:42 +03:00
|
|
|
const char *fmt, ...)
|
|
|
|
__attribute__ ((format (printf, 2, 3)));
|
|
|
|
void
|
2019-12-26 18:44:06 +03:00
|
|
|
weston_log_subscription_printf(struct weston_log_subscription *sub,
|
2019-07-17 15:43:53 +03:00
|
|
|
const char *fmt, ...)
|
|
|
|
__attribute__ ((format (printf, 2, 3)));
|
|
|
|
void
|
2019-06-21 14:20:15 +03:00
|
|
|
weston_log_scope_complete(struct weston_log_scope *scope);
|
2017-10-12 14:13:42 +03:00
|
|
|
|
2019-07-17 15:43:53 +03:00
|
|
|
void
|
|
|
|
weston_log_subscription_complete(struct weston_log_subscription *sub);
|
|
|
|
|
2017-10-12 14:13:42 +03:00
|
|
|
char *
|
2019-04-17 13:47:06 +03:00
|
|
|
weston_log_scope_timestamp(struct weston_log_scope *scope,
|
2017-10-12 14:13:42 +03:00
|
|
|
char *buf, size_t len);
|
2022-03-09 02:29:55 +03:00
|
|
|
char *
|
|
|
|
weston_log_timestamp(char *buf, size_t len, int *cached_tm_mday);
|
2017-10-12 14:13:42 +03:00
|
|
|
|
2020-02-06 22:43:51 +03:00
|
|
|
void
|
|
|
|
weston_log_subscriber_destroy(struct weston_log_subscriber *subscriber);
|
|
|
|
|
2019-06-22 00:29:31 +03:00
|
|
|
void
|
|
|
|
weston_log_subscribe(struct weston_log_context *log_ctx,
|
|
|
|
struct weston_log_subscriber *subscriber,
|
|
|
|
const char *scope_name);
|
|
|
|
|
2019-06-22 20:12:24 +03:00
|
|
|
struct weston_log_subscriber *
|
|
|
|
weston_log_subscriber_create_log(FILE *dump_to);
|
|
|
|
|
2019-06-23 23:24:34 +03:00
|
|
|
struct weston_log_subscriber *
|
|
|
|
weston_log_subscriber_create_flight_rec(size_t size);
|
|
|
|
|
|
|
|
void
|
|
|
|
weston_log_subscriber_display_flight_rec(struct weston_log_subscriber *sub);
|
|
|
|
|
2019-08-06 19:22:53 +03:00
|
|
|
struct weston_log_subscription *
|
|
|
|
weston_log_subscription_iterate(struct weston_log_scope *scope,
|
|
|
|
struct weston_log_subscription *sub_iter);
|
|
|
|
|
2019-07-18 17:04:37 +03:00
|
|
|
void
|
|
|
|
weston_log_flight_recorder_display_buffer(FILE *file);
|
|
|
|
|
2023-05-29 16:30:02 +03:00
|
|
|
const char *
|
|
|
|
weston_log_scope_get_description(struct weston_log_scope *scope);
|
|
|
|
|
|
|
|
const char *
|
|
|
|
weston_log_scope_get_name(struct weston_log_scope *scope);
|
|
|
|
|
|
|
|
struct weston_log_scope *
|
|
|
|
weston_log_scopes_iterate(struct weston_log_context *log_ctx,
|
|
|
|
struct weston_log_scope *nscope);
|
|
|
|
|
2017-10-12 14:13:42 +03:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2019-06-21 22:49:18 +03:00
|
|
|
#endif /* WESTON_LOG_H */
|