2005-11-02 13:19:10 +00:00
|
|
|
/*
|
|
|
|
* internal.h: internal definitions just used by code from the library
|
|
|
|
*/
|
|
|
|
|
2005-12-05 11:16:07 +00:00
|
|
|
#ifndef __VIR_INTERNAL_H__
|
|
|
|
#define __VIR_INTERNAL_H__
|
2005-11-02 13:19:10 +00:00
|
|
|
|
2006-01-13 16:41:01 +00:00
|
|
|
#include <sys/types.h>
|
|
|
|
#include <sys/socket.h>
|
|
|
|
#include <sys/un.h>
|
|
|
|
#include <netinet/in.h>
|
|
|
|
#include <netinet/tcp.h>
|
2006-04-05 09:31:29 +00:00
|
|
|
#include <libxml/threads.h>
|
2006-01-13 16:41:01 +00:00
|
|
|
|
2005-12-13 16:22:05 +00:00
|
|
|
#include "hash.h"
|
2006-06-26 15:02:18 +00:00
|
|
|
#include "libvirt/libvirt.h"
|
|
|
|
#include "libvirt/virterror.h"
|
2006-03-27 15:24:36 +00:00
|
|
|
#include "driver.h"
|
2006-09-21 15:24:37 +00:00
|
|
|
#include <libintl.h>
|
2005-12-13 16:22:05 +00:00
|
|
|
|
2005-11-02 13:19:10 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
2006-09-21 15:24:37 +00:00
|
|
|
#define _(str) dgettext(GETTEXT_PACKAGE, (str))
|
|
|
|
#define _N(str) dgettext(GETTEXT_PACKAGE, (str))
|
|
|
|
#define gettext_noop(str) (str)
|
|
|
|
|
2007-03-16 15:03:21 +00:00
|
|
|
#ifdef __GNUC__
|
|
|
|
#ifdef HAVE_ANSIDECL_H
|
|
|
|
#include <ansidecl.h>
|
|
|
|
#endif
|
|
|
|
|
2005-11-07 17:16:18 +00:00
|
|
|
/**
|
|
|
|
* ATTRIBUTE_UNUSED:
|
|
|
|
*
|
|
|
|
* Macro to flag conciously unused parameters to functions
|
|
|
|
*/
|
2005-11-02 13:19:10 +00:00
|
|
|
#ifndef ATTRIBUTE_UNUSED
|
2007-03-16 15:03:21 +00:00
|
|
|
#define ATTRIBUTE_UNUSED __attribute__((__unused__))
|
2005-11-02 13:19:10 +00:00
|
|
|
#endif
|
2007-03-16 15:03:21 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* ATTRIBUTE_FORMAT
|
|
|
|
*
|
|
|
|
* Macro used to check printf/scanf-like functions, if compiling
|
|
|
|
* with gcc.
|
|
|
|
*/
|
|
|
|
#ifndef ATTRIBUTE_FORMAT
|
|
|
|
#define ATTRIBUTE_FORMAT(args...) __attribute__((__format__ (args)))
|
2005-11-02 13:19:10 +00:00
|
|
|
#endif
|
|
|
|
|
2007-03-16 15:03:21 +00:00
|
|
|
#else
|
|
|
|
#define ATTRIBUTE_UNUSED
|
|
|
|
#define ATTRIBUTE_FORMAT(...)
|
2006-03-27 15:24:36 +00:00
|
|
|
#endif
|
|
|
|
|
2005-11-07 17:16:18 +00:00
|
|
|
/**
|
|
|
|
* TODO:
|
|
|
|
*
|
|
|
|
* macro to flag unimplemented blocks
|
|
|
|
*/
|
|
|
|
#define TODO \
|
|
|
|
fprintf(stderr, "Unimplemented block at %s:%d\n", \
|
|
|
|
__FILE__, __LINE__);
|
|
|
|
|
2005-12-13 16:22:05 +00:00
|
|
|
/**
|
|
|
|
* VIR_CONNECT_MAGIC:
|
|
|
|
*
|
|
|
|
* magic value used to protect the API when pointers to connection structures
|
|
|
|
* are passed down by the uers.
|
|
|
|
*/
|
2005-12-16 18:41:46 +00:00
|
|
|
#define VIR_CONNECT_MAGIC 0x4F23DEAD
|
|
|
|
#define VIR_IS_CONNECT(obj) ((obj) && (obj)->magic==VIR_CONNECT_MAGIC)
|
|
|
|
|
2005-12-13 16:22:05 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* VIR_DOMAIN_MAGIC:
|
|
|
|
*
|
|
|
|
* magic value used to protect the API when pointers to domain structures
|
|
|
|
* are passed down by the uers.
|
|
|
|
*/
|
2005-12-16 18:41:46 +00:00
|
|
|
#define VIR_DOMAIN_MAGIC 0xDEAD4321
|
|
|
|
#define VIR_IS_DOMAIN(obj) ((obj) && (obj)->magic==VIR_DOMAIN_MAGIC)
|
|
|
|
#define VIR_IS_CONNECTED_DOMAIN(obj) (VIR_IS_DOMAIN(obj) && VIR_IS_CONNECT((obj)->conn))
|
2005-12-13 16:22:05 +00:00
|
|
|
|
2007-03-08 14:12:06 +00:00
|
|
|
/**
|
|
|
|
* VIR_NETWORK_MAGIC:
|
|
|
|
*
|
|
|
|
* magic value used to protect the API when pointers to network structures
|
|
|
|
* are passed down by the uers.
|
|
|
|
*/
|
|
|
|
#define VIR_NETWORK_MAGIC 0xDEAD1234
|
|
|
|
#define VIR_IS_NETWORK(obj) ((obj) && (obj)->magic==VIR_NETWORK_MAGIC)
|
|
|
|
#define VIR_IS_CONNECTED_NETWORK(obj) (VIR_IS_NETWORK(obj) && VIR_IS_CONNECT((obj)->conn))
|
|
|
|
|
|
|
|
/*
|
|
|
|
* arbitrary limitations
|
|
|
|
*/
|
2006-11-16 19:06:13 +00:00
|
|
|
#define MAX_DRIVERS 10
|
2007-03-08 14:12:06 +00:00
|
|
|
#define MIN_XEN_GUEST_SIZE 64 /* 64 megabytes */
|
2006-03-29 12:46:03 +00:00
|
|
|
|
2005-12-13 16:22:05 +00:00
|
|
|
/*
|
|
|
|
* Flags for Xen connections
|
|
|
|
*/
|
|
|
|
#define VIR_CONNECT_RO 1
|
|
|
|
|
|
|
|
/**
|
|
|
|
* _virConnect:
|
|
|
|
*
|
|
|
|
* Internal structure associated to a connection
|
|
|
|
*/
|
2006-03-20 17:49:28 +00:00
|
|
|
struct _virConnect {
|
|
|
|
unsigned int magic; /* specific value to check */
|
2006-03-29 12:46:03 +00:00
|
|
|
|
2006-04-09 13:11:22 +00:00
|
|
|
int uses; /* reference count */
|
2006-03-29 12:46:03 +00:00
|
|
|
/* the list of available drivers for that connection */
|
|
|
|
virDriverPtr drivers[MAX_DRIVERS];
|
|
|
|
int nb_drivers;
|
|
|
|
|
2007-03-08 14:12:06 +00:00
|
|
|
/* the list of available network drivers */
|
|
|
|
virNetworkDriverPtr networkDrivers[MAX_DRIVERS];
|
|
|
|
int nb_network_drivers;
|
|
|
|
|
2006-03-29 12:46:03 +00:00
|
|
|
/* extra data needed by drivers */
|
2006-03-20 17:49:28 +00:00
|
|
|
int handle; /* internal handle used for hypercall */
|
2006-06-28 18:19:13 +00:00
|
|
|
struct xs_handle *xshandle;/* handle to talk to the xenstore */
|
|
|
|
int proxy; /* file descriptor if using the proxy */
|
2006-12-14 01:56:14 +00:00
|
|
|
int xendConfigVersion; /* XenD config version */
|
2006-03-20 17:49:28 +00:00
|
|
|
|
|
|
|
/* connection to xend */
|
|
|
|
int type; /* PF_UNIX or PF_INET */
|
|
|
|
int len; /* lenght of addr */
|
|
|
|
struct sockaddr *addr; /* type of address used */
|
|
|
|
struct sockaddr_un addr_un; /* the unix address */
|
|
|
|
struct sockaddr_in addr_in; /* the inet address */
|
|
|
|
|
2007-02-14 15:37:18 +00:00
|
|
|
int qemud_fd; /* connection to qemud */
|
|
|
|
|
2006-03-20 17:49:28 +00:00
|
|
|
/* error stuff */
|
|
|
|
virError err; /* the last error */
|
|
|
|
virErrorFunc handler; /* associated handlet */
|
|
|
|
void *userData; /* the user data */
|
|
|
|
|
|
|
|
/* misc */
|
2007-03-08 14:12:06 +00:00
|
|
|
xmlMutexPtr hashes_mux;/* a mutex to protect the domain and networks hash tables */
|
2006-04-05 09:31:29 +00:00
|
|
|
virHashTablePtr domains;/* hash table for known domains */
|
2007-03-08 14:12:06 +00:00
|
|
|
virHashTablePtr networks;/* hash table for known domains */
|
2006-03-20 17:49:28 +00:00
|
|
|
int flags; /* a set of connection flags */
|
|
|
|
};
|
2005-12-13 16:22:05 +00:00
|
|
|
|
2005-12-16 12:16:41 +00:00
|
|
|
/**
|
2006-03-20 17:49:28 +00:00
|
|
|
* virDomainFlags:
|
|
|
|
*
|
|
|
|
* a set of special flag values associated to the domain
|
|
|
|
*/
|
2005-12-16 12:16:41 +00:00
|
|
|
|
2007-03-19 14:18:05 +00:00
|
|
|
enum virDomainFlags {
|
2006-04-28 18:29:26 +00:00
|
|
|
DOMAIN_IS_SHUTDOWN = (1 << 0), /* the domain is being shutdown */
|
|
|
|
DOMAIN_IS_DEFINED = (1 << 1) /* the domain is defined not running */
|
2007-03-19 14:18:05 +00:00
|
|
|
};
|
2005-12-16 12:16:41 +00:00
|
|
|
|
2005-12-13 16:22:05 +00:00
|
|
|
/**
|
2006-03-20 17:49:28 +00:00
|
|
|
* _virDomain:
|
|
|
|
*
|
|
|
|
* Internal structure associated to a domain
|
|
|
|
*/
|
|
|
|
struct _virDomain {
|
Mon Jan 23 14:36:18 IST 2007 Mark McLoughlin <markmc@redhat.com>
* include/libvirt/libvirt.h.in: add VIR_UUID_BUFLEN and
VIR_UUID_STRING_BUFLEN
* libvirt/proxy/libvirt_proxy.c, libvirt/src/hash.c,
libvirt/src/internal.h, libvirt/src/libvirt.c,
libvirt/src/proxy_internal.c, libvirt/src/test.c,
libvirt/src/virsh.c, libvirt/src/xend_internal.c,
libvirt/src/xm_internal.c, libvirt/src/xml.c,
libvirt/python/libvir.c: use them
2007-01-23 14:39:45 +00:00
|
|
|
unsigned int magic; /* specific value to check */
|
|
|
|
int uses; /* reference count */
|
|
|
|
virConnectPtr conn; /* pointer back to the connection */
|
|
|
|
char *name; /* the domain external name */
|
|
|
|
char *path; /* the domain internal path */
|
|
|
|
int id; /* the domain ID */
|
|
|
|
int flags; /* extra flags */
|
|
|
|
unsigned char uuid[VIR_UUID_BUFLEN]; /* the domain unique identifier */
|
|
|
|
char *xml; /* the XML description for defined domains */
|
2006-03-20 17:49:28 +00:00
|
|
|
};
|
2005-12-13 16:22:05 +00:00
|
|
|
|
2007-03-08 14:12:06 +00:00
|
|
|
/**
|
|
|
|
* _virNetwork:
|
|
|
|
*
|
|
|
|
* Internal structure associated to a domain
|
|
|
|
*/
|
|
|
|
struct _virNetwork {
|
|
|
|
unsigned int magic; /* specific value to check */
|
|
|
|
int uses; /* reference count */
|
|
|
|
virConnectPtr conn; /* pointer back to the connection */
|
|
|
|
char *name; /* the network external name */
|
|
|
|
unsigned char uuid[VIR_UUID_BUFLEN]; /* the network unique identifier */
|
|
|
|
};
|
|
|
|
|
2005-12-16 00:51:27 +00:00
|
|
|
/*
|
2006-03-20 17:49:28 +00:00
|
|
|
* Internal routines
|
|
|
|
*/
|
|
|
|
char *virDomainGetVM(virDomainPtr domain);
|
|
|
|
char *virDomainGetVMInfo(virDomainPtr domain,
|
|
|
|
const char *vm, const char *name);
|
|
|
|
|
2006-04-09 13:11:22 +00:00
|
|
|
/************************************************************************
|
|
|
|
* *
|
|
|
|
* API for error handling *
|
|
|
|
* *
|
|
|
|
************************************************************************/
|
2006-03-20 17:49:28 +00:00
|
|
|
void __virRaiseError(virConnectPtr conn,
|
|
|
|
virDomainPtr dom,
|
2007-03-08 14:12:06 +00:00
|
|
|
virNetworkPtr net,
|
2006-03-20 17:49:28 +00:00
|
|
|
int domain,
|
|
|
|
int code,
|
|
|
|
virErrorLevel level,
|
|
|
|
const char *str1,
|
|
|
|
const char *str2,
|
|
|
|
const char *str3,
|
2007-03-16 15:03:21 +00:00
|
|
|
int int1, int int2, const char *msg, ...)
|
|
|
|
ATTRIBUTE_FORMAT(printf, 12, 13);
|
2006-03-20 17:49:28 +00:00
|
|
|
const char *__virErrorMsg(virErrorNumber error, const char *info);
|
2006-02-27 16:27:18 +00:00
|
|
|
|
2006-04-09 13:11:22 +00:00
|
|
|
/************************************************************************
|
|
|
|
* *
|
2006-04-24 18:21:29 +00:00
|
|
|
* API for domain/connections (de)allocations and lookups *
|
2006-04-09 13:11:22 +00:00
|
|
|
* *
|
|
|
|
************************************************************************/
|
|
|
|
|
|
|
|
virConnectPtr virGetConnect (void);
|
|
|
|
int virFreeConnect (virConnectPtr conn);
|
|
|
|
virDomainPtr virGetDomain (virConnectPtr conn,
|
|
|
|
const char *name,
|
2006-05-29 18:03:27 +00:00
|
|
|
const unsigned char *uuid);
|
2006-04-09 13:11:22 +00:00
|
|
|
int virFreeDomain (virConnectPtr conn,
|
|
|
|
virDomainPtr domain);
|
2006-04-24 18:21:29 +00:00
|
|
|
virDomainPtr virGetDomainByID(virConnectPtr conn,
|
|
|
|
int id);
|
2007-03-08 14:12:06 +00:00
|
|
|
virNetworkPtr virGetNetwork (virConnectPtr conn,
|
|
|
|
const char *name,
|
|
|
|
const unsigned char *uuid);
|
|
|
|
int virFreeNetwork (virConnectPtr conn,
|
|
|
|
virNetworkPtr domain);
|
2006-04-09 13:11:22 +00:00
|
|
|
|
2005-11-02 13:19:10 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
2006-03-15 12:13:25 +00:00
|
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* __VIR_INTERNAL_H__ */
|
2007-03-15 17:24:56 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* vim: set tabstop=4:
|
|
|
|
* vim: set shiftwidth=4:
|
|
|
|
* vim: set expandtab:
|
|
|
|
*/
|
|
|
|
/*
|
|
|
|
* Local variables:
|
|
|
|
* indent-tabs-mode: nil
|
|
|
|
* c-indent-level: 4
|
|
|
|
* c-basic-offset: 4
|
|
|
|
* tab-width: 4
|
|
|
|
* End:
|
|
|
|
*/
|