summaryrefslogtreecommitdiffstats
path: root/src/VBox/Devices/Storage/HBDMgmt.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-06 03:01:46 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-06 03:01:46 +0000
commitf8fe689a81f906d1b91bb3220acde2a4ecb14c5b (patch)
tree26484e9d7e2c67806c2d1760196ff01aaa858e8c /src/VBox/Devices/Storage/HBDMgmt.h
parentInitial commit. (diff)
downloadvirtualbox-f8fe689a81f906d1b91bb3220acde2a4ecb14c5b.tar.xz
virtualbox-f8fe689a81f906d1b91bb3220acde2a4ecb14c5b.zip
Adding upstream version 6.0.4-dfsg.upstream/6.0.4-dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/VBox/Devices/Storage/HBDMgmt.h')
-rw-r--r--src/VBox/Devices/Storage/HBDMgmt.h94
1 files changed, 94 insertions, 0 deletions
diff --git a/src/VBox/Devices/Storage/HBDMgmt.h b/src/VBox/Devices/Storage/HBDMgmt.h
new file mode 100644
index 00000000..326f1638
--- /dev/null
+++ b/src/VBox/Devices/Storage/HBDMgmt.h
@@ -0,0 +1,94 @@
+/* $Id: HBDMgmt.h $ */
+/** @file
+ * VBox storage devices: Host block device management API.
+ */
+
+/*
+ * Copyright (C) 2015-2019 Oracle Corporation
+ *
+ * This file is part of VirtualBox Open Source Edition (OSE), as
+ * available from http://www.virtualbox.org. This file is free software;
+ * you can redistribute it and/or modify it under the terms of the GNU
+ * General Public License (GPL) as published by the Free Software
+ * Foundation, in version 2 as it comes in the "COPYING" file of the
+ * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
+ * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
+ */
+
+#ifndef VBOX_INCLUDED_SRC_Storage_HBDMgmt_h
+#define VBOX_INCLUDED_SRC_Storage_HBDMgmt_h
+#ifndef RT_WITHOUT_PRAGMA_ONCE
+# pragma once
+#endif
+
+#include <VBox/cdefs.h>
+
+RT_C_DECLS_BEGIN
+
+/**
+ * Opaque host block device manager.
+ */
+typedef struct HBDMGRINT *HBDMGR;
+/** Pointer to a block device manager. */
+typedef HBDMGR *PHBDMGR;
+
+/* NIL HBD manager handle. */
+#define NIL_HBDMGR ((HBDMGR)0)
+
+/**
+ * Creates host block device manager.
+ *
+ * @returns VBox status code.
+ * @param phHbdMgr Where to store the handle to the block device manager on success.
+ */
+DECLHIDDEN(int) HBDMgrCreate(PHBDMGR phHbdMgr);
+
+/**
+ * Destroys the given block device manager unclaiming all managed block devices.
+ *
+ * @returns nothing.
+ * @param hHbdMgr The block device manager.
+ */
+DECLHIDDEN(void) HBDMgrDestroy(HBDMGR hHbdMgr);
+
+/**
+ * Returns whether a given filename resembles a block device which can
+ * be managed by this API.
+ *
+ * @returns true if the given filename point to a block device manageable
+ * by the given manager
+ * false otherwise.
+ * @param pszFilename The block device to check.
+ */
+DECLHIDDEN(bool) HBDMgrIsBlockDevice(const char *pszFilename);
+
+/**
+ * Prepares the given block device for use by unmounting and claiming it for exclusive use.
+ *
+ * @returns VBox status code.
+ * @param hHbdMgr The block device manager.
+ * @param pszFilename The block device to claim.
+ */
+DECLHIDDEN(int) HBDMgrClaimBlockDevice(HBDMGR hHbdMgr, const char *pszFilename);
+
+/**
+ * Unclaims the given block device.
+ *
+ * @returns VBox status code.
+ * @param hHbdMgr The block device manager.
+ * @param pszFilename The block device to unclaim.
+ */
+DECLHIDDEN(int) HBDMgrUnclaimBlockDevice(HBDMGR hHbdMgr, const char *pszFilename);
+
+/**
+ * Returns whether the given block device is claimed by the manager.
+ *
+ * @returns true if the block device is claimed, false otherwisw.
+ * @param hHbdMgr The block device manager.
+ * @param pszFilename The block device to check.
+ */
+DECLHIDDEN(bool) HBDMgrIsBlockDeviceClaimed(HBDMGR hHbdMgr, const char *pszFilename);
+
+RT_C_DECLS_END
+
+#endif /* !VBOX_INCLUDED_SRC_Storage_HBDMgmt_h */