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 <polkit/polkit.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
*HOSTNAME
, *STATIC_HOSTNAME
, *PRETTY_HOSTNAME
;
83 gchar
*CHASSIS
, *ICON
;
84 gchar
*KERN_NAME
, *KERN_RELEASE
, *KERN_VERS
, *OS_CPENAME
;
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
))
141 hostname1_complete_set_hostname(hn1_passed_interf
, invoc
);
143 if(proposed_hostname
)
144 g_free(proposed_hostname
);
145 if(valid_hostname_buf
)
146 g_free(valid_hostname_buf
);
152 on_handle_set_static_hostname(Hostname1
*hn1_passed_interf
,
153 GDBusMethodInvocation
*invoc
,
160 on_handle_set_pretty_hostname(Hostname1
*hn1_passed_interf
,
161 GDBusMethodInvocation
*invoc
,
168 on_handle_set_chassis(Hostname1
*hn1_passed_interf
,
169 GDBusMethodInvocation
*invoc
,
176 on_handle_set_icon_name(Hostname1
*hn1_passed_interf
,
177 GDBusMethodInvocation
*invoc
,
183 /* note: all hostnamed/hostname1's properties are read-only,
184 * and do not need set_ functions, gdbus-codegen realized
185 * this from the XML and handled the to-be error of trying
186 * to set a read-only property's value
199 our_get_static_hostname() {
202 return STATIC_HOSTNAME
;
210 our_get_pretty_hostname() {
213 return PRETTY_HOSTNAME
;
224 return "desktop"; /* this leads to the most generic beheivor in the unlikely case its returned */
228 our_get_icon_name() {
237 our_get_kernel_name() {
246 our_get_kernel_version() {
255 our_get_kernel_release() {
264 our_get_os_cpename() {
270 our_get_os_pretty_name() {
275 /* --- end method/property/dbus signal code, begin bus/name handlers --- */
277 static void hostnamed_on_bus_acquired(GDBusConnection
*conn
,
279 gpointer user_data
) {
281 g_printf("got bus/name, exporting %s's interface...\n", name
);
283 hostnamed_interf
= hostname1_skeleton_new();
285 /* attach function pointers to generated struct's method handlers */
286 g_signal_connect(hostnamed_interf
, "handle-set-hostname", G_CALLBACK(on_handle_set_hostname
), NULL
);
287 g_signal_connect(hostnamed_interf
, "handle-set-static-hostname", G_CALLBACK(on_handle_set_static_hostname
), NULL
);
288 g_signal_connect(hostnamed_interf
, "handle-set-pretty-hostname", G_CALLBACK(on_handle_set_pretty_hostname
), NULL
);
289 g_signal_connect(hostnamed_interf
, "handle-set-chassis", G_CALLBACK(on_handle_set_chassis
), NULL
);
290 g_signal_connect(hostnamed_interf
, "handle-set-icon-name", G_CALLBACK(on_handle_set_icon_name
), NULL
);
292 /* set our properties before export */
293 hostname1_set_hostname(hostnamed_interf
, our_get_hostname());
294 hostname1_set_static_hostname(hostnamed_interf
, our_get_static_hostname());
295 hostname1_set_pretty_hostname(hostnamed_interf
, our_get_pretty_hostname());
296 hostname1_set_chassis(hostnamed_interf
, our_get_chassis());
297 hostname1_set_icon_name(hostnamed_interf
, our_get_icon_name());
298 hostname1_set_kernel_name(hostnamed_interf
, our_get_kernel_name());
299 hostname1_set_kernel_version(hostnamed_interf
, our_get_kernel_version());
300 hostname1_set_kernel_release(hostnamed_interf
, our_get_kernel_release());
301 hostname1_set_operating_system_cpename(hostnamed_interf
, our_get_os_cpename());
302 hostname1_set_operating_system_pretty_name(hostnamed_interf
, our_get_os_pretty_name());
304 if(!g_dbus_interface_skeleton_export(G_DBUS_INTERFACE_SKELETON(hostnamed_interf
),
306 "/org/freedesktop/hostname1",
309 g_printf("failed to export %s's interface!\n", name
); /* unusual edge case, TODO check errno */
310 hostnamed_mem_clean();
314 dbus_interface_exported
= TRUE
;
315 g_printf("exported %s's interface on the system bus...\n", name
);
319 static void hostnamed_on_name_acquired(GDBusConnection
*conn
,
321 gpointer user_data
) {
323 g_printf("success!\n");
326 static void hostnamed_on_name_lost(GDBusConnection
*conn
,
328 gpointer user_data
) {
332 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
);
333 hostnamed_mem_clean();
336 g_printf("lost name %s, exiting...\n", name
);
338 hostnamed_mem_clean();
341 /* --- end bus/name handlers, begin misc unix functions --- */
343 /* safe call to clean and then exit
344 * this stops our GMainLoop safely before letting main() return */
345 void hostnamed_mem_clean() {
347 g_printf("exiting...\n");
349 if(dbus_interface_exported
)
350 g_dbus_interface_skeleton_unexport(G_DBUS_INTERFACE_SKELETON(hostnamed_interf
));
352 if(g_main_loop_is_running(hostnamed_loop
))
353 g_main_loop_quit(hostnamed_loop
);
357 /* wrapper for glib's unix signal handling; called only once if terminatating signal is raised against us */
358 gboolean
unix_sig_terminate_handler(gpointer data
) {
360 g_printf("caught SIGINT/HUP/TERM, exiting\n");
362 hostnamed_mem_clean();
363 return G_SOURCE_REMOVE
;
366 void set_signal_handlers() {
368 /* we don't care about its descriptor, we never need to unregister these */
369 g_unix_signal_add(SIGINT
, unix_sig_terminate_handler
, NULL
);
370 g_unix_signal_add(SIGHUP
, unix_sig_terminate_handler
, NULL
);
371 g_unix_signal_add(SIGTERM
, unix_sig_terminate_handler
, NULL
);
373 /* TODO: the "only once" guarantee only counts towards specific signals.
374 * make sure calling a SIGINT and SIGHUP doesn't cause term_handler()
375 * to be called twice */
380 hostnamed_freeable
= g_ptr_array_new();
382 /* TODO: check for valid, writable config at init. if no, complain to `make install` */
384 CHASSIS
= ICON
= OS_CPENAME
= 0;
385 KERN_NAME
= KERN_RELEASE
= KERN_VERS
= 0;
386 HOSTNAME
= STATIC_HOSTNAME
= PRETTY_HOSTNAME
= NULL
;
388 set_signal_handlers();
390 if(!determine_chassis_and_icon() || !set_uname_properties() || !set_names())
393 hostnamed_loop
= g_main_loop_new(NULL
, TRUE
);
395 bus_descriptor
= g_bus_own_name(G_BUS_TYPE_SYSTEM
,
396 "org.freedesktop.hostname1",
397 G_BUS_NAME_OWNER_FLAGS_NONE
,
398 hostnamed_on_bus_acquired
,
399 hostnamed_on_name_acquired
,
400 hostnamed_on_name_lost
,
404 g_main_loop_run(hostnamed_loop
);
405 /* runs until single g_main_loop_quit() call is raised inside <interface>_mem_clean() */
406 g_main_loop_unref(hostnamed_loop
);
408 /* guaranteed unownable */
409 g_bus_unown_name(bus_descriptor
);
411 /* at this point no operations can occur with our data, it is safe to free it + its container */
412 g_ptr_array_free(hostnamed_freeable
, TRUE
);
417 gboolean
set_names() {
420 gchar
*hostname_buf
, *static_hostname_buf
, *pretty_hostname_buf
;
422 size_t hostname_divider
;
424 hostname_buf
= (gchar
*) g_malloc0(MAXHOSTNAMELEN
);
425 static_hostname_buf
= (gchar
*) g_malloc0(4096);
426 pretty_hostname_buf
= (gchar
*) g_malloc0(4096);
428 config
= g_key_file_new();
430 g_ptr_array_add(hostnamed_freeable
, hostname_buf
);
431 g_ptr_array_add(hostnamed_freeable
, static_hostname_buf
);
432 g_ptr_array_add(hostnamed_freeable
, pretty_hostname_buf
);
434 /* (2) set HOSTNAME */
435 if(gethostname(hostname_buf
, MAXHOSTNAMELEN
) || !g_strcmp0(hostname_buf
, ""))
436 HOSTNAME
= "localhost";
438 HOSTNAME
= hostname_buf
;
440 /* this bit gets you the /etc/myname style hostname
441 hostname_divider = strcspn(hostname_buf, ".");
442 strncpy(ret, hostname_buf, hostname_divider); */
444 /* (3) set PRETTY_HOSTNAME */
445 if(g_key_file_load_from_file(config
, "/etc/systemd_compat.conf", G_KEY_FILE_NONE
, NULL
)
446 && (pretty_hostname_buf
= g_key_file_get_value(config
, "hostnamed", "PrettyHostname", NULL
)))
447 PRETTY_HOSTNAME
= pretty_hostname_buf
;
449 PRETTY_HOSTNAME
= "";
452 g_key_file_unref(config
);
454 /* (4) set STATIC_HOSTNAME */
455 if(!g_strcmp0(PRETTY_HOSTNAME
, ""))
456 STATIC_HOSTNAME
= HOSTNAME
;
458 else if((static_hostname_buf
= g_hostname_to_ascii(PRETTY_HOSTNAME
)))
459 STATIC_HOSTNAME
= static_hostname_buf
;
461 return (HOSTNAME
&& STATIC_HOSTNAME
&& PRETTY_HOSTNAME
) ? TRUE
: FALSE
;
465 gboolean
set_uname_properties() {
472 KERN_NAME
= (gchar
*)g_malloc0(sizeof(un
.sysname
));
473 g_ptr_array_add(hostnamed_freeable
, KERN_NAME
);
474 g_strlcpy(KERN_NAME
, un
.sysname
, sizeof(un
.sysname
));
476 KERN_RELEASE
= (gchar
*)g_malloc0(sizeof(un
.release
));
477 g_ptr_array_add(hostnamed_freeable
, KERN_RELEASE
);
478 g_strlcpy(KERN_RELEASE
, un
.release
, sizeof(un
.release
));
480 KERN_VERS
= (gchar
*)g_malloc0(sizeof(un
.version
));
481 g_ptr_array_add(hostnamed_freeable
, KERN_VERS
);
482 g_strlcpy(KERN_VERS
, un
.version
, sizeof(un
.version
));
487 gboolean
determine_chassis_and_icon() {
489 const size_t bufsize
= 4096;
491 char *hwproduct
, *hwmodel
, *hwvendor
, *hwmachine
;
492 size_t hwproduct_size
, hwmodel_size
, hwvendor_size
, hwmachine_size
;
493 int hwproduct_name
[2], hwmodel_name
[2], hwvendor_name
[2], hwmachine_name
[2];
495 gboolean UNSURE_CHASSIS_FLAG
, UNSURE_ICON_FLAG
;
497 hwproduct_size
= hwmodel_size
= hwvendor_size
= hwmachine_size
= bufsize
;
498 UNSURE_CHASSIS_FLAG
= UNSURE_ICON_FLAG
= FALSE
;
501 hwproduct
= (char*)g_malloc0(4096);
502 hwmodel
= (char*)g_malloc0(4096);
503 hwvendor
= (char*)g_malloc0(4096);
504 hwmachine
= (char*)g_malloc0(4096);
506 g_ptr_array_add(hostnamed_freeable
, hwproduct
);
507 g_ptr_array_add(hostnamed_freeable
, hwmodel
);
508 g_ptr_array_add(hostnamed_freeable
, hwvendor
);
509 g_ptr_array_add(hostnamed_freeable
, hwmachine
);
511 hwproduct_name
[0] = CTL_HW
;
512 hwproduct_name
[1] = HW_PRODUCT
;
514 hwmodel_name
[0] = CTL_HW
;
515 hwmodel_name
[1] = HW_MODEL
;
517 hwvendor_name
[0] = CTL_HW
;
518 hwvendor_name
[1] = HW_VENDOR
;
520 hwmachine_name
[0] = CTL_HW
;
521 hwmachine_name
[1] = HW_MACHINE
;
523 /* pass NULL buffer to check size first, then pass hw to be filled according to freshly-set hw_size */
524 if(-1 == sysctl(hwproduct_name
, 2, NULL
, &hwproduct_size
, NULL
, 0) || -1 == sysctl(hwproduct_name
, 2, hwproduct
, &hwproduct_size
, NULL
, 0))
527 if(-1 == sysctl(hwmodel_name
, 2, NULL
, &hwmodel_size
, NULL
, 0) || -1 == sysctl(hwmodel_name
, 2, hwmodel
, &hwmodel_size
, NULL
, 0))
530 if(-1 == sysctl(hwvendor_name
, 2, NULL
, &hwvendor_size
, NULL
, 0) || -1 == sysctl(hwvendor_name
, 2, hwvendor
, &hwvendor_size
, NULL
, 0))
533 if(-1 == sysctl(hwmachine_name
, 2, NULL
, &hwmachine_size
, NULL
, 0) || -1 == sysctl(hwmachine_name
, 2, hwmachine
, &hwmachine_size
, NULL
, 0))
536 /* TODO: test for laptop, if not, dmidecode for desktop vs. server
537 * probably move this code to vm test func and set a global after running it early, once */
539 for(; i
< G_N_ELEMENTS(chassis_indicator_table
); i
++) {
540 if(strcasestr(hwproduct
, chassis_indicator_table
[i
].match_string
)
541 || strcasestr(hwmodel
, chassis_indicator_table
[i
].match_string
)
542 || strcasestr(hwvendor
, chassis_indicator_table
[i
].match_string
)) {
544 if(!UNSURE_CHASSIS_FLAG
&& chassis_indicator_table
[i
].chassis
) {
546 UNSURE_CHASSIS_FLAG
= chassis_indicator_table
[i
].chassis_precedence
;
547 CHASSIS
= chassis_indicator_table
[i
].chassis
;
550 if(!UNSURE_ICON_FLAG
&& chassis_indicator_table
[i
].icon
) {
552 UNSURE_ICON_FLAG
= chassis_indicator_table
[i
].icon_precedence
;
553 ICON
= chassis_indicator_table
[i
].icon
;
558 if(up_native_is_laptop()) {
563 ICON
= "input-touchpad"; /* TODO pull an icon package that actually has the icons we're looking for */
565 } else if(is_server(hwmachine
)) {
570 ICON
= "uninterruptible-power-supply";
572 } else if(!CHASSIS
|| !ICON
) {
580 return (CHASSIS
&& ICON
);
583 gboolean
is_server(gchar
*arch
) {
587 for(; i
< G_N_ELEMENTS(server_archs
); i
++)
588 if(strcasestr(arch
, server_archs
[i
]))
594 gboolean
up_native_is_laptop() {
596 struct apm_power_info bstate
;
597 struct sensordev acpiac
;
599 if (up_native_get_sensordev("acpiac0", &acpiac
))
602 if (-1 == ioctl(up_apm_get_fd(), APM_IOC_GETPOWER
, &bstate
))
603 g_error("ioctl on apm fd failed : %s", g_strerror(errno
));
605 return bstate
.ac_state
!= APM_AC_UNKNOWN
;
608 int up_apm_get_fd() {
610 static int apm_fd
= 0;
614 g_debug("apm_fd is not initialized yet, opening");
617 if((apm_fd
= open("/dev/apm", O_RDONLY
)) == -1) {
618 if(errno
!= ENXIO
&& errno
!= ENOENT
)
619 g_error("cannot open device file");
626 gboolean
up_native_get_sensordev(const char * id
, struct sensordev
* snsrdev
) {
629 size_t sdlen
= sizeof(struct sensordev
);
630 int mib
[] = {CTL_HW
, HW_SENSORS
, 0, 0 ,0};
632 for (devn
= 0 ; ; devn
++) {
634 if(sysctl(mib
, 3, snsrdev
, &sdlen
, NULL
, 0) == -1) {
641 if (!strcmp(snsrdev
->xname
, id
))