OvmfPkg/Xen*: Pass struct XENSTORE_TRANSACTION argument as a pointer

[mirror_edk2.git] / OvmfPkg / XenBusDxe / XenStore.h

/** @file\r
  Method declarations and structures for accessing the XenStore\r
\r
  Copyright (C) 2005 Rusty Russell, IBM Corporation\r
  Copyright (C) 2005 XenSource Ltd.\r
  Copyright (C) 2009,2010 Spectra Logic Corporation\r
  Copyright (C) 2014, Citrix Ltd.\r
\r
  This file may be distributed separately from the Linux kernel, or\r
  incorporated into other software packages, subject to the following license:\r
\r
  Permission is hereby granted, free of charge, to any person obtaining a copy\r
  of this source file (the "Software"), to deal in the Software without\r
  restriction, including without limitation the rights to use, copy, modify,\r
  merge, publish, distribute, sublicense, and/or sell copies of the Software,\r
  and to permit persons to whom the Software is furnished to do so, subject to\r
  the following conditions:\r
\r
  The above copyright notice and this permission notice shall be included in\r
  all copies or substantial portions of the Software.\r
\r
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\r
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\r
  IN THE SOFTWARE.\r
**/\r
\r
#ifndef _XEN_XENSTORE_XENSTOREVAR_H\r
#define _XEN_XENSTORE_XENSTOREVAR_H\r
\r
#include "XenBusDxe.h"\r
\r
#include <IndustryStandard/Xen/io/xs_wire.h>\r
\r
typedef struct _XENSTORE_WATCH XENSTORE_WATCH;\r
\r
/**\r
  Fetch the contents of a directory in the XenStore.\r
\r
  @param Transaction        The XenStore transaction covering this request.\r
  @param DirectoryPath      The dirname of the path to read.\r
  @param Node               The basename of the path to read.\r
  @param DirectoryCountPtr  The returned number of directory entries.\r
  @param DirectoryListPtr   An array of directory entry strings.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of failure.\r
\r
  @note The results buffer is alloced and should be free'd by the\r
        caller.\r
**/\r
XENSTORE_STATUS\r
XenStoreListDirectory (\r
  IN  CONST XENSTORE_TRANSACTION *Transaction,\r
  IN  CONST CHAR8           *DirectoryPath,\r
  IN  CONST CHAR8           *Node,\r
  OUT UINT32                *DirectoryCountPtr,\r
  OUT CONST CHAR8           ***DirectoryListPtr\r
  );\r
\r
/**\r
  Determine if a path exists in the XenStore.\r
\r
  @param Transaction  The XenStore transaction covering this request.\r
  @param Directory    The dirname of the path to read.\r
  @param Node         The basename of the path to read.\r
\r
  @retval TRUE  The path exists.\r
  @retval FALSE The path does not exist or an error occurred attempting\r
                to make that determination.\r
**/\r
BOOLEAN\r
XenStorePathExists (\r
  IN CONST XENSTORE_TRANSACTION *Transaction,\r
  IN CONST CHAR8 *Directory,\r
  IN CONST CHAR8 *Node\r
  );\r
\r
/**\r
  Get the contents of a single "file".  Returns the contents in *Result which\r
  should be freed after use.  The length of the value in bytes is returned in\r
  *LenPtr.\r
\r
  @param Transaction    The XenStore transaction covering this request.\r
  @param DirectoryPath  The dirname of the file to read.\r
  @param Node           The basename of the file to read.\r
  @param LenPtr         The amount of data read.\r
  @param Result         The returned contents from this file.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of failure.\r
\r
  @note The results buffer is malloced and should be free'd by the\r
        caller.\r
**/\r
XENSTORE_STATUS\r
XenStoreRead (\r
  IN  CONST XENSTORE_TRANSACTION *Transaction,\r
  IN  CONST CHAR8             *DirectoryPath,\r
  IN  CONST CHAR8             *Node,\r
  OUT UINT32                  *LenPtr OPTIONAL,\r
  OUT VOID                    **Result\r
  );\r
\r
/**\r
  Write to a single file.\r
\r
  @param Transaction    The XenStore transaction covering this request.\r
  @param DirectoryPath  The dirname of the file to write.\r
  @param Node           The basename of the file to write.\r
  @param Str            The NUL terminated string of data to write.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of failure.\r
**/\r
XENSTORE_STATUS\r
XenStoreWrite (\r
  IN CONST XENSTORE_TRANSACTION *Transaction,\r
  IN CONST CHAR8           *DirectoryPath,\r
  IN CONST CHAR8           *Node,\r
  IN CONST CHAR8           *Str\r
  );\r
\r
/**\r
  Remove a file or directory (directories must be empty).\r
\r
  @param Transaction    The XenStore transaction covering this request.\r
  @param DirectoryPath  The dirname of the directory to remove.\r
  @param Node           The basename of the directory to remove.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of failure.\r
**/\r
XENSTORE_STATUS\r
XenStoreRemove (\r
  IN CONST XENSTORE_TRANSACTION *Transaction,\r
  IN CONST CHAR8            *DirectoryPath,\r
  IN CONST CHAR8            *Node\r
  );\r
\r
/**\r
  Start a transaction.\r
\r
  Changes by others will not be seen during the lifetime of this\r
  transaction, and changes will not be visible to others until it\r
  is committed (XenStoreTransactionEnd).\r
\r
  @param Transaction  The returned transaction.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of failure.\r
**/\r
XENSTORE_STATUS\r
XenStoreTransactionStart (\r
  OUT XENSTORE_TRANSACTION *Transaction\r
  );\r
\r
/**\r
  End a transaction.\r
\r
  @param Transaction  The transaction to end/commit.\r
  @param Abort        If TRUE, the transaction is discarded\r
                      instead of committed.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of failure.\r
**/\r
XENSTORE_STATUS\r
XenStoreTransactionEnd (\r
  IN CONST XENSTORE_TRANSACTION *Transaction,\r
  IN BOOLEAN                Abort\r
  );\r
\r
/**\r
  Printf formatted write to a XenStore file.\r
\r
  @param Transaction      The XenStore transaction covering this request.\r
  @param DirectoryPath    The dirname of the path to read.\r
  @param Node             The basename of the path to read.\r
  @param FormatString     AsciiSPrint format string followed by a variable number\r
                          of arguments.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of write failure.\r
**/\r
XENSTORE_STATUS\r
EFIAPI\r
XenStoreSPrint (\r
  IN CONST XENSTORE_TRANSACTION *Transaction,\r
  IN CONST CHAR8            *DirectoryPath,\r
  IN CONST CHAR8            *Node,\r
  IN CONST CHAR8            *FormatString,\r
  ...\r
  );\r
\r
/**\r
  VA_LIST version of XenStoreSPrint().\r
\r
  @param Transaction    The XenStore transaction covering this request.\r
  @param DirectoryPath  The dirname of the path to read.\r
  @param Node           The basename of the path to read.\r
  @param FormatString   Printf format string.\r
  @param Marker         VA_LIST of printf arguments.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of write failure.\r
**/\r
XENSTORE_STATUS\r
XenStoreVSPrint (\r
  IN CONST XENSTORE_TRANSACTION *Transaction,\r
  IN CONST CHAR8           *DirectoryPath,\r
  IN CONST CHAR8           *Node,\r
  IN CONST CHAR8           *FormatString,\r
  IN VA_LIST               Marker\r
  );\r
\r
/**\r
  Register a XenStore watch.\r
\r
  XenStore watches allow a client to be notified via a callback (embedded\r
  within the watch object) of changes to an object in the XenStore.\r
\r
  @param DirectoryPath  The dirname of the path to watch.\r
  @param Node           The basename of the path to watch.\r
  @param WatchPtr       A returned XENSTORE_WATCH pointer.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of write failure.  EEXIST errors from the\r
           XenStore are supressed, allowing multiple, physically different,\r
           xenbus_watch objects, to watch the same path in the XenStore.\r
**/\r
XENSTORE_STATUS\r
XenStoreRegisterWatch (\r
  IN  CONST CHAR8     *DirectoryPath,\r
  IN  CONST CHAR8     *Node,\r
  OUT XENSTORE_WATCH  **WatchPtr\r
  );\r
\r
/**\r
  Unregister a XenStore watch.\r
\r
  @param Watch  An XENSTORE_WATCH object previously returned by a successful\r
                call to XenStoreRegisterWatch ().\r
**/\r
VOID\r
XenStoreUnregisterWatch (\r
  IN XENSTORE_WATCH *Watch\r
  );\r
\r
/**\r
  Allocate and return the XenStore path string <DirectoryPath>/<Node>.  If name\r
  is the NUL string, the returned value contains the path string\r
  <DirectoryPath>.\r
\r
  @param DirectoryPath	The NUL terminated directory prefix for new path.\r
  @param Node           The NUL terminated basename for the new path.\r
\r
  @return  A buffer containing the joined path.\r
 */\r
CHAR8 *\r
XenStoreJoin (\r
  IN CONST CHAR8 *DirectoryPath,\r
  IN CONST CHAR8 *Node\r
  );\r
\r
\r
/**\r
  Initialize the XenStore states and rings.\r
\r
  @param Dev  A pointer to a XENBUS_DEVICE instance.\r
\r
  @return     EFI_SUCCESS if everything went smoothly.\r
**/\r
EFI_STATUS\r
XenStoreInit (\r
  XENBUS_DEVICE *Dev\r
  );\r
\r
/**\r
  Deinitialize the XenStore states and rings.\r
\r
  @param Dev  A pointer to a XENBUS_DEVICE instance.\r
**/\r
VOID\r
XenStoreDeinit (\r
  IN XENBUS_DEVICE *Dev\r
  );\r
\r
\r
//\r
// XENBUS protocol\r
//\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusWaitForWatch (\r
  IN XENBUS_PROTOCOL *This,\r
  IN VOID *Token\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusXenStoreRead (\r
  IN  XENBUS_PROTOCOL       *This,\r
  IN  CONST XENSTORE_TRANSACTION *Transaction,\r
  IN  CONST CHAR8           *Node,\r
  OUT VOID                  **Value\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusXenStoreBackendRead (\r
  IN  XENBUS_PROTOCOL       *This,\r
  IN  CONST XENSTORE_TRANSACTION *Transaction,\r
  IN  CONST CHAR8           *Node,\r
  OUT VOID                  **Value\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusXenStoreRemove (\r
  IN XENBUS_PROTOCOL        *This,\r
  IN CONST XENSTORE_TRANSACTION *Transaction,\r
  IN CONST CHAR8            *Node\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusXenStoreTransactionStart (\r
  IN  XENBUS_PROTOCOL       *This,\r
  OUT XENSTORE_TRANSACTION  *Transaction\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusXenStoreTransactionEnd (\r
  IN XENBUS_PROTOCOL        *This,\r
  IN CONST XENSTORE_TRANSACTION *Transaction,\r
  IN BOOLEAN                Abort\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusXenStoreSPrint (\r
  IN XENBUS_PROTOCOL        *This,\r
  IN CONST XENSTORE_TRANSACTION *Transaction,\r
  IN CONST CHAR8            *DirectoryPath,\r
  IN CONST CHAR8            *Node,\r
  IN CONST CHAR8            *FormatString,\r
  ...\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusRegisterWatch (\r
  IN  XENBUS_PROTOCOL *This,\r
  IN  CONST CHAR8     *Node,\r
  OUT VOID            **Token\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusRegisterWatchBackend (\r
  IN  XENBUS_PROTOCOL *This,\r
  IN  CONST CHAR8     *Node,\r
  OUT VOID            **Token\r
  );\r
\r
VOID\r
EFIAPI\r
XenBusUnregisterWatch (\r
  IN XENBUS_PROTOCOL  *This,\r
  IN VOID             *Token\r
  );\r
\r
#endif /* _XEN_XENSTORE_XENSTOREVAR_H */\r