Browse Source

device-nodes: move device node specific code to own file

In the process, rename udev_encode_string which is poorly named for what
it does. It deals specifically with encoding names that udev creates and
has its own rules: utf8 is valid but some ascii is not (e.g. path
separators), and everything else is simply escaped. Rename it to
encode_devnode_name.
keep-around/ba91431154ad7bac82ddf0a540ec1b40db62d782
Dave Reisner 9 years ago
parent
commit
8f6ce71fe7
  1. 1
      .gitignore
  2. 14
      Makefile.am
  3. 5
      src/libudev/libudev-util.c
  4. 74
      src/shared/device-nodes.c
  5. 23
      src/shared/device-nodes.h
  6. 46
      src/shared/utf8.c
  7. 2
      src/shared/utf8.h
  8. 4
      src/shared/util.c
  9. 55
      src/test/test-device-nodes.c
  10. 28
      src/test/test-utf8.c

1
.gitignore

@ -101,6 +101,7 @@
/test-cgroup-util
/test-daemon
/test-date
/test-device-nodes
/test-efivars
/test-engine
/test-env-replace

14
Makefile.am

@ -642,6 +642,8 @@ libsystemd_shared_la_SOURCES = \
src/shared/list.h \
src/shared/macro.h \
src/shared/def.h \
src/shared/device-nodes.c \
src/shared/device-nodes.h \
src/shared/sparse-endian.h \
src/shared/util.c \
src/shared/util.h \
@ -1137,7 +1139,8 @@ tests += \
test-time \
test-hashmap \
test-list \
test-tables
test-tables \
test-device-nodes
EXTRA_DIST += \
test/sched_idle_bad.service \
@ -1149,6 +1152,15 @@ EXTRA_DIST += \
EXTRA_DIST += \
src/test/test-helper.h
test_device_nodes_SOURCES = \
src/test/test-device-nodes.c
test_device_nodes_CFLAGS = \
$(AM_CFLAGS)
test_device_nodes_LDADD = \
libsystemd-shared.la
test_engine_SOURCES = \
src/test/test-engine.c

5
src/libudev/libudev-util.c

@ -32,6 +32,7 @@
#include <sys/stat.h>
#include <sys/param.h>
#include "device-nodes.h"
#include "libudev.h"
#include "libudev-private.h"
#include "utf8.h"
@ -344,7 +345,7 @@ int util_replace_chars(char *str, const char *white)
while (str[i] != '\0') {
int len;
if (is_utf8_encoding_whitelisted(str[i], white)) {
if (whitelisted_char_for_devnode(str[i], white)) {
i++;
continue;
}
@ -392,7 +393,7 @@ int util_replace_chars(char *str, const char *white)
**/
_public_ int udev_util_encode_string(const char *str, char *str_enc, size_t len)
{
return udev_encode_string(str, str_enc, len);
return encode_devnode_name(str, str_enc, len);
}
/*

74
src/shared/device-nodes.c

@ -0,0 +1,74 @@
/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
/***
This file is part of systemd.
Copyright 2012 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/
#include <stdlib.h>
#include <stdio.h>
#include <stdint.h>
#include <sys/types.h>
#include "device-nodes.h"
#include "utf8.h"
int whitelisted_char_for_devnode(char c, const char *white) {
if ((c >= '0' && c <= '9') ||
(c >= 'A' && c <= 'Z') ||
(c >= 'a' && c <= 'z') ||
strchr("#+-.:=@_", c) != NULL ||
(white != NULL && strchr(white, c) != NULL))
return 1;
return 0;
}
int encode_devnode_name(const char *str, char *str_enc, size_t len) {
size_t i, j;
if (str == NULL || str_enc == NULL)
return -1;
for (i = 0, j = 0; str[i] != '\0'; i++) {
int seqlen;
seqlen = utf8_encoded_valid_unichar(&str[i]);
if (seqlen > 1) {
if (len-j < (size_t)seqlen)
goto err;
memcpy(&str_enc[j], &str[i], seqlen);
j += seqlen;
i += (seqlen-1);
} else if (str[i] == '\\' || !whitelisted_char_for_devnode(str[i], NULL)) {
if (len-j < 4)
goto err;
sprintf(&str_enc[j], "\\x%02x", (unsigned char) str[i]);
j += 4;
} else {
if (len-j < 1)
goto err;
str_enc[j] = str[i];
j++;
}
}
if (len-j < 1)
goto err;
str_enc[j] = '\0';
return 0;
err:
return -1;
}

23
src/shared/device-nodes.h

@ -0,0 +1,23 @@
/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
/***
This file is part of systemd.
Copyright 2012 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/
int encode_devnode_name(const char *str, char *str_enc, size_t len);
int whitelisted_char_for_devnode(char c, const char *additional);

46
src/shared/utf8.c

@ -285,49 +285,3 @@ int utf8_encoded_valid_unichar(const char *str) {
return len;
}
int is_utf8_encoding_whitelisted(char c, const char *white) {
if ((c >= '0' && c <= '9') ||
(c >= 'A' && c <= 'Z') ||
(c >= 'a' && c <= 'z') ||
strchr("#+-.:=@_", c) != NULL ||
(white != NULL && strchr(white, c) != NULL))
return 1;
return 0;
}
int udev_encode_string(const char *str, char *str_enc, size_t len) {
size_t i, j;
if (str == NULL || str_enc == NULL)
return -1;
for (i = 0, j = 0; str[i] != '\0'; i++) {
int seqlen;
seqlen = utf8_encoded_valid_unichar(&str[i]);
if (seqlen > 1) {
if (len-j < (size_t)seqlen)
goto err;
memcpy(&str_enc[j], &str[i], seqlen);
j += seqlen;
i += (seqlen-1);
} else if (str[i] == '\\' || !is_utf8_encoding_whitelisted(str[i], NULL)) {
if (len-j < 4)
goto err;
sprintf(&str_enc[j], "\\x%02x", (unsigned char) str[i]);
j += 4;
} else {
if (len-j < 1)
goto err;
str_enc[j] = str[i];
j++;
}
}
if (len-j < 1)
goto err;
str_enc[j] = '\0';
return 0;
err:
return -1;
}

2
src/shared/utf8.h

@ -35,5 +35,3 @@ char *ascii_filter(const char *s);
char *utf16_to_utf8(const void *s, size_t length);
int utf8_encoded_valid_unichar(const char *str);
int is_utf8_encoding_whitelisted(char c, const char *white);
int udev_encode_string(const char *str, char *str_enc, size_t len);

4
src/shared/util.c

@ -73,7 +73,7 @@
#include "hashmap.h"
#include "env-util.h"
#include "fileio.h"
#include "utf8.h"
#include "device-nodes.h"
int saved_argc = 0;
char **saved_argv = NULL;
@ -3509,7 +3509,7 @@ static char *tag_to_udev_node(const char *tagvalue, const char *by) {
if (t == NULL)
return NULL;
if (udev_encode_string(u, t, enc_len) < 0)
if (encode_devnode_name(u, t, enc_len) < 0)
return NULL;
if (asprintf(&dn, "/dev/disk/by-%s/%s", by, t) < 0)

55
src/test/test-device-nodes.c

@ -0,0 +1,55 @@
/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
/***
This file is part of systemd.
Copyright 2013 Dave Reisner
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/
#include <sys/types.h>
#include "device-nodes.h"
#include "util.h"
/* helpers for test_encode_devnode_name */
static char *do_encode_string(const char *in) {
size_t out_len = strlen(in) * 4;
char *out = malloc(out_len);
assert_se(out);
assert_se(encode_devnode_name(in, out, out_len) >= 0);
puts(out);
return out;
}
static bool expect_encoded_as(const char *in, const char *expected) {
_cleanup_free_ char *encoded = do_encode_string(in);
return streq(encoded, expected);
}
static void test_encode_devnode_name(void) {
assert_se(expect_encoded_as("systemd sucks", "systemd\\x20sucks"));
assert_se(expect_encoded_as("pinkiepie", "pinkiepie"));
assert_se(expect_encoded_as("valíd\\ųtf8", "valíd\\x5cųtf8"));
assert_se(expect_encoded_as("s/ash/ng", "s\\x2fash\\x2fng"));
}
int main(int argc, char *argv[]) {
test_encode_devnode_name();
return 0;
}

28
src/test/test-utf8.c

@ -19,34 +19,9 @@
along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/
#include "utf8.h"
#include "util.h"
/* helpers for test_udev_encode_string */
static char *do_encode_string(const char *in) {
size_t out_len = strlen(in) * 4;
char *out = malloc(out_len);
assert_se(out);
assert_se(udev_encode_string(in, out, out_len) >= 0);
puts(out);
return out;
}
static bool expect_encoded_as(const char *in, const char *expected) {
_cleanup_free_ char *encoded = do_encode_string(in);
return streq(encoded, expected);
}
static void test_udev_encode_string(void) {
assert_se(expect_encoded_as("systemd sucks", "systemd\\x20sucks"));
assert_se(expect_encoded_as("pinkiepie", "pinkiepie"));
assert_se(expect_encoded_as("valíd\\ųtf8", "valíd\\x5cųtf8"));
assert_se(expect_encoded_as("s/ash/ng", "s\\x2fash\\x2fng"));
}
static void test_utf8_is_printable(void) {
assert_se(utf8_is_printable("ascii is valid\tunicode", 22));
assert_se(utf8_is_printable("\342\204\242", 3));
@ -55,14 +30,13 @@ static void test_utf8_is_printable(void) {
static void test_utf8_is_valid(void) {
assert_se(utf8_is_valid("ascii is valid unicode"));
assert_se(utf8_is_valid("\341\204\242"));
assert_se(utf8_is_valid("\342\204\242"));
assert_se(!utf8_is_valid("\341\204"));
}
int main(int argc, char *argv[]) {
test_utf8_is_valid();
test_utf8_is_printable();
test_udev_encode_string();
return 0;
}

Loading…
Cancel
Save