mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-10-07 06:45:45 +00:00
868136624f
Rework the code such that virDomainObjListFindByID will always return a locked/ref counted object so that the callers can always do the same cleanup logic to call virDomainObjEndAPI. Makes accessing the objects much more consistent. NB: There were 2 callers (lxcDomainLookupByID and qemuDomainLookupByID) that were already using the ByID name, but not virDomainObjEndAPI - these were changed as well in this update/patch. Signed-off-by: John Ferlan <jferlan@redhat.com> Reviewed-by: Jim Fehlig <jfehlig@suse.com>
156 lines
6.7 KiB
C
156 lines
6.7 KiB
C
/*
|
|
* virdomainobjlist.h: domain objects list utilities
|
|
*
|
|
* Copyright (C) 2006-2015 Red Hat, Inc.
|
|
* Copyright (C) 2006-2008 Daniel P. Berrange
|
|
* Copyright (c) 2015 SUSE LINUX Products GmbH, Nuernberg, Germany.
|
|
*
|
|
* 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, see
|
|
* <http://www.gnu.org/licenses/>.
|
|
*
|
|
* Author: Daniel P. Berrange <berrange@redhat.com>
|
|
*/
|
|
|
|
#ifndef __VIRDOMAINOBJLIST_H__
|
|
# define __VIRDOMAINOBJLIST_H__
|
|
|
|
# include "domain_conf.h"
|
|
|
|
typedef struct _virDomainObjList virDomainObjList;
|
|
typedef virDomainObjList *virDomainObjListPtr;
|
|
|
|
virDomainObjListPtr virDomainObjListNew(void);
|
|
|
|
virDomainObjPtr virDomainObjListFindByID(virDomainObjListPtr doms,
|
|
int id);
|
|
virDomainObjPtr virDomainObjListFindByUUID(virDomainObjListPtr doms,
|
|
const unsigned char *uuid);
|
|
virDomainObjPtr virDomainObjListFindByName(virDomainObjListPtr doms,
|
|
const char *name);
|
|
|
|
enum {
|
|
VIR_DOMAIN_OBJ_LIST_ADD_LIVE = (1 << 0),
|
|
VIR_DOMAIN_OBJ_LIST_ADD_CHECK_LIVE = (1 << 1),
|
|
};
|
|
virDomainObjPtr virDomainObjListAdd(virDomainObjListPtr doms,
|
|
virDomainDefPtr def,
|
|
virDomainXMLOptionPtr xmlopt,
|
|
unsigned int flags,
|
|
virDomainDefPtr *oldDef);
|
|
|
|
typedef int (*virDomainObjListRenameCallback)(virDomainObjPtr dom,
|
|
const char *new_name,
|
|
unsigned int flags,
|
|
void *opaque);
|
|
int virDomainObjListRename(virDomainObjListPtr doms,
|
|
virDomainObjPtr dom,
|
|
const char *new_name,
|
|
unsigned int flags,
|
|
virDomainObjListRenameCallback callback,
|
|
void *opaque);
|
|
|
|
void virDomainObjListRemove(virDomainObjListPtr doms,
|
|
virDomainObjPtr dom);
|
|
void virDomainObjListRemoveLocked(virDomainObjListPtr doms,
|
|
virDomainObjPtr dom);
|
|
|
|
int virDomainObjListLoadAllConfigs(virDomainObjListPtr doms,
|
|
const char *configDir,
|
|
const char *autostartDir,
|
|
bool liveStatus,
|
|
virCapsPtr caps,
|
|
virDomainXMLOptionPtr xmlopt,
|
|
virDomainLoadConfigNotify notify,
|
|
void *opaque);
|
|
|
|
int virDomainObjListNumOfDomains(virDomainObjListPtr doms,
|
|
bool active,
|
|
virDomainObjListACLFilter filter,
|
|
virConnectPtr conn);
|
|
|
|
int virDomainObjListGetActiveIDs(virDomainObjListPtr doms,
|
|
int *ids,
|
|
int maxids,
|
|
virDomainObjListACLFilter filter,
|
|
virConnectPtr conn);
|
|
int virDomainObjListGetInactiveNames(virDomainObjListPtr doms,
|
|
char **const names,
|
|
int maxnames,
|
|
virDomainObjListACLFilter filter,
|
|
virConnectPtr conn);
|
|
|
|
typedef int (*virDomainObjListIterator)(virDomainObjPtr dom,
|
|
void *opaque);
|
|
|
|
int virDomainObjListForEach(virDomainObjListPtr doms,
|
|
virDomainObjListIterator callback,
|
|
void *opaque);
|
|
|
|
# define VIR_CONNECT_LIST_DOMAINS_FILTERS_ACTIVE \
|
|
(VIR_CONNECT_LIST_DOMAINS_ACTIVE | \
|
|
VIR_CONNECT_LIST_DOMAINS_INACTIVE)
|
|
|
|
# define VIR_CONNECT_LIST_DOMAINS_FILTERS_PERSISTENT \
|
|
(VIR_CONNECT_LIST_DOMAINS_PERSISTENT | \
|
|
VIR_CONNECT_LIST_DOMAINS_TRANSIENT)
|
|
|
|
# define VIR_CONNECT_LIST_DOMAINS_FILTERS_STATE \
|
|
(VIR_CONNECT_LIST_DOMAINS_RUNNING | \
|
|
VIR_CONNECT_LIST_DOMAINS_PAUSED | \
|
|
VIR_CONNECT_LIST_DOMAINS_SHUTOFF | \
|
|
VIR_CONNECT_LIST_DOMAINS_OTHER)
|
|
|
|
# define VIR_CONNECT_LIST_DOMAINS_FILTERS_MANAGEDSAVE \
|
|
(VIR_CONNECT_LIST_DOMAINS_MANAGEDSAVE | \
|
|
VIR_CONNECT_LIST_DOMAINS_NO_MANAGEDSAVE)
|
|
|
|
# define VIR_CONNECT_LIST_DOMAINS_FILTERS_AUTOSTART \
|
|
(VIR_CONNECT_LIST_DOMAINS_AUTOSTART | \
|
|
VIR_CONNECT_LIST_DOMAINS_NO_AUTOSTART)
|
|
|
|
# define VIR_CONNECT_LIST_DOMAINS_FILTERS_SNAPSHOT \
|
|
(VIR_CONNECT_LIST_DOMAINS_HAS_SNAPSHOT | \
|
|
VIR_CONNECT_LIST_DOMAINS_NO_SNAPSHOT)
|
|
|
|
# define VIR_CONNECT_LIST_DOMAINS_FILTERS_ALL \
|
|
(VIR_CONNECT_LIST_DOMAINS_FILTERS_ACTIVE | \
|
|
VIR_CONNECT_LIST_DOMAINS_FILTERS_PERSISTENT | \
|
|
VIR_CONNECT_LIST_DOMAINS_FILTERS_STATE | \
|
|
VIR_CONNECT_LIST_DOMAINS_FILTERS_MANAGEDSAVE | \
|
|
VIR_CONNECT_LIST_DOMAINS_FILTERS_AUTOSTART | \
|
|
VIR_CONNECT_LIST_DOMAINS_FILTERS_SNAPSHOT)
|
|
|
|
int virDomainObjListCollect(virDomainObjListPtr doms,
|
|
virConnectPtr conn,
|
|
virDomainObjPtr **vms,
|
|
size_t *nvms,
|
|
virDomainObjListACLFilter filter,
|
|
unsigned int flags);
|
|
int virDomainObjListExport(virDomainObjListPtr doms,
|
|
virConnectPtr conn,
|
|
virDomainPtr **domains,
|
|
virDomainObjListACLFilter filter,
|
|
unsigned int flags);
|
|
int virDomainObjListConvert(virDomainObjListPtr domlist,
|
|
virConnectPtr conn,
|
|
virDomainPtr *doms,
|
|
size_t ndoms,
|
|
virDomainObjPtr **vms,
|
|
size_t *nvms,
|
|
virDomainObjListACLFilter filter,
|
|
unsigned int flags,
|
|
bool skip_missing);
|
|
|
|
#endif /* __VIRDOMAINOBJLIST_H__ */
|