2 * Copyright (c) 2014 Ian Sutton <ian@kremlin.cc>
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 #include <sys/param.h>
23 #include <sys/sysctl.h>
24 #include <sys/sensors.h>
25 #include <sys/ioctl.h>
26 #include <sys/utsname.h>
28 #include <machine/apmvar.h>
30 #include <glib/gprintf.h>
31 #include <glib-unix.h>
32 /* #include <gtk/gtk.h> */
34 #include "hostnamed-gen.h"
35 #include "hostnamed.h"
38 * (1) string to be matched against runtime machine's sysctl output.
39 * can be either the exact string or a substring contained
40 * within sysctl strings. no "guesses" here, a match should
41 * reliably indicate the chassis/icon.
43 * (2) string describing chassis type divulged by (1).
44 * must be one of "desktop", "laptop", "server",
45 * "tablet", "handset", "vm", "container" or NULL
46 * if only icon string can be ascertained. "vm" refers
47 * to operating systems running on baremetal hypervisors
48 * (hardware virtualization, like XEN) while "container"
49 * refers to OSs running on shared hypervisors like
50 * virtualbox or VMware. consider the distinction carefully
51 * as common virtualization software like KVM may share
52 * characteristics of both "vm" and "container" types.
54 * (3) string specifying icon to use. follows XDG icon spec.
55 * see http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
56 * for allowed strings.
58 * (4) chassis precedence bit. TRUE if (2) is defined and
59 * we're certain it is the proper string. FALSE in the
60 * circumstance (2) may be the correct string, unless
61 * a match with this bit set to TRUE overrides it.
62 * if (2) is NULL, this bit is inconsequential.
64 * (5) icon precedence bit. see previous definition.
66 struct SYSCTL_LOOKUP_TABLE
{
70 gboolean chassis_precedence
;
71 gboolean icon_precedence
;
74 GPtrArray
*hostnamed_freeable
;
75 Hostname1
*hostnamed_interf
;
77 GMainLoop
*hostnamed_loop
;
80 gboolean dbus_interface_exported
; /* reliable because of gdbus operational guarantees */
82 gchar
*CHASSIS
, *ICON
;
84 gchar
*KERN_NAME
, *KERN_RELEASE
, *KERN_VERS
;
86 /* TODO no specific vm or laptop icon in gnome
87 * NOTE paravirtualization on xen is only available for linuxes right now
88 * dmesg on linux systems reveals xen and virtualization method (HVM or PVM)
89 * but we will worry about those later */
91 /* add any sysctl strings that suggest virtualization here */
92 const struct SYSCTL_LOOKUP_TABLE chassis_indicator_table
[] =
94 { "QEMU Virtual CPU", "vm", NULL
, FALSE
, FALSE
}, /* could be QEMU running in userspace or as part of KVM */
95 { "KVM", "vm", "drive-multidisk", FALSE
, FALSE
},
96 { "SmartDC HVM", "vm", "drive-multidisk", TRUE
, TRUE
}, /* illumos-joyent kvm */
97 { "VirtualBox", "vm", "drive-multidisk", TRUE
, TRUE
},
98 { "VMware, Inc.", "vm", "drive-multidisk", TRUE
, TRUE
},
99 { "VMware Virtual Platform", "vm", "drive-multidisk", TRUE
, TRUE
},
100 { "Parallels", "vm", "drive-multidisk", TRUE
, TRUE
}, /* need verification */
101 { "Xen", "vm", "drive-multidisk", FALSE
, FALSE
}
102 }; /* TODO: chroots, etc. are the actual "containers", add them */
104 /* archs to check against when determining if machine is server */
105 const gchar
*server_archs
[] = {
111 /* --- begin method/property/dbus signal code --- */
113 /* TODO the extra boolean passed to these funcs is for policykit auth */
114 /* TODO complete call with error, message, etc */
116 on_handle_set_hostname(Hostname1
*hn1_passed_interf
,
117 GDBusMethodInvocation
*invoc
,
121 gchar
*proposed_hostname
, *valid_hostname_buf
;
122 gboolean policykit_auth
, ret
;
123 size_t check_length
, bad_length
;
125 bad_length
= MAXHOSTNAMELEN
+ 1;
126 proposed_hostname
= NULL
;
129 params
= g_dbus_method_invocation_get_parameters(invoc
);
130 g_variant_get(params
, "(sb)", &proposed_hostname
, &policykit_auth
);
132 if(proposed_hostname
&& (valid_hostname_buf
= g_hostname_to_ascii(proposed_hostname
))) {
134 check_length
= strnlen(proposed_hostname
, bad_length
);
136 if(check_length
< bad_length
&& !sethostname(proposed_hostname
, check_length
))
140 hostname1_complete_set_hostname(hn1_passed_interf
, invoc
);
142 if(proposed_hostname
)
143 g_free(proposed_hostname
);
144 if(valid_hostname_buf
)
145 g_free(valid_hostname_buf
);
151 on_handle_set_static_hostname(Hostname1
*hn1_passed_interf
,
152 GDBusMethodInvocation
*invoc
,
159 on_handle_set_pretty_hostname(Hostname1
*hn1_passed_interf
,
160 GDBusMethodInvocation
*invoc
,
167 on_handle_set_chassis(Hostname1
*hn1_passed_interf
,
168 GDBusMethodInvocation
*invoc
,
175 on_handle_set_icon_name(Hostname1
*hn1_passed_interf
,
176 GDBusMethodInvocation
*invoc
,
182 /* note: all hostnamed/hostname1's properties are read-only,
183 * and do not need set_ functions, gdbus-codegen realized
184 * this from the XML and handled the to-be error of trying
185 * to set a read-only property's value
191 gchar
*hostname_buf
, *ret
;
192 size_t hostname_divider
;
194 hostname_buf
= (gchar
*) g_malloc0(MAXHOSTNAMELEN
);
195 ret
= (gchar
*) g_malloc0(MAXHOSTNAMELEN
);
197 g_ptr_array_add(hostnamed_freeable
, hostname_buf
);
198 g_ptr_array_add(hostnamed_freeable
, ret
);
200 if(gethostname(hostname_buf
, MAXHOSTNAMELEN
) || g_strcmp0(hostname_buf
, "") == 0)
203 hostname_divider
= strcspn(hostname_buf
, ".");
205 return strncpy(ret
, hostname_buf
, hostname_divider
);
209 our_get_static_hostname() {
211 const gchar
*pretty_hostname
;
214 pretty_hostname
= our_get_pretty_hostname();
216 if(g_strcmp0(pretty_hostname
, "") == 0)
217 ret
= our_get_hostname();
219 else if((ret
= g_hostname_to_ascii(pretty_hostname
))) {
221 g_ptr_array_add(hostnamed_freeable
, (gpointer
)ret
);
229 our_get_pretty_hostname() {
234 config
= g_key_file_new();
236 if(g_key_file_load_from_file(config
, "/etc/systemd_compat.conf", G_KEY_FILE_NONE
, NULL
)
237 && (ret
= g_key_file_get_value(config
, "hostnamed", "PrettyHostname", NULL
))) { /* ret might need to be freed, docs dont specify but i am suspicious */
239 g_key_file_unref(config
);
259 our_get_icon_name() {
268 our_get_kernel_name() {
277 our_get_kernel_version() {
286 our_get_kernel_release() {
295 our_get_os_cpename() {
301 our_get_os_pretty_name() {
306 /* --- end method/property/dbus signal code, begin bus/name handlers --- */
308 static void hostnamed_on_bus_acquired(GDBusConnection
*conn
,
310 gpointer user_data
) {
312 g_printf("got bus/name, exporting %s's interface...\n", name
);
314 hostnamed_interf
= hostname1_skeleton_new();
316 /* attach function pointers to generated struct's method handlers */
317 g_signal_connect(hostnamed_interf
, "handle-set-hostname", G_CALLBACK(on_handle_set_hostname
), NULL
);
318 g_signal_connect(hostnamed_interf
, "handle-set-static-hostname", G_CALLBACK(on_handle_set_static_hostname
), NULL
);
319 g_signal_connect(hostnamed_interf
, "handle-set-pretty-hostname", G_CALLBACK(on_handle_set_pretty_hostname
), NULL
);
320 g_signal_connect(hostnamed_interf
, "handle-set-chassis", G_CALLBACK(on_handle_set_chassis
), NULL
);
321 g_signal_connect(hostnamed_interf
, "handle-set-icon-name", G_CALLBACK(on_handle_set_icon_name
), NULL
);
323 /* set our properties before export */
324 hostname1_set_hostname(hostnamed_interf
, our_get_hostname());
325 hostname1_set_static_hostname(hostnamed_interf
, our_get_static_hostname());
326 hostname1_set_pretty_hostname(hostnamed_interf
, our_get_pretty_hostname());
327 hostname1_set_chassis(hostnamed_interf
, our_get_chassis());
328 hostname1_set_icon_name(hostnamed_interf
, our_get_icon_name());
329 hostname1_set_kernel_name(hostnamed_interf
, our_get_kernel_name());
330 hostname1_set_kernel_version(hostnamed_interf
, our_get_kernel_version());
331 hostname1_set_kernel_release(hostnamed_interf
, our_get_kernel_release());
332 hostname1_set_operating_system_cpename(hostnamed_interf
, our_get_os_cpename());
333 hostname1_set_operating_system_pretty_name(hostnamed_interf
, our_get_os_pretty_name());
335 if(!g_dbus_interface_skeleton_export(G_DBUS_INTERFACE_SKELETON(hostnamed_interf
),
337 "/org/freedesktop/hostname1",
340 g_printf("failed to export %s's interface!\n", name
); /* unusual edge case, TODO check errno */
341 hostnamed_mem_clean();
345 dbus_interface_exported
= TRUE
;
346 g_printf("exported %s's interface on the system bus...\n", name
);
350 static void hostnamed_on_name_acquired(GDBusConnection
*conn
,
352 gpointer user_data
) {
354 g_printf("success!\n");
357 static void hostnamed_on_name_lost(GDBusConnection
*conn
,
359 gpointer user_data
) {
363 g_printf("failed to connect to the system bus while trying to acquire name '%s': either dbus-daemon isn't running or we don't have permission to push names and/or their interfaces to it.\n", name
);
364 hostnamed_mem_clean();
367 g_printf("lost name %s, exiting...\n", name
);
369 hostnamed_mem_clean();
372 /* --- end bus/name handlers, begin misc unix functions --- */
374 /* safe call to clean and then exit
375 * this stops our GMainLoop safely before letting main() return */
376 void hostnamed_mem_clean() {
378 g_printf("exiting...\n");
380 if(dbus_interface_exported
)
381 g_dbus_interface_skeleton_unexport(G_DBUS_INTERFACE_SKELETON(hostnamed_interf
));
383 if(g_main_loop_is_running(hostnamed_loop
))
384 g_main_loop_quit(hostnamed_loop
);
388 /* wrapper for glib's unix signal handling; called only once if terminatating signal is raised against us */
389 gboolean
unix_sig_terminate_handler(gpointer data
) {
391 g_printf("caught SIGINT/HUP/TERM, exiting\n");
393 hostnamed_mem_clean();
394 return G_SOURCE_REMOVE
;
397 void set_signal_handlers() {
399 /* we don't care about its descriptor, we never need to unregister these */
400 g_unix_signal_add(SIGINT
, unix_sig_terminate_handler
, NULL
);
401 g_unix_signal_add(SIGHUP
, unix_sig_terminate_handler
, NULL
);
402 g_unix_signal_add(SIGTERM
, unix_sig_terminate_handler
, NULL
);
404 /* TODO: the "only once" guarantee only counts towards specific signals.
405 * make sure calling a SIGINT and SIGHUP doesn't cause term_handler()
406 * to be called twice */
411 hostnamed_freeable
= g_ptr_array_new();
413 /* TODO: check for valid, writable config at init. if no, complain to `make install` */
415 CHASSIS
= ICON
= OS_CPENAME
= 0;
416 KERN_NAME
= KERN_RELEASE
= KERN_VERS
= 0;
418 set_signal_handlers();
420 if(!determine_chassis_and_icon() || !set_uname_properties())
423 hostnamed_loop
= g_main_loop_new(NULL
, TRUE
);
425 bus_descriptor
= g_bus_own_name(G_BUS_TYPE_SYSTEM
,
426 "org.freedesktop.hostname1",
427 G_BUS_NAME_OWNER_FLAGS_NONE
,
428 hostnamed_on_bus_acquired
,
429 hostnamed_on_name_acquired
,
430 hostnamed_on_name_lost
,
434 g_main_loop_run(hostnamed_loop
);
435 /* runs until single g_main_loop_quit() call is raised inside <interface>_mem_clean() */
436 g_main_loop_unref(hostnamed_loop
);
438 /* guaranteed unownable */
439 g_bus_unown_name(bus_descriptor
);
441 /* at this point no operations can occur with our data, it is safe to free it + its container */
442 g_ptr_array_free(hostnamed_freeable
, TRUE
);
447 gboolean
set_uname_properties() {
454 KERN_NAME
= (gchar
*)g_malloc0(sizeof(un
.sysname
));
455 g_ptr_array_add(hostnamed_freeable
, KERN_NAME
);
456 g_strlcpy(KERN_NAME
, un
.sysname
, sizeof(un
.sysname
));
458 KERN_RELEASE
= (gchar
*)g_malloc0(sizeof(un
.release
));
459 g_ptr_array_add(hostnamed_freeable
, KERN_RELEASE
);
460 g_strlcpy(KERN_RELEASE
, un
.release
, sizeof(un
.release
));
462 KERN_VERS
= (gchar
*)g_malloc0(sizeof(un
.version
));
463 g_ptr_array_add(hostnamed_freeable
, KERN_VERS
);
464 g_strlcpy(KERN_VERS
, un
.version
, sizeof(un
.version
));
469 gboolean
determine_chassis_and_icon() {
471 const size_t bufsize
= 4096;
473 char *hwproduct
, *hwmodel
, *hwvendor
, *hwmachine
;
474 size_t hwproduct_size
, hwmodel_size
, hwvendor_size
, hwmachine_size
;
475 int hwproduct_name
[2], hwmodel_name
[2], hwvendor_name
[2], hwmachine_name
[2];
477 gboolean UNSURE_CHASSIS_FLAG
, UNSURE_ICON_FLAG
;
479 hwproduct_size
= hwmodel_size
= hwvendor_size
= hwmachine_size
= bufsize
;
480 UNSURE_CHASSIS_FLAG
= UNSURE_ICON_FLAG
= FALSE
;
483 hwproduct
= (char*)g_malloc0(4096);
484 hwmodel
= (char*)g_malloc0(4096);
485 hwvendor
= (char*)g_malloc0(4096);
486 hwmachine
= (char*)g_malloc0(4096);
488 g_ptr_array_add(hostnamed_freeable
, hwproduct
);
489 g_ptr_array_add(hostnamed_freeable
, hwmodel
);
490 g_ptr_array_add(hostnamed_freeable
, hwvendor
);
491 g_ptr_array_add(hostnamed_freeable
, hwmachine
);
493 hwproduct_name
[0] = CTL_HW
;
494 hwproduct_name
[1] = HW_PRODUCT
;
496 hwmodel_name
[0] = CTL_HW
;
497 hwmodel_name
[1] = HW_MODEL
;
499 hwvendor_name
[0] = CTL_HW
;
500 hwvendor_name
[1] = HW_VENDOR
;
502 hwmachine_name
[0] = CTL_HW
;
503 hwmachine_name
[1] = HW_MACHINE
;
505 /* pass NULL buffer to check size first, then pass hw to be filled according to freshly-set hw_size */
506 if(-1 == sysctl(hwproduct_name
, 2, NULL
, &hwproduct_size
, NULL
, 0) || -1 == sysctl(hwproduct_name
, 2, hwproduct
, &hwproduct_size
, NULL
, 0))
509 if(-1 == sysctl(hwmodel_name
, 2, NULL
, &hwmodel_size
, NULL
, 0) || -1 == sysctl(hwmodel_name
, 2, hwmodel
, &hwmodel_size
, NULL
, 0))
512 if(-1 == sysctl(hwvendor_name
, 2, NULL
, &hwvendor_size
, NULL
, 0) || -1 == sysctl(hwvendor_name
, 2, hwvendor
, &hwvendor_size
, NULL
, 0))
515 if(-1 == sysctl(hwmachine_name
, 2, NULL
, &hwmachine_size
, NULL
, 0) || -1 == sysctl(hwmachine_name
, 2, hwmachine
, &hwmachine_size
, NULL
, 0))
518 /* TODO: test for laptop, if not, dmidecode for desktop vs. server
519 * probably move this code to vm test func and set a global after running it early, once */
521 for(; i
< G_N_ELEMENTS(chassis_indicator_table
); i
++) {
522 if(strcasestr(hwproduct
, chassis_indicator_table
[i
].match_string
)
523 || strcasestr(hwmodel
, chassis_indicator_table
[i
].match_string
)
524 || strcasestr(hwvendor
, chassis_indicator_table
[i
].match_string
)) {
526 if(!UNSURE_CHASSIS_FLAG
&& chassis_indicator_table
[i
].chassis
) {
528 UNSURE_CHASSIS_FLAG
= chassis_indicator_table
[i
].chassis_precedence
;
529 CHASSIS
= chassis_indicator_table
[i
].chassis
;
532 if(!UNSURE_ICON_FLAG
&& chassis_indicator_table
[i
].icon
) {
534 UNSURE_ICON_FLAG
= chassis_indicator_table
[i
].icon_precedence
;
535 ICON
= chassis_indicator_table
[i
].icon
;
540 if(up_native_is_laptop()) {
545 ICON
= "input-touchpad"; /* TODO pull an icon package that actually has the icons we're looking for */
547 } else if(is_server(hwmachine
)) {
552 ICON
= "uninterruptible-power-supply";
554 } else if(!CHASSIS
|| !ICON
) {
562 return (CHASSIS
&& ICON
);
565 gboolean
is_server(gchar
*arch
) {
569 for(; i
< G_N_ELEMENTS(server_archs
); i
++)
570 if(strcasestr(arch
, server_archs
[i
]))
576 gboolean
up_native_is_laptop() {
578 struct apm_power_info bstate
;
579 struct sensordev acpiac
;
581 if (up_native_get_sensordev("acpiac0", &acpiac
))
584 if (-1 == ioctl(up_apm_get_fd(), APM_IOC_GETPOWER
, &bstate
))
585 g_error("ioctl on apm fd failed : %s", g_strerror(errno
));
587 return bstate
.ac_state
!= APM_AC_UNKNOWN
;
590 int up_apm_get_fd() {
592 static int apm_fd
= 0;
596 g_debug("apm_fd is not initialized yet, opening");
599 if((apm_fd
= open("/dev/apm", O_RDONLY
)) == -1) {
600 if(errno
!= ENXIO
&& errno
!= ENOENT
)
601 g_error("cannot open device file");
608 gboolean
up_native_get_sensordev(const char * id
, struct sensordev
* snsrdev
) {
611 size_t sdlen
= sizeof(struct sensordev
);
612 int mib
[] = {CTL_HW
, HW_SENSORS
, 0, 0 ,0};
614 for (devn
= 0 ; ; devn
++) {
616 if(sysctl(mib
, 3, snsrdev
, &sdlen
, NULL
, 0) == -1) {
623 if (!strcmp(snsrdev
->xname
, id
))