morgan/systemd
1
0
Fork 0
mirror of https://github.com/morgan9e/systemd synced 2026-04-15 00:47:10 +09:00
Code Issues Packages Projects Releases Wiki Activity

sd-varlink: Expose sd_varlink_idl_parse() (#37513)

Browse Source
This commit is contained in:
Daan De Meyer
2025-05-19 16:13:44 +02:00
committed by GitHub
parent 741a184a31 d94c24e9cc
commit e53a3f4b40
7 changed files with 52 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/fuzz/fuzz-varlink-idl.c
View File

@@ -14,7 +14,7 @@
#include "varlink-idl-util.h"
int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
_cleanup_(varlink_interface_freep) sd_varlink_interface *vi = NULL;
_cleanup_(sd_varlink_interface_freep) sd_varlink_interface *vi = NULL;
_cleanup_free_ char *str = NULL, *dump = NULL;
int r;
@@ -25,7 +25,7 @@ int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
assert_se(str = memdup_suffix0(data, size));
r = varlink_idl_parse(str, /* ret_line= */ NULL, /* column= */ NULL, &vi);
r = sd_varlink_idl_parse(str, /* ret_line= */ NULL, /* column= */ NULL, &vi);
if (r < 0) {
log_debug_errno(r, "Failed to parse varlink interface definition: %m");
return 0;

2
src/libsystemd/libsystemd.sym
View File

@@ -1072,6 +1072,8 @@ global:
sd_varlink_get_input_fd;
sd_varlink_get_n_fds;
sd_varlink_get_output_fd;
sd_varlink_idl_parse;
sd_varlink_interface_free;
sd_varlink_reset_fds;
sd_varlink_server_listen_name;
} LIBSYSTEMD_257;

52
src/libsystemd/sd-varlink/sd-varlink-idl.c
View File

@@ -588,7 +588,7 @@ static sd_varlink_symbol* varlink_symbol_free(sd_varlink_symbol *symbol) {
return mfree(symbol);
}
sd_varlink_interface* varlink_interface_free(sd_varlink_interface *interface) {
_public_ sd_varlink_interface* sd_varlink_interface_free(sd_varlink_interface *interface) {
if (!interface)
return NULL;
@@ -1139,13 +1139,13 @@ static int varlink_idl_resolve_types(sd_varlink_interface *interface) {
return 0;
}
int varlink_idl_parse(
_public_ int sd_varlink_idl_parse(
const char *text,
unsigned *line,
unsigned *column,
unsigned *reterr_line,
unsigned *reterr_column,
sd_varlink_interface **ret) {
_cleanup_(varlink_interface_freep) sd_varlink_interface *interface = NULL;
_cleanup_(sd_varlink_interface_freep) sd_varlink_interface *interface = NULL;
_cleanup_(varlink_symbol_freep) sd_varlink_symbol *symbol = NULL;
enum {
STATE_PRE_INTERFACE,
@@ -1166,18 +1166,18 @@ int varlink_idl_parse(
const char **p = &text;
int r;
if (!line)
line = &_line;
if (!column)
column = &_column;
if (!reterr_line)
reterr_line = &_line;
if (!reterr_column)
reterr_column = &_column;
while (state != STATE_DONE) {
_cleanup_free_ char *token = NULL;
r = varlink_idl_subparse_token(
p,
line,
column,
reterr_line,
reterr_column,
allowed_delimiters,
allowed_chars,
&token);
@@ -1188,11 +1188,11 @@ int varlink_idl_parse(
case STATE_PRE_INTERFACE:
if (!token)
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Premature EOF.", *line, *column);
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Premature EOF.", *reterr_line, *reterr_column);
if (streq(token, "#")) {
_cleanup_free_ char *comment = NULL;
r = varlink_idl_subparse_comment(&text, line, column, &comment);
r = varlink_idl_subparse_comment(&text, reterr_line, reterr_column, &comment);
if (r < 0)
return r;
@@ -1213,12 +1213,12 @@ int varlink_idl_parse(
allowed_delimiters = NULL;
allowed_chars = VALID_CHARS_INTERFACE_NAME;
} else
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Unexpected token '%s'.", *line, *column, token);
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Unexpected token '%s'.", *reterr_line, *reterr_column, token);
break;
case STATE_INTERFACE:
if (!token)
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Premature EOF.", *line, *column);
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Premature EOF.", *reterr_line, *reterr_column);
r = varlink_interface_realloc(&interface, n_symbols);
if (r < 0)
@@ -1241,7 +1241,7 @@ int varlink_idl_parse(
if (streq(token, "#")) {
_cleanup_free_ char *comment = NULL;
r = varlink_idl_subparse_comment(&text, line, column, &comment);
r = varlink_idl_subparse_comment(&text, reterr_line, reterr_column, &comment);
if (r < 0)
return r;
@@ -1268,7 +1268,7 @@ int varlink_idl_parse(
state = STATE_ERROR;
allowed_chars = VALID_CHARS_IDENTIFIER;
} else
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Unexpected token '%s'.", *line, *column, token);
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Unexpected token '%s'.", *reterr_line, *reterr_column, token);
break;
@@ -1277,7 +1277,7 @@ int varlink_idl_parse(
n_fields = 0;
if (!token)
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Premature EOF.", *line, *column);
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Premature EOF.", *reterr_line, *reterr_column);
r = varlink_symbol_realloc(&symbol, n_fields);
if (r < 0)
@@ -1286,7 +1286,7 @@ int varlink_idl_parse(
symbol->symbol_type = SD_VARLINK_METHOD;
symbol->name = TAKE_PTR(token);
r = varlink_idl_subparse_struct_or_enum(&text, line, column, &symbol, &n_fields, SD_VARLINK_INPUT, 0);
r = varlink_idl_subparse_struct_or_enum(&text, reterr_line, reterr_column, &symbol, &n_fields, SD_VARLINK_INPUT, 0);
if (r < 0)
return r;
@@ -1298,12 +1298,12 @@ int varlink_idl_parse(
assert(symbol);
if (!token)
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Premature EOF.", *line, *column);
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Premature EOF.", *reterr_line, *reterr_column);
if (!streq(token, "->"))
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Unexpected token '%s'.", *line, *column, token);
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Unexpected token '%s'.", *reterr_line, *reterr_column, token);
r = varlink_idl_subparse_struct_or_enum(&text, line, column, &symbol, &n_fields, SD_VARLINK_OUTPUT, 0);
r = varlink_idl_subparse_struct_or_enum(&text, reterr_line, reterr_column, &symbol, &n_fields, SD_VARLINK_OUTPUT, 0);
if (r < 0)
return r;
@@ -1322,7 +1322,7 @@ int varlink_idl_parse(
n_fields = 0;
if (!token)
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Premature EOF.", *line, *column);
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Premature EOF.", *reterr_line, *reterr_column);
r = varlink_symbol_realloc(&symbol, n_fields);
if (r < 0)
@@ -1331,7 +1331,7 @@ int varlink_idl_parse(
symbol->symbol_type = _SD_VARLINK_SYMBOL_TYPE_INVALID; /* don't know yet if enum or struct, will be field in by varlink_idl_subparse_struct_or_enum() */
symbol->name = TAKE_PTR(token);
r = varlink_idl_subparse_struct_or_enum(&text, line, column, &symbol, &n_fields, SD_VARLINK_REGULAR, 0);
r = varlink_idl_subparse_struct_or_enum(&text, reterr_line, reterr_column, &symbol, &n_fields, SD_VARLINK_REGULAR, 0);
if (r < 0)
return r;
@@ -1350,7 +1350,7 @@ int varlink_idl_parse(
n_fields = 0;
if (!token)
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Premature EOF.", *line, *column);
return varlink_idl_log(SYNTHETIC_ERRNO(EBADMSG), "%u:%u: Premature EOF.", *reterr_line, *reterr_column);
r = varlink_symbol_realloc(&symbol, n_fields);
if (r < 0)
@@ -1359,7 +1359,7 @@ int varlink_idl_parse(
symbol->symbol_type = SD_VARLINK_ERROR;
symbol->name = TAKE_PTR(token);
r = varlink_idl_subparse_struct_or_enum(&text, line, column, &symbol, &n_fields, SD_VARLINK_REGULAR, 0);
r = varlink_idl_subparse_struct_or_enum(&text, reterr_line, reterr_column, &symbol, &n_fields, SD_VARLINK_REGULAR, 0);
if (r < 0)
return r;

4
src/libsystemd/sd-varlink/varlink-idl-util.h
View File

@@ -6,10 +6,6 @@
#include "memory-util.h"
int varlink_idl_parse(const char *text, unsigned *ret_line, unsigned *ret_column, sd_varlink_interface **ret);
sd_varlink_interface* varlink_interface_free(sd_varlink_interface *interface);
DEFINE_TRIVIAL_CLEANUP_FUNC(sd_varlink_interface*, varlink_interface_free);
bool varlink_idl_field_name_is_valid(const char *name);
bool varlink_idl_symbol_name_is_valid(const char *name);
bool varlink_idl_interface_name_is_valid(const char *name);

4
src/systemd/sd-varlink-idl.h
View File

@@ -221,6 +221,10 @@ int sd_varlink_idl_dump(FILE *f, const sd_varlink_interface *interface, sd_varli
int sd_varlink_idl_format_full(const sd_varlink_interface *interface, sd_varlink_idl_format_flags_t flags, size_t cols, char **ret);
int sd_varlink_idl_format(const sd_varlink_interface *interface, char **ret);
int sd_varlink_idl_parse(const char *text, unsigned *reterr_line, unsigned *reterr_column, sd_varlink_interface **ret);
sd_varlink_interface* sd_varlink_interface_free(sd_varlink_interface *interface);
_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_varlink_interface, sd_varlink_interface_free);
_SD_END_DECLARATIONS;
#endif

28
src/test/test-varlink-idl.c
View File

@@ -129,7 +129,7 @@ static SD_VARLINK_DEFINE_INTERFACE(
&vl_error_ErrorTest);
static void test_parse_format_one(const sd_varlink_interface *iface) {
_cleanup_(varlink_interface_freep) sd_varlink_interface *parsed = NULL;
_cleanup_(sd_varlink_interface_freep) sd_varlink_interface *parsed = NULL;
_cleanup_free_ char *text = NULL, *text2 = NULL;
assert_se(iface);
@@ -137,7 +137,7 @@ static void test_parse_format_one(const sd_varlink_interface *iface) {
assert_se(sd_varlink_idl_dump(stdout, iface, SD_VARLINK_IDL_FORMAT_COLOR, /* cols= */ SIZE_MAX) >= 0);
assert_se(varlink_idl_consistent(iface, LOG_ERR) >= 0);
assert_se(sd_varlink_idl_format(iface, &text) >= 0);
assert_se(varlink_idl_parse(text, NULL, NULL, &parsed) >= 0);
assert_se(sd_varlink_idl_parse(text, NULL, NULL, &parsed) >= 0);
assert_se(varlink_idl_consistent(parsed, LOG_ERR) >= 0);
assert_se(sd_varlink_idl_format(parsed, &text2) >= 0);
@@ -145,13 +145,13 @@ static void test_parse_format_one(const sd_varlink_interface *iface) {
text = mfree(text);
text2 = mfree(text2);
parsed = varlink_interface_free(parsed);
parsed = sd_varlink_interface_free(parsed);
/* Do the same thing, but aggressively line break, and make sure this is roundtrippable as well */
assert_se(sd_varlink_idl_dump(stdout, iface, SD_VARLINK_IDL_FORMAT_COLOR, 23) >= 0);
assert_se(varlink_idl_consistent(iface, LOG_ERR) >= 0);
assert_se(sd_varlink_idl_format_full(iface, 0, 23, &text) >= 0);
assert_se(varlink_idl_parse(text, NULL, NULL, &parsed) >= 0);
assert_se(sd_varlink_idl_parse(text, NULL, NULL, &parsed) >= 0);
assert_se(varlink_idl_consistent(parsed, LOG_ERR) >= 0);
assert_se(sd_varlink_idl_format_full(parsed, 0, 23, &text2) >= 0);
@@ -213,7 +213,7 @@ TEST(parse_format) {
}
TEST(parse) {
_cleanup_(varlink_interface_freep) sd_varlink_interface *parsed = NULL;
_cleanup_(sd_varlink_interface_freep) sd_varlink_interface *parsed = NULL;
/* This one has (nested) enonymous enums and structs */
static const char text[] =
@@ -222,13 +222,13 @@ TEST(parse) {
"type Barstruct ( a : (x, y, z), b : (x : int), c: (f, ff, fff), d: object, e : (sub : (subsub: (subsubsub: string, subsubsub2: (iii, ooo)))))"
;
assert_se(varlink_idl_parse(text, NULL, NULL, &parsed) >= 0);
assert_se(sd_varlink_idl_parse(text, NULL, NULL, &parsed) >= 0);
test_parse_format_one(parsed);
assert_se(varlink_idl_parse("interface org.freedesktop.Foo\n"
"type Foo (b: bool, c: foo, c: int)", NULL, NULL, NULL) == -ENETUNREACH); /* unresolved type */
assert_se(varlink_idl_parse("interface org.freedesktop.Foo\n"
"type Foo ()", NULL, NULL, NULL) == -EBADMSG); /* empty struct/enum */
assert_se(sd_varlink_idl_parse("interface org.freedesktop.Foo\n"
"type Foo (b: bool, c: foo, c: int)", NULL, NULL, NULL) == -ENETUNREACH); /* unresolved type */
assert_se(sd_varlink_idl_parse("interface org.freedesktop.Foo\n"
"type Foo ()", NULL, NULL, NULL) == -EBADMSG); /* empty struct/enum */
}
TEST(interface_name_is_valid) {
@@ -300,7 +300,7 @@ TEST(qualified_symbol_name_is_valid) {
TEST(validate_json) {
_cleanup_(varlink_interface_freep) sd_varlink_interface *parsed = NULL;
_cleanup_(sd_varlink_interface_freep) sd_varlink_interface *parsed = NULL;
/* This one has (nested) enonymous enums and structs */
static const char text[] =
@@ -311,7 +311,7 @@ TEST(validate_json) {
"#paff\n"
"b:int, c:?bool, d:[]int, e:?[string]bool, f:?(piff, paff), g:(f:float) ) -> ()\n";
assert_se(varlink_idl_parse(text, NULL, NULL, &parsed) >= 0);
assert_se(sd_varlink_idl_parse(text, NULL, NULL, &parsed) >= 0);
test_parse_format_one(parsed);
_cleanup_(sd_json_variant_unrefp) sd_json_variant *v = NULL;
@@ -330,7 +330,7 @@ TEST(validate_json) {
}
static int test_recursive_one(unsigned depth) {
_cleanup_(varlink_interface_freep) sd_varlink_interface *parsed = NULL;
_cleanup_(sd_varlink_interface_freep) sd_varlink_interface *parsed = NULL;
_cleanup_free_ char *pre = NULL, *post = NULL, *text = NULL;
static const char header[] =
"interface recursive.test\n"
@@ -346,7 +346,7 @@ static int test_recursive_one(unsigned depth) {
if (!text)
return log_oom();
return varlink_idl_parse(text, NULL, NULL, &parsed);
return sd_varlink_idl_parse(text, NULL, NULL, &parsed);
}
TEST(recursive) {

8
src/varlinkctl/varlinkctl.c
View File

@@ -449,7 +449,7 @@ static int verb_introspect(int argc, char *argv[], void *userdata) {
{ "description", SD_JSON_VARIANT_STRING, sd_json_dispatch_const_string, 0, SD_JSON_MANDATORY },
{}
};
_cleanup_(varlink_interface_freep) sd_varlink_interface *vi = NULL;
_cleanup_(sd_varlink_interface_freep) sd_varlink_interface *vi = NULL;
const char *description = NULL;
unsigned line = 0, column = 0;
@@ -461,7 +461,7 @@ static int verb_introspect(int argc, char *argv[], void *userdata) {
print_separator();
/* Try to parse the returned description, so that we can add syntax highlighting */
r = varlink_idl_parse(ASSERT_PTR(description), &line, &column, &vi);
r = sd_varlink_idl_parse(ASSERT_PTR(description), &line, &column, &vi);
if (r < 0) {
if (list_methods)
return log_error_errno(r, "Failed to parse returned interface description at %u:%u: %m", line, column);
@@ -818,7 +818,7 @@ static int verb_call(int argc, char *argv[], void *userdata) {
}
static int verb_validate_idl(int argc, char *argv[], void *userdata) {
_cleanup_(varlink_interface_freep) sd_varlink_interface *vi = NULL;
_cleanup_(sd_varlink_interface_freep) sd_varlink_interface *vi = NULL;
_cleanup_free_ char *text = NULL;
const char *fname;
unsigned line = 1, column = 1;
@@ -838,7 +838,7 @@ static int verb_validate_idl(int argc, char *argv[], void *userdata) {
fname = "<stdin>";
}
r = varlink_idl_parse(text, &line, &column, &vi);
r = sd_varlink_idl_parse(text, &line, &column, &vi);
if (r == -EBADMSG)
return log_error_errno(r, "%s:%u:%u: Bad syntax.", fname, line, column);
if (r == -ENETUNREACH)