Add utils_expand_path_keep_symlink fonction
[lttng-tools.git] / include / lttng / health-internal.h
CommitLineData
55d09795
MD
1#ifndef HEALTH_INTERNAL_H
2#define HEALTH_INTERNAL_H
3
44a5e5eb
DG
4/*
5 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
55d09795 6 * Copyright (C) 2013 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
44a5e5eb
DG
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License, version 2 only, as
10 * published by the Free Software Foundation.
11 *
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * more details.
16 *
17 * You should have received a copy of the GNU General Public License along with
18 * this program; if not, write to the Free Software Foundation, Inc., 51
19 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 */
21
86acf0da 22#include <assert.h>
389fbf04 23#include <common/compat/time.h>
927ca06a
DG
24#include <pthread.h>
25#include <urcu/tls-compat.h>
44a5e5eb 26#include <urcu/uatomic.h>
927ca06a 27#include <urcu/list.h>
d74df422 28#include <lttng/health.h>
6c71277b 29#include <common/macros.h>
44a5e5eb
DG
30
31/*
32 * These are the value added to the current state depending of the position in
33 * the thread where is either waiting on a poll() or running in the code.
34 */
139ac872
MD
35#define HEALTH_POLL_VALUE (1UL << 0)
36#define HEALTH_CODE_VALUE (1UL << 1)
44a5e5eb 37
139ac872
MD
38#define HEALTH_IS_IN_POLL(x) ((x) & HEALTH_POLL_VALUE)
39
8782cc74
MD
40struct health_app;
41
139ac872 42enum health_flags {
9edd46e7 43 HEALTH_ERROR = (1U << 0),
927ca06a
DG
44};
45
44a5e5eb 46struct health_state {
139ac872 47 /*
8809eec0 48 * last counter and last_time are only read and updated by the health_check
139ac872
MD
49 * thread (single updater).
50 */
51 unsigned long last;
8809eec0
MD
52 struct timespec last_time;
53
139ac872
MD
54 /*
55 * current and flags are updated by multiple threads concurrently.
56 */
57 unsigned long current; /* progress counter, updated atomically */
58 enum health_flags flags; /* other flags, updated atomically */
8782cc74 59 int type; /* Indicates the nature of the thread. */
927ca06a
DG
60 /* Node of the global TLS state list. */
61 struct cds_list_head node;
44a5e5eb
DG
62};
63
0c89d795
MD
64enum health_cmd {
65 HEALTH_CMD_CHECK = 0,
66};
67
68struct health_comm_msg {
0c89d795
MD
69 uint32_t cmd; /* enum health_cmd */
70} LTTNG_PACKED;
71
72struct health_comm_reply {
6c71277b 73 uint64_t ret_code; /* bitmask of threads in bad health */
0c89d795
MD
74} LTTNG_PACKED;
75
927ca06a
DG
76/* Declare TLS health state. */
77extern DECLARE_URCU_TLS(struct health_state, health_state);
78
44a5e5eb 79/*
a78af745
DG
80 * Update current counter by 1 to indicate that the thread entered or left a
81 * blocking state caused by a poll(). If the counter's value is not an even
82 * number (meaning a code execution flow), an assert() is raised.
44a5e5eb 83 */
a78af745 84static inline void health_poll_entry(void)
44a5e5eb 85{
a78af745
DG
86 /* Code MUST be in code execution state which is an even number. */
87 assert(!(uatomic_read(&URCU_TLS(health_state).current)
88 & HEALTH_POLL_VALUE));
89
90 uatomic_add(&URCU_TLS(health_state).current, HEALTH_POLL_VALUE);
91}
92
93/*
94 * Update current counter by 1 indicating the exit of a poll or blocking call.
95 * If the counter's value is not an odd number (a poll execution), an assert()
96 * is raised.
97 */
98static inline void health_poll_exit(void)
99{
100 /* Code MUST be in poll execution state which is an odd number. */
101 assert(uatomic_read(&URCU_TLS(health_state).current)
102 & HEALTH_POLL_VALUE);
103
927ca06a 104 uatomic_add(&URCU_TLS(health_state).current, HEALTH_POLL_VALUE);
44a5e5eb
DG
105}
106
107/*
139ac872
MD
108 * Update current counter by 2 indicates progress in execution of a
109 * thread.
44a5e5eb 110 */
840cb59c 111static inline void health_code_update(void)
44a5e5eb 112{
927ca06a 113 uatomic_add(&URCU_TLS(health_state).current, HEALTH_CODE_VALUE);
139ac872 114}
44a5e5eb 115
139ac872
MD
116/*
117 * Set health "error" flag.
118 */
840cb59c 119static inline void health_error(void)
139ac872 120{
927ca06a 121 uatomic_or(&URCU_TLS(health_state).flags, HEALTH_ERROR);
44a5e5eb
DG
122}
123
8782cc74
MD
124struct health_app *health_app_create(int nr_types);
125void health_app_destroy(struct health_app *ha);
126int health_check_state(struct health_app *ha, int type);
127void health_register(struct health_app *ha, int type);
128void health_unregister(struct health_app *ha);
44a5e5eb 129
55d09795 130#endif /* HEALTH_INTERNAL_H */
This page took 0.058517 seconds and 5 git commands to generate.