libvirt/src/util/virnvme.h
Michal Privoznik c8238579fb lib: Drop internal virXXXPtr typedefs
Historically, we declared pointer type to our types:

  typedef struct _virXXX virXXX;
  typedef virXXX *virXXXPtr;

But usefulness of such declaration is questionable, at best.
Unfortunately, we can't drop every such declaration - we have to
carry some over, because they are part of public API (e.g.
virDomainPtr). But for internal types - we can do drop them and
use what every other C project uses 'virXXX *'.

This change was generated by a very ugly shell script that
generated sed script which was then called over each file in the
repository. For the shell script refer to the cover letter:

https://listman.redhat.com/archives/libvir-list/2021-March/msg00537.html

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
2021-04-13 17:00:38 +02:00

96 lines
2.8 KiB
C

/*
* virnvme.h: helper APIs for managing NVMe devices
*
* 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/>.
*/
#pragma once
#include "virpci.h"
typedef struct _virNVMeDevice virNVMeDevice;
/* Note that this list is lockable, and in fact, it is caller's
* responsibility to acquire the lock and release it. The reason
* is that in a lot of cases the list must be locked between two
* API calls and therefore only caller knows when it is safe to
* finally release the lock. */
typedef struct _virNVMeDeviceList virNVMeDeviceList;
G_DEFINE_AUTOPTR_CLEANUP_FUNC(virNVMeDeviceList, virObjectUnref);
virNVMeDevice *
virNVMeDeviceNew(const virPCIDeviceAddress *address,
unsigned long namespace,
bool managed);
void
virNVMeDeviceFree(virNVMeDevice *dev);
G_DEFINE_AUTOPTR_CLEANUP_FUNC(virNVMeDevice, virNVMeDeviceFree);
virNVMeDevice *
virNVMeDeviceCopy(const virNVMeDevice *dev);
const virPCIDeviceAddress *
virNVMeDeviceAddressGet(const virNVMeDevice *dev);
void
virNVMeDeviceUsedByClear(virNVMeDevice *dev);
void
virNVMeDeviceUsedByGet(const virNVMeDevice *dev,
const char **drv,
const char **dom);
void
virNVMeDeviceUsedBySet(virNVMeDevice *dev,
const char *drv,
const char *dom);
virNVMeDeviceList *
virNVMeDeviceListNew(void);
size_t
virNVMeDeviceListCount(const virNVMeDeviceList *list);
int
virNVMeDeviceListAdd(virNVMeDeviceList *list,
const virNVMeDevice *dev);
int
virNVMeDeviceListDel(virNVMeDeviceList *list,
const virNVMeDevice *dev);
virNVMeDevice *
virNVMeDeviceListGet(virNVMeDeviceList *list,
size_t i);
virNVMeDevice *
virNVMeDeviceListLookup(virNVMeDeviceList *list,
const virNVMeDevice *dev);
ssize_t
virNVMeDeviceListLookupIndex(virNVMeDeviceList *list,
const virNVMeDevice *dev);
virPCIDeviceList *
virNVMeDeviceListCreateDetachList(virNVMeDeviceList *activeList,
virNVMeDeviceList *toDetachList);
virPCIDeviceList *
virNVMeDeviceListCreateReAttachList(virNVMeDeviceList *activeList,
virNVMeDeviceList *toReAttachList);