2019-04-21 00:46:08 +02:00
|
|
|
#ifndef UTIL_H
|
|
|
|
#define UTIL_H
|
|
|
|
/**
|
|
|
|
* \file util.h
|
|
|
|
* \brief utility functions
|
|
|
|
*/
|
|
|
|
|
2019-09-01 22:36:58 +02:00
|
|
|
#include <pthread.h>
|
2019-09-01 02:21:40 +02:00
|
|
|
#include <stdint.h>
|
2019-09-03 23:11:23 +02:00
|
|
|
#include <stdio.h>
|
2019-09-01 02:21:40 +02:00
|
|
|
|
2019-09-03 23:11:23 +02:00
|
|
|
/**
|
|
|
|
* \brief append a path
|
|
|
|
* \details This function appends a path with the next level, while taking the
|
|
|
|
* trailing slash of the upper level into account.
|
2019-10-24 01:44:18 +02:00
|
|
|
* \note You need to free the char * after use.
|
2019-09-03 23:11:23 +02:00
|
|
|
*/
|
|
|
|
char *path_append(const char *path, const char *filename);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* \brief division, but rounded to the nearest integer rather than truncating
|
|
|
|
*/
|
|
|
|
int64_t round_div(int64_t a, int64_t b);
|
|
|
|
|
2019-09-01 09:52:18 +02:00
|
|
|
/**
|
2019-10-21 04:28:57 +02:00
|
|
|
* \brief wrapper for pthread_mutex_lock(), with error handling
|
2019-09-01 09:52:18 +02:00
|
|
|
*/
|
2021-09-03 15:56:11 +02:00
|
|
|
void PTHREAD_MUTEX_LOCK(pthread_mutex_t *x);
|
2019-09-01 02:21:40 +02:00
|
|
|
|
2019-09-01 09:52:18 +02:00
|
|
|
/**
|
2019-10-21 04:28:57 +02:00
|
|
|
* \brief wrapper for pthread_mutex_unlock(), with error handling
|
2019-09-01 09:52:18 +02:00
|
|
|
*/
|
2021-09-03 15:56:11 +02:00
|
|
|
void PTHREAD_MUTEX_UNLOCK(pthread_mutex_t *x);
|
2019-09-01 22:36:58 +02:00
|
|
|
|
2019-09-03 15:47:12 +02:00
|
|
|
/**
|
2019-10-21 04:28:57 +02:00
|
|
|
* \brief wrapper for exit(EXIT_FAILURE), with error handling
|
2019-09-03 15:47:12 +02:00
|
|
|
*/
|
2019-09-03 23:37:27 +02:00
|
|
|
void exit_failure(void);
|
2019-09-03 15:47:12 +02:00
|
|
|
|
2019-04-25 00:58:26 +02:00
|
|
|
/**
|
2019-09-03 23:11:23 +02:00
|
|
|
* \brief erase a string from the terminal
|
2019-04-25 00:58:26 +02:00
|
|
|
*/
|
2021-09-03 15:56:11 +02:00
|
|
|
void erase_string(FILE *file, size_t max_len, char *s);
|
2019-04-25 00:58:26 +02:00
|
|
|
|
2019-10-21 04:28:57 +02:00
|
|
|
/**
|
|
|
|
* \brief generate the salt for authentication string
|
|
|
|
* \details this effectively generates a UUID string, which we use as the salt
|
|
|
|
* \return a pointer to a 37-char array with the salt.
|
|
|
|
*/
|
2019-10-24 04:15:30 +02:00
|
|
|
char *generate_salt(void);
|
2019-10-21 04:28:57 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* \brief generate the md5sum of a string
|
|
|
|
* \param[in] str a character array for the input string
|
|
|
|
* \return a pointer to a 33-char array with the salt
|
|
|
|
*/
|
|
|
|
char *generate_md5sum(const char *str);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* \brief wrapper for calloc(), with error handling
|
|
|
|
*/
|
|
|
|
void *CALLOC(size_t nmemb, size_t size);
|
|
|
|
|
2021-08-30 03:50:03 +02:00
|
|
|
/**
|
|
|
|
* \brief wrapper for free(), but the pointer is set to NULL afterwards.
|
|
|
|
*/
|
|
|
|
void FREE(void *ptr);
|
|
|
|
|
2019-10-28 01:16:44 +01:00
|
|
|
/**
|
|
|
|
* \brief Convert a string to hex
|
|
|
|
*/
|
|
|
|
char *str_to_hex(char *s);
|
|
|
|
|
2019-10-23 22:04:25 +02:00
|
|
|
/**
|
|
|
|
* \brief initialise the configuration data structure
|
|
|
|
*/
|
|
|
|
void Config_init(void);
|
|
|
|
|
2019-04-21 00:46:08 +02:00
|
|
|
#endif
|