Blame jemalloc/test/unit/emitter.c

Packit 345191
#include "test/jemalloc_test.h"
Packit 345191
#include "jemalloc/internal/emitter.h"
Packit 345191
Packit 345191
/*
Packit 345191
 * This is so useful for debugging and feature work, we'll leave printing
Packit 345191
 * functionality committed but disabled by default.
Packit 345191
 */
Packit 345191
/* Print the text as it will appear. */
Packit 345191
static bool print_raw = false;
Packit 345191
/* Print the text escaped, so it can be copied back into the test case. */
Packit 345191
static bool print_escaped = false;
Packit 345191
Packit 345191
typedef struct buf_descriptor_s buf_descriptor_t;
Packit 345191
struct buf_descriptor_s {
Packit 345191
	char *buf;
Packit 345191
	size_t len;
Packit 345191
	bool mid_quote;
Packit 345191
};
Packit 345191
Packit 345191
/*
Packit 345191
 * Forwards all writes to the passed-in buf_v (which should be cast from a
Packit 345191
 * buf_descriptor_t *).
Packit 345191
 */
Packit 345191
static void
Packit 345191
forwarding_cb(void *buf_descriptor_v, const char *str) {
Packit 345191
	buf_descriptor_t *buf_descriptor = (buf_descriptor_t *)buf_descriptor_v;
Packit 345191
Packit 345191
	if (print_raw) {
Packit 345191
		malloc_printf("%s", str);
Packit 345191
	}
Packit 345191
	if (print_escaped) {
Packit 345191
		const char *it = str;
Packit 345191
		while (*it != '\0') {
Packit 345191
			if (!buf_descriptor->mid_quote) {
Packit 345191
				malloc_printf("\"");
Packit 345191
				buf_descriptor->mid_quote = true;
Packit 345191
			}
Packit 345191
			switch (*it) {
Packit 345191
			case '\\':
Packit 345191
				malloc_printf("\\");
Packit 345191
				break;
Packit 345191
			case '\"':
Packit 345191
				malloc_printf("\\\"");
Packit 345191
				break;
Packit 345191
			case '\t':
Packit 345191
				malloc_printf("\\t");
Packit 345191
				break;
Packit 345191
			case '\n':
Packit 345191
				malloc_printf("\\n\"\n");
Packit 345191
				buf_descriptor->mid_quote = false;
Packit 345191
				break;
Packit 345191
			default:
Packit 345191
				malloc_printf("%c", *it);
Packit 345191
			}
Packit 345191
			it++;
Packit 345191
		}
Packit 345191
	}
Packit 345191
Packit 345191
	size_t written = malloc_snprintf(buf_descriptor->buf,
Packit 345191
	    buf_descriptor->len, "%s", str);
Packit 345191
	assert_zu_eq(written, strlen(str), "Buffer overflow!");
Packit 345191
	buf_descriptor->buf += written;
Packit 345191
	buf_descriptor->len -= written;
Packit 345191
	assert_zu_gt(buf_descriptor->len, 0, "Buffer out of space!");
Packit 345191
}
Packit 345191
Packit 345191
static void
Packit 345191
assert_emit_output(void (*emit_fn)(emitter_t *),
Packit 345191
    const char *expected_json_output, const char *expected_table_output) {
Packit 345191
	emitter_t emitter;
Packit 345191
	char buf[MALLOC_PRINTF_BUFSIZE];
Packit 345191
	buf_descriptor_t buf_descriptor;
Packit 345191
Packit 345191
	buf_descriptor.buf = buf;
Packit 345191
	buf_descriptor.len = MALLOC_PRINTF_BUFSIZE;
Packit 345191
	buf_descriptor.mid_quote = false;
Packit 345191
Packit 345191
	emitter_init(&emitter, emitter_output_json, &forwarding_cb,
Packit 345191
	    &buf_descriptor);
Packit 345191
	(*emit_fn)(&emitter);
Packit 345191
	assert_str_eq(expected_json_output, buf, "json output failure");
Packit 345191
Packit 345191
	buf_descriptor.buf = buf;
Packit 345191
	buf_descriptor.len = MALLOC_PRINTF_BUFSIZE;
Packit 345191
	buf_descriptor.mid_quote = false;
Packit 345191
Packit 345191
	emitter_init(&emitter, emitter_output_table, &forwarding_cb,
Packit 345191
	    &buf_descriptor);
Packit 345191
	(*emit_fn)(&emitter);
Packit 345191
	assert_str_eq(expected_table_output, buf, "table output failure");
Packit 345191
}
Packit 345191
Packit 345191
static void
Packit 345191
emit_dict(emitter_t *emitter) {
Packit 345191
	bool b_false = false;
Packit 345191
	bool b_true = true;
Packit 345191
	int i_123 = 123;
Packit 345191
	const char *str = "a string";
Packit 345191
Packit 345191
	emitter_begin(emitter);
Packit 345191
	emitter_dict_begin(emitter, "foo", "This is the foo table:");
Packit 345191
	emitter_kv(emitter, "abc", "ABC", emitter_type_bool, &b_false);
Packit 345191
	emitter_kv(emitter, "def", "DEF", emitter_type_bool, &b_true);
Packit 345191
	emitter_kv_note(emitter, "ghi", "GHI", emitter_type_int, &i_123,
Packit 345191
	    "note_key1", emitter_type_string, &str);
Packit 345191
	emitter_kv_note(emitter, "jkl", "JKL", emitter_type_string, &str,
Packit 345191
	    "note_key2", emitter_type_bool, &b_false);
Packit 345191
	emitter_dict_end(emitter);
Packit 345191
	emitter_end(emitter);
Packit 345191
}
Packit 345191
static const char *dict_json =
Packit 345191
"{\n"
Packit 345191
"\t\"foo\": {\n"
Packit 345191
"\t\t\"abc\": false,\n"
Packit 345191
"\t\t\"def\": true,\n"
Packit 345191
"\t\t\"ghi\": 123,\n"
Packit 345191
"\t\t\"jkl\": \"a string\"\n"
Packit 345191
"\t}\n"
Packit 345191
"}\n";
Packit 345191
static const char *dict_table =
Packit 345191
"This is the foo table:\n"
Packit 345191
"  ABC: false\n"
Packit 345191
"  DEF: true\n"
Packit 345191
"  GHI: 123 (note_key1: \"a string\")\n"
Packit 345191
"  JKL: \"a string\" (note_key2: false)\n";
Packit 345191
Packit 345191
TEST_BEGIN(test_dict) {
Packit 345191
	assert_emit_output(&emit_dict, dict_json, dict_table);
Packit 345191
}
Packit 345191
TEST_END
Packit 345191
Packit 345191
static void
Packit 345191
emit_table_printf(emitter_t *emitter) {
Packit 345191
	emitter_begin(emitter);
Packit 345191
	emitter_table_printf(emitter, "Table note 1\n");
Packit 345191
	emitter_table_printf(emitter, "Table note 2 %s\n",
Packit 345191
	    "with format string");
Packit 345191
	emitter_end(emitter);
Packit 345191
}
Packit 345191
Packit 345191
static const char *table_printf_json =
Packit 345191
"{\n"
Packit 345191
"}\n";
Packit 345191
Packit 345191
static const char *table_printf_table =
Packit 345191
"Table note 1\n"
Packit 345191
"Table note 2 with format string\n";
Packit 345191
Packit 345191
TEST_BEGIN(test_table_printf) {
Packit 345191
	assert_emit_output(&emit_table_printf, table_printf_json,
Packit 345191
	    table_printf_table);
Packit 345191
}
Packit 345191
TEST_END
Packit 345191
Packit 345191
static void emit_nested_dict(emitter_t *emitter) {
Packit 345191
	int val = 123;
Packit 345191
	emitter_begin(emitter);
Packit 345191
	emitter_dict_begin(emitter, "json1", "Dict 1");
Packit 345191
	emitter_dict_begin(emitter, "json2", "Dict 2");
Packit 345191
	emitter_kv(emitter, "primitive", "A primitive", emitter_type_int, &val;;
Packit 345191
	emitter_dict_end(emitter); /* Close 2 */
Packit 345191
	emitter_dict_begin(emitter, "json3", "Dict 3");
Packit 345191
	emitter_dict_end(emitter); /* Close 3 */
Packit 345191
	emitter_dict_end(emitter); /* Close 1 */
Packit 345191
	emitter_dict_begin(emitter, "json4", "Dict 4");
Packit 345191
	emitter_kv(emitter, "primitive", "Another primitive",
Packit 345191
	    emitter_type_int, &val;;
Packit 345191
	emitter_dict_end(emitter); /* Close 4 */
Packit 345191
	emitter_end(emitter);
Packit 345191
}
Packit 345191
Packit 345191
static const char *nested_object_json =
Packit 345191
"{\n"
Packit 345191
"\t\"json1\": {\n"
Packit 345191
"\t\t\"json2\": {\n"
Packit 345191
"\t\t\t\"primitive\": 123\n"
Packit 345191
"\t\t},\n"
Packit 345191
"\t\t\"json3\": {\n"
Packit 345191
"\t\t}\n"
Packit 345191
"\t},\n"
Packit 345191
"\t\"json4\": {\n"
Packit 345191
"\t\t\"primitive\": 123\n"
Packit 345191
"\t}\n"
Packit 345191
"}\n";
Packit 345191
Packit 345191
static const char *nested_object_table =
Packit 345191
"Dict 1\n"
Packit 345191
"  Dict 2\n"
Packit 345191
"    A primitive: 123\n"
Packit 345191
"  Dict 3\n"
Packit 345191
"Dict 4\n"
Packit 345191
"  Another primitive: 123\n";
Packit 345191
Packit 345191
TEST_BEGIN(test_nested_dict) {
Packit 345191
	assert_emit_output(&emit_nested_dict, nested_object_json,
Packit 345191
	    nested_object_table);
Packit 345191
}
Packit 345191
TEST_END
Packit 345191
Packit 345191
static void
Packit 345191
emit_types(emitter_t *emitter) {
Packit 345191
	bool b = false;
Packit 345191
	int i = -123;
Packit 345191
	unsigned u = 123;
Packit 345191
	ssize_t zd = -456;
Packit 345191
	size_t zu = 456;
Packit 345191
	const char *str = "string";
Packit 345191
	uint32_t u32 = 789;
Packit 345191
	uint64_t u64 = 10000000000ULL;
Packit 345191
Packit 345191
	emitter_begin(emitter);
Packit 345191
	emitter_kv(emitter, "k1", "K1", emitter_type_bool, &b);
Packit 345191
	emitter_kv(emitter, "k2", "K2", emitter_type_int, &i);
Packit 345191
	emitter_kv(emitter, "k3", "K3", emitter_type_unsigned, &u);
Packit 345191
	emitter_kv(emitter, "k4", "K4", emitter_type_ssize, &zd);
Packit 345191
	emitter_kv(emitter, "k5", "K5", emitter_type_size, &zu;;
Packit 345191
	emitter_kv(emitter, "k6", "K6", emitter_type_string, &str);
Packit 345191
	emitter_kv(emitter, "k7", "K7", emitter_type_uint32, &u32);
Packit 345191
	emitter_kv(emitter, "k8", "K8", emitter_type_uint64, &u64);
Packit 345191
	/*
Packit 345191
	 * We don't test the title type, since it's only used for tables.  It's
Packit 345191
	 * tested in the emitter_table_row tests.
Packit 345191
	 */
Packit 345191
	emitter_end(emitter);
Packit 345191
}
Packit 345191
Packit 345191
static const char *types_json =
Packit 345191
"{\n"
Packit 345191
"\t\"k1\": false,\n"
Packit 345191
"\t\"k2\": -123,\n"
Packit 345191
"\t\"k3\": 123,\n"
Packit 345191
"\t\"k4\": -456,\n"
Packit 345191
"\t\"k5\": 456,\n"
Packit 345191
"\t\"k6\": \"string\",\n"
Packit 345191
"\t\"k7\": 789,\n"
Packit 345191
"\t\"k8\": 10000000000\n"
Packit 345191
"}\n";
Packit 345191
Packit 345191
static const char *types_table =
Packit 345191
"K1: false\n"
Packit 345191
"K2: -123\n"
Packit 345191
"K3: 123\n"
Packit 345191
"K4: -456\n"
Packit 345191
"K5: 456\n"
Packit 345191
"K6: \"string\"\n"
Packit 345191
"K7: 789\n"
Packit 345191
"K8: 10000000000\n";
Packit 345191
Packit 345191
TEST_BEGIN(test_types) {
Packit 345191
	assert_emit_output(&emit_types, types_json, types_table);
Packit 345191
}
Packit 345191
TEST_END
Packit 345191
Packit 345191
static void
Packit 345191
emit_modal(emitter_t *emitter) {
Packit 345191
	int val = 123;
Packit 345191
	emitter_begin(emitter);
Packit 345191
	emitter_dict_begin(emitter, "j0", "T0");
Packit 345191
	emitter_json_key(emitter, "j1");
Packit 345191
	emitter_json_object_begin(emitter);
Packit 345191
	emitter_kv(emitter, "i1", "I1", emitter_type_int, &val;;
Packit 345191
	emitter_json_kv(emitter, "i2", emitter_type_int, &val;;
Packit 345191
	emitter_table_kv(emitter, "I3", emitter_type_int, &val;;
Packit 345191
	emitter_table_dict_begin(emitter, "T1");
Packit 345191
	emitter_kv(emitter, "i4", "I4", emitter_type_int, &val;;
Packit 345191
	emitter_json_object_end(emitter); /* Close j1 */
Packit 345191
	emitter_kv(emitter, "i5", "I5", emitter_type_int, &val;;
Packit 345191
	emitter_table_dict_end(emitter); /* Close T1 */
Packit 345191
	emitter_kv(emitter, "i6", "I6", emitter_type_int, &val;;
Packit 345191
	emitter_dict_end(emitter); /* Close j0 / T0 */
Packit 345191
	emitter_end(emitter);
Packit 345191
}
Packit 345191
Packit 345191
const char *modal_json =
Packit 345191
"{\n"
Packit 345191
"\t\"j0\": {\n"
Packit 345191
"\t\t\"j1\": {\n"
Packit 345191
"\t\t\t\"i1\": 123,\n"
Packit 345191
"\t\t\t\"i2\": 123,\n"
Packit 345191
"\t\t\t\"i4\": 123\n"
Packit 345191
"\t\t},\n"
Packit 345191
"\t\t\"i5\": 123,\n"
Packit 345191
"\t\t\"i6\": 123\n"
Packit 345191
"\t}\n"
Packit 345191
"}\n";
Packit 345191
Packit 345191
const char *modal_table =
Packit 345191
"T0\n"
Packit 345191
"  I1: 123\n"
Packit 345191
"  I3: 123\n"
Packit 345191
"  T1\n"
Packit 345191
"    I4: 123\n"
Packit 345191
"    I5: 123\n"
Packit 345191
"  I6: 123\n";
Packit 345191
Packit 345191
TEST_BEGIN(test_modal) {
Packit 345191
	assert_emit_output(&emit_modal, modal_json, modal_table);
Packit 345191
}
Packit 345191
TEST_END
Packit 345191
Packit 345191
static void
Packit 345191
emit_json_arr(emitter_t *emitter) {
Packit 345191
	int ival = 123;
Packit 345191
Packit 345191
	emitter_begin(emitter);
Packit 345191
	emitter_json_key(emitter, "dict");
Packit 345191
	emitter_json_object_begin(emitter);
Packit 345191
	emitter_json_key(emitter, "arr");
Packit 345191
	emitter_json_array_begin(emitter);
Packit 345191
	emitter_json_object_begin(emitter);
Packit 345191
	emitter_json_kv(emitter, "foo", emitter_type_int, &ival);
Packit 345191
	emitter_json_object_end(emitter); /* Close arr[0] */
Packit 345191
	/* arr[1] and arr[2] are primitives. */
Packit 345191
	emitter_json_value(emitter, emitter_type_int, &ival);
Packit 345191
	emitter_json_value(emitter, emitter_type_int, &ival);
Packit 345191
	emitter_json_object_begin(emitter);
Packit 345191
	emitter_json_kv(emitter, "bar", emitter_type_int, &ival);
Packit 345191
	emitter_json_kv(emitter, "baz", emitter_type_int, &ival);
Packit 345191
	emitter_json_object_end(emitter); /* Close arr[3]. */
Packit 345191
	emitter_json_array_end(emitter); /* Close arr. */
Packit 345191
	emitter_json_object_end(emitter); /* Close dict. */
Packit 345191
	emitter_end(emitter);
Packit 345191
}
Packit 345191
Packit 345191
static const char *json_array_json =
Packit 345191
"{\n"
Packit 345191
"\t\"dict\": {\n"
Packit 345191
"\t\t\"arr\": [\n"
Packit 345191
"\t\t\t{\n"
Packit 345191
"\t\t\t\t\"foo\": 123\n"
Packit 345191
"\t\t\t},\n"
Packit 345191
"\t\t\t123,\n"
Packit 345191
"\t\t\t123,\n"
Packit 345191
"\t\t\t{\n"
Packit 345191
"\t\t\t\t\"bar\": 123,\n"
Packit 345191
"\t\t\t\t\"baz\": 123\n"
Packit 345191
"\t\t\t}\n"
Packit 345191
"\t\t]\n"
Packit 345191
"\t}\n"
Packit 345191
"}\n";
Packit 345191
Packit 345191
static const char *json_array_table = "";
Packit 345191
Packit 345191
TEST_BEGIN(test_json_arr) {
Packit 345191
	assert_emit_output(&emit_json_arr, json_array_json, json_array_table);
Packit 345191
}
Packit 345191
TEST_END
Packit 345191
Packit 345191
static void
Packit 345191
emit_json_nested_array(emitter_t *emitter) {
Packit 345191
	int ival = 123;
Packit 345191
	char *sval = "foo";
Packit 345191
	emitter_begin(emitter);
Packit 345191
	emitter_json_array_begin(emitter);
Packit 345191
		emitter_json_array_begin(emitter);
Packit 345191
		emitter_json_value(emitter, emitter_type_int, &ival);
Packit 345191
		emitter_json_value(emitter, emitter_type_string, &sval);
Packit 345191
		emitter_json_value(emitter, emitter_type_int, &ival);
Packit 345191
		emitter_json_value(emitter, emitter_type_string, &sval);
Packit 345191
		emitter_json_array_end(emitter);
Packit 345191
		emitter_json_array_begin(emitter);
Packit 345191
		emitter_json_value(emitter, emitter_type_int, &ival);
Packit 345191
		emitter_json_array_end(emitter);
Packit 345191
		emitter_json_array_begin(emitter);
Packit 345191
		emitter_json_value(emitter, emitter_type_string, &sval);
Packit 345191
		emitter_json_value(emitter, emitter_type_int, &ival);
Packit 345191
		emitter_json_array_end(emitter);
Packit 345191
		emitter_json_array_begin(emitter);
Packit 345191
		emitter_json_array_end(emitter);
Packit 345191
	emitter_json_array_end(emitter);
Packit 345191
	emitter_end(emitter);
Packit 345191
}
Packit 345191
Packit 345191
static const char *json_nested_array_json =
Packit 345191
"{\n"
Packit 345191
"\t[\n"
Packit 345191
"\t\t[\n"
Packit 345191
"\t\t\t123,\n"
Packit 345191
"\t\t\t\"foo\",\n"
Packit 345191
"\t\t\t123,\n"
Packit 345191
"\t\t\t\"foo\"\n"
Packit 345191
"\t\t],\n"
Packit 345191
"\t\t[\n"
Packit 345191
"\t\t\t123\n"
Packit 345191
"\t\t],\n"
Packit 345191
"\t\t[\n"
Packit 345191
"\t\t\t\"foo\",\n"
Packit 345191
"\t\t\t123\n"
Packit 345191
"\t\t],\n"
Packit 345191
"\t\t[\n"
Packit 345191
"\t\t]\n"
Packit 345191
"\t]\n"
Packit 345191
"}\n";
Packit 345191
Packit 345191
TEST_BEGIN(test_json_nested_arr) {
Packit 345191
	assert_emit_output(&emit_json_nested_array, json_nested_array_json,
Packit 345191
	    json_array_table);
Packit 345191
}
Packit 345191
TEST_END
Packit 345191
Packit 345191
static void
Packit 345191
emit_table_row(emitter_t *emitter) {
Packit 345191
	emitter_begin(emitter);
Packit 345191
	emitter_row_t row;
Packit 345191
	emitter_col_t abc = {emitter_justify_left, 10, emitter_type_title, {0}, {0, 0}};
Packit 345191
	abc.str_val = "ABC title";
Packit 345191
	emitter_col_t def = {emitter_justify_right, 15, emitter_type_title, {0}, {0, 0}};
Packit 345191
	def.str_val = "DEF title";
Packit 345191
	emitter_col_t ghi = {emitter_justify_right, 5, emitter_type_title, {0}, {0, 0}};
Packit 345191
	ghi.str_val = "GHI";
Packit 345191
Packit 345191
	emitter_row_init(&row;;
Packit 345191
	emitter_col_init(&abc, &row;;
Packit 345191
	emitter_col_init(&def, &row;;
Packit 345191
	emitter_col_init(&ghi, &row;;
Packit 345191
Packit 345191
	emitter_table_row(emitter, &row;;
Packit 345191
Packit 345191
	abc.type = emitter_type_int;
Packit 345191
	def.type = emitter_type_bool;
Packit 345191
	ghi.type = emitter_type_int;
Packit 345191
Packit 345191
	abc.int_val = 123;
Packit 345191
	def.bool_val = true;
Packit 345191
	ghi.int_val = 456;
Packit 345191
	emitter_table_row(emitter, &row;;
Packit 345191
Packit 345191
	abc.int_val = 789;
Packit 345191
	def.bool_val = false;
Packit 345191
	ghi.int_val = 1011;
Packit 345191
	emitter_table_row(emitter, &row;;
Packit 345191
Packit 345191
	abc.type = emitter_type_string;
Packit 345191
	abc.str_val = "a string";
Packit 345191
	def.bool_val = false;
Packit 345191
	ghi.type = emitter_type_title;
Packit 345191
	ghi.str_val = "ghi";
Packit 345191
	emitter_table_row(emitter, &row;;
Packit 345191
Packit 345191
	emitter_end(emitter);
Packit 345191
}
Packit 345191
Packit 345191
static const char *table_row_json =
Packit 345191
"{\n"
Packit 345191
"}\n";
Packit 345191
Packit 345191
static const char *table_row_table =
Packit 345191
"ABC title       DEF title  GHI\n"
Packit 345191
"123                  true  456\n"
Packit 345191
"789                 false 1011\n"
Packit 345191
"\"a string\"          false  ghi\n";
Packit 345191
Packit 345191
TEST_BEGIN(test_table_row) {
Packit 345191
	assert_emit_output(&emit_table_row, table_row_json, table_row_table);
Packit 345191
}
Packit 345191
TEST_END
Packit 345191
Packit 345191
int
Packit 345191
main(void) {
Packit 345191
	return test_no_reentrancy(
Packit 345191
	    test_dict,
Packit 345191
	    test_table_printf,
Packit 345191
	    test_nested_dict,
Packit 345191
	    test_types,
Packit 345191
	    test_modal,
Packit 345191
	    test_json_arr,
Packit 345191
	    test_json_nested_arr,
Packit 345191
	    test_table_row);
Packit 345191
}