mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-11-02 19:31:18 +00:00
30783d36b2
Using the new VIR_DEFINE_AUTOPTR_FUNC macro defined in src/util/viralloc.h, define a new wrapper around an existing cleanup function which will be called when a variable declared with VIR_AUTOPTR macro goes out of scope. Also, drop the redundant viralloc.h include, since that has moved from the source module into the header. When variables of type virSCSIDevicePtr and virUsedByInfoPtr are declared using VIR_AUTOPTR, the functions virSCSIDeviceFree and virSCSIDeviceUsedByInfoFree, respectively, will be run automatically on them when they go out of scope. This commit also adds an intermediate typedef for virUsedByInfo type for use with the cleanup macros. Signed-off-by: Sukrit Bhatnagar <skrtbhtngr@gmail.com> Reviewed-by: Erik Skultety <eskultet@redhat.com>
102 lines
4.0 KiB
C
102 lines
4.0 KiB
C
/*
|
|
* virscsi.h: helper APIs for managing host SCSI devices
|
|
*
|
|
* Copyright (C) 2013 Fujitsu, 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/>.
|
|
*
|
|
* Authors:
|
|
* Han Cheng <hanc.fnst@cn.fujitsu.com>
|
|
*/
|
|
|
|
#ifndef __VIR_SCSI_H__
|
|
# define __VIR_SCSI_H__
|
|
|
|
# include "internal.h"
|
|
# include "virobject.h"
|
|
# include "viralloc.h"
|
|
|
|
typedef struct _virSCSIDevice virSCSIDevice;
|
|
typedef virSCSIDevice *virSCSIDevicePtr;
|
|
|
|
typedef struct _virSCSIDeviceList virSCSIDeviceList;
|
|
typedef virSCSIDeviceList *virSCSIDeviceListPtr;
|
|
|
|
char *virSCSIDeviceGetSgName(const char *sysfs_prefix,
|
|
const char *adapter,
|
|
unsigned int bus,
|
|
unsigned int target,
|
|
unsigned long long unit) ATTRIBUTE_NOINLINE;
|
|
char *virSCSIDeviceGetDevName(const char *sysfs_prefix,
|
|
const char *adapter,
|
|
unsigned int bus,
|
|
unsigned int target,
|
|
unsigned long long unit);
|
|
|
|
virSCSIDevicePtr virSCSIDeviceNew(const char *sysfs_prefix,
|
|
const char *adapter,
|
|
unsigned int bus,
|
|
unsigned int target,
|
|
unsigned long long unit,
|
|
bool readonly,
|
|
bool shareable);
|
|
|
|
void virSCSIDeviceFree(virSCSIDevicePtr dev);
|
|
int virSCSIDeviceSetUsedBy(virSCSIDevicePtr dev,
|
|
const char *drvname,
|
|
const char *domname);
|
|
bool virSCSIDeviceIsAvailable(virSCSIDevicePtr dev);
|
|
const char *virSCSIDeviceGetName(virSCSIDevicePtr dev);
|
|
const char *virSCSIDeviceGetPath(virSCSIDevicePtr dev);
|
|
unsigned int virSCSIDeviceGetAdapter(virSCSIDevicePtr dev);
|
|
unsigned int virSCSIDeviceGetBus(virSCSIDevicePtr dev);
|
|
unsigned int virSCSIDeviceGetTarget(virSCSIDevicePtr dev);
|
|
unsigned long long virSCSIDeviceGetUnit(virSCSIDevicePtr dev);
|
|
bool virSCSIDeviceGetReadonly(virSCSIDevicePtr dev);
|
|
bool virSCSIDeviceGetShareable(virSCSIDevicePtr dev);
|
|
|
|
/*
|
|
* Callback that will be invoked once for each file
|
|
* associated with / used for SCSI host device access.
|
|
*
|
|
* Should return 0 if successfully processed, or
|
|
* -1 to indicate error and abort iteration
|
|
*/
|
|
typedef int (*virSCSIDeviceFileActor)(virSCSIDevicePtr dev,
|
|
const char *path, void *opaque);
|
|
|
|
int virSCSIDeviceFileIterate(virSCSIDevicePtr dev,
|
|
virSCSIDeviceFileActor actor,
|
|
void *opaque);
|
|
|
|
virSCSIDeviceListPtr virSCSIDeviceListNew(void);
|
|
int virSCSIDeviceListAdd(virSCSIDeviceListPtr list,
|
|
virSCSIDevicePtr dev);
|
|
virSCSIDevicePtr virSCSIDeviceListGet(virSCSIDeviceListPtr list,
|
|
int idx);
|
|
size_t virSCSIDeviceListCount(virSCSIDeviceListPtr list);
|
|
virSCSIDevicePtr virSCSIDeviceListSteal(virSCSIDeviceListPtr list,
|
|
virSCSIDevicePtr dev);
|
|
void virSCSIDeviceListDel(virSCSIDeviceListPtr list,
|
|
virSCSIDevicePtr dev,
|
|
const char *drvname,
|
|
const char *domname);
|
|
virSCSIDevicePtr virSCSIDeviceListFind(virSCSIDeviceListPtr list,
|
|
virSCSIDevicePtr dev);
|
|
|
|
VIR_DEFINE_AUTOPTR_FUNC(virSCSIDevice, virSCSIDeviceFree)
|
|
|
|
#endif /* __VIR_SCSI_H__ */
|