Section 3: library functions
qblog.h – The logging API provides four main parts (basics, filtering, threading & blackbox). Synopsis #include <stdint.h> #include <stdlib.h> #include <stdio.h> #include <stdarg.h> #include <errno.h> #include <syslog.h> #include <string.h> #include <qb/qbutil.h> #include <qb/qbconfig.h> Data Structures struct qb_log_callsite An instance of this structure is created in a special ELF section at every dynamic debug callsite. union…
qblist.h – This is a kernel style list implementation. Synopsis #include <stdint.h> #include <qb/qbdefs.h> Data Structures struct qb_list_head Macros #define QB_LIST_DECLARE(name) struct qb_list_head name = {&(name), &(name)} Declare and initialize a list head. #define QB_INIT_LIST_HEAD(ptr) #define qb_list_entry(ptr, type, member) ((type *)((char *)(ptr) – (char *)(&((type *)0)->member))) Get the struct for this entry. #define qb_list_first_entry(ptr, type,…
qbipcs.h – Server IPC API. Synopsis #include <stdlib.h> #include <sys/uio.h> #include <qb/qbipc_common.h> #include <qb/qbhdb.h> #include <qb/qbloop.h> Data Structures struct qb_ipcs_stats struct qb_ipcs_connection_stats struct qb_ipcs_connection_stats_2 struct qb_ipcs_poll_handlers struct qb_ipcs_service_handlers Typedefs typedef struct qb_ipcs_connection qb_ipcs_connection_t typedef struct qb_ipcs_service qb_ipcs_service_t typedef int32_t(* qb_ipcs_dispatch_fn_t )(int32_t fd, int32_t revents, void *data) typedef int32_t(* qb_ipcs_dispatch_add_fn )(enum qb_loop_priority p, int32_t fd, int32_t…
qbipcc.h – Client IPC API. Synopsis #include <qb/qbconfig.h> #include <pthread.h> #include <sys/poll.h> #include <sys/socket.h> #include <qb/qbhdb.h> #include <qb/qbipc_common.h> Typedefs typedef struct qb_ipcc_connection qb_ipcc_connection_t Functions qb_ipcc_connection_t * qb_ipcc_connect (const char *name, size_t max_msg_size) Create a connection to an IPC service. int32_t qb_ipcc_verify_dgram_max_msg_size (size_t max_msg_size) Test kernel dgram socket buffers to verify the largest size up to…
qbipc_common.h – common types and definitions Synopsis #include <stdint.h> Data Structures struct qb_ipc_request_header struct qb_ipc_response_header Macros #define QB_IPC_MSG_NEW_MESSAGE 0 #define QB_IPC_MSG_USER_START QB_IPC_MSG_NEW_MESSAGE #define QB_IPC_MSG_AUTHENTICATE -1 #define QB_IPC_MSG_NEW_EVENT_SOCK -2 #define QB_IPC_MSG_DISCONNECT -3 Enumerations enum qb_ipc_type { QB_IPC_SOCKET, QB_IPC_SHM, QB_IPC_POSIX_MQ, QB_IPC_SYSV_MQ, QB_IPC_NATIVE } Functions struct qb_ipc_request_header __attribute__ ((aligned(8))) Variables enum qb_ipc_type __attribute__ Detailed Description common types and…
qbhdb.h – The handle database is for reference counting objects. Synopsis #include <stdlib.h> #include <stdint.h> #include <inttypes.h> #include <qb/qbarray.h> Data Structures struct qb_hdb_handle struct qb_hdb Macros #define _GNU_SOURCE #define QB_HDB_D_FORMAT ‘%’ PRIu64 #define QB_HDB_X_FORMAT ‘%’ PRIx64 #define QB_HDB_DECLARE(database_name, destructor_function) Convience macro for declaring a file scoped handle database. Typedefs typedef uint64_t qb_handle_t Generic handle type…
qbdefs.h – Synopsis Macros #define QB_ROUNDUP(x, y) ((((x) + ((y) – 1)) / (y)) * (y)) #define QB_ABS(i) (((i) < 0) ? -(i) : (i)) #define QB_MAX(a, b) (((a) > (b)) ? (a) : (b)) #define QB_MIN(a, b) (((a) < (b)) ? (a) : (b)) #define QB_FALSE 0 #define QB_TRUE (!QB_FALSE) #define qb_bit_value(bit) (1 <<…
qbatomic.h – Basic atomic integer and pointer operations. Synopsis #include <stdint.h> #include <qb/qbdefs.h> #include <qb/qbconfig.h> Macros #define qb_atomic_int_get(atomic) #define qb_atomic_int_set(atomic, newval) #define qb_atomic_pointer_get(atomic) #define qb_atomic_pointer_set(atomic, newval) #define qb_atomic_int_inc(atomic) (qb_atomic_int_add ((atomic), 1)) Atomically increments the integer pointed to by atomic by 1. #define qb_atomic_int_dec_and_test(atomic) (qb_atomic_int_exchange_and_add ((atomic), -1) == 1) Atomically decrements the integer pointed to by…
qbarray.h – This is a dynamic array (it can grow, but without moving memory). Synopsis #include <stdint.h> #include <unistd.h> #include <qb/qbdefs.h> Typedefs typedef struct qb_array qb_array_t This is an opaque data type representing an instance of an array. typedef void(* qb_array_new_bin_cb_fn )(qb_array_t *a, uint32_t bin) Functions qb_array_t * qb_array_create (size_t max_elements, size_t element_size) Create an…
posix_memalign, aligned_alloc, memalign, valloc, pvalloc – allocate aligned memory Synopsis #include <stdlib.h> int posix_memalign(void **memptr, size_t alignment, size_t size); void *aligned_alloc(size_t alignment, size_t size); void *valloc(size_t size); #include <malloc.h> void *memalign(size_t alignment, size_t size); void *pvalloc(size_t size); Feature Test Macro Requirements for glibc (see feature_test_macros(7)): posix_memalign(): _POSIX_C_SOURCE >= 200112L aligned_alloc(): _ISOC11_SOURCE valloc(): Since glibc 2.12: (_XOPEN_SOURCE >= 500) &&…
getc_unlocked, getchar_unlocked, putc_unlocked, putchar_unlocked – nonlocking stdio functions Synopsis #include <stdio.h> int getc_unlocked(FILE *stream); int getchar_unlocked(void); int putc_unlocked(int c, FILE *stream); int putchar_unlocked(int c); void clearerr_unlocked(FILE *stream); int feof_unlocked(FILE *stream); int ferror_unlocked(FILE *stream); int fileno_unlocked(FILE *stream); int fflush_unlocked(FILE *stream); int fgetc_unlocked(FILE *stream); int fputc_unlocked(int c, FILE *stream); size_t fread_unlocked(void *ptr, size_t size, size_t n, FILE…
putwchar – write a wide character to standard output Synopsis #include <wchar.h> wint_t putwchar(wchar_t wc); Description The putwchar() function is the wide-character equivalent of the putchar(3) function. It writes the wide character wc to stdout. If ferror(stdout) becomes true, it returns WEOF. If a wide character conversion error occurs, it sets errno to EILSEQ and…
getc_unlocked, getchar_unlocked, putc_unlocked, putchar_unlocked – nonlocking stdio functions Synopsis #include <stdio.h> int getc_unlocked(FILE *stream); int getchar_unlocked(void); int putc_unlocked(int c, FILE *stream); int putchar_unlocked(int c); void clearerr_unlocked(FILE *stream); int feof_unlocked(FILE *stream); int ferror_unlocked(FILE *stream); int fileno_unlocked(FILE *stream); int fflush_unlocked(FILE *stream); int fgetc_unlocked(FILE *stream); int fputc_unlocked(int c, FILE *stream); size_t fread_unlocked(void *ptr, size_t size, size_t n, FILE…
fputwc, putwc – write a wide character to a FILE stream Synopsis #include <stdio.h> #include <wchar.h> wint_t fputwc(wchar_t wc, FILE *stream); wint_t putwc(wchar_t wc, FILE *stream); Description The fputwc() function is the wide-character equivalent of the fputc(3) function. It writes the wide character wc to stream. If ferror(stream) becomes true, it returns WEOF. If a…
getw, putw – input and output of words (ints) Synopsis #include <stdio.h> int getw(FILE *stream); int putw(int w, FILE *stream); Feature Test Macro Requirements for glibc (see feature_test_macros(7)): getw(), putw(): Since glibc 2.3.3: _XOPEN_SOURCE && ! (_POSIX_C_SOURCE >= 200112L) || /* Glibc since 2.19: */ _DEFAULT_SOURCE || /* Glibc versions <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE Before glibc 2.3.3: _SVID_SOURCE || _BSD_SOURCE || _XOPEN_SOURCE Description getw() reads a…
getutent, getutid, getutline, pututline, setutent, endutent, utmpname – access utmp file entries Synopsis #include <utmp.h> struct utmp *getutent(void); struct utmp *getutid(const struct utmp *ut); struct utmp *getutline(const struct utmp *ut); struct utmp *pututline(const struct utmp *ut); void setutent(void); void endutent(void); int utmpname(const char *file); Description New applications should use the POSIX.1-specified "utmpx" versions of these…
getutent, getutid, getutline, pututline, setutent, endutent, utmpname – access utmp file entries Synopsis #include <utmp.h> struct utmp *getutent(void); struct utmp *getutid(const struct utmp *ut); struct utmp *getutline(const struct utmp *ut); struct utmp *pututline(const struct utmp *ut); void setutent(void); void endutent(void); int utmpname(const char *file); Description New applications should use the POSIX.1-specified "utmpx" versions of these…
getspnam, getspnam_r, getspent, getspent_r, setspent, endspent, fgetspent, fgetspent_r, sgetspent, sgetspent_r, putspent, lckpwdf, ulckpwdf – get shadow password file entry Synopsis /* General shadow password file API */ #include <shadow.h> struct spwd *getspnam(const char *name); struct spwd *getspent(void); void setspent(void); void endspent(void); struct spwd *fgetspent(FILE *stream); struct spwd *sgetspent(const char *s); int putspent(const struct spwd *p,…
fputc, fputs, putc, putchar, puts – output of characters and strings Synopsis #include <stdio.h> int fputc(int c, FILE *stream); int fputs(const char *s, FILE *stream); int putc(int c, FILE *stream); int putchar(int c); int puts(const char *s); Description fputc() writes the character c, cast to an unsigned char, to stream. fputs() writes the string s…
putpwent – write a password file entry Synopsis #include <pwd.h> #include <stdio.h> #include <sys/types.h> int putpwent(const struct passwd *p, FILE *stream); Feature Test Macro Requirements for glibc (see feature_test_macros(7)): putpwent(): Since glibc 2.19: _DEFAULT_SOURCE Glibc 2.19 and earlier: _SVID_SOURCE Description The putpwent() function writes a password entry from the structure p in the file associated…