Debian Codegraph @

modules/iscsi/udiskslinuxiscsisessionobject.c

raw
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
2 *
3 * Copyright (C) 2015 Peter Hatina <[email protected]>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19
20 #include "config.h"
21
22 #include <libiscsi.h>
23 #include <src/udisksdaemon.h>
24 #include <src/udiskslogging.h>
25 #include <src/udiskslinuxdevice.h>
26 #include <src/udisksmodulemanager.h>
27 #include <src/udisksmoduleobject.h>
28
29 #include "udiskslinuxiscsisession.h"
30 #include "udiskslinuxiscsisessionobject.h"
31
32 /**
33 * SECTION:udiskslinuxiscsisessionobject
34 * @title: UDisksLinuxISCSISessionObject
35 * @short_description: Object representing iSCSI sessions on Linux.
36 *
37 * Object corresponding to the iSCSI session on Linux.
38 */
39
40 /**
41 * UDisksLinuxISCSISessionObject:
42 *
43 * The #UDisksLinuxISCSISessionObject structure contains only private data
44 * and should only be accessed using the provided API.
45 */
46 struct _UDisksLinuxISCSISessionObject {
47 UDisksObjectSkeleton parent_instance;
48
49 UDisksLinuxModuleISCSI *module;
50 gchar *session_id;
51
52 GHashTable *sysfs_paths;
53
54 /* Interface(s) */
55 UDisksLinuxISCSISession *iface_iscsi_session;
56 };
57
58 struct _UDisksLinuxISCSISessionObjectClass {
59 UDisksObjectSkeletonClass parent_class;
60 };
61
62 enum
63 {
64 PROP_0,
65 PROP_MODULE,
66 PROP_SESSION_ID,
67 N_PROPERTIES
68 };
69
70 #define ISCSI_SESSION_OBJECT_PATH_PREFIX "/org/freedesktop/UDisks2/iscsi/"
71
72 static void udisks_linux_iscsi_session_object_update_iface (UDisksLinuxISCSISessionObject *session_object);
73 static void udisks_linux_iscsi_session_object_iface_init (UDisksModuleObjectIface *iface);
74
75 G_DEFINE_TYPE_WITH_CODE (UDisksLinuxISCSISessionObject, udisks_linux_iscsi_session_object, UDISKS_TYPE_OBJECT_SKELETON,
76 G_IMPLEMENT_INTERFACE (UDISKS_TYPE_MODULE_OBJECT, udisks_linux_iscsi_session_object_iface_init));
77
78 static void
79 udisks_linux_iscsi_session_object_get_property (GObject *object, guint property_id,
80 GValue *value, GParamSpec *pspec)
81 {
82 UDisksLinuxISCSISessionObject *session_object = UDISKS_LINUX_ISCSI_SESSION_OBJECT (object);
83
84 switch (property_id)
85 {
86 case PROP_MODULE:
87 g_value_set_object (value, udisks_linux_iscsi_session_object_get_module (session_object));
88 break;
89
90 case PROP_SESSION_ID:
91 g_value_set_string (value, udisks_linux_iscsi_session_object_get_session_id (session_object));
92 break;
93
94 default:
95 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
96 break;
97 }
98 }
99
100 static void
101 udisks_linux_iscsi_session_object_set_property (GObject *object, guint property_id,
102 const GValue *value, GParamSpec *pspec)
103 {
104 UDisksLinuxISCSISessionObject *session_object = UDISKS_LINUX_ISCSI_SESSION_OBJECT (object);
105
106 switch (property_id)
107 {
108 case PROP_MODULE:
109 g_assert (session_object->module == NULL);
110 session_object->module = g_value_dup_object (value);
111 break;
112
113 case PROP_SESSION_ID:
114 g_assert (session_object->session_id == NULL);
115 session_object->session_id = g_value_dup_string (value);
116 break;
117
118 default:
119 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
120 break;
121 }
122 }
123
124 static void
125 udisks_linux_iscsi_session_object_constructed (GObject *object)
126 {
127 UDisksLinuxISCSISessionObject *session_object = UDISKS_LINUX_ISCSI_SESSION_OBJECT (object);
128 gchar *object_path;
129
130 /* Set the object path. */
131 object_path = udisks_linux_iscsi_session_object_get_object_path (session_object);
132 g_dbus_object_skeleton_set_object_path (G_DBUS_OBJECT_SKELETON (session_object), object_path);
133 g_free (object_path);
134
135 /* Create the D-Bus interface. */
136 session_object->iface_iscsi_session = udisks_linux_iscsi_session_new ();
137 g_dbus_object_skeleton_add_interface (G_DBUS_OBJECT_SKELETON (session_object),
138 G_DBUS_INTERFACE_SKELETON (session_object->iface_iscsi_session));
139
140 /* Update the interface. */
141 udisks_linux_iscsi_session_object_update_iface (session_object);
142
143 if (G_OBJECT_CLASS (udisks_linux_iscsi_session_object_parent_class)->constructed)
144 G_OBJECT_CLASS (udisks_linux_iscsi_session_object_parent_class)->constructed (object);
145 }
146
147 static void
148 udisks_linux_iscsi_session_object_finalize (GObject *object)
149 {
150 UDisksLinuxISCSISessionObject *session_object = UDISKS_LINUX_ISCSI_SESSION_OBJECT (object);
151
152 g_clear_object (&session_object->iface_iscsi_session);
153
154 g_free (session_object->session_id);
155 g_object_unref (session_object->module);
156 g_hash_table_destroy (session_object->sysfs_paths);
157
158 if (G_OBJECT_CLASS (udisks_linux_iscsi_session_object_parent_class)->finalize)
159 G_OBJECT_CLASS (udisks_linux_iscsi_session_object_parent_class)->finalize (object);
160 }
161
162 static void
163 udisks_linux_iscsi_session_object_class_init (UDisksLinuxISCSISessionObjectClass *klass)
164 {
165 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
166
167 gobject_class->get_property = udisks_linux_iscsi_session_object_get_property;
168 gobject_class->set_property = udisks_linux_iscsi_session_object_set_property;
169 gobject_class->constructed = udisks_linux_iscsi_session_object_constructed;
170 gobject_class->finalize = udisks_linux_iscsi_session_object_finalize;
171
172 /**
173 * UDisksLinuxISCSISessionObject:module:
174 *
175 * The #UDisksDaemon for the object.
176 */
177 g_object_class_install_property (gobject_class,
178 PROP_MODULE,
179 g_param_spec_object ("module",
180 "Module",
181 "The module for the object",
182 UDISKS_TYPE_LINUX_MODULE_ISCSI,
183 G_PARAM_READABLE |
184 G_PARAM_WRITABLE |
185 G_PARAM_CONSTRUCT_ONLY |
186 G_PARAM_STATIC_STRINGS));
187
188 /**
189 * UDisksLinuxISCSISessionObject:session_id:
190 *
191 * The iSCSI session id.
192 */
193 g_object_class_install_property (gobject_class,
194 PROP_SESSION_ID,
195 g_param_spec_string ("session-id",
196 "Session ID",
197 "The iSCSI session ID",
198 NULL,
199 G_PARAM_READABLE |
200 G_PARAM_WRITABLE |
201 G_PARAM_CONSTRUCT_ONLY |
202 G_PARAM_STATIC_STRINGS));
203 }
204
205 static void
206 udisks_linux_iscsi_session_object_init (UDisksLinuxISCSISessionObject *session_object)
207 {
208 g_return_if_fail (UDISKS_IS_LINUX_ISCSI_SESSION_OBJECT (session_object));
209
210 session_object->module = NULL;
211 session_object->sysfs_paths = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
212 }
213
214 /**
215 * udisks_linux_iscsi_session_object_new:
216 * @module: A #UDisksLinuxModuleISCSI.
217 * @session_id: A iSCSI session identifier.
218 *
219 * Create a new iSCSI session object.
220 *
221 * Returns: A #UDisksLinuxISCSISessionObject object. Free with g_object_unref().
222 */
223 UDisksLinuxISCSISessionObject *
224 udisks_linux_iscsi_session_object_new (UDisksLinuxModuleISCSI *module,
225 const gchar *session_id)
226 {
227 g_return_val_if_fail (UDISKS_IS_LINUX_MODULE_ISCSI (module), NULL);
228 g_return_val_if_fail (session_id, NULL);
229
230 return g_object_new (UDISKS_TYPE_LINUX_ISCSI_SESSION_OBJECT,
231 "module", module,
232 "session-id", session_id,
233 NULL);
234 }
235
236 /**
237 * udisks_linux_iscsi_session_object_get_module:
238 * @session_object: A #UDisksLinuxISCSISessionObject.
239 *
240 * Returns: A #UDisksLinuxModuleISCSI. Do not free, the object is owned by @session_object.
241 */
242 UDisksLinuxModuleISCSI *
243 udisks_linux_iscsi_session_object_get_module (UDisksLinuxISCSISessionObject *session_object)
244 {
245 g_return_val_if_fail (UDISKS_IS_LINUX_ISCSI_SESSION_OBJECT (session_object), NULL);
246 return session_object->module;
247 }
248
249 /**
250 * udisks_linux_iscsi_session_object_get_session_id:
251 * @session_object: A #UDisksLinuxISCSISessionObject.
252 *
253 * Returns: The iSCSI session id.
254 */
255 const gchar *
256 udisks_linux_iscsi_session_object_get_session_id (UDisksLinuxISCSISessionObject *session_object)
257 {
258 g_return_val_if_fail (UDISKS_IS_LINUX_ISCSI_SESSION_OBJECT (session_object), NULL);
259 return session_object->session_id;
260 }
261
262 /**
263 * udisks_linux_iscsi_session_object_make_object_path:
264 * @session_id: A string with iSCSI session id.
265 *
266 * Returns: DBus object path for the given session identifier.
267 */
268 gchar *
269 udisks_linux_iscsi_session_object_make_object_path (const gchar *session_id)
270 {
271 GString *object_path;
272
273 g_return_val_if_fail (session_id, NULL);
274
275 object_path = g_string_new (ISCSI_SESSION_OBJECT_PATH_PREFIX);
276 object_path = g_string_append (object_path, session_id);
277
278 return g_string_free (object_path, FALSE);
279 }
280
281 /**
282 * udisks_linux_iscsi_session_object_get_session_id_from_sysfs_path:
283 * @sysfs_path: Path to sysfs.
284 *
285 * Returns: String with session identifier.
286 */
287 gchar *
288 udisks_linux_iscsi_session_object_get_session_id_from_sysfs_path (const gchar *sysfs_path)
289 {
290 GRegex *regex;
291 GMatchInfo *match_info;
292 GError *error = NULL;
293 gchar *rval = NULL;
294
295 /* Search for session ID */
296 regex = g_regex_new ("session[0-9]+", 0, 0, &error);
297 g_regex_match (regex, sysfs_path, 0, &match_info);
298 if (g_match_info_matches (match_info))
299 rval = g_match_info_fetch (match_info, 0);
300
301 g_match_info_free (match_info);
302 g_regex_unref (regex);
303
304 return rval;
305 }
306
307 /**
308 * udisks_linux_iscsi_session_object_get_object_path:
309 * @session_object: A #UDisksLinuxISCSISessionObject.
310 *
311 * Returns: The object path of DBus object.
312 */
313 gchar *
314 udisks_linux_iscsi_session_object_get_object_path (UDisksLinuxISCSISessionObject *session_object)
315 {
316 const gchar *session_id;
317
318 g_return_val_if_fail (UDISKS_IS_LINUX_ISCSI_SESSION_OBJECT (session_object), NULL);
319
320 session_id = udisks_linux_iscsi_session_object_get_session_id (session_object);
321
322 return udisks_linux_iscsi_session_object_make_object_path (session_id);
323 }
324
325 static void
326 udisks_linux_iscsi_session_object_update_iface (UDisksLinuxISCSISessionObject *session_object)
327 {
328 UDisksISCSISession *iface;
329 struct libiscsi_context *ctx;
330 struct libiscsi_session_info session_info = {0,};
331
332 g_return_if_fail (UDISKS_IS_LINUX_ISCSI_SESSION_OBJECT (session_object));
333
334 ctx = udisks_linux_module_iscsi_get_libiscsi_context (session_object->module);
335
336 /* Enter a critical section. */
337 udisks_linux_module_iscsi_lock_libiscsi_context (session_object->module);
338
339 /* Get session info */
340 if (libiscsi_get_session_info_by_id (ctx, &session_info, session_object->session_id) != 0)
341 {
342 udisks_linux_module_iscsi_unlock_libiscsi_context (session_object->module);
343 udisks_warning ("Cannot retrieve session information for %s", session_object->session_id);
344 return;
345 }
346
347 /* Leave the critical section. */
348 udisks_linux_module_iscsi_unlock_libiscsi_context (session_object->module);
349
350 /* Set properties */
351 iface = UDISKS_ISCSI_SESSION (session_object->iface_iscsi_session);
352 udisks_iscsi_session_set_target_name (iface, session_info.targetname);
353 udisks_iscsi_session_set_tpgt (iface, session_info.tpgt);
354 udisks_iscsi_session_set_address (iface, session_info.address);
355 udisks_iscsi_session_set_port (iface, session_info.port);
356 udisks_iscsi_session_set_persistent_address (iface, session_info.persistent_address);
357 udisks_iscsi_session_set_persistent_port (iface, session_info.persistent_port);
358 udisks_iscsi_session_set_abort_timeout (iface, session_info.tmo.abort_tmo);
359 udisks_iscsi_session_set_lu_reset_timeout (iface, session_info.tmo.lu_reset_tmo);
360 udisks_iscsi_session_set_recovery_timeout (iface, session_info.tmo.recovery_tmo);
361 udisks_iscsi_session_set_tgt_reset_timeout (iface, session_info.tmo.tgt_reset_tmo);
362
363 g_dbus_interface_skeleton_flush (G_DBUS_INTERFACE_SKELETON (iface));
364 }
365
366 gboolean
367 udisks_linux_iscsi_session_object_process_uevent (UDisksModuleObject *module_object,
368 const gchar *action,
369 UDisksLinuxDevice *device,
370 gboolean *keep)
371 {
372 UDisksLinuxISCSISessionObject *session_object;
373 gchar *session_id;
374 const gchar *sysfs_path;
375
376 g_return_val_if_fail (UDISKS_IS_LINUX_ISCSI_SESSION_OBJECT (module_object), FALSE);
377 g_return_val_if_fail (device != NULL && UDISKS_IS_LINUX_DEVICE (device), FALSE);
378
379 session_object = UDISKS_LINUX_ISCSI_SESSION_OBJECT (module_object);
380 sysfs_path = g_udev_device_get_sysfs_path (device->udev_device);
381 session_id = udisks_linux_iscsi_session_object_get_session_id_from_sysfs_path (sysfs_path);
382
383 /* Did we get uevent for this session? */
384 if (session_id && g_strcmp0 (session_id, session_object->session_id) == 0)
385 {
386 g_free (session_id);
387 if (g_strcmp0 (action, "remove") == 0)
388 {
389 g_warn_if_fail (g_hash_table_remove (session_object->sysfs_paths, sysfs_path));
390 *keep = g_hash_table_size (session_object->sysfs_paths) > 0;
391 return TRUE;
392 }
393 else
394 {
395 *keep = TRUE;
396 g_hash_table_add (session_object->sysfs_paths, g_strdup (sysfs_path));
397 return TRUE;
398 }
399 }
400
401 g_free (session_id);
402
403 return FALSE;
404 }
405
406 static gboolean
407 udisks_linux_iscsi_session_object_housekeeping (UDisksModuleObject *object,
408 guint secs_since_last,
409 GCancellable *cancellable,
410 GError **error)
411 {
412 /* No housekeeping needed so far. Return TRUE to indicate, we finished
413 * successfully. */
414 return TRUE;
415 }
416
417 /* -------------------------------------------------------------------------- */
418
419 void udisks_linux_iscsi_session_object_iface_init (UDisksModuleObjectIface *iface)
420 {
421 iface->process_uevent = udisks_linux_iscsi_session_object_process_uevent;
422 iface->housekeeping = udisks_linux_iscsi_session_object_housekeeping;
423 }