utils.c File Reference

#include "utils.h"
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <stddef.h>
#include <stdint.h>
#include <time.h>
#include <string.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/file.h>
#include <sys/stat.h>
#include <arpa/inet.h>
#include <netinet/in.h>

Go to the source code of this file.

Functions
void	get_timestamp (char *buffer, size_t buffer_size)
	Get the timestamp.
void	get_formatted_timestamp (char *buffer, size_t buffer_size)
	Get the formatted timestamp.
void	clear_cli ()
	Clear the CLI window.
int	init_config_dir ()
	Initialize the configuration directory.
void	guarded_print (const char *format,...)
	Guarded print function.
void	guarded_print_line (const char *format,...)
	Guarded print line function.
uint64_t	ntohll (uint64_t value)
	Convert a 64-bit integer from host byte order to network byte order.
uint64_t	read_var_int (const unsigned char *data, size_t *offset)
int	is_valid_ipv4 (const char *ip_str)
	Check if the IP address is valid.

Function Documentation

clear_cli()

void clear_cli

(

)

Clear the CLI window.

Definition at line 33 of file utils.c.

{
    guarded_print("\033[H\033[J");
}

References guarded_print().

Referenced by cli_clear().

get_formatted_timestamp()

void get_formatted_timestamp	(	char *	buffer,
		size_t	buffer_size
	)

Get the formatted timestamp.

This function is used to get the formatted timestamp in a YYYY-MM-DD HH:MM:SS format.

Parameters

buffer	The buffer to store the formatted timestamp.
buffer_size	The size of the buffer.

Definition at line 25 of file utils.c.

{
    time_t now = time(NULL);
    struct tm tm_now;
    localtime_r(&now, &tm_now);
    strftime(buffer, buffer_size, "%Y-%m-%d %H:%M:%S", &tm_now);
}

References localtime_r().

Referenced by log_message().

get_timestamp()

void get_timestamp	(	char *	buffer,
		size_t	buffer_size
	)

Get the timestamp.

This function is used to get the timestamp in a YYYYMMDDHHMMSS format.

Parameters

buffer	The buffer to store the timestamp.
buffer_size	The size of the buffer.

Definition at line 17 of file utils.c.

{
    time_t now = time(NULL);
    struct tm tm_now;
    localtime_r(&now, &tm_now);
    strftime(buffer, buffer_size, "%Y%m%d%H%M%S", &tm_now);
}

References localtime_r().

guarded_print()

void guarded_print	(	const char *	format,
			...
	)

Guarded print function.

This function is used to lock the stdout file and print the formatted string.

Parameters

format

The format string.

Definition at line 55 of file utils.c.

{
    flockfile(stdout);
    va_list args;
    va_start(args, format);
    vprintf(format, args);
    va_end(args);
    funlockfile(stdout);
}

References flockfile(), and funlockfile().

Referenced by clear_cli(), cli_completion(), cli_echo(), load_blocks_from_file(), parse_inv_message(), save_blocks_to_file(), send_getblocks_and_wait(), and send_getheaders_and_wait().

guarded_print_line()

void guarded_print_line	(	const char *	format,
			...
	)

Guarded print line function.

This function is used to lock the stdout file and print the formatted string.

Parameters

format

The format string.

Definition at line 65 of file utils.c.

{
    flockfile(stdout);
    va_list args;
    va_start(args, format);
    vprintf(format, args);
    va_end(args);
    printf("\n");
    funlockfile(stdout);
}

References flockfile(), and funlockfile().

Referenced by cli_connect(), cli_disconnect(), cli_exec_line(), cli_get_ip(), cli_getaddr(), cli_getblocks(), cli_getdata(), cli_getheaders(), cli_help(), cli_history(), cli_info(), cli_peer_discovery(), cli_ping(), cli_tx(), cli_whoami(), connect_to_peer(), handle_peer_discovery(), list_connected_nodes(), print_commands(), print_help(), print_peer_queue(), print_program_state(), print_usage(), run_bitlab(), send_addr(), and send_getaddr_and_wait().

init_config_dir()

int init_config_dir

(

)

Initialize the configuration directory.

Definition at line 38 of file utils.c.

{
    const char* home = getenv("HOME");
    if (home == NULL)
        return 1;
    const char* suffix = "/.bitlab";
    char* init_dir = malloc(strlen(home) + strlen(suffix) + 1);
    if (init_dir == NULL)
        return 1;
    strcpy(init_dir, home);
    strcat(init_dir, suffix);
 
    mkdir(init_dir, 0700);
    free(init_dir);
    return 0;
}

Referenced by run_bitlab().

is_valid_ipv4()

int is_valid_ipv4

(

const char *

ip_str

)

Check if the IP address is valid.

Parameters

ip_str

The IP address string.

Returns

True if the IP address is valid, false otherwise.

Definition at line 116 of file utils.c.

{
    struct sockaddr_in sa;
    return inet_pton(AF_INET, ip_str, &(sa.sin_addr)) == 1;
}

Referenced by send_getaddr_and_wait().

ntohll()

uint64_t ntohll

(

uint64_t

value

)

Convert a 64-bit integer from host byte order to network byte order.

Parameters

value

The 64-bit integer in host byte order.

Returns

The 64-bit integer in network byte order.

Definition at line 76 of file utils.c.

{
    if (__BYTE_ORDER == __LITTLE_ENDIAN)
    {
        return ((uint64_t)ntohl(value & 0xFFFFFFFF) << 32) | ntohl(value >> 32);
    }
    else
    {
        return value;
    }
}

read_var_int()

uint64_t read_var_int	(	const unsigned char *	data,
		size_t *	offset
	)

Definition at line 88 of file utils.c.

{
    uint64_t result = 0;
    unsigned char first_byte = data[*offset];
    *offset += 1;
 
    if (first_byte < 0xfd)
    {
        result = first_byte;
    }
    else if (first_byte == 0xfd)
    {
        result = *(uint16_t*)(data + *offset);
        *offset += 2;
    }
    else if (first_byte == 0xfe)
    {
        result = *(uint32_t*)(data + *offset);
        *offset += 4;
    }
    else if (first_byte == 0xff)
    {
        result = *(uint64_t*)(data + *offset);
        *offset += 8;
    }
    return result;
}