1 /*
2  * libvirt-gobject-output-stream.h: libvirt gobject integration
3  *
4  * Copyright (C) 2011 Red Hat, Inc.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library. If not, see
18  * <http://www.gnu.org/licenses/>.
19  *
20  * Authors: Daniel P. Berrange <berrange@redhat.com>
21  *          Marc-André Lureau <marcandre.lureau@redhat.com>
22  */
23 
24 #include <config.h>
25 
26 #include <libvirt/virterror.h>
27 #include <string.h>
28 
29 #include "libvirt-glib/libvirt-glib.h"
30 #include "libvirt-gobject/libvirt-gobject.h"
31 #include "libvirt-gobject-output-stream.h"
32 #include "libvirt-gobject-compat.h"
33 
34 enum
35 {
36     PROP_0,
37     PROP_STREAM
38 };
39 
40 struct _GVirOutputStreamPrivate
41 {
42     GVirStream *stream;
43 
44     /* pending operation metadata */
45     GTask *task;
46     const void * buffer;
47     gsize count;
48 };
49 
50 #define gvir_output_stream_get_type _gvir_output_stream_get_type
51 G_DEFINE_TYPE_WITH_PRIVATE(GVirOutputStream, gvir_output_stream, G_TYPE_OUTPUT_STREAM);
52 
gvir_output_stream_get_property(GObject * object,guint prop_id,GValue * value,GParamSpec * pspec)53 static void gvir_output_stream_get_property(GObject *object,
54                                             guint prop_id,
55                                             GValue *value,
56                                             GParamSpec *pspec)
57 {
58     GVirOutputStream *stream = GVIR_OUTPUT_STREAM(object);
59 
60     switch (prop_id) {
61     case PROP_STREAM:
62         g_value_set_object(value, stream->priv->stream);
63         break;
64 
65     default:
66         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
67     }
68 }
69 
gvir_output_stream_set_property(GObject * object,guint prop_id,const GValue * value,GParamSpec * pspec)70 static void gvir_output_stream_set_property(GObject *object,
71                                             guint prop_id,
72                                             const GValue *value,
73                                             GParamSpec *pspec)
74 {
75     GVirOutputStream *stream = GVIR_OUTPUT_STREAM(object);
76 
77     switch (prop_id) {
78     case PROP_STREAM:
79         stream->priv->stream = g_value_get_object(value);
80         break;
81 
82     default:
83         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
84     }
85 }
86 
gvir_output_stream_finalize(GObject * object)87 static void gvir_output_stream_finalize(GObject *object)
88 {
89     GVirOutputStream *stream = GVIR_OUTPUT_STREAM(object);
90 
91     stream->priv->stream = NULL; // unowned
92 
93     if (G_OBJECT_CLASS(gvir_output_stream_parent_class)->finalize)
94         (*G_OBJECT_CLASS(gvir_output_stream_parent_class)->finalize)(object);
95 }
96 
97 static gboolean
gvir_output_stream_write_ready(GVirStream * stream,GVirStreamIOCondition cond,void * opaque)98 gvir_output_stream_write_ready(GVirStream *stream,
99                                GVirStreamIOCondition cond,
100                                void *opaque)
101 {
102     GVirOutputStream *output_stream = GVIR_OUTPUT_STREAM(opaque);
103     GVirOutputStreamPrivate *priv = output_stream->priv;
104     GTask *task = priv->task;
105     GCancellable *cancellable = g_task_get_cancellable(task);
106     GError *error = NULL;
107     gssize result;
108 
109     if (!(cond & GVIR_STREAM_IO_CONDITION_WRITABLE)) {
110         g_warn_if_reached();
111         g_task_return_new_error(task,
112                                 G_IO_ERROR,
113                                 G_IO_ERROR_INVALID_ARGUMENT,
114                                 "%s",
115                                 "Expected stream to be readable");
116         goto cleanup;
117     }
118 
119     result  = gvir_stream_send(stream, priv->buffer, priv->count,
120                                cancellable, &error);
121 
122     if (error != NULL) {
123         if (g_error_matches(error, G_IO_ERROR, G_IO_ERROR_WOULD_BLOCK)) {
124             g_warn_if_reached();
125             g_task_return_new_error(task,
126                                     G_IO_ERROR,
127                                     G_IO_ERROR_INVALID_ARGUMENT,
128                                     "%s",
129                                     "Expected stream to be writable");
130             g_error_free (error);
131         } else {
132             g_task_return_error(task, error);
133         }
134 
135         goto cleanup;
136     }
137 
138     g_task_return_int(task, result);
139 
140 cleanup:
141     priv->task = NULL;
142     g_object_unref(task);
143     return FALSE;
144 }
145 
gvir_output_stream_write_async(GOutputStream * stream,const void * buffer,gsize count,int io_priority G_GNUC_UNUSED,GCancellable * cancellable,GAsyncReadyCallback callback,gpointer user_data)146 static void gvir_output_stream_write_async(GOutputStream *stream,
147                                            const void *buffer,
148                                            gsize count,
149                                            int io_priority G_GNUC_UNUSED,
150                                            GCancellable *cancellable,
151                                            GAsyncReadyCallback callback,
152                                            gpointer user_data)
153 {
154     GVirOutputStream *output_stream = GVIR_OUTPUT_STREAM(stream);
155 
156     g_return_if_fail(GVIR_IS_OUTPUT_STREAM(stream));
157     g_return_if_fail(output_stream->priv->task == NULL);
158 
159     gvir_stream_add_watch_full(output_stream->priv->stream,
160                                G_PRIORITY_DEFAULT,
161                                GVIR_STREAM_IO_CONDITION_WRITABLE,
162                                gvir_output_stream_write_ready,
163                                g_object_ref(stream),
164                                (GDestroyNotify)g_object_unref);
165 
166     output_stream->priv->task =
167         g_task_new(stream, cancellable, callback, user_data);
168     output_stream->priv->buffer = buffer;
169     output_stream->priv->count = count;
170 }
171 
172 
gvir_output_stream_write_finish(GOutputStream * stream,GAsyncResult * result,GError ** error)173 static gssize gvir_output_stream_write_finish(GOutputStream *stream,
174                                               GAsyncResult *result,
175                                               GError **error)
176 {
177     GVirOutputStream *output_stream = GVIR_OUTPUT_STREAM(stream);
178     virStreamPtr handle;
179     gssize count;
180 
181     g_return_val_if_fail(GVIR_IS_OUTPUT_STREAM(stream), -1);
182     g_return_val_if_fail(g_task_is_valid(result, stream), -1);
183     g_return_val_if_fail(error == NULL || *error == NULL, -1);
184     g_object_get(output_stream->priv->stream, "handle", &handle, NULL);
185 
186     count = g_task_propagate_int(G_TASK(result), error);
187 
188     virStreamFree(handle);
189 
190     return count;
191 }
192 
193 
gvir_output_stream_class_init(GVirOutputStreamClass * klass)194 static void gvir_output_stream_class_init(GVirOutputStreamClass *klass)
195 {
196     GObjectClass *gobject_class = G_OBJECT_CLASS(klass);
197     GOutputStreamClass *goutputstream_class = G_OUTPUT_STREAM_CLASS(klass);
198 
199     gobject_class->finalize = gvir_output_stream_finalize;
200     gobject_class->get_property = gvir_output_stream_get_property;
201     gobject_class->set_property = gvir_output_stream_set_property;
202 
203     goutputstream_class->write_fn = NULL;
204     goutputstream_class->write_async = gvir_output_stream_write_async;
205     goutputstream_class->write_finish = gvir_output_stream_write_finish;
206 
207     g_object_class_install_property(gobject_class, PROP_STREAM,
208                                     g_param_spec_object("stream",
209                                                         "stream",
210                                                         "GVirStream",
211                                                         GVIR_TYPE_STREAM, G_PARAM_CONSTRUCT_ONLY |
212                                                         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
213 }
214 
gvir_output_stream_init(GVirOutputStream * stream)215 static void gvir_output_stream_init(GVirOutputStream *stream)
216 {
217     stream->priv = G_TYPE_INSTANCE_GET_PRIVATE(stream, GVIR_TYPE_OUTPUT_STREAM, GVirOutputStreamPrivate);
218 }
219 
_gvir_output_stream_new(GVirStream * stream)220 GVirOutputStream* _gvir_output_stream_new(GVirStream *stream)
221 {
222     return GVIR_OUTPUT_STREAM(g_object_new(GVIR_TYPE_OUTPUT_STREAM, "stream", stream, NULL));
223 }
224