OvmfPkg/XenBusDxe: Add XenStore client implementation
XenStore is a key/value database, which is running on another virtual machine. It can be accessed through shared memory. This is a client implementation. Change in V3: - moving xs_wire.h from patch #1 to this patch - fix return value of XenStoreListDirectory - Use a timeout to print a debug message if the other side of the xenstore ring does not notify through the event channel. This is done with the new XenStoreWaitForEvent function. - Have XenStoreReadReply check status of XenStoreProcessMessage and return an error if needed. - Have XenStoreTalkv return the status of XenStoreReadReply. - Have a loop to check for the quiescent of the response ring in the XenStoreInitComms function. (with a timeout of 5 seconds) - use the recently introduced XenStore 'closing' feature. Change in V2: - Change comment style, from freebsd to ovmf - Fix type of EventChannel - Fix debug print, no more cast - Implement XenStoreDeinit. - Clean up comments - Fix few codding style issue - Add FAIL xenstore status value. Origin: FreeBSD 10.0 License: This patch adds several files under the MIT licence. Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Anthony PERARD <anthony.perard@citrix.com> Reviewed-by: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com> Acked-by: Jordan Justen <jordan.l.justen@intel.com> git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16267 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Anthony PERARD
jljusten
292
OvmfPkg/XenBusDxe/XenStore.h
Normal file
292
OvmfPkg/XenBusDxe/XenStore.h
Normal file
@@ -0,0 +1,292 @@
|
||||
/** @file
|
||||
Method declarations and structures for accessing the XenStore
|
||||
|
||||
Copyright (C) 2005 Rusty Russell, IBM Corporation
|
||||
Copyright (C) 2005 XenSource Ltd.
|
||||
Copyright (C) 2009,2010 Spectra Logic Corporation
|
||||
Copyright (C) 2014, Citrix Ltd.
|
||||
|
||||
This file may be distributed separately from the Linux kernel, or
|
||||
incorporated into other software packages, subject to the following license:
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this source file (the "Software"), to deal in the Software without
|
||||
restriction, including without limitation the rights to use, copy, modify,
|
||||
merge, publish, distribute, sublicense, and/or sell copies of the Software,
|
||||
and to permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
||||
IN THE SOFTWARE.
|
||||
**/
|
||||
|
||||
#ifndef _XEN_XENSTORE_XENSTOREVAR_H
|
||||
#define _XEN_XENSTORE_XENSTOREVAR_H
|
||||
|
||||
#include "XenBusDxe.h"
|
||||
|
||||
#include <IndustryStandard/Xen/io/xs_wire.h>
|
||||
|
||||
typedef struct _XENSTORE_WATCH XENSTORE_WATCH;
|
||||
|
||||
/**
|
||||
Fetch the contents of a directory in the XenStore.
|
||||
|
||||
@param Transaction The XenStore transaction covering this request.
|
||||
@param DirectoryPath The dirname of the path to read.
|
||||
@param Node The basename of the path to read.
|
||||
@param DirectoryCountPtr The returned number of directory entries.
|
||||
@param DirectoryListPtr An array of directory entry strings.
|
||||
|
||||
@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value
|
||||
indicating the type of failure.
|
||||
|
||||
@note The results buffer is alloced and should be free'd by the
|
||||
caller.
|
||||
**/
|
||||
XENSTORE_STATUS
|
||||
XenStoreListDirectory (
|
||||
IN XENSTORE_TRANSACTION Transaction,
|
||||
IN CONST CHAR8 *DirectoryPath,
|
||||
IN CONST CHAR8 *Node,
|
||||
OUT UINT32 *DirectoryCountPtr,
|
||||
OUT CONST CHAR8 ***DirectoryListPtr
|
||||
);
|
||||
|
||||
/**
|
||||
Determine if a path exists in the XenStore.
|
||||
|
||||
@param Transaction The XenStore transaction covering this request.
|
||||
@param Directory The dirname of the path to read.
|
||||
@param Node The basename of the path to read.
|
||||
|
||||
@retval TRUE The path exists.
|
||||
@retval FALSE The path does not exist or an error occurred attempting
|
||||
to make that determination.
|
||||
**/
|
||||
BOOLEAN
|
||||
XenStorePathExists (
|
||||
IN XENSTORE_TRANSACTION Transaction,
|
||||
IN CONST CHAR8 *Directory,
|
||||
IN CONST CHAR8 *Node
|
||||
);
|
||||
|
||||
/**
|
||||
Get the contents of a single "file". Returns the contents in *Result which
|
||||
should be freed after use. The length of the value in bytes is returned in
|
||||
*LenPtr.
|
||||
|
||||
@param Transaction The XenStore transaction covering this request.
|
||||
@param DirectoryPath The dirname of the file to read.
|
||||
@param Node The basename of the file to read.
|
||||
@param LenPtr The amount of data read.
|
||||
@param Result The returned contents from this file.
|
||||
|
||||
@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value
|
||||
indicating the type of failure.
|
||||
|
||||
@note The results buffer is malloced and should be free'd by the
|
||||
caller.
|
||||
**/
|
||||
XENSTORE_STATUS
|
||||
XenStoreRead (
|
||||
IN XENSTORE_TRANSACTION Transaction,
|
||||
IN CONST CHAR8 *DirectoryPath,
|
||||
IN CONST CHAR8 *Node,
|
||||
OUT UINT32 *LenPtr OPTIONAL,
|
||||
OUT VOID **Result
|
||||
);
|
||||
|
||||
/**
|
||||
Write to a single file.
|
||||
|
||||
@param Transaction The XenStore transaction covering this request.
|
||||
@param DirectoryPath The dirname of the file to write.
|
||||
@param Node The basename of the file to write.
|
||||
@param Str The NUL terminated string of data to write.
|
||||
|
||||
@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value
|
||||
indicating the type of failure.
|
||||
**/
|
||||
XENSTORE_STATUS
|
||||
XenStoreWrite (
|
||||
IN XENSTORE_TRANSACTION Transaction,
|
||||
IN CONST CHAR8 *DirectoryPath,
|
||||
IN CONST CHAR8 *Node,
|
||||
IN CONST CHAR8 *Str
|
||||
);
|
||||
|
||||
/**
|
||||
Remove a file or directory (directories must be empty).
|
||||
|
||||
@param Transaction The XenStore transaction covering this request.
|
||||
@param DirectoryPath The dirname of the directory to remove.
|
||||
@param Node The basename of the directory to remove.
|
||||
|
||||
@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value
|
||||
indicating the type of failure.
|
||||
**/
|
||||
XENSTORE_STATUS
|
||||
XenStoreRemove (
|
||||
IN XENSTORE_TRANSACTION Transaction,
|
||||
IN CONST CHAR8 *DirectoryPath,
|
||||
IN CONST CHAR8 *Node
|
||||
);
|
||||
|
||||
/**
|
||||
Start a transaction.
|
||||
|
||||
Changes by others will not be seen during the lifetime of this
|
||||
transaction, and changes will not be visible to others until it
|
||||
is committed (XenStoreTransactionEnd).
|
||||
|
||||
@param Transaction The returned transaction.
|
||||
|
||||
@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value
|
||||
indicating the type of failure.
|
||||
**/
|
||||
XENSTORE_STATUS
|
||||
XenStoreTransactionStart (
|
||||
OUT XENSTORE_TRANSACTION *Transaction
|
||||
);
|
||||
|
||||
/**
|
||||
End a transaction.
|
||||
|
||||
@param Transaction The transaction to end/commit.
|
||||
@param Abort If TRUE, the transaction is discarded
|
||||
instead of committed.
|
||||
|
||||
@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value
|
||||
indicating the type of failure.
|
||||
**/
|
||||
XENSTORE_STATUS
|
||||
XenStoreTransactionEnd (
|
||||
IN XENSTORE_TRANSACTION Transaction,
|
||||
IN BOOLEAN Abort
|
||||
);
|
||||
|
||||
/**
|
||||
Printf formatted write to a XenStore file.
|
||||
|
||||
@param Transaction The XenStore transaction covering this request.
|
||||
@param DirectoryPath The dirname of the path to read.
|
||||
@param Node The basename of the path to read.
|
||||
@param FormatString AsciiSPrint format string followed by a variable number
|
||||
of arguments.
|
||||
|
||||
@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value
|
||||
indicating the type of write failure.
|
||||
**/
|
||||
XENSTORE_STATUS
|
||||
EFIAPI
|
||||
XenStoreSPrint (
|
||||
IN XENSTORE_TRANSACTION Transaction,
|
||||
IN CONST CHAR8 *DirectoryPath,
|
||||
IN CONST CHAR8 *Node,
|
||||
IN CONST CHAR8 *FormatString,
|
||||
...
|
||||
);
|
||||
|
||||
/**
|
||||
VA_LIST version of XenStoreSPrint().
|
||||
|
||||
@param Transaction The XenStore transaction covering this request.
|
||||
@param DirectoryPath The dirname of the path to read.
|
||||
@param Node The basename of the path to read.
|
||||
@param FormatString Printf format string.
|
||||
@param Marker VA_LIST of printf arguments.
|
||||
|
||||
@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value
|
||||
indicating the type of write failure.
|
||||
**/
|
||||
XENSTORE_STATUS
|
||||
XenStoreVSPrint (
|
||||
IN XENSTORE_TRANSACTION Transaction,
|
||||
IN CONST CHAR8 *DirectoryPath,
|
||||
IN CONST CHAR8 *Node,
|
||||
IN CONST CHAR8 *FormatString,
|
||||
IN VA_LIST Marker
|
||||
);
|
||||
|
||||
/**
|
||||
Register a XenStore watch.
|
||||
|
||||
XenStore watches allow a client to be notified via a callback (embedded
|
||||
within the watch object) of changes to an object in the XenStore.
|
||||
|
||||
@param DirectoryPath The dirname of the path to watch.
|
||||
@param Node The basename of the path to watch.
|
||||
@param WatchPtr A returned XENSTORE_WATCH pointer.
|
||||
|
||||
@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value
|
||||
indicating the type of write failure. EEXIST errors from the
|
||||
XenStore are supressed, allowing multiple, physically different,
|
||||
xenbus_watch objects, to watch the same path in the XenStore.
|
||||
**/
|
||||
XENSTORE_STATUS
|
||||
XenStoreRegisterWatch (
|
||||
IN CONST CHAR8 *DirectoryPath,
|
||||
IN CONST CHAR8 *Node,
|
||||
OUT XENSTORE_WATCH **WatchPtr
|
||||
);
|
||||
|
||||
/**
|
||||
Unregister a XenStore watch.
|
||||
|
||||
@param Watch An XENSTORE_WATCH object previously returned by a successful
|
||||
call to XenStoreRegisterWatch ().
|
||||
**/
|
||||
VOID
|
||||
XenStoreUnregisterWatch (
|
||||
IN XENSTORE_WATCH *Watch
|
||||
);
|
||||
|
||||
/**
|
||||
Allocate and return the XenStore path string <DirectoryPath>/<Node>. If name
|
||||
is the NUL string, the returned value contains the path string
|
||||
<DirectoryPath>.
|
||||
|
||||
@param DirectoryPath The NUL terminated directory prefix for new path.
|
||||
@param Node The NUL terminated basename for the new path.
|
||||
|
||||
@return A buffer containing the joined path.
|
||||
*/
|
||||
CHAR8 *
|
||||
XenStoreJoin (
|
||||
IN CONST CHAR8 *DirectoryPath,
|
||||
IN CONST CHAR8 *Node
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
Initialize the XenStore states and rings.
|
||||
|
||||
@param Dev A pointer to a XENBUS_DEVICE instance.
|
||||
|
||||
@return EFI_SUCCESS if everything went smoothly.
|
||||
**/
|
||||
EFI_STATUS
|
||||
XenStoreInit (
|
||||
XENBUS_DEVICE *Dev
|
||||
);
|
||||
|
||||
/**
|
||||
Deinitialize the XenStore states and rings.
|
||||
|
||||
@param Dev A pointer to a XENBUS_DEVICE instance.
|
||||
**/
|
||||
VOID
|
||||
XenStoreDeinit (
|
||||
IN XENBUS_DEVICE *Dev
|
||||
);
|
||||
|
||||
#endif /* _XEN_XENSTORE_XENSTOREVAR_H */
|
||||
Reference in New Issue
Block a user