1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSAPICPUUsageReporting
*
* @brief This header file provides the CPU usage reporting API.
*/
/*
* Copyright (C) 2021 embedded brains GmbH & Co. KG
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*
* This file is part of the RTEMS quality process and was automatically
* generated. If you find something that needs to be fixed or
* worded better please post a report or patch to an RTEMS mailing list
* or raise a bug report:
*
* https://www.rtems.org/bugs.html
*
* For information on updating and regenerating please refer to the How-To
* section in the Software Requirements Engineering chapter of the
* RTEMS Software Engineering manual. The manual is provided as a part of
* a release. For development sources please refer to the online
* documentation at:
*
* https://docs.rtems.org
*/
/* Generated from spec:/rtems/cpuuse/if/header */
#ifndef _RTEMS_CPUUSE_H
#define _RTEMS_CPUUSE_H
#ifdef __cplusplus
extern "C" {
#endif
/* Generated from spec:/rtems/cpuuse/if/group */
/**
* @defgroup RTEMSAPICPUUsageReporting CPU Usage Reporting
*
* @ingroup RTEMSAPI
*
* @brief The CPU usage reporting directives can be used to report and reset
* the CPU usage of threads.
*/
/* Generated from spec:/rtems/cpuuse/if/printer */
/* Forward declaration */
struct rtems_printer;
/* Generated from spec:/rtems/cpuuse/if/cpu-info-report */
/**
* @ingroup RTEMSAPICPUUsageReporting
*
* @brief Reports the CPU information using the printer plugin.
*
* @param printer is the printer plugin to output the report.
*
* @return Returns the number of characters printed.
*
* @par Constraints
* @parblock
* The following constraints apply to this directive:
*
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
* @endparblock
*/
int rtems_cpu_info_report( const struct rtems_printer *printer );
/* Generated from spec:/rtems/cpuuse/if/report */
/**
* @ingroup RTEMSAPICPUUsageReporting
*
* @brief Reports the CPU usage of each thread using the printk() printer.
*
* @par Notes
* See also rtems_cpu_usage_report_with_plugin().
*
* @par Constraints
* @parblock
* The following constraints apply to this directive:
*
* * The directive may be called from within device driver initialization
* context.
*
* * The directive may be called from within task context.
*
* * The directive may obtain and release the object allocator mutex. This may
* cause the calling task to be preempted.
* @endparblock
*/
void rtems_cpu_usage_report( void );
/* Generated from spec:/rtems/cpuuse/if/report-with-plugin */
/**
* @ingroup RTEMSAPICPUUsageReporting
*
* @brief Reports the CPU usage of each thread using the printer plugin.
*
* @param printer is the printer plugin to output the report.
*
* @par Constraints
* @parblock
* The following constraints apply to this directive:
*
* * The directive may be called from within device driver initialization
* context.
*
* * The directive may be called from within task context.
*
* * The directive may obtain and release the object allocator mutex. This may
* cause the calling task to be preempted.
* @endparblock
*/
void rtems_cpu_usage_report_with_plugin( const struct rtems_printer *printer );
/* Generated from spec:/rtems/cpuuse/if/reset */
/**
* @ingroup RTEMSAPICPUUsageReporting
*
* @brief Resets the CPU usage of each thread.
*
* @par Constraints
* @parblock
* The following constraints apply to this directive:
*
* * The directive may be called from within device driver initialization
* context.
*
* * The directive may be called from within task context.
*
* * The directive may obtain and release the object allocator mutex. This may
* cause the calling task to be preempted.
* @endparblock
*/
void rtems_cpu_usage_reset( void );
/* Generated from spec:/rtems/cpuuse/if/top */
/**
* @ingroup RTEMSAPICPUUsageReporting
*
* @brief Starts an interactive CPU usage reporting using the printk() printer.
*
* @par Notes
* See also rtems_cpu_usage_top_with_plugin().
*
* @par Constraints
* @parblock
* The following constraints apply to this directive:
*
* * The directive may be called from within task context.
*
* * The directive may obtain and release the object allocator mutex. This may
* cause the calling task to be preempted.
*
* * The directive sends a request to another task and waits for a response.
* This may cause the calling task to be blocked and unblocked.
* @endparblock
*/
void rtems_cpu_usage_top( void );
/* Generated from spec:/rtems/cpuuse/if/top-with-plugin */
/**
* @ingroup RTEMSAPICPUUsageReporting
*
* @brief Starts an interactive CPU usage reporting using the printer plugin.
*
* @param printer is the printer plugin to output the report.
*
* @par Notes
* The directive starts a task to do the reporting. The getchar() function is
* used to get commands from the user.
*
* @par Constraints
* @parblock
* The following constraints apply to this directive:
*
* * The directive may be called from within task context.
*
* * The directive may obtain and release the object allocator mutex. This may
* cause the calling task to be preempted.
*
* * The directive sends a request to another task and waits for a response.
* This may cause the calling task to be blocked and unblocked.
* @endparblock
*/
void rtems_cpu_usage_top_with_plugin( const struct rtems_printer *printer );
#ifdef __cplusplus
}
#endif
#endif /* _RTEMS_CPUUSE_H */
|
