Merge pull request #31 from whot/master

extra _safe() helper functions, start of the cleanup attribute

src/hidpp20.c

@@ -63,7 +63,7 @@ hidpp20_feature_get_name(uint16_t feature)
 	CASE_RETURN_STRING(HIDPP_PAGE_ONBOARD_PROFILES);
 	CASE_RETURN_STRING(HIDPP_PAGE_MOUSE_BUTTON_SPY);
 	default:
-		sprintf(numeric, "%#4x", feature);
+		sprintf_safe(numeric, "%#4x", feature);
 		str = numeric;
 		break;
 	}

src/libratbag-hidraw.c

@@ -186,7 +186,7 @@ ratbag_open_hidraw_node(struct ratbag_device *device, struct udev_device *hidraw
 	device->hidraw.reports = zalloc(reports_size);
 	ratbag_hidraw_parse_report_descriptor(device);
 
-	device->hidraw.sysname = strdup(sysname);
+	device->hidraw.sysname = strdup_safe(sysname);
 	return 0;
 
 err:

src/libratbag-private.h

@@ -33,6 +33,28 @@
 #include "libratbag-util.h"
 #include "libratbag-hidraw.h"
 
+static inline void
+cleanup_device(struct ratbag_device **d)
+{
+	ratbag_device_unref(*d);
+}
+
+static inline void
+cleanup_profile(struct ratbag_profile **p)
+{
+	ratbag_profile_unref(*p);
+}
+
+static inline void
+cleanup_resolution(struct ratbag_resolution **r)
+{
+	ratbag_resolution_unref(*r);
+}
+
+#define _cleanup_device_ _cleanup_(cleanup_device)
+#define _cleanup_profile_ _cleanup_(cleanup_profile)
+#define _cleanup_resolution_ _cleanup_(cleanup_resolution)
+
 #define BUS_ANY					0xffff
 #define VENDOR_ANY				0xffff
 #define PRODUCT_ANY				0xffff

src/libratbag-util.h

@@ -25,6 +25,7 @@
 #define LIBRATBAG_UTIL_H
 
 #include <stdlib.h>
+#include <stdio.h>
 #include <string.h>
 #include <unistd.h>
 #include <libudev.h>
@@ -79,6 +80,14 @@ int list_empty(const struct list *list);
 #define streq(s1, s2) (strcmp((s1), (s2)) == 0)
 #define strneq(s1, s2, n) (strncmp((s1), (s2), (n)) == 0)
 
+static inline void
+cleanup_free(void *p) {
+	free(*(void**)p);
+}
+
+#define _cleanup_(x) __attribute__((cleanup(x)))
+#define _cleanup_free_ _cleanup_(cleanup_free)
+
 static inline char*
 strncpy_safe(char *dest, const char *src, size_t n)
 {
@@ -99,6 +108,43 @@ zalloc(size_t size)
 	return p;
 }
 
+/**
+ * returns NULL if str is NULL, otherwise guarantees a successful strdup.
+ */
+static inline char *
+strdup_safe(const char *str)
+{
+	char *s;
+
+	if (!str)
+		return NULL;
+
+	s = strdup(str);
+	if (!s)
+		abort();
+
+	return s;
+}
+
+static inline int
+snprintf_safe(char *buf, size_t n, const char *fmt, ...)
+{
+	va_list args;
+	int rc;
+
+	va_start(args, fmt);
+	rc = vsnprintf(buf, n, fmt, args);
+	va_end(args);
+
+	if (rc < 0 || n < (size_t)rc)
+		abort();
+
+	return rc;
+}
+
+#define sprintf_safe(buf, fmt, ...) \
+	snprintf_safe(buf, ARRAY_LENGTH(buf), fmt, __VA_ARGS__)
+
 static inline void
 msleep(unsigned int ms)
 {

src/libratbag.c

@@ -90,7 +90,7 @@ log_buffer(struct ratbag *ratbag,
 	const char *header,
 	uint8_t *buf, size_t len)
 {
-	char *output_buf;
+	_cleanup_free_ char *output_buf = NULL;
 	char *sep = "";
 	unsigned int i, n;
 	unsigned int buf_len;
@@ -106,16 +106,14 @@ log_buffer(struct ratbag *ratbag,
 	output_buf = zalloc(buf_len);
 	n = 0;
 	if (header)
-		n += sprintf(output_buf, "%s", header);
+		n += snprintf_safe(output_buf, buf_len - n, "%s", header);
 
 	for (i = 0; i < len; ++i) {
-		n += sprintf(&output_buf[n], "%s%02x", sep, buf[i] & 0xFF);
+		n += snprintf_safe(&output_buf[n], buf_len - n, "%s%02x", sep, buf[i] & 0xFF);
 		sep = " ";
 	}
 
 	log_msg(ratbag, priority, "%s\n", output_buf);
-
-	free(output_buf);
 }
 
 LIBRATBAG_EXPORT void
@@ -157,7 +155,7 @@ ratbag_device_new(struct ratbag *ratbag, struct udev_device *udev_device,
 	struct ratbag_device *device = NULL;
 
 	device = zalloc(sizeof(*device));
-	device->name = strdup(name);
+	device->name = strdup_safe(name);
 
 	if (!name) {
 		free(device);
@@ -208,8 +206,8 @@ static inline bool
 ratbag_sanity_check_device(struct ratbag_device *device)
 {
 	struct ratbag *ratbag = device->ratbag;
-	struct ratbag_profile *profile = NULL;
-	struct ratbag_resolution *res = NULL;
+	_cleanup_profile_ struct ratbag_profile *profile = NULL;
+	_cleanup_resolution_ struct ratbag_resolution *res = NULL;
 	bool has_active = false;
 	bool has_default = false;
 	unsigned int nres, nprofiles;
@@ -278,9 +276,6 @@ ratbag_sanity_check_device(struct ratbag_device *device)
 	rc = true;
 
 out:
-	ratbag_profile_unref(profile);
-	ratbag_resolution_unref(res);
-
 	return rc;
 }
 
@@ -1180,7 +1175,7 @@ ratbag_button_set_macro(struct ratbag_button *button, const char *name)
 	}
 
 	button->action.type = RATBAG_BUTTON_ACTION_TYPE_MACRO;
-	button->action.macro->name = name ? strdup(name) : NULL;
+	button->action.macro->name = strdup_safe(name);
 
 	return 0;
 }

tools/ratbag-command.c

@@ -481,7 +481,7 @@ str_to_macro(const char *action_arg, struct macro *m)
 	if (!action_arg)
 		return -EINVAL;
 
-	str = strdup(action_arg);
+	str = strdup_safe(action_arg);
 	s = str;
 
 	m->name = "<cmdline>";
@@ -706,7 +706,7 @@ ratbag_cmd_list_supported_devices(const struct ratbag_cmd *cmd,
 
 	i = -1;
 	while (++i < n) {
-		sprintf(path, "/dev/input/%s", input_list[i]->d_name);
+		sprintf_safe(path, "/dev/input/%s", input_list[i]->d_name);
 		device = ratbag_cmd_open_device(ratbag, path);
 		if (device) {
 			printf("%s:\t%s\n", path, ratbag_device_get_name(device));

tools/shared.c

@@ -129,9 +129,9 @@ button_action_button_to_str(struct ratbag_button *button)
 {
 	char str[96];
 
-	sprintf(str, "button %d", ratbag_button_get_button(button));
+	sprintf_safe(str, "button %d", ratbag_button_get_button(button));
 
-	return strdup(str);
+	return strdup_safe(str);
 }
 
 char *
@@ -145,7 +145,7 @@ button_action_key_to_str(struct ratbag_button *button)
 	if (!str)
 		str = "UNKNOWN";
 
-	return strdup(str);
+	return strdup_safe(str);
 }
 
 static const char *strip_ev_key(int key)
@@ -191,7 +191,7 @@ button_action_macro_to_str(struct ratbag_button *button)
 		}
 	}
 
-	return strdup(str);
+	return strdup_safe(str);
 }
 
 char *
@@ -205,12 +205,12 @@ button_action_to_str(struct ratbag_button *button)
 	switch (type) {
 	case RATBAG_BUTTON_ACTION_TYPE_BUTTON:	str = button_action_button_to_str(button); break;
 	case RATBAG_BUTTON_ACTION_TYPE_KEY:	str = button_action_key_to_str(button); break;
-	case RATBAG_BUTTON_ACTION_TYPE_SPECIAL:	str = strdup(button_action_special_to_str(button)); break;
+	case RATBAG_BUTTON_ACTION_TYPE_SPECIAL:	str = strdup_safe(button_action_special_to_str(button)); break;
 	case RATBAG_BUTTON_ACTION_TYPE_MACRO:	str = button_action_macro_to_str(button); break;
-	case RATBAG_BUTTON_ACTION_TYPE_NONE:	str = strdup("none"); break;
+	case RATBAG_BUTTON_ACTION_TYPE_NONE:	str = strdup_safe("none"); break;
 	default:
 		error("type %d unknown\n", type);
-		str = strdup("UNKNOWN");
+		str = strdup_safe("UNKNOWN");
 	}
 
 	return str;