47c1e9d533
All whitespace in object names is now converted to a compacted format with whitespace replaced with hyphens. If a conversion takes place, a warning is logged. Converted some of the tests into C++ as they directly include .cc files.
126 lines
4.3 KiB
C
126 lines
4.3 KiB
C
#pragma once
|
|
/*
|
|
* Copyright (c) 2016 MariaDB Corporation Ab
|
|
*
|
|
* Use of this software is governed by the Business Source License included
|
|
* in the LICENSE.TXT file and at www.mariadb.com/bsl11.
|
|
*
|
|
* Change Date: 2019-07-01
|
|
*
|
|
* On the date above, in accordance with the Business Source License, use
|
|
* of this software will be governed by version 2 or later of the General
|
|
* Public License.
|
|
*/
|
|
|
|
/**
|
|
* @file utils.h Utility functions headers
|
|
*/
|
|
|
|
#include <maxscale/cdefs.h>
|
|
#include <ctype.h>
|
|
#include <math.h>
|
|
#include <stdlib.h>
|
|
#include <netinet/in.h>
|
|
|
|
MXS_BEGIN_DECLS
|
|
|
|
#define CALCLEN(i) ((size_t)(floor(log10(abs(i))) + 1))
|
|
#define UINTLEN(i) (i<10 ? 1 : (i<100 ? 2 : (i<1000 ? 3 : CALCLEN(i))))
|
|
|
|
#define MXS_ARRAY_NELEMS(array) ((size_t)(sizeof(array)/sizeof(array[0])))
|
|
|
|
/** Macro for safe pointer arithmetic on void pointers
|
|
* @param a The void pointer
|
|
* @param b The offset into @c a
|
|
*/
|
|
#define MXS_PTR(a, b) (((uint8_t*)(a)) + (b))
|
|
|
|
/** The type of the socket */
|
|
enum mxs_socket_type
|
|
{
|
|
MXS_SOCKET_LISTENER, /**< */
|
|
MXS_SOCKET_NETWORK,
|
|
};
|
|
|
|
bool utils_init(); /*< Call this first before using any other function */
|
|
void utils_end();
|
|
|
|
/**
|
|
* @brief Create a network socket and a socket configuration
|
|
*
|
|
* This helper function can be used to open both listener socket and network
|
|
* connection sockets. For listener sockets, the @c host and @c port parameters
|
|
* tell where the socket will bind to. For network sockets, the parameters tell
|
|
* where the connection is created.
|
|
*
|
|
* After calling this function, the only thing that needs to be done is to
|
|
* give @c addr and the return value of this function as the parameters to
|
|
* either bind() (for listeners) or connect() (for outbound network connections).
|
|
*
|
|
* @param type Type of the socket, either MXS_SOCKET_LISTENER for a listener
|
|
* socket or MXS_SOCKET_NETWORK for a network connection socket
|
|
* @param addr Pointer to a struct sockaddr_storage where the socket
|
|
* configuration is stored
|
|
* @param host The target host for which the socket is created
|
|
* @param port The target port on the host
|
|
*
|
|
* @return The opened socket or -1 on failure
|
|
*/
|
|
int open_network_socket(enum mxs_socket_type type, struct sockaddr_storage *addr,
|
|
const char *host, uint16_t port);
|
|
|
|
/**
|
|
* @brief Create a UNIX domain socket
|
|
*
|
|
* This opens and prepares a UNIX domain socket for use. The @c addr parameter
|
|
* can be given to the bind() function to bind the socket.
|
|
*
|
|
* @param type Type of the socket, either MXS_SOCKET_LISTENER for a listener
|
|
* socket or MXS_SOCKET_NETWORK for a network connection socket
|
|
* @param addr Pointer to a struct sockaddr_un where the socket configuration
|
|
* is stored
|
|
* @param path Path to the socket
|
|
*
|
|
* @return The opened socket or -1 on failure
|
|
*/
|
|
int open_unix_socket(enum mxs_socket_type type, struct sockaddr_un *addr,
|
|
const char *path);
|
|
|
|
int setnonblocking(int fd);
|
|
int setblocking(int fd);
|
|
char *gw_strend(register const char *s);
|
|
static char gw_randomchar();
|
|
int gw_generate_random_str(char *output, int len);
|
|
int gw_hex2bin(uint8_t *out, const char *in, unsigned int len);
|
|
char *gw_bin2hex(char *out, const uint8_t *in, unsigned int len);
|
|
void gw_str_xor(uint8_t *output, const uint8_t *input1, const uint8_t *input2, unsigned int len);
|
|
void gw_sha1_str(const uint8_t *in, int in_len, uint8_t *out);
|
|
void gw_sha1_2_str(const uint8_t *in, int in_len, const uint8_t *in2, int in2_len, uint8_t *out);
|
|
int gw_getsockerrno(int fd);
|
|
char *create_hex_sha1_sha1_passwd(char *passwd);
|
|
|
|
/** String formatting functions */
|
|
char* trim(char *str);
|
|
void replace_whitespace(char* str);
|
|
char* squeeze_whitespace(char* str);
|
|
bool strip_escape_chars(char*);
|
|
|
|
bool is_valid_posix_path(char* path);
|
|
|
|
char* remove_mysql_comments(const char** src, const size_t* srcsize, char** dest,
|
|
size_t* destsize);
|
|
char* replace_values(const char** src, const size_t* srcsize, char** dest,
|
|
size_t* destsize);
|
|
char* replace_literal(char* haystack,
|
|
const char* needle,
|
|
const char* replacement);
|
|
char* replace_quoted(const char** src, const size_t* srcsize, char** dest, size_t* destsize);
|
|
|
|
bool clean_up_pathname(char *path);
|
|
|
|
bool mxs_mkdir_all(const char *path, int mask);
|
|
|
|
long get_processor_count();
|
|
|
|
MXS_END_DECLS
|