system.h File Reference

#include "dbg.h"
#include "detect.h"
#include "fs.h"
#include "mem.h"
#include "str.h"
#include "time.h"
#include "types.h"
#include <chrono>
#include <cinttypes>
#include <cstdarg>
#include <cstdint>
#include <cstring>
#include <ctime>
#include <functional>
#include <mutex>
#include <optional>
#include <string>
#include <sys/un.h>
#include <semaphore.h>

Include dependency graph for system.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	CCmdlineFix

Macros
#define	PRIzu   "zu"
#define	str_format   str_format_opt

Typedefs
typedef struct ASYNCIO	ASYNCIO
typedef sem_t	SEMAPHORE
typedef int	UNIXSOCKET
typedef struct sockaddr_un	UNIXSOCKETADDR

Enumerations
enum	{ IOFLAG_READ = 1 , IOFLAG_WRITE = 2 , IOFLAG_APPEND = 4 }
enum	ESeekOrigin { IOSEEK_START = 0 , IOSEEK_CUR = 1 , IOSEEK_END = 2 }
enum class	EShellExecuteWindowState { EShellExecuteWindowState::FOREGROUND , EShellExecuteWindowState::BACKGROUND }

Functions
IOHANDLE	io_open (const char *filename, int flags)
unsigned	io_read (IOHANDLE io, void *buffer, unsigned size)
bool	io_read_all (IOHANDLE io, void **result, unsigned *result_len)
char *	io_read_all_str (IOHANDLE io)
int	io_skip (IOHANDLE io, int64_t size)
int	io_seek (IOHANDLE io, int64_t offset, ESeekOrigin origin)
int64_t	io_tell (IOHANDLE io)
int64_t	io_length (IOHANDLE io)
unsigned	io_write (IOHANDLE io, const void *buffer, unsigned size)
bool	io_write_newline (IOHANDLE io)
int	io_close (IOHANDLE io)
int	io_flush (IOHANDLE io)
int	io_sync (IOHANDLE io)
int	io_error (IOHANDLE io)
IOHANDLE	io_stdin ()
IOHANDLE	io_stdout ()
IOHANDLE	io_stderr ()
IOHANDLE	io_current_exe ()
ASYNCIO *	aio_new (IOHANDLE io)
void	aio_lock (ASYNCIO *aio)
void	aio_unlock (ASYNCIO *aio)
void	aio_write (ASYNCIO *aio, const void *buffer, unsigned size)
void	aio_write_newline (ASYNCIO *aio)
void	aio_write_unlocked (ASYNCIO *aio, const void *buffer, unsigned size)
void	aio_write_newline_unlocked (ASYNCIO *aio)
int	aio_error (ASYNCIO *aio)
void	aio_close (ASYNCIO *aio)
void	aio_wait (ASYNCIO *aio)
void	aio_free (ASYNCIO *aio)
void *	thread_init (void(*threadfunc)(void *), void *user, const char *name)
void	thread_wait (void *thread)
void	thread_yield ()
void	thread_detach (void *thread)
void	thread_init_and_detach (void(*threadfunc)(void *), void *user, const char *name)
void	sphore_init (SEMAPHORE *sem)
void	sphore_wait (SEMAPHORE *sem)
void	sphore_signal (SEMAPHORE *sem)
void	sphore_destroy (SEMAPHORE *sem)
void	net_init ()
int	net_host_lookup (const char *hostname, NETADDR *addr, int types)
int	net_addr_comp (const NETADDR *a, const NETADDR *b)
int	net_addr_comp_noport (const NETADDR *a, const NETADDR *b)
void	net_addr_str (const NETADDR *addr, char *string, int max_length, bool add_port)
int	net_addr_from_url (NETADDR *addr, const char *string, char *host_buf, size_t host_buf_size)
bool	net_addr_is_local (const NETADDR *addr)
int	net_addr_from_str (NETADDR *addr, const char *string)
int	net_set_non_blocking (NETSOCKET sock)
int	net_set_blocking (NETSOCKET sock)
int	net_errno ()
std::string	net_error_message ()
int	net_would_block ()
int	net_socket_read_wait (NETSOCKET sock, std::chrono::nanoseconds nanoseconds)
int	net_socket_type (NETSOCKET sock)
NETSOCKET	net_udp_create (NETADDR bindaddr)
int	net_udp_send (NETSOCKET sock, const NETADDR *addr, const void *data, int size)
int	net_udp_recv (NETSOCKET sock, NETADDR *addr, unsigned char **data)
void	net_udp_close (NETSOCKET sock)
NETSOCKET	net_tcp_create (NETADDR bindaddr)
int	net_tcp_listen (NETSOCKET sock, int backlog)
int	net_tcp_accept (NETSOCKET sock, NETSOCKET *new_sock, NETADDR *addr)
int	net_tcp_connect (NETSOCKET sock, const NETADDR *addr)
int	net_tcp_connect_non_blocking (NETSOCKET sock, NETADDR bindaddr)
int	net_tcp_send (NETSOCKET sock, const void *data, int size)
int	net_tcp_recv (NETSOCKET sock, void *data, int maxsize)
void	net_tcp_close (NETSOCKET sock)
UNIXSOCKET	net_unix_create_unnamed ()
int	net_unix_send (UNIXSOCKET sock, UNIXSOCKETADDR *addr, void *data, int size)
void	net_unix_set_addr (UNIXSOCKETADDR *addr, const char *path)
void	net_unix_close (UNIXSOCKET sock)
int	str_format_v (char *buffer, int buffer_size, const char *format, va_list args)
int	str_format (char *buffer, int buffer_size, const char *format,...)
int	str_format_int (char *buffer, size_t buffer_size, int value)
template<typename... Args>
int	str_format_opt (char *buffer, int buffer_size, const char *format, Args... args)
template<>
int	str_format_opt (char *buffer, int buffer_size, const char *format, int val)
int	str_utf8_dist (const char *a, const char *b)
int	str_utf8_dist_buffer (const char *a, const char *b, int *buf, int buf_len)
int	str_utf32_dist_buffer (const int *a, int a_len, const int *b, int b_len, int *buf, int buf_len)
void	fs_listdir (const char *dir, FS_LISTDIR_CALLBACK cb, int type, void *user)
void	fs_listdir_fileinfo (const char *dir, FS_LISTDIR_CALLBACK_FILEINFO cb, int type, void *user)
int	fs_makedir_rec_for (const char *path)
int	fs_storage_path (const char *appname, char *path, int max)
int	fs_executable_path (char *buffer, int buffer_size)
int	fs_is_file (const char *path)
int	fs_is_dir (const char *path)
int	fs_is_relative_path (const char *path)
int	fs_chdir (const char *path)
char *	fs_getcwd (char *buffer, int buffer_size)
const char *	fs_filename (const char *path)
void	fs_split_file_extension (const char *filename, char *name, size_t name_size, char *extension=nullptr, size_t extension_size=0)
void	fs_normalize_path (char *path)
int	fs_parent_dir (char *path)
int	fs_remove (const char *filename)
int	fs_rename (const char *oldname, const char *newname)
int	fs_file_time (const char *name, time_t *created, time_t *modified)
void	swap_endian (void *data, unsigned elem_size, unsigned num)
void	net_stats (NETSTATS *stats)
int	str_utf8_to_skeleton (const char *str, int *buf, int buf_len)
int	str_utf8_comp_confusable (const char *str1, const char *str2)
int	str_utf8_tolower_codepoint (int code)
unsigned	bytes_be_to_uint (const unsigned char *bytes)
void	uint_to_bytes_be (unsigned char *bytes, unsigned value)
int	pid ()
void	cmdline_fix (int *argc, const char ***argv)
void	cmdline_free (int argc, const char **argv)
PROCESS	shell_execute (const char *file, EShellExecuteWindowState window_state, const char **arguments=nullptr, size_t num_arguments=0)
int	kill_process (PROCESS process)
bool	is_process_alive (PROCESS process)
int	open_link (const char *link)
int	open_file (const char *path)
void	generate_password (char *buffer, unsigned length, const unsigned short *random, unsigned random_length)
void	secure_random_password (char *buffer, unsigned length, unsigned pw_length)
void	secure_random_fill (void *bytes, unsigned length)
int	secure_rand_below (int below)
bool	os_version_str (char *version, size_t length)
void	os_locale_str (char *locale, size_t length)
void	crashdump_init_if_available (const char *log_file_path)

Variables
const NETADDR	NETADDR_ZEROED

Macro Definition Documentation

PRIzu

#define PRIzu   "zu"

str_format

#define str_format   str_format_opt

Typedef Documentation

SEMAPHORE

typedef sem_t SEMAPHORE

Function Documentation

bytes_be_to_uint()

unsigned bytes_be_to_uint

(

const unsigned char *

bytes

)

Packs 4 big endian bytes into an unsigned.

Parameters

bytes

Pointer to an array of bytes that will be packed.

Returns

The packed unsigned.

Remarks

Assumes the passed array is least 4 bytes in size.

Assumes unsigned is 4 bytes in size.

See also

uint_to_bytes_be

net_set_blocking()

int net_set_blocking

(

NETSOCKET

sock

)

Make a socket block on operations.

Parameters

sock	The socket to set the mode on.

Returns

0 on success.

net_stats()

void net_stats

(

NETSTATS *

stats

)

str_format_int()

int str_format_int	(	char *	buffer,
		size_t	buffer_size,
		int	value )

str_format_opt() [1/2]

template<typename... Args>

int str_format_opt	(	char *	buffer,
		int	buffer_size,
		const char *	format,
		Args...	args )

str_format_opt() [2/2]

template<>

int str_format_opt ( char * buffer, int buffer_size, const char * format, int val )

inline

str_utf8_dist()

int str_utf8_dist	(	const char *	a,
		const char *	b )

Computes the edit distance between two strings.

Parameters

a	First string for the edit distance.
b	Second string for the edit distance.

Returns

The edit distance between the both strings.

Remarks

The strings are treated as null-terminated strings.

str_utf8_to_skeleton()

int str_utf8_to_skeleton	(	const char *	str,
		int *	buf,
		int	buf_len )

swap_endian()

void swap_endian	(	void *	data,
		unsigned	elem_size,
		unsigned	num )

Swaps the endianness of data. Each element is swapped individually by reversing its bytes.

Parameters

data	Pointer to data to be swapped.
elem_size	Size in bytes of each element.
num	Number of elements.

Remarks

The caller must ensure that the data is at least elem_size * num bytes in size.

uint_to_bytes_be()

void uint_to_bytes_be	(	unsigned char *	bytes,
		unsigned	value )

Packs an unsigned into 4 big endian bytes.

Parameters

bytes	Pointer to an array where the bytes will be stored.
value	The values that will be packed into the array.

Remarks

Assumes the passed array is least 4 bytes in size.

Assumes unsigned is 4 bytes in size.

See also

bytes_be_to_uint