Files
xen/tools/libxen/include/xen_vtpm.h
T
2007-01-30 16:23:35 +00:00

199 lines
4.3 KiB
C

/*
* Copyright (c) 2006, XenSource Inc.
* Copyright (c) 2006, IBM Corp.
*
* 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_VTPM_H
#define XEN_VTPM_H
#include "xen_common.h"
#include "xen_vm_decl.h"
#include "xen_vtpm_decl.h"
/*
* The VTPM class.
*
* A virtual TPM device.
*/
/**
* Free the given xen_vtpm. The given handle must have been allocated
* by this library.
*/
extern void
xen_vtpm_free(xen_vtpm vtpm);
typedef struct xen_vtpm_set
{
size_t size;
xen_vtpm *contents[];
} xen_vtpm_set;
/**
* Allocate a xen_vtpm_set of the given size.
*/
extern xen_vtpm_set *
xen_vtpm_set_alloc(size_t size);
/**
* Free the given xen_vtpm_set. The given set must have been allocated
* by this library.
*/
extern void
xen_vtpm_set_free(xen_vtpm_set *set);
typedef struct xen_vtpm_record
{
xen_vtpm handle;
char *uuid;
struct xen_vm_record_opt *vm;
struct xen_vm_record_opt *backend;
} xen_vtpm_record;
/**
* Allocate a xen_vtpm_record.
*/
extern xen_vtpm_record *
xen_vtpm_record_alloc(void);
/**
* Free the given xen_vtpm_record, and all referenced values. The
* given record must have been allocated by this library.
*/
extern void
xen_vtpm_record_free(xen_vtpm_record *record);
typedef struct xen_vtpm_record_opt
{
bool is_record;
union
{
xen_vtpm handle;
xen_vtpm_record *record;
} u;
} xen_vtpm_record_opt;
/**
* Allocate a xen_vtpm_record_opt.
*/
extern xen_vtpm_record_opt *
xen_vtpm_record_opt_alloc(void);
/**
* Free the given xen_vtpm_record_opt, and all referenced values. The
* given record_opt must have been allocated by this library.
*/
extern void
xen_vtpm_record_opt_free(xen_vtpm_record_opt *record_opt);
typedef struct xen_vtpm_record_set
{
size_t size;
xen_vtpm_record *contents[];
} xen_vtpm_record_set;
/**
* Allocate a xen_vtpm_record_set of the given size.
*/
extern xen_vtpm_record_set *
xen_vtpm_record_set_alloc(size_t size);
/**
* Free the given xen_vtpm_record_set, and all referenced values. The
* given set must have been allocated by this library.
*/
extern void
xen_vtpm_record_set_free(xen_vtpm_record_set *set);
typedef struct xen_vtpm_record_opt_set
{
size_t size;
xen_vtpm_record_opt *contents[];
} xen_vtpm_record_opt_set;
/**
* Allocate a xen_vtpm_record_opt_set of the given size.
*/
extern xen_vtpm_record_opt_set *
xen_vtpm_record_opt_set_alloc(size_t size);
/**
* Free the given xen_vtpm_record_opt_set, and all referenced values.
* The given set must have been allocated by this library.
*/
extern void
xen_vtpm_record_opt_set_free(xen_vtpm_record_opt_set *set);
/**
* Get a record containing the current state of the given VTPM.
*/
extern bool
xen_vtpm_get_record(xen_session *session, xen_vtpm_record **result, xen_vtpm vtpm);
/**
* Get a reference to the VTPM instance with the specified UUID.
*/
extern bool
xen_vtpm_get_by_uuid(xen_session *session, xen_vtpm *result, char *uuid);
/**
* Create a new VTPM instance, and return its handle.
*/
extern bool
xen_vtpm_create(xen_session *session, xen_vtpm *result, xen_vtpm_record *record);
/**
* Destroy the specified VTPM instance.
*/
extern bool
xen_vtpm_destroy(xen_session *session, xen_vtpm vtpm);
/**
* Get the uuid field of the given VTPM.
*/
extern bool
xen_vtpm_get_uuid(xen_session *session, char **result, xen_vtpm vtpm);
/**
* Get the VM field of the given VTPM.
*/
extern bool
xen_vtpm_get_vm(xen_session *session, xen_vm *result, xen_vtpm vtpm);
/**
* Get the backend field of the given VTPM.
*/
extern bool
xen_vtpm_get_backend(xen_session *session, xen_vm *result, xen_vtpm vtpm);
#endif