# HG changeset patch
# User Ewan Mellor <ewan@xxxxxxxxxxxxx>
# Date 1176414542 -3600
# Node ID 456c611ada027df8b38a5373dba3eee1e4b6c252
# Parent 0c00c6a48d52ff7143c5a259c4ec1b76becf679a
Added documentation and C bindings for VBD. and VIF.runtime_properties.
Signed-off-by: Ewan Mellor <ewan@xxxxxxxxxxxxx>
---
docs/xen-api/xenapi-datamodel.tex | 66 ++++++++++++++++++++++++++++++++++++++
tools/libxen/include/xen_vbd.h | 8 ++++
tools/libxen/include/xen_vif.h | 12 +++++-
tools/libxen/src/xen_vbd.c | 21 ++++++++++++
tools/libxen/src/xen_vif.c | 21 ++++++++++++
5 files changed, 126 insertions(+), 2 deletions(-)
diff -r 0c00c6a48d52 -r 456c611ada02 docs/xen-api/xenapi-datamodel.tex
--- a/docs/xen-api/xenapi-datamodel.tex Fri Apr 13 17:17:21 2007 +0100
+++ b/docs/xen-api/xenapi-datamodel.tex Thu Apr 12 22:49:02 2007 +0100
@@ -7742,6 +7742,7 @@ Quals & Field & Type & Description \\
$\mathit{RO}_\mathit{run}$ & {\tt currently\_attached} & bool & is the device
currently attached (erased on reboot) \\
$\mathit{RO}_\mathit{run}$ & {\tt status\_code} & int & error/success code
associated with last attach-operation (erased on reboot) \\
$\mathit{RO}_\mathit{run}$ & {\tt status\_detail} & string & error/success
information associated with last attach-operation status (erased on reboot) \\
+$\mathit{RO}_\mathit{run}$ & {\tt runtime\_properties} & (string
$\rightarrow$ string) Map & Device runtime properties \\
$\mathit{RW}$ & {\tt qos/algorithm\_type} & string & QoS algorithm to use \\
$\mathit{RW}$ & {\tt qos/algorithm\_params} & (string $\rightarrow$ string)
Map & parameters for chosen QoS algorithm \\
$\mathit{RO}_\mathit{run}$ & {\tt qos/supported\_algorithms} & string Set &
supported QoS algorithms for this VIF \\
@@ -8218,6 +8219,38 @@ Get the status\_detail field of the give
\noindent {\bf Return Type:}
{\tt
string
+}
+
+
+value of the field
+\vspace{0.3cm}
+\vspace{0.3cm}
+\vspace{0.3cm}
+\subsubsection{RPC name:~get\_runtime\_properties}
+
+{\bf Overview:}
+Get the runtime\_properties field of the given VIF.
+
+ \noindent {\bf Signature:}
+\begin{verbatim} ((string -> string) Map) get_runtime_properties (session_id
s, VIF ref self)\end{verbatim}
+
+
+\noindent{\bf Arguments:}
+
+
+\vspace{0.3cm}
+\begin{tabular}{|c|c|p{7cm}|}
+ \hline
+{\bf type} & {\bf name} & {\bf description} \\ \hline
+{\tt VIF ref } & self & reference to the object \\ \hline
+
+\end{tabular}
+
+\vspace{0.3cm}
+
+ \noindent {\bf Return Type:}
+{\tt
+(string $\rightarrow$ string) Map
}
@@ -11108,6 +11141,7 @@ Quals & Field & Type & Description \\
$\mathit{RO}_\mathit{run}$ & {\tt currently\_attached} & bool & is the device
currently attached (erased on reboot) \\
$\mathit{RO}_\mathit{run}$ & {\tt status\_code} & int & error/success code
associated with last attach-operation (erased on reboot) \\
$\mathit{RO}_\mathit{run}$ & {\tt status\_detail} & string & error/success
information associated with last attach-operation status (erased on reboot) \\
+$\mathit{RO}_\mathit{run}$ & {\tt runtime\_properties} & (string
$\rightarrow$ string) Map & Device runtime properties \\
$\mathit{RW}$ & {\tt qos/algorithm\_type} & string & QoS algorithm to use \\
$\mathit{RW}$ & {\tt qos/algorithm\_params} & (string $\rightarrow$ string)
Map & parameters for chosen QoS algorithm \\
$\mathit{RO}_\mathit{run}$ & {\tt qos/supported\_algorithms} & string Set &
supported QoS algorithms for this VBD \\
@@ -11685,6 +11719,38 @@ Get the status\_detail field of the give
\noindent {\bf Return Type:}
{\tt
string
+}
+
+
+value of the field
+\vspace{0.3cm}
+\vspace{0.3cm}
+\vspace{0.3cm}
+\subsubsection{RPC name:~get\_runtime\_properties}
+
+{\bf Overview:}
+Get the runtime\_properties field of the given VBD.
+
+ \noindent {\bf Signature:}
+\begin{verbatim} ((string -> string) Map) get_runtime_properties (session_id
s, VBD ref self)\end{verbatim}
+
+
+\noindent{\bf Arguments:}
+
+
+\vspace{0.3cm}
+\begin{tabular}{|c|c|p{7cm}|}
+ \hline
+{\bf type} & {\bf name} & {\bf description} \\ \hline
+{\tt VBD ref } & self & reference to the object \\ \hline
+
+\end{tabular}
+
+\vspace{0.3cm}
+
+ \noindent {\bf Return Type:}
+{\tt
+(string $\rightarrow$ string) Map
}
diff -r 0c00c6a48d52 -r 456c611ada02 tools/libxen/include/xen_vbd.h
--- a/tools/libxen/include/xen_vbd.h Fri Apr 13 17:17:21 2007 +0100
+++ b/tools/libxen/include/xen_vbd.h Thu Apr 12 22:49:02 2007 +0100
@@ -78,6 +78,7 @@ typedef struct xen_vbd_record
bool currently_attached;
int64_t status_code;
char *status_detail;
+ xen_string_string_map *runtime_properties;
char *qos_algorithm_type;
xen_string_string_map *qos_algorithm_params;
struct xen_string_set *qos_supported_algorithms;
@@ -262,6 +263,13 @@ xen_vbd_get_status_detail(xen_session *s
/**
+ * Get the runtime_properties field of the given VBD.
+ */
+extern bool
+xen_vbd_get_runtime_properties(xen_session *session, xen_string_string_map
**result, xen_vbd vbd);
+
+
+/**
* Get the qos/algorithm_type field of the given VBD.
*/
extern bool
diff -r 0c00c6a48d52 -r 456c611ada02 tools/libxen/include/xen_vif.h
--- a/tools/libxen/include/xen_vif.h Fri Apr 13 17:17:21 2007 +0100
+++ b/tools/libxen/include/xen_vif.h Thu Apr 12 22:49:02 2007 +0100
@@ -75,6 +75,7 @@ typedef struct xen_vif_record
bool currently_attached;
int64_t status_code;
char *status_detail;
+ xen_string_string_map *runtime_properties;
char *qos_algorithm_type;
xen_string_string_map *qos_algorithm_params;
struct xen_string_set *qos_supported_algorithms;
@@ -252,6 +253,13 @@ xen_vif_get_status_detail(xen_session *s
/**
+ * Get the runtime_properties field of the given VIF.
+ */
+extern bool
+xen_vif_get_runtime_properties(xen_session *session, xen_string_string_map
**result, xen_vif vif);
+
+
+/**
* Get the qos/algorithm_type field of the given VIF.
*/
extern bool
@@ -333,7 +341,7 @@ xen_vif_remove_from_qos_algorithm_params
/**
* Hotplug the specified VIF, dynamically attaching it to the running
- * VM
+ * VM.
*/
extern bool
xen_vif_plug(xen_session *session, xen_vif self);
@@ -341,7 +349,7 @@ xen_vif_plug(xen_session *session, xen_v
/**
* Hot-unplug the specified VIF, dynamically unattaching it from the
- * running VM
+ * running VM.
*/
extern bool
xen_vif_unplug(xen_session *session, xen_vif self);
diff -r 0c00c6a48d52 -r 456c611ada02 tools/libxen/src/xen_vbd.c
--- a/tools/libxen/src/xen_vbd.c Fri Apr 13 17:17:21 2007 +0100
+++ b/tools/libxen/src/xen_vbd.c Thu Apr 12 22:49:02 2007 +0100
@@ -72,6 +72,9 @@ static const struct_member xen_vbd_recor
{ .key = "status_detail",
.type = &abstract_type_string,
.offset = offsetof(xen_vbd_record, status_detail) },
+ { .key = "runtime_properties",
+ .type = &abstract_type_string_string_map,
+ .offset = offsetof(xen_vbd_record, runtime_properties) },
{ .key = "qos_algorithm_type",
.type = &abstract_type_string,
.offset = offsetof(xen_vbd_record, qos_algorithm_type) },
@@ -109,6 +112,7 @@ xen_vbd_record_free(xen_vbd_record *reco
xen_vdi_record_opt_free(record->vdi);
free(record->device);
free(record->status_detail);
+ xen_string_string_map_free(record->runtime_properties);
free(record->qos_algorithm_type);
xen_string_string_map_free(record->qos_algorithm_params);
xen_string_set_free(record->qos_supported_algorithms);
@@ -335,6 +339,23 @@ xen_vbd_get_status_detail(xen_session *s
bool
+xen_vbd_get_runtime_properties(xen_session *session, xen_string_string_map
**result, xen_vbd vbd)
+{
+ abstract_value param_values[] =
+ {
+ { .type = &abstract_type_string,
+ .u.string_val = vbd }
+ };
+
+ abstract_type result_type = abstract_type_string_string_map;
+
+ *result = NULL;
+ XEN_CALL_("VBD.get_runtime_properties");
+ return session->ok;
+}
+
+
+bool
xen_vbd_get_qos_algorithm_type(xen_session *session, char **result, xen_vbd
vbd)
{
abstract_value param_values[] =
diff -r 0c00c6a48d52 -r 456c611ada02 tools/libxen/src/xen_vif.c
--- a/tools/libxen/src/xen_vif.c Fri Apr 13 17:17:21 2007 +0100
+++ b/tools/libxen/src/xen_vif.c Thu Apr 12 22:49:02 2007 +0100
@@ -67,6 +67,9 @@ static const struct_member xen_vif_recor
{ .key = "status_detail",
.type = &abstract_type_string,
.offset = offsetof(xen_vif_record, status_detail) },
+ { .key = "runtime_properties",
+ .type = &abstract_type_string_string_map,
+ .offset = offsetof(xen_vif_record, runtime_properties) },
{ .key = "qos_algorithm_type",
.type = &abstract_type_string,
.offset = offsetof(xen_vif_record, qos_algorithm_type) },
@@ -105,6 +108,7 @@ xen_vif_record_free(xen_vif_record *reco
xen_vm_record_opt_free(record->vm);
free(record->mac);
free(record->status_detail);
+ xen_string_string_map_free(record->runtime_properties);
free(record->qos_algorithm_type);
xen_string_string_map_free(record->qos_algorithm_params);
xen_string_set_free(record->qos_supported_algorithms);
@@ -318,6 +322,23 @@ xen_vif_get_status_detail(xen_session *s
bool
+xen_vif_get_runtime_properties(xen_session *session, xen_string_string_map
**result, xen_vif vif)
+{
+ abstract_value param_values[] =
+ {
+ { .type = &abstract_type_string,
+ .u.string_val = vif }
+ };
+
+ abstract_type result_type = abstract_type_string_string_map;
+
+ *result = NULL;
+ XEN_CALL_("VIF.get_runtime_properties");
+ return session->ok;
+}
+
+
+bool
xen_vif_get_qos_algorithm_type(xen_session *session, char **result, xen_vif
vif)
{
abstract_value param_values[] =
_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-changelog
|
Home