Skip to content

Commit

Permalink
Make tox.c unambiguously parseable.
Browse files Browse the repository at this point in the history 
Rules:
1. Constants are uppercase names: THE_CONSTANT.
2. SUE[1] types start with an uppercase letter and have at least one
   lowercase letter in it: The_Type, THE_Type.
3. Function types end in "_cb": tox_friend_connection_cb.
4. Variable and function names are all lowercase: the_function.

This makes it easier for humans reading the code to determine what an
identifier means. I'm not convinced by the enum type name change, but I
don't know a better rule. Currently, a lot of enum types are spelled like
constants, which is confusing.

[1] struct/union/enum
  • Loading branch information
@iphydf
iphydf committed Jul 5, 2018
1 parent 64d0297 commit 972cc97
Show file tree
Hide file tree
Showing 21 changed files with 327 additions and 246 deletions.
22 changes: 11 additions & 11 deletions auto_tests/dht_test.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ static void test_addto_lists(IP ip)
Networking_Core *net = new_networking(log, ip, TOX_PORT_DEFAULT);
ck_assert_msg(net != nullptr, "Failed to create Networking_Core");

DHT *dht = new_DHT(log, net, true);
DHT *dht = new_dht(log, net, true);
ck_assert_msg(dht != nullptr, "Failed to create DHT");

IP_Port ip_port;
Expand Down Expand Up @@ -391,7 +391,7 @@ static void test_addto_lists(IP ip)
test_addto_lists_good(dht, dht->friends_list[i].client_list, MAX_FRIEND_CLIENTS, &ip_port,
dht->friends_list[i].public_key);

kill_DHT(dht);
kill_dht(dht);
kill_networking(net);
logger_kill(log);
}
Expand Down Expand Up @@ -475,7 +475,7 @@ static void test_list_main(void)
index[i] = i + 1;
logger_callback_log(logs[i], (logger_cb *)print_debug_log, nullptr, &index[i]);

dhts[i] = new_DHT(logs[i], new_networking(logs[i], ip, DHT_DEFAULT_PORT + i), true);
dhts[i] = new_dht(logs[i], new_networking(logs[i], ip, DHT_DEFAULT_PORT + i), true);
ck_assert_msg(dhts[i] != nullptr, "Failed to create dht instances %u", i);
ck_assert_msg(net_port(dhts[i]->net) != DHT_DEFAULT_PORT + i,
"Bound to wrong port: %d", net_port(dhts[i]->net));
Expand Down Expand Up @@ -580,7 +580,7 @@ static void test_list_main(void)

for (i = 0; i < NUM_DHT; ++i) {
Networking_Core *n = dhts[i]->net;
kill_DHT(dhts[i]);
kill_dht(dhts[i]);
kill_networking(n);
logger_kill(logs[i]);
}
Expand Down Expand Up @@ -620,7 +620,7 @@ START_TEST(test_DHT_test)
index[i] = i + 1;
logger_callback_log(logs[i], (logger_cb *)print_debug_log, nullptr, &index[i]);

dhts[i] = new_DHT(logs[i], new_networking(logs[i], ip, DHT_DEFAULT_PORT + i), true);
dhts[i] = new_dht(logs[i], new_networking(logs[i], ip, DHT_DEFAULT_PORT + i), true);
ck_assert_msg(dhts[i] != nullptr, "Failed to create dht instances %u", i);
ck_assert_msg(net_port(dhts[i]->net) != DHT_DEFAULT_PORT + i, "Bound to wrong port");
}
Expand All @@ -642,7 +642,7 @@ START_TEST(test_DHT_test)
}

uint16_t lock_count = 0;
ck_assert_msg(DHT_addfriend(dhts[pairs[i].tox2], dhts[pairs[i].tox1]->self_public_key, &ip_callback, &to_comp, 1337,
ck_assert_msg(dht_addfriend(dhts[pairs[i].tox2], dhts[pairs[i].tox1]->self_public_key, &ip_callback, &to_comp, 1337,
&lock_count) == 0, "Failed to add friend");
ck_assert_msg(lock_count == 1, "bad lock count: %u %u", lock_count, i);
}
Expand All @@ -651,7 +651,7 @@ START_TEST(test_DHT_test)
IP_Port ip_port;
ip_port.ip = get_loopback();
ip_port.port = net_htons(DHT_DEFAULT_PORT + i);
DHT_bootstrap(dhts[(i - 1) % NUM_DHT], ip_port, dhts[i]->self_public_key);
dht_bootstrap(dhts[(i - 1) % NUM_DHT], ip_port, dhts[i]->self_public_key);
}

while (1) {
Expand All @@ -660,7 +660,7 @@ START_TEST(test_DHT_test)
for (i = 0; i < NUM_DHT_FRIENDS; ++i) {
IP_Port a;

if (DHT_getfriendip(dhts[pairs[i].tox2], dhts[pairs[i].tox1]->self_public_key, &a) == 1) {
if (dht_getfriendip(dhts[pairs[i].tox2], dhts[pairs[i].tox1]->self_public_key, &a) == 1) {
++counter;
}
}
Expand All @@ -671,15 +671,15 @@ START_TEST(test_DHT_test)

for (i = 0; i < NUM_DHT; ++i) {
networking_poll(dhts[i]->net, nullptr);
do_DHT(dhts[i]);
do_dht(dhts[i]);
}

c_sleep(500);
}

for (i = 0; i < NUM_DHT; ++i) {
Networking_Core *n = dhts[i]->net;
kill_DHT(dhts[i]);
kill_dht(dhts[i]);
kill_networking(n);
logger_kill(logs[i]);
}
Expand All @@ -694,7 +694,7 @@ START_TEST(test_dht_create_packet)
uint8_t key[CRYPTO_SYMMETRIC_KEY_SIZE];
new_symmetric_key(key);

int length = DHT_create_packet(key, key, NET_PACKET_GET_NODES, plain, sizeof(plain), pkt);
int length = dht_create_packet(key, key, NET_PACKET_GET_NODES, plain, sizeof(plain), pkt);

ck_assert_msg(pkt[0] == NET_PACKET_GET_NODES, "Malformed packet.");
ck_assert_msg(memcmp(pkt + 1, key, CRYPTO_SYMMETRIC_KEY_SIZE) == 0, "Malformed packet.");
Expand Down
14 changes: 7 additions & 7 deletions auto_tests/messenger_test.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -241,18 +241,18 @@ START_TEST(test_dht_state_saveloadsave)
* c) a second save() is of equal size
* d) the second save() is of equal content */
const size_t extra = 64;
const size_t size = DHT_size(m->dht);
const size_t size = dht_size(m->dht);
VLA(uint8_t, buffer, size + 2 * extra);
memset(buffer, 0xCD, extra);
memset(buffer + extra + size, 0xCD, extra);
DHT_save(m->dht, buffer + extra);
dht_save(m->dht, buffer + extra);

for (size_t i = 0; i < extra; i++) {
ck_assert_msg(buffer[i] == 0xCD, "Buffer underwritten from DHT_save() @%u", (unsigned)i);
ck_assert_msg(buffer[extra + size + i] == 0xCD, "Buffer overwritten from DHT_save() @%u", (unsigned)i);
ck_assert_msg(buffer[i] == 0xCD, "Buffer underwritten from dht_save() @%u", (unsigned)i);
ck_assert_msg(buffer[extra + size + i] == 0xCD, "Buffer overwritten from dht_save() @%u", (unsigned)i);
}

const int res = DHT_load(m->dht, buffer + extra, size);
const int res = dht_load(m->dht, buffer + extra, size);

if (res == -1) {
ck_assert_msg(res == 0, "Failed to load back stored buffer: res == -1");
Expand All @@ -264,12 +264,12 @@ START_TEST(test_dht_state_saveloadsave)
(unsigned)offset, (unsigned)size, res & 0x0F);
}

const size_t size2 = DHT_size(m->dht);
const size_t size2 = dht_size(m->dht);
ck_assert_msg(size == size2, "Messenger \"grew\" in size from a store/load cycle: %u -> %u", (unsigned)size,
(unsigned)size2);

VLA(uint8_t, buffer2, size2);
DHT_save(m->dht, buffer2);
dht_save(m->dht, buffer2);

ck_assert_msg(!memcmp(buffer + extra, buffer2, size), "DHT state changed by store/load/store cycle");
}
Expand Down
38 changes: 19 additions & 19 deletions auto_tests/onion_test.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ static inline IP get_loopback()
static void do_onion(Onion *onion)
{
networking_poll(onion->net, nullptr);
do_DHT(onion->dht);
do_dht(onion->dht);
}

static int handled_test_1;
Expand Down Expand Up @@ -167,8 +167,8 @@ START_TEST(test_basic)
logger_callback_log(log2, (logger_cb *)print_debug_log, nullptr, &index[1]);

IP ip = get_loopback();
Onion *onion1 = new_onion(new_DHT(log1, new_networking(log1, ip, 36567), true));
Onion *onion2 = new_onion(new_DHT(log2, new_networking(log2, ip, 36568), true));
Onion *onion1 = new_onion(new_dht(log1, new_networking(log1, ip, 36567), true));
Onion *onion2 = new_onion(new_dht(log2, new_networking(log2, ip, 36568), true));
ck_assert_msg((onion1 != nullptr) && (onion2 != nullptr), "Onion failed initializing.");
networking_registerhandler(onion2->net, NET_PACKET_ANNOUNCE_REQUEST, &handle_test_1, onion2);

Expand Down Expand Up @@ -256,7 +256,7 @@ START_TEST(test_basic)
Logger *log3 = logger_new();
logger_callback_log(log3, (logger_cb *)print_debug_log, nullptr, &index[2]);

Onion *onion3 = new_onion(new_DHT(log3, new_networking(log3, ip, 36569), true));
Onion *onion3 = new_onion(new_dht(log3, new_networking(log3, ip, 36569), true));
ck_assert_msg((onion3 != nullptr), "Onion failed initializing.");

random_nonce(nonce);
Expand All @@ -282,7 +282,7 @@ START_TEST(test_basic)
Networking_Core *net = dht_get_net(onion->dht);
DHT *dht = onion->dht;
kill_onion(onion);
kill_DHT(dht);
kill_dht(dht);
kill_networking(net);
logger_kill(log3);
}
Expand All @@ -293,7 +293,7 @@ START_TEST(test_basic)
Networking_Core *net = dht_get_net(onion->dht);
DHT *dht = onion->dht;
kill_onion(onion);
kill_DHT(dht);
kill_dht(dht);
kill_networking(net);
logger_kill(log2);
}
Expand All @@ -304,7 +304,7 @@ START_TEST(test_basic)
Networking_Core *net = dht_get_net(onion->dht);
DHT *dht = onion->dht;
kill_onion(onion);
kill_DHT(dht);
kill_dht(dht);
kill_networking(net);
logger_kill(log1);
}
Expand Down Expand Up @@ -345,7 +345,7 @@ static Onions *new_onions(uint16_t port, uint32_t *index)
return nullptr;
}

DHT *dht = new_DHT(on->log, net, true);
DHT *dht = new_dht(on->log, net, true);

if (!dht) {
kill_networking(net);
Expand All @@ -357,7 +357,7 @@ static Onions *new_onions(uint16_t port, uint32_t *index)
on->onion = new_onion(dht);

if (!on->onion) {
kill_DHT(dht);
kill_dht(dht);
kill_networking(net);
logger_kill(on->log);
free(on);
Expand All @@ -368,7 +368,7 @@ static Onions *new_onions(uint16_t port, uint32_t *index)

if (!on->onion_a) {
kill_onion(on->onion);
kill_DHT(dht);
kill_dht(dht);
kill_networking(net);
logger_kill(on->log);
free(on);
Expand All @@ -381,7 +381,7 @@ static Onions *new_onions(uint16_t port, uint32_t *index)
if (!on->onion_c) {
kill_onion_announce(on->onion_a);
kill_onion(on->onion);
kill_DHT(dht);
kill_dht(dht);
kill_networking(net);
logger_kill(on->log);
free(on);
Expand All @@ -394,7 +394,7 @@ static Onions *new_onions(uint16_t port, uint32_t *index)
static void do_onions(Onions *on)
{
networking_poll(on->onion->net, nullptr);
do_DHT(on->onion->dht);
do_dht(on->onion->dht);
do_onion_client(on->onion_c);
}

Expand All @@ -407,7 +407,7 @@ static void kill_onions(Onions *on)
kill_onion_announce(on->onion_a);
kill_onion(on->onion);
kill_net_crypto(c);
kill_DHT(dht);
kill_dht(dht);
kill_networking(net);
logger_kill(on->log);
free(on);
Expand Down Expand Up @@ -442,8 +442,8 @@ static void dht_pk_callback(void *object, int32_t number, const uint8_t *dht_pub
if ((NUM_FIRST == number && !first) || (NUM_LAST == number && !last)) {
Onions *on = (Onions *)object;
uint16_t count = 0;
int ret = DHT_addfriend(on->onion->dht, dht_public_key, &dht_ip_callback, object, number, &count);
ck_assert_msg(ret == 0, "DHT_addfriend() did not return 0");
int ret = dht_addfriend(on->onion->dht, dht_public_key, &dht_ip_callback, object, number, &count);
ck_assert_msg(ret == 0, "dht_addfriend() did not return 0");
ck_assert_msg(count == 1, "Count not 1, count is %u", count);

if (NUM_FIRST == number && !first) {
Expand Down Expand Up @@ -486,11 +486,11 @@ START_TEST(test_announce)

for (i = 3; i < NUM_ONIONS; ++i) {
IP_Port ip_port = {ip, net_port(onions[i - 1]->onion->net)};
DHT_bootstrap(onions[i]->onion->dht, ip_port, dht_get_self_public_key(onions[i - 1]->onion->dht));
dht_bootstrap(onions[i]->onion->dht, ip_port, dht_get_self_public_key(onions[i - 1]->onion->dht));
IP_Port ip_port1 = {ip, net_port(onions[i - 2]->onion->net)};
DHT_bootstrap(onions[i]->onion->dht, ip_port1, dht_get_self_public_key(onions[i - 2]->onion->dht));
dht_bootstrap(onions[i]->onion->dht, ip_port1, dht_get_self_public_key(onions[i - 2]->onion->dht));
IP_Port ip_port2 = {ip, net_port(onions[i - 3]->onion->net)};
DHT_bootstrap(onions[i]->onion->dht, ip_port2, dht_get_self_public_key(onions[i - 3]->onion->dht));
dht_bootstrap(onions[i]->onion->dht, ip_port2, dht_get_self_public_key(onions[i - 3]->onion->dht));
}

uint32_t connected = 0;
Expand All @@ -500,7 +500,7 @@ START_TEST(test_announce)

for (i = 0; i < NUM_ONIONS; ++i) {
do_onions(onions[i]);
connected += DHT_isconnected(onions[i]->onion->dht);
connected += dht_isconnected(onions[i]->onion->dht);
}

c_sleep(50);
Expand Down
8 changes: 4 additions & 4 deletions other/DHT_bootstrap.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ int main(int argc, char *argv[])
ip_init(&ip, ipv6enabled);

Logger *logger = logger_new();
DHT *dht = new_DHT(logger, new_networking(logger, ip, PORT), true);
DHT *dht = new_dht(logger, new_networking(logger, ip, PORT), true);
Onion *onion = new_onion(dht);
Onion_Announce *onion_a = new_onion_announce(dht);

Expand Down Expand Up @@ -171,7 +171,7 @@ int main(int argc, char *argv[])
printf("Trying to bootstrap into the network...\n");
uint16_t port = net_htons(atoi(argv[argvoffset + 2]));
uint8_t *bootstrap_key = hex_string_to_bin(argv[argvoffset + 3]);
int res = DHT_bootstrap_from_address(dht, argv[argvoffset + 1],
int res = dht_bootstrap_from_address(dht, argv[argvoffset + 1],
ipv6enabled, port, bootstrap_key);
free(bootstrap_key);

Expand All @@ -187,12 +187,12 @@ int main(int argc, char *argv[])
lan_discovery_init(dht);

while (1) {
if (is_waiting_for_dht_connection && DHT_isconnected(dht)) {
if (is_waiting_for_dht_connection && dht_isconnected(dht)) {
printf("Connected to other bootstrap node successfully.\n");
is_waiting_for_dht_connection = 0;
}

do_DHT(dht);
do_dht(dht);

if (is_timeout(last_LANdiscovery, is_waiting_for_dht_connection ? 5 : LAN_DISCOVERY_INTERVAL)) {
lan_discovery_send(net_htons(PORT), dht);
Expand Down
2 changes: 1 addition & 1 deletion other/bootstrap_daemon/src/config.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ int bootstrap_from_config(const char *cfg_file_path, DHT *dht, int enable_ipv6)
}

bs_public_key_bin = hex_string_to_bin(bs_public_key);
address_resolved = DHT_bootstrap_from_address(dht, bs_address, enable_ipv6, net_htons(bs_port),
address_resolved = dht_bootstrap_from_address(dht, bs_address, enable_ipv6, net_htons(bs_port),
bs_public_key_bin);
free(bs_public_key_bin);

Expand Down
6 changes: 3 additions & 3 deletions other/bootstrap_daemon/src/tox-bootstrapd.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ int main(int argc, char *argv[])
}
}

DHT *dht = new_DHT(logger, net, true);
DHT *dht = new_dht(logger, net, true);

if (dht == nullptr) {
log_write(LOG_LEVEL_ERROR, "Couldn't initialize Tox DHT instance. Exiting.\n");
Expand Down Expand Up @@ -333,7 +333,7 @@ int main(int argc, char *argv[])
}

while (1) {
do_DHT(dht);
do_dht(dht);

if (enable_lan_discovery && is_timeout(last_LANdiscovery, LAN_DISCOVERY_INTERVAL)) {
lan_discovery_send(net_htons_port, dht);
Expand All @@ -346,7 +346,7 @@ int main(int argc, char *argv[])

networking_poll(dht_get_net(dht), nullptr);

if (waiting_for_dht_connection && DHT_isconnected(dht)) {
if (waiting_for_dht_connection && dht_isconnected(dht)) {
log_write(LOG_LEVEL_INFO, "Connected to another bootstrap node successfully.\n");
waiting_for_dht_connection = 0;
}
Expand Down
Loading

0 comments on commit 972cc97

Please sign in to comment.