aboutsummaryrefslogtreecommitdiffstats
path: root/tools/libxen/include/xen/api/xen_vbd_metrics.h
blob: 1cb1a2bc850795014bd8bb4dc51e2946937c2bf0 (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
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
/*
 * Copyright (c) 2006-2007, XenSource Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 */

#ifndef XEN_VBD_METRICS_H
#define XEN_VBD_METRICS_H

#include <xen/api/xen_common.h>
#include <xen/api/xen_vbd_metrics_decl.h>


/*
 * The VBD_metrics class.
 * 
 * The metrics associated with a virtual block device.
 */


/**
 * Free the given xen_vbd_metrics.  The given handle must have been
 * allocated by this library.
 */
extern void
xen_vbd_metrics_free(xen_vbd_metrics vbd_metrics);


typedef struct xen_vbd_metrics_set
{
    size_t size;
    xen_vbd_metrics *contents[];
} xen_vbd_metrics_set;

/**
 * Allocate a xen_vbd_metrics_set of the given size.
 */
extern xen_vbd_metrics_set *
xen_vbd_metrics_set_alloc(size_t size);

/**
 * Free the given xen_vbd_metrics_set.  The given set must have been
 * allocated by this library.
 */
extern void
xen_vbd_metrics_set_free(xen_vbd_metrics_set *set);


typedef struct xen_vbd_metrics_record
{
    xen_vbd_metrics handle;
    char *uuid;
    double io_read_kbs;
    double io_write_kbs;
    time_t last_updated;
} xen_vbd_metrics_record;

/**
 * Allocate a xen_vbd_metrics_record.
 */
extern xen_vbd_metrics_record *
xen_vbd_metrics_record_alloc(void);

/**
 * Free the given xen_vbd_metrics_record, and all referenced values. 
 * The given record must have been allocated by this library.
 */
extern void
xen_vbd_metrics_record_free(xen_vbd_metrics_record *record);


typedef struct xen_vbd_metrics_record_opt
{
    bool is_record;
    union
    {
        xen_vbd_metrics handle;
        xen_vbd_metrics_record *record;
    } u;
} xen_vbd_metrics_record_opt;

/**
 * Allocate a xen_vbd_metrics_record_opt.
 */
extern xen_vbd_metrics_record_opt *
xen_vbd_metrics_record_opt_alloc(void);

/**
 * Free the given xen_vbd_metrics_record_opt, and all referenced
 * values.  The given record_opt must have been allocated by this library.
 */
extern void
xen_vbd_metrics_record_opt_free(xen_vbd_metrics_record_opt *record_opt);


typedef struct xen_vbd_metrics_record_set
{
    size_t size;
    xen_vbd_metrics_record *contents[];
} xen_vbd_metrics_record_set;

/**
 * Allocate a xen_vbd_metrics_record_set of the given size.
 */
extern xen_vbd_metrics_record_set *
xen_vbd_metrics_record_set_alloc(size_t size);

/**
 * Free the given xen_vbd_metrics_record_set, and all referenced
 * values.  The given set must have been allocated by this library.
 */
extern void
xen_vbd_metrics_record_set_free(xen_vbd_metrics_record_set *set);



typedef struct xen_vbd_metrics_record_opt_set
{
    size_t size;
    xen_vbd_metrics_record_opt *contents[];
} xen_vbd_metrics_record_opt_set;

/**
 * Allocate a xen_vbd_metrics_record_opt_set of the given size.
 */
extern xen_vbd_metrics_record_opt_set *
xen_vbd_metrics_record_opt_set_alloc(size_t size);

/**
 * Free the given xen_vbd_metrics_record_opt_set, and all referenced
 * values.  The given set must have been allocated by this library.
 */
extern void
xen_vbd_metrics_record_opt_set_free(xen_vbd_metrics_record_opt_set *set);


/**
 * Get a record containing the current state of the given VBD_metrics.
 */
extern bool
xen_vbd_metrics_get_record(xen_session *session, xen_vbd_metrics_record **result, xen_vbd_metrics vbd_metrics);


/**
 * Get a reference to the VBD_metrics instance with the specified UUID.
 */
extern bool
xen_vbd_metrics_get_by_uuid(xen_session *session, xen_vbd_metrics *result, char *uuid);


/**
 * Get the uuid field of the given VBD_metrics.
 */
extern bool
xen_vbd_metrics_get_uuid(xen_session *session, char **result, xen_vbd_metrics vbd_metrics);


/**
 * Get the io/read_kbs field of the given VBD_metrics.
 */
extern bool
xen_vbd_metrics_get_io_read_kbs(xen_session *session, double *result, xen_vbd_metrics vbd_metrics);


/**
 * Get the io/write_kbs field of the given VBD_metrics.
 */
extern bool
xen_vbd_metrics_get_io_write_kbs(xen_session *session, double *result, xen_vbd_metrics vbd_metrics);


/**
 * Get the last_updated field of the given VBD_metrics.
 */
extern bool
xen_vbd_metrics_get_last_updated(xen_session *session, time_t *result, xen_vbd_metrics vbd_metrics);


/**
 * Return a list of all the VBD_metrics instances known to the system.
 */
extern bool
xen_vbd_metrics_get_all(xen_session *session, struct xen_vbd_metrics_set **result);


#endif