datatypes.h 15.0 KB
Newer Older
1 2 3
/*
 * datatypes.h: management of structs for public data types
 *
4
 * Copyright (C) 2006-2014 Red Hat, Inc.
5 6 7 8 9 10 11 12 13 14 15 16
 *
 * 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
17
 * License along with this library.  If not, see
O
Osier Yang 已提交
18
 * <http://www.gnu.org/licenses/>.
19 20 21
 *
 */

22 23
#ifndef __VIR_DATATYPES_H_
# define __VIR_DATATYPES_H_
24

25
# include "internal.h"
26

27
# include "driver.h"
28
# include "virthread.h"
29 30 31 32 33 34 35 36 37 38 39 40 41 42
# include "virobject.h"

extern virClassPtr virConnectClass;
extern virClassPtr virDomainClass;
extern virClassPtr virDomainSnapshotClass;
extern virClassPtr virInterfaceClass;
extern virClassPtr virNetworkClass;
extern virClassPtr virNodeDeviceClass;
extern virClassPtr virNWFilterClass;
extern virClassPtr virSecretClass;
extern virClassPtr virStreamClass;
extern virClassPtr virStorageVolClass;
extern virClassPtr virStoragePoolClass;

43 44
# define virCheckConnectReturn(obj, retval)                             \
    do {                                                                \
E
Eric Blake 已提交
45
        if (!virObjectIsClass(obj, virConnectClass)) {                  \
46 47 48 49 50 51 52 53 54
            virReportErrorHelper(VIR_FROM_THIS, VIR_ERR_INVALID_CONN,   \
                                 __FILE__, __FUNCTION__, __LINE__,      \
                                 __FUNCTION__);                         \
            virDispatchError(NULL);                                     \
            return retval;                                              \
        }                                                               \
    } while (0)
# define virCheckConnectGoto(obj, label)                                \
    do {                                                                \
E
Eric Blake 已提交
55
        if (!virObjectIsClass(obj, virConnectClass)) {                  \
56 57 58 59 60 61
            virReportErrorHelper(VIR_FROM_THIS, VIR_ERR_INVALID_CONN,   \
                                 __FILE__, __FUNCTION__, __LINE__,      \
                                 __FUNCTION__);                         \
            goto label;                                                 \
        }                                                               \
    } while (0)
62 63 64 65

# define VIR_IS_DOMAIN(obj) \
    (virObjectIsClass((obj), virDomainClass))
# define VIR_IS_CONNECTED_DOMAIN(obj) \
E
Eric Blake 已提交
66
    (VIR_IS_DOMAIN(obj) && virObjectIsClass((obj)->conn, virConnectClass))
67 68 69 70

# define VIR_IS_NETWORK(obj) \
    (virObjectIsClass((obj), virNetworkClass))
# define VIR_IS_CONNECTED_NETWORK(obj) \
E
Eric Blake 已提交
71
    (VIR_IS_NETWORK(obj) && virObjectIsClass((obj)->conn, virConnectClass))
72 73 74 75

# define VIR_IS_INTERFACE(obj) \
    (virObjectIsClass((obj), virInterfaceClass))
# define VIR_IS_CONNECTED_INTERFACE(obj) \
E
Eric Blake 已提交
76
    (VIR_IS_INTERFACE(obj) && virObjectIsClass((obj)->conn, virConnectClass))
77 78 79 80

# define VIR_IS_STORAGE_POOL(obj) \
    (virObjectIsClass((obj), virStoragePoolClass))
# define VIR_IS_CONNECTED_STORAGE_POOL(obj) \
E
Eric Blake 已提交
81
    (VIR_IS_STORAGE_POOL(obj) && virObjectIsClass((obj)->conn, virConnectClass))
82 83 84 85

# define VIR_IS_STORAGE_VOL(obj) \
    (virObjectIsClass((obj), virStorageVolClass))
# define VIR_IS_CONNECTED_STORAGE_VOL(obj) \
E
Eric Blake 已提交
86
    (VIR_IS_STORAGE_VOL(obj) && virObjectIsClass((obj)->conn, virConnectClass))
87 88 89 90

# define VIR_IS_NODE_DEVICE(obj) \
    (virObjectIsClass((obj), virNodeDeviceClass))
# define VIR_IS_CONNECTED_NODE_DEVICE(obj) \
E
Eric Blake 已提交
91
    (VIR_IS_NODE_DEVICE(obj) && virObjectIsClass((obj)->conn, virConnectClass))
92 93 94 95

# define VIR_IS_SECRET(obj) \
    (virObjectIsClass((obj), virSecretClass))
# define VIR_IS_CONNECTED_SECRET(obj) \
E
Eric Blake 已提交
96
    (VIR_IS_SECRET(obj) && virObjectIsClass((obj)->conn, virConnectClass))
97 98 99 100

# define VIR_IS_STREAM(obj) \
    (virObjectIsClass((obj), virStreamClass))
# define VIR_IS_CONNECTED_STREAM(obj) \
E
Eric Blake 已提交
101
    (VIR_IS_STREAM(obj) && virObjectIsClass((obj)->conn, virConnectClass))
102 103 104 105

# define VIR_IS_NWFILTER(obj) \
    (virObjectIsClass((obj), virNWFilterClass))
# define VIR_IS_CONNECTED_NWFILTER(obj) \
E
Eric Blake 已提交
106
    (VIR_IS_NWFILTER(obj) && virObjectIsClass((obj)->conn, virConnectClass))
107 108 109 110 111

# define VIR_IS_SNAPSHOT(obj) \
    (virObjectIsClass((obj), virDomainSnapshotClass))
# define VIR_IS_DOMAIN_SNAPSHOT(obj) \
    (VIR_IS_SNAPSHOT(obj) && VIR_IS_DOMAIN((obj)->domain))
S
Stefan Berger 已提交
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
/* Helper macros to implement VIR_DOMAIN_DEBUG using just C99.  This
 * assumes you pass fewer than 15 arguments to VIR_DOMAIN_DEBUG, but
 * can easily be expanded if needed.
 *
 * Note that gcc provides extensions of "define a(b...) b" or
 * "define a(b,...) b,##__VA_ARGS__" as a means of eliding a comma
 * when no var-args are present, but we don't want to require gcc.
 */
# define VIR_ARG15(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, \
                   _11, _12, _13, _14, _15, ...) _15
# define VIR_HAS_COMMA(...) VIR_ARG15(__VA_ARGS__, \
                                      1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0)

/* Form the name VIR_DOMAIN_DEBUG_[01], then call that macro,
 * according to how many arguments are present.  Two-phase due to
 * macro expansion rules.  */
# define VIR_DOMAIN_DEBUG_EXPAND(a, b, ...)      \
    VIR_DOMAIN_DEBUG_PASTE(a, b, __VA_ARGS__)
# define VIR_DOMAIN_DEBUG_PASTE(a, b, ...)       \
    a##b(__VA_ARGS__)

/* Internal use only, when VIR_DOMAIN_DEBUG has one argument.  */
# define VIR_DOMAIN_DEBUG_0(dom)                 \
    VIR_DOMAIN_DEBUG_2(dom, "%s", "")

/* Internal use only, when VIR_DOMAIN_DEBUG has three or more arguments.  */
# define VIR_DOMAIN_DEBUG_1(dom, fmt, ...)       \
    VIR_DOMAIN_DEBUG_2(dom, ", " fmt, __VA_ARGS__)

/* Internal use only, with final format.  */
# define VIR_DOMAIN_DEBUG_2(dom, fmt, ...)                              \
    do {                                                                \
        char _uuidstr[VIR_UUID_STRING_BUFLEN];                          \
        const char *_domname = NULL;                                    \
                                                                        \
        if (!VIR_IS_DOMAIN(dom)) {                                      \
            memset(_uuidstr, 0, sizeof(_uuidstr));                      \
        } else {                                                        \
            virUUIDFormat((dom)->uuid, _uuidstr);                       \
            _domname = (dom)->name;                                     \
        }                                                               \
                                                                        \
        VIR_DEBUG("dom=%p, (VM: name=%s, uuid=%s)" fmt,                 \
                  dom, NULLSTR(_domname), _uuidstr, __VA_ARGS__);       \
    } while (0)

/**
 * VIR_DOMAIN_DEBUG:
 * @dom: domain
 * @fmt: optional format for additional information
 * @...: optional arguments corresponding to @fmt.
 */
# define VIR_DOMAIN_DEBUG(...)                          \
    VIR_DOMAIN_DEBUG_EXPAND(VIR_DOMAIN_DEBUG_,          \
                            VIR_HAS_COMMA(__VA_ARGS__), \
                            __VA_ARGS__)


172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
typedef struct _virConnectCloseCallbackData virConnectCloseCallbackData;
typedef virConnectCloseCallbackData *virConnectCloseCallbackDataPtr;

/**
 * Internal structure holding data related to connection close callbacks.
 */
struct _virConnectCloseCallbackData {
    virObjectLockable parent;

    virConnectPtr conn;
    virConnectCloseFunc callback;
    void *opaque;
    virFreeCallback freeCallback;
};

187 188 189 190 191 192
/**
 * _virConnect:
 *
 * Internal structure associated to a connection
 */
struct _virConnect {
193
    virObject object;
194 195 196 197
    /* All the variables from here, until the 'lock' declaration
     * are setup at time of connection open, and never changed
     * since. Thus no need to lock when accessing them
     */
E
Eric Blake 已提交
198
    unsigned int flags;     /* a set of connection flags */
M
Martin Kletzander 已提交
199
    virURIPtr uri;          /* connection URI */
200 201 202 203

    /* The underlying hypervisor driver and network driver. */
    virDriverPtr      driver;
    virNetworkDriverPtr networkDriver;
D
Daniel Veillard 已提交
204
    virInterfaceDriverPtr interfaceDriver;
205
    virStorageDriverPtr storageDriver;
206
    virNodeDeviceDriverPtr  nodeDeviceDriver;
207
    virSecretDriverPtr secretDriver;
S
Stefan Berger 已提交
208
    virNWFilterDriverPtr nwfilterDriver;
209 210 211 212 213 214 215

    /* Private data pointer which can be used by driver and
     * network driver as they wish.
     * NB: 'private' is a reserved word in C++.
     */
    void *            privateData;
    void *            networkPrivateData;
D
Daniel Veillard 已提交
216
    void *            interfacePrivateData;
217
    void *            storagePrivateData;
218
    void *            nodeDevicePrivateData;
219
    void *            secretPrivateData;
S
Stefan Berger 已提交
220
    void *            nwfilterPrivateData;
221 222 223 224 225 226 227

    /*
     * The lock mutex must be acquired before accessing/changing
     * any of members following this point, or changing the ref
     * count of any virDomain/virNetwork object associated with
     * this connection
     */
228
    virMutex lock;
229 230 231 232 233 234

    /* Per-connection error. */
    virError err;           /* the last error */
    virErrorFunc handler;   /* associated handlet */
    void *userData;         /* the user data */

235
    /* Per-connection close callback */
236
    virConnectCloseCallbackDataPtr closeCallback;
237 238 239 240 241 242 243 244
};

/**
* _virDomain:
*
* Internal structure associated to a domain
*/
struct _virDomain {
245
    virObject object;
246 247 248 249 250 251 252 253 254 255 256 257
    virConnectPtr conn;                  /* pointer back to the connection */
    char *name;                          /* the domain external name */
    int id;                              /* the domain ID */
    unsigned char uuid[VIR_UUID_BUFLEN]; /* the domain unique identifier */
};

/**
* _virNetwork:
*
* Internal structure associated to a domain
*/
struct _virNetwork {
258
    virObject object;
259 260 261 262 263
    virConnectPtr conn;                  /* pointer back to the connection */
    char *name;                          /* the network external name */
    unsigned char uuid[VIR_UUID_BUFLEN]; /* the network unique identifier */
};

D
Daniel Veillard 已提交
264 265 266 267 268 269
/**
* _virInterface:
*
* Internal structure associated to a physical host interface
*/
struct _virInterface {
270
    virObject object;
D
Daniel Veillard 已提交
271 272 273 274 275
    virConnectPtr conn;                  /* pointer back to the connection */
    char *name;                          /* the network external name */
    char *mac;                           /* the interface MAC address */
};

276 277 278 279 280 281
/**
* _virStoragePool:
*
* Internal structure associated to a storage pool
*/
struct _virStoragePool {
282
    virObject object;
283 284 285
    virConnectPtr conn;                  /* pointer back to the connection */
    char *name;                          /* the storage pool external name */
    unsigned char uuid[VIR_UUID_BUFLEN]; /* the storage pool unique identifier */
286 287 288 289 290 291 292

    /* Private data pointer which can be used by driver as they wish.
     * Cleanup function pointer can be hooked to provide custom cleanup
     * operation.
     */
    void *privateData;
    virFreeCallback privateDataFreeFunc;
293 294 295 296 297 298 299 300
};

/**
* _virStorageVol:
*
* Internal structure associated to a storage volume
*/
struct _virStorageVol {
301
    virObject object;
302 303 304
    virConnectPtr conn;                  /* pointer back to the connection */
    char *pool;                          /* Pool name of owner */
    char *name;                          /* the storage vol external name */
305
    char *key;                           /* unique key for storage vol */
306 307 308 309 310 311 312

    /* Private data pointer which can be used by driver as they wish.
     * Cleanup function pointer can be hooked to provide custom cleanup
     * operation.
     */
    void *privateData;
    virFreeCallback privateDataFreeFunc;
313 314
};

315 316 317 318 319 320
/**
 * _virNodeDevice:
 *
 * Internal structure associated with a node device
 */
struct _virNodeDevice {
321
    virObject object;
322 323
    virConnectPtr conn;                 /* pointer back to the connection */
    char *name;                         /* device name (unique on node) */
324
    char *parent;                       /* parent device name */
325 326
};

327 328 329 330 331 332
/**
 * _virSecret:
 *
 * Internal structure associated with a secret
 */
struct _virSecret {
333
    virObject object;
334
    virConnectPtr conn;                  /* pointer back to the connection */
335
    unsigned char uuid[VIR_UUID_BUFLEN]; /* the domain unique identifier */
336 337
    int usageType;                       /* the type of usage */
    char *usageID;                       /* the usage's unique identifier */
338 339
};

340

341 342 343 344 345 346 347 348 349
typedef int (*virStreamAbortFunc)(virStreamPtr, void *opaque);
typedef int (*virStreamFinishFunc)(virStreamPtr, void *opaque);

/**
 * _virStream:
 *
 * Internal structure associated with an input stream
 */
struct _virStream {
350
    virObject object;
351
    virConnectPtr conn;
E
Eric Blake 已提交
352
    unsigned int flags;
353 354 355 356 357

    virStreamDriverPtr driver;
    void *privateData;
};

C
Chris Lalancette 已提交
358 359 360 361 362 363
/**
 * _virDomainSnapshot
 *
 * Internal structure associated with a domain snapshot
 */
struct _virDomainSnapshot {
364
    virObject object;
C
Chris Lalancette 已提交
365 366 367
    char *name;
    virDomainPtr domain;
};
368

369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
/**
* _virNWFilter:
*
* Internal structure associated to a network filter
*/
struct _virNWFilter {
    virObject object;
    virConnectPtr conn;                  /* pointer back to the connection */
    char *name;                          /* the network filter external name */
    unsigned char uuid[VIR_UUID_BUFLEN]; /* the network filter unique identifier */
};


/*
 * Helper APIs for allocating new object instances
 */
385 386

virConnectPtr virGetConnect(void);
D
Daniel P. Berrange 已提交
387
virDomainPtr virGetDomain(virConnectPtr conn,
O
Osier Yang 已提交
388 389
                          const char *name,
                          const unsigned char *uuid);
D
Daniel P. Berrange 已提交
390
virNetworkPtr virGetNetwork(virConnectPtr conn,
O
Osier Yang 已提交
391 392
                            const char *name,
                            const unsigned char *uuid);
D
Daniel Veillard 已提交
393 394 395
virInterfacePtr virGetInterface(virConnectPtr conn,
                                const char *name,
                                const char *mac);
D
Daniel P. Berrange 已提交
396
virStoragePoolPtr virGetStoragePool(virConnectPtr conn,
397 398 399 400
                                    const char *name,
                                    const unsigned char *uuid,
                                    void *privateData,
                                    virFreeCallback freeFunc);
D
Daniel P. Berrange 已提交
401
virStorageVolPtr virGetStorageVol(virConnectPtr conn,
402 403
                                     const char *pool,
                                    const char *name,
404 405 406
                                    const char *key,
                                    void *privateData,
                                    virFreeCallback freeFunc);
407 408
virNodeDevicePtr virGetNodeDevice(virConnectPtr conn,
                                  const char *name);
409
virSecretPtr virGetSecret(virConnectPtr conn,
410 411 412
                          const unsigned char *uuid,
                          int usageType,
                          const char *usageID);
413
virStreamPtr virGetStream(virConnectPtr conn);
S
Stefan Berger 已提交
414
virNWFilterPtr virGetNWFilter(virConnectPtr conn,
O
Osier Yang 已提交
415 416
                              const char *name,
                              const unsigned char *uuid);
C
Chris Lalancette 已提交
417 418 419
virDomainSnapshotPtr virGetDomainSnapshot(virDomainPtr domain,
                                          const char *name);

420
#endif /* __VIR_DATATYPES_H__ */