blob: 4edd956102e0b49072a96d86ec05f43c322ea5f1 (
plain)
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
|
/*
* Copyright (c) 2012 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef MEMORY_H
#define MEMORY_H 1
/* Memory usage monitor.
*
* This is intended to be called as part of a daemon's main loop. After some
* time to allow the daemon to allocate an initial memory usage, it logs some
* memory usage information (most of which must actually be provided by the
* client). At intervals, if the daemon's memory usage has grown
* significantly, it again logs information.
*
* The monitor also has a unixctl interface.
*
* Intended usage in the program's main loop is like this:
*
* for (;;) {
* memory_run();
* if (memory_should_report()) {
* struct simap usage;
*
* simap_init(&usage);
* ...fill in 'usage' with meaningful statistics...
* memory_report(&usage);
* simap_destroy(&usage);
* }
*
* ...
*
* memory_wait();
* poll_block();
* }
*/
#include <stdbool.h>
struct simap;
void memory_run(void);
void memory_wait(void);
bool memory_should_report(void);
void memory_report(const struct simap *usage);
#endif /* memory.h */
|