internal.h 3.9 KB
Newer Older
1 2 3 4
/*
 * internal.h: internal definitions just used by code from the library
 */

5 6
#ifndef __VIR_INTERNAL_H__
#define __VIR_INTERNAL_H__
7

8 9 10 11 12 13
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/un.h>
#include <netinet/in.h>
#include <netinet/tcp.h>

14
#include "hash.h"
15
#include "libvirt.h"
16
#include "virterror.h"
17

18 19 20 21
#ifdef __cplusplus
extern "C" {
#endif

D
Daniel Veillard 已提交
22 23 24 25 26
/**
 * ATTRIBUTE_UNUSED:
 *
 * Macro to flag conciously unused parameters to functions
 */
27 28 29 30 31 32 33 34 35 36 37
#ifdef __GNUC__
#ifdef HAVE_ANSIDECL_H
#include <ansidecl.h>
#endif
#ifndef ATTRIBUTE_UNUSED
#define ATTRIBUTE_UNUSED __attribute__((unused))
#endif
#else
#define ATTRIBUTE_UNUSED
#endif

D
Daniel Veillard 已提交
38 39 40 41 42 43 44 45 46
/**
 * TODO:
 *
 * macro to flag unimplemented blocks
 */
#define TODO 								\
    fprintf(stderr, "Unimplemented block at %s:%d\n",			\
            __FILE__, __LINE__);

47 48 49 50 51 52
/**
 * VIR_CONNECT_MAGIC:
 *
 * magic value used to protect the API when pointers to connection structures
 * are passed down by the uers.
 */
K
Karel Zak 已提交
53 54 55
#define VIR_CONNECT_MAGIC 	0x4F23DEAD
#define VIR_IS_CONNECT(obj)	((obj) && (obj)->magic==VIR_CONNECT_MAGIC)

56 57 58 59 60 61 62

/**
 * VIR_DOMAIN_MAGIC:
 *
 * magic value used to protect the API when pointers to domain structures
 * are passed down by the uers.
 */
K
Karel Zak 已提交
63 64 65
#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))
66 67 68 69 70 71 72 73 74 75 76

/*
 * Flags for Xen connections
 */
#define VIR_CONNECT_RO 1

/**
 * _virConnect:
 *
 * Internal structure associated to a connection
 */
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
    struct _virConnect {
        unsigned int magic;     /* specific value to check */
        int handle;             /* internal handle used for hypercall */
        struct xs_handle *xshandle;     /* handle to talk to the xenstore */

        /* 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 */

        /* error stuff */
        virError err;           /* the last error */
        virErrorFunc handler;   /* associated handlet */
        void *userData;         /* the user data */

        /* misc */
        virHashTablePtr domains;        /* hash table for known domains */
        int flags;              /* a set of connection flags */
    };
98

99 100 101 102 103 104
/**
 * virDomainFlags:
 *
 * a set of special flag values associated to the domain
 */

105 106 107
    enum {
        DOMAIN_IS_SHUTDOWN = (1 << 0)   /* the domain is being shutdown */
    } virDomainFlags;
108

109 110 111 112 113
/**
 * _virDomain:
 *
 * Internal structure associated to a domain
 */
114 115 116 117 118 119 120 121 122
    struct _virDomain {
        unsigned int magic;     /* specific value to check */
        virConnectPtr conn;     /* pointer back to the connection */
        char *name;             /* the domain external name */
        char *path;             /* the domain internal path */
        int handle;             /* internal handle for the dmonain ID */
        int flags;              /* extra flags */
        unsigned char uuid[16]; /* the domain unique identifier */
    };
123

124 125 126
/*
 * Internal routines
 */
127 128 129 130 131 132 133 134 135 136 137 138 139 140
    char *virDomainGetVM(virDomainPtr domain);
    char *virDomainGetVMInfo(virDomainPtr domain,
                             const char *vm, const char *name);

    void __virRaiseError(virConnectPtr conn,
                         virDomainPtr dom,
                         int domain,
                         int code,
                         virErrorLevel level,
                         const char *str1,
                         const char *str2,
                         const char *str3,
                         int int1, int int2, const char *msg, ...);
    const char *__virErrorMsg(virErrorNumber error, const char *info);
D
Daniel Veillard 已提交
141

142 143
#ifdef __cplusplus
}
144 145
#endif                          /* __cplusplus */
#endif                          /* __VIR_INTERNAL_H__ */