mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-10-06 22:35:46 +00:00
a5e89ae16e
Extend it to a universal helper used for clearing lists of any objects. Note that the argument type is specifically void * to allow implicit typecasting. Additionally add a helper that works on non-NULL terminated arrays once we know the length.
106 lines
3.0 KiB
C
106 lines
3.0 KiB
C
/*
|
|
* virobject.h: libvirt reference counted object
|
|
*
|
|
* Copyright (C) 2012-2014 Red Hat, Inc.
|
|
*
|
|
* 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/>.
|
|
*
|
|
*/
|
|
|
|
#ifndef __VIR_OBJECT_H__
|
|
# define __VIR_OBJECT_H__
|
|
|
|
# include "internal.h"
|
|
# include "virthread.h"
|
|
|
|
typedef struct _virClass virClass;
|
|
typedef virClass *virClassPtr;
|
|
|
|
typedef struct _virObject virObject;
|
|
typedef virObject *virObjectPtr;
|
|
|
|
typedef struct _virObjectLockable virObjectLockable;
|
|
typedef virObjectLockable *virObjectLockablePtr;
|
|
|
|
typedef void (*virObjectDisposeCallback)(void *obj);
|
|
|
|
/* Most code should not play with the contents of this struct; however,
|
|
* the struct itself is public so that it can be embedded as the first
|
|
* field of a subclassed object. */
|
|
struct _virObject {
|
|
/* Ensure correct alignment of this and all subclasses, even on
|
|
* platforms where 'long long' or function pointers have stricter
|
|
* requirements than 'void *'. */
|
|
union {
|
|
long long dummy_align1;
|
|
void (*dummy_align2) (void);
|
|
struct {
|
|
unsigned int magic;
|
|
int refs;
|
|
} s;
|
|
} u;
|
|
virClassPtr klass;
|
|
};
|
|
|
|
struct _virObjectLockable {
|
|
virObject parent;
|
|
virMutex lock;
|
|
};
|
|
|
|
|
|
virClassPtr virClassForObject(void);
|
|
virClassPtr virClassForObjectLockable(void);
|
|
|
|
# ifndef VIR_PARENT_REQUIRED
|
|
# define VIR_PARENT_REQUIRED ATTRIBUTE_NONNULL(1)
|
|
# endif
|
|
virClassPtr virClassNew(virClassPtr parent,
|
|
const char *name,
|
|
size_t objectSize,
|
|
virObjectDisposeCallback dispose)
|
|
VIR_PARENT_REQUIRED ATTRIBUTE_NONNULL(2);
|
|
|
|
const char *virClassName(virClassPtr klass)
|
|
ATTRIBUTE_NONNULL(1);
|
|
|
|
bool virClassIsDerivedFrom(virClassPtr klass,
|
|
virClassPtr parent)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
|
|
void *virObjectNew(virClassPtr klass)
|
|
ATTRIBUTE_NONNULL(1);
|
|
bool virObjectUnref(void *obj);
|
|
void *virObjectRef(void *obj);
|
|
|
|
bool virObjectIsClass(void *obj,
|
|
virClassPtr klass)
|
|
ATTRIBUTE_NONNULL(2);
|
|
|
|
void virObjectFreeCallback(void *opaque);
|
|
void virObjectFreeHashData(void *opaque, const void *name);
|
|
|
|
void *virObjectLockableNew(virClassPtr klass)
|
|
ATTRIBUTE_NONNULL(1);
|
|
|
|
void virObjectLock(void *lockableobj)
|
|
ATTRIBUTE_NONNULL(1);
|
|
void virObjectUnlock(void *lockableobj)
|
|
ATTRIBUTE_NONNULL(1);
|
|
|
|
void virObjectListFree(void *list);
|
|
void virObjectListFreeCount(void *list, size_t count);
|
|
|
|
#endif /* __VIR_OBJECT_H */
|