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
;
125 proposed_hostname
= NULL
;
128 params
= g_dbus_method_invocation_get_parameters(invoc
);
129 g_variant_get(params
, "(sb)", &proposed_hostname
, &policykit_auth
);
131 if(proposed_hostname
&& (valid_hostname_buf
= g_hostname_to_ascii(proposed_hostname
))) {
133 check_length
= strnlen(proposed_hostname
, MAXHOSTNAMELEN
+ 1);
135 if(check_length
> MAXHOSTNAMELEN
)
136 g_dbus_method_invocation_return_dbus_error(invoc
, "org.freedesktop.hostname1.Error.ENAMETOOLONG", "Hostname string exceeded maximum length.");
138 else if(sethostname(proposed_hostname
, check_length
))
139 g_dbus_method_invocation_return_dbus_error(invoc
, "org.freedesktop.hostname1.Error.EACCES", "Insufficient permissions to change hostname.");
142 HOSTNAME
= proposed_hostname
;
143 hostname1_set_hostname(hn1_passed_interf
, HOSTNAME
);
145 hostname1_complete_set_hostname(hn1_passed_interf
, invoc
);
149 if(proposed_hostname
)
150 g_free(proposed_hostname
);
151 if(valid_hostname_buf
)
152 g_free(valid_hostname_buf
);
158 on_handle_set_static_hostname(Hostname1
*hn1_passed_interf
,
159 GDBusMethodInvocation
*invoc
,
166 on_handle_set_pretty_hostname(Hostname1
*hn1_passed_interf
,
167 GDBusMethodInvocation
*invoc
,
174 on_handle_set_chassis(Hostname1
*hn1_passed_interf
,
175 GDBusMethodInvocation
*invoc
,
182 on_handle_set_icon_name(Hostname1
*hn1_passed_interf
,
183 GDBusMethodInvocation
*invoc
,
189 /* note: all hostnamed/hostname1's properties are read-only,
190 * and do not need set_ functions, gdbus-codegen realized
191 * this from the XML and handled the to-be error of trying
192 * to set a read-only property's value
199 hostname_buf
= (gchar
*)g_malloc0(MAXHOSTNAMELEN
);
201 if(gethostname(hostname_buf
, MAXHOSTNAMELEN
))
202 return "localhost.home.network"; /* TODO bomb out here probably */
204 else if(!g_strcmp0(HOSTNAME
, hostname_buf
)) {
206 g_free(hostname_buf
);
210 g_ptr_array_add(hostnamed_freeable
, hostname_buf
);
211 HOSTNAME
= hostname_buf
;
212 hostname1_set_hostname(hostnamed_interf
, HOSTNAME
);
218 our_get_static_hostname() {
220 if(STATIC_HOSTNAME
&& g_strcmp0(STATIC_HOSTNAME
, ""))
221 return STATIC_HOSTNAME
;
225 return "localhost.home.network";
229 our_get_pretty_hostname() {
232 return PRETTY_HOSTNAME
;
243 return "desktop"; /* this leads to the most generic beheivor in the unlikely case its returned */
247 our_get_icon_name() {
256 our_get_kernel_name() {
265 our_get_kernel_version() {
274 our_get_kernel_release() {
283 our_get_os_cpename() {
289 our_get_os_pretty_name() {
294 /* --- end method/property/dbus signal code, begin bus/name handlers --- */
296 static void hostnamed_on_bus_acquired(GDBusConnection
*conn
,
298 gpointer user_data
) {
300 g_printf("got bus/name, exporting %s's interface...\n", name
);
302 hostnamed_interf
= hostname1_skeleton_new();
304 /* attach function pointers to generated struct's method handlers */
305 g_signal_connect(hostnamed_interf
, "handle-set-hostname", G_CALLBACK(on_handle_set_hostname
), NULL
);
306 g_signal_connect(hostnamed_interf
, "handle-set-static-hostname", G_CALLBACK(on_handle_set_static_hostname
), NULL
);
307 g_signal_connect(hostnamed_interf
, "handle-set-pretty-hostname", G_CALLBACK(on_handle_set_pretty_hostname
), NULL
);
308 g_signal_connect(hostnamed_interf
, "handle-set-chassis", G_CALLBACK(on_handle_set_chassis
), NULL
);
309 g_signal_connect(hostnamed_interf
, "handle-set-icon-name", G_CALLBACK(on_handle_set_icon_name
), NULL
);
311 /* set our properties before export */
312 hostname1_set_hostname(hostnamed_interf
, our_get_hostname());
313 hostname1_set_static_hostname(hostnamed_interf
, our_get_static_hostname());
314 hostname1_set_pretty_hostname(hostnamed_interf
, our_get_pretty_hostname());
315 hostname1_set_chassis(hostnamed_interf
, our_get_chassis());
316 hostname1_set_icon_name(hostnamed_interf
, our_get_icon_name());
317 hostname1_set_kernel_name(hostnamed_interf
, our_get_kernel_name());
318 hostname1_set_kernel_version(hostnamed_interf
, our_get_kernel_version());
319 hostname1_set_kernel_release(hostnamed_interf
, our_get_kernel_release());
320 hostname1_set_operating_system_cpename(hostnamed_interf
, our_get_os_cpename());
321 hostname1_set_operating_system_pretty_name(hostnamed_interf
, our_get_os_pretty_name());
323 if(!g_dbus_interface_skeleton_export(G_DBUS_INTERFACE_SKELETON(hostnamed_interf
),
325 "/org/freedesktop/hostname1",
328 g_printf("failed to export %s's interface!\n", name
); /* unusual edge case, TODO check errno */
329 hostnamed_mem_clean();
333 dbus_interface_exported
= TRUE
;
334 g_printf("exported %s's interface on the system bus...\n", name
);
338 static void hostnamed_on_name_acquired(GDBusConnection
*conn
,
340 gpointer user_data
) {
342 g_printf("success!\n");
345 static void hostnamed_on_name_lost(GDBusConnection
*conn
,
347 gpointer user_data
) {
351 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
);
352 hostnamed_mem_clean();
355 g_printf("lost name %s, exiting...\n", name
);
357 hostnamed_mem_clean();
360 /* --- end bus/name handlers, begin misc unix functions --- */
362 /* safe call to clean and then exit
363 * this stops our GMainLoop safely before letting main() return */
364 void hostnamed_mem_clean() {
366 g_printf("exiting...\n");
368 if(dbus_interface_exported
)
369 g_dbus_interface_skeleton_unexport(G_DBUS_INTERFACE_SKELETON(hostnamed_interf
));
371 if(g_main_loop_is_running(hostnamed_loop
))
372 g_main_loop_quit(hostnamed_loop
);
376 /* wrapper for glib's unix signal handling; called only once if terminatating signal is raised against us */
377 gboolean
unix_sig_terminate_handler(gpointer data
) {
379 g_printf("caught SIGINT/HUP/TERM, exiting\n");
381 hostnamed_mem_clean();
382 return G_SOURCE_REMOVE
;
385 void set_signal_handlers() {
387 /* we don't care about its descriptor, we never need to unregister these */
388 g_unix_signal_add(SIGINT
, unix_sig_terminate_handler
, NULL
);
389 g_unix_signal_add(SIGHUP
, unix_sig_terminate_handler
, NULL
);
390 g_unix_signal_add(SIGTERM
, unix_sig_terminate_handler
, NULL
);
392 /* TODO: the "only once" guarantee only counts towards specific signals.
393 * make sure calling a SIGINT and SIGHUP doesn't cause term_handler()
394 * to be called twice */
399 hostnamed_freeable
= g_ptr_array_new();
401 /* TODO: check for valid, writable config at init. if no, complain to `make install` */
403 CHASSIS
= ICON
= OS_CPENAME
= 0;
404 KERN_NAME
= KERN_RELEASE
= KERN_VERS
= 0;
405 HOSTNAME
= STATIC_HOSTNAME
= PRETTY_HOSTNAME
= NULL
;
407 set_signal_handlers();
409 if(!determine_chassis_and_icon() || !set_uname_properties() || !set_names())
412 hostnamed_loop
= g_main_loop_new(NULL
, TRUE
);
414 bus_descriptor
= g_bus_own_name(G_BUS_TYPE_SYSTEM
,
415 "org.freedesktop.hostname1",
416 G_BUS_NAME_OWNER_FLAGS_NONE
,
417 hostnamed_on_bus_acquired
,
418 hostnamed_on_name_acquired
,
419 hostnamed_on_name_lost
,
423 g_main_loop_run(hostnamed_loop
);
424 /* runs until single g_main_loop_quit() call is raised inside <interface>_mem_clean() */
425 g_main_loop_unref(hostnamed_loop
);
427 /* guaranteed unownable */
428 g_bus_unown_name(bus_descriptor
);
430 /* at this point no operations can occur with our data, it is safe to free it + its container */
431 g_ptr_array_free(hostnamed_freeable
, TRUE
);
436 gboolean
set_names() {
439 gchar
*hostname_buf
, *static_hostname_buf
, *pretty_hostname_buf
;
441 size_t hostname_divider
;
443 hostname_buf
= (gchar
*) g_malloc0(MAXHOSTNAMELEN
);
444 static_hostname_buf
= (gchar
*) g_malloc0(4096);
445 pretty_hostname_buf
= (gchar
*) g_malloc0(4096);
447 config
= g_key_file_new();
449 g_ptr_array_add(hostnamed_freeable
, hostname_buf
);
450 g_ptr_array_add(hostnamed_freeable
, static_hostname_buf
);
451 g_ptr_array_add(hostnamed_freeable
, pretty_hostname_buf
);
453 /* (2) set HOSTNAME */
454 if(gethostname(hostname_buf
, MAXHOSTNAMELEN
) || !g_strcmp0(hostname_buf
, ""))
455 HOSTNAME
= "localhost";
457 HOSTNAME
= hostname_buf
;
459 /* this bit gets you the /etc/myname style hostname
460 hostname_divider = strcspn(hostname_buf, ".");
461 strncpy(ret, hostname_buf, hostname_divider); */
463 /* (3) set PRETTY_HOSTNAME */
464 if(g_key_file_load_from_file(config
, "/etc/systemd_compat.conf", G_KEY_FILE_NONE
, NULL
)
465 && (pretty_hostname_buf
= g_key_file_get_value(config
, "hostnamed", "PrettyHostname", NULL
)))
466 PRETTY_HOSTNAME
= pretty_hostname_buf
;
468 PRETTY_HOSTNAME
= "";
471 g_key_file_unref(config
);
473 /* (4) set STATIC_HOSTNAME */
474 if(!g_strcmp0(PRETTY_HOSTNAME
, ""))
475 STATIC_HOSTNAME
= HOSTNAME
;
477 else if((static_hostname_buf
= g_hostname_to_ascii(PRETTY_HOSTNAME
)))
478 STATIC_HOSTNAME
= static_hostname_buf
;
480 return (HOSTNAME
&& STATIC_HOSTNAME
&& PRETTY_HOSTNAME
) ? TRUE
: FALSE
;
484 gboolean
set_uname_properties() {
491 KERN_NAME
= (gchar
*)g_malloc0(sizeof(un
.sysname
));
492 g_ptr_array_add(hostnamed_freeable
, KERN_NAME
);
493 g_strlcpy(KERN_NAME
, un
.sysname
, sizeof(un
.sysname
));
495 KERN_RELEASE
= (gchar
*)g_malloc0(sizeof(un
.release
));
496 g_ptr_array_add(hostnamed_freeable
, KERN_RELEASE
);
497 g_strlcpy(KERN_RELEASE
, un
.release
, sizeof(un
.release
));
499 KERN_VERS
= (gchar
*)g_malloc0(sizeof(un
.version
));
500 g_ptr_array_add(hostnamed_freeable
, KERN_VERS
);
501 g_strlcpy(KERN_VERS
, un
.version
, sizeof(un
.version
));
506 gboolean
determine_chassis_and_icon() {
508 const size_t bufsize
= 4096;
510 char *hwproduct
, *hwmodel
, *hwvendor
, *hwmachine
;
511 size_t hwproduct_size
, hwmodel_size
, hwvendor_size
, hwmachine_size
;
512 int hwproduct_name
[2], hwmodel_name
[2], hwvendor_name
[2], hwmachine_name
[2];
514 gboolean UNSURE_CHASSIS_FLAG
, UNSURE_ICON_FLAG
;
516 hwproduct_size
= hwmodel_size
= hwvendor_size
= hwmachine_size
= bufsize
;
517 UNSURE_CHASSIS_FLAG
= UNSURE_ICON_FLAG
= FALSE
;
520 hwproduct
= (char*)g_malloc0(4096);
521 hwmodel
= (char*)g_malloc0(4096);
522 hwvendor
= (char*)g_malloc0(4096);
523 hwmachine
= (char*)g_malloc0(4096);
525 g_ptr_array_add(hostnamed_freeable
, hwproduct
);
526 g_ptr_array_add(hostnamed_freeable
, hwmodel
);
527 g_ptr_array_add(hostnamed_freeable
, hwvendor
);
528 g_ptr_array_add(hostnamed_freeable
, hwmachine
);
530 hwproduct_name
[0] = CTL_HW
;
531 hwproduct_name
[1] = HW_PRODUCT
;
533 hwmodel_name
[0] = CTL_HW
;
534 hwmodel_name
[1] = HW_MODEL
;
536 hwvendor_name
[0] = CTL_HW
;
537 hwvendor_name
[1] = HW_VENDOR
;
539 hwmachine_name
[0] = CTL_HW
;
540 hwmachine_name
[1] = HW_MACHINE
;
542 /* pass NULL buffer to check size first, then pass hw to be filled according to freshly-set hw_size */
543 if(-1 == sysctl(hwproduct_name
, 2, NULL
, &hwproduct_size
, NULL
, 0) || -1 == sysctl(hwproduct_name
, 2, hwproduct
, &hwproduct_size
, NULL
, 0))
546 if(-1 == sysctl(hwmodel_name
, 2, NULL
, &hwmodel_size
, NULL
, 0) || -1 == sysctl(hwmodel_name
, 2, hwmodel
, &hwmodel_size
, NULL
, 0))
549 if(-1 == sysctl(hwvendor_name
, 2, NULL
, &hwvendor_size
, NULL
, 0) || -1 == sysctl(hwvendor_name
, 2, hwvendor
, &hwvendor_size
, NULL
, 0))
552 if(-1 == sysctl(hwmachine_name
, 2, NULL
, &hwmachine_size
, NULL
, 0) || -1 == sysctl(hwmachine_name
, 2, hwmachine
, &hwmachine_size
, NULL
, 0))
555 /* TODO: test for laptop, if not, dmidecode for desktop vs. server
556 * probably move this code to vm test func and set a global after running it early, once */
558 for(; i
< G_N_ELEMENTS(chassis_indicator_table
); i
++) {
559 if(strcasestr(hwproduct
, chassis_indicator_table
[i
].match_string
)
560 || strcasestr(hwmodel
, chassis_indicator_table
[i
].match_string
)
561 || strcasestr(hwvendor
, chassis_indicator_table
[i
].match_string
)) {
563 if(!UNSURE_CHASSIS_FLAG
&& chassis_indicator_table
[i
].chassis
) {
565 UNSURE_CHASSIS_FLAG
= chassis_indicator_table
[i
].chassis_precedence
;
566 CHASSIS
= chassis_indicator_table
[i
].chassis
;
569 if(!UNSURE_ICON_FLAG
&& chassis_indicator_table
[i
].icon
) {
571 UNSURE_ICON_FLAG
= chassis_indicator_table
[i
].icon_precedence
;
572 ICON
= chassis_indicator_table
[i
].icon
;
577 if(up_native_is_laptop()) {
582 ICON
= "input-touchpad"; /* TODO pull an icon package that actually has the icons we're looking for */
584 } else if(is_server(hwmachine
)) {
589 ICON
= "uninterruptible-power-supply";
591 } else if(!CHASSIS
|| !ICON
) {
599 return (CHASSIS
&& ICON
);
602 gboolean
is_server(gchar
*arch
) {
606 for(; i
< G_N_ELEMENTS(server_archs
); i
++)
607 if(strcasestr(arch
, server_archs
[i
]))
613 gboolean
up_native_is_laptop() {
615 struct apm_power_info bstate
;
616 struct sensordev acpiac
;
618 if (up_native_get_sensordev("acpiac0", &acpiac
))
621 if (-1 == ioctl(up_apm_get_fd(), APM_IOC_GETPOWER
, &bstate
))
622 g_error("ioctl on apm fd failed : %s", g_strerror(errno
));
624 return bstate
.ac_state
!= APM_AC_UNKNOWN
;
627 int up_apm_get_fd() {
629 static int apm_fd
= 0;
633 g_debug("apm_fd is not initialized yet, opening");
636 if((apm_fd
= open("/dev/apm", O_RDONLY
)) == -1) {
637 if(errno
!= ENXIO
&& errno
!= ENOENT
)
638 g_error("cannot open device file");
645 gboolean
up_native_get_sensordev(const char * id
, struct sensordev
* snsrdev
) {
648 size_t sdlen
= sizeof(struct sensordev
);
649 int mib
[] = {CTL_HW
, HW_SENSORS
, 0, 0 ,0};
651 for (devn
= 0 ; ; devn
++) {
653 if(sysctl(mib
, 3, snsrdev
, &sdlen
, NULL
, 0) == -1) {
660 if (!strcmp(snsrdev
->xname
, id
))