Doc: Mention several undocumented modules

[libucw.git] / ucw / lib.h

diff --git a/ucw/lib.h b/ucw/lib.h
index b15b6d0cfe395391ee7254fe0684971c0bf790c7..ebb6d32a86868fdbc157e0e54dcac935c06c6f5e 100644 (file)
--- a/ucw/lib.h
+++ b/ucw/lib.h
@@ -20,7 +20,7 @@
 
 #define CHECK_PTR_TYPE(x, type) ((x)-(type)(x) + (type)(x))            /** Check that a pointer @x is of type @type. Fail compilation if not. **/
 #define PTR_TO(s, i) &((s*)0)->i                                       /** Return OFFSETOF() in form of a pointer. **/
-#define OFFSETOF(s, i) ((unsigned int) (uintptr_t) PTR_TO(s, i))       /** Offset of item @i from the start of structure @s **/
+#define OFFSETOF(s, i) ((uns)offsetof(s, i))                           /** Offset of item @i from the start of structure @s **/
 #define SKIP_BACK(s, i, p) ((s *)((char *)p - OFFSETOF(s, i)))         /** Given a pointer @p to item @i of structure @s, return a pointer to the start of the struct. **/
 
 /** Align an integer @s to the nearest higher multiple of @a (which should be a power of two) **/
@@ -105,6 +105,9 @@ enum log_levels {                   /** The available log levels to pass to msg() and friends. *
 
 #define LOG_LEVEL_NAMES P(DEBUG) P(INFO) P(WARN) P(ERROR) P(INFO_R) P(WARN_R) P(ERROR_R) P(FATAL)
 
+// Return the letter associated with a given severity level
+#define LS_LEVEL_LETTER(level) ("DIWEiwe!###"[( level )])
+
 #define L_SIGHANDLER   0x80000000      /** Avoid operations that are unsafe in signal handlers **/
 #define L_LOGGER_ERR   0x40000000      /** Used internally to avoid infinite reporting of logging errors **/
 
@@ -156,12 +159,23 @@ void assert_failed_noinfo(void) NONRET;
 #define xrealloc ucw_xrealloc
 #define xfree ucw_xfree
 
-void *xmalloc(uns) LIKE_MALLOC;                        /** Allocate memory and die() if there is none. **/
-void *xrealloc(void *, uns);                   /** Reallocate memory and die() if there is none. **/
+void *xmalloc(size_t) LIKE_MALLOC;             /** Allocate memory and die() if there is none. **/
+void *xrealloc(void *, size_t);                        /** Reallocate memory and die() if there is none. **/
 void xfree(void *);                            /** Free memory allocated by xmalloc() or xrealloc(). **/
 
-void *xmalloc_zero(uns) LIKE_MALLOC;           /** Allocate memory and fill it by zeroes. **/
-char *xstrdup(const char *) LIKE_MALLOC;       /** Make a xmalloc()'ed copy of a string. **/
+void *xmalloc_zero(size_t) LIKE_MALLOC;                /** Allocate memory and fill it by zeroes. **/
+char *xstrdup(const char *) LIKE_MALLOC;       /** Make a xmalloc()'ed copy of a string. Returns NULL for NULL string. **/
+
+/* bigalloc.c */
+
+void *page_alloc(u64 len) LIKE_MALLOC;         // Internal: allocates a multiple of CPU_PAGE_SIZE bytes with mmap
+void *page_alloc_zero(u64 len) LIKE_MALLOC;
+void page_free(void *start, u64 len);
+void *page_realloc(void *start, u64 old_len, u64 new_len);
+
+void *big_alloc(u64 len) LIKE_MALLOC;          /** Allocate a large memory block in the most efficient way available. **/
+void *big_alloc_zero(u64 len) LIKE_MALLOC;     /** Allocate and clear a large memory block. **/
+void big_free(void *start, u64 len);           /** Free block allocated by @big_alloc() or @big_alloc_zero(). **/
 
 /*** === Trivial timers (timer.c) ***/
 
@@ -178,61 +192,4 @@ uns random_max(uns max);                   /** Return a pseudorandom 32-bit number in range [0,@
 u64 random_u64(void);                          /** Return a pseudorandom 64-bit number. **/
 u64 random_max_u64(u64 max);                   /** Return a pseudorandom 64-bit number in range [0,@max). **/
 
-/* mmap.c */
-
-void *mmap_file(const char *name, unsigned *len, int writeable);
-void munmap_file(void *start, unsigned len);
-
-/* proctitle.c */
-
-void setproctitle_init(int argc, char **argv);
-void setproctitle(const char *msg, ...) FORMAT_CHECK(printf,1,2);
-char *getproctitle(void);
-
-/* randomkey.c */
-
-void randomkey(byte *buf, uns size);
-
-/* exitstatus.c */
-
-#define EXIT_STATUS_MSG_SIZE 32
-int format_exit_status(char *msg, int stat);
-
-/* runcmd.c */
-
-int run_command(const char *cmd, ...);
-void NONRET exec_command(const char *cmd, ...);
-void echo_command(char *buf, int size, const char *cmd, ...);
-int run_command_v(const char *cmd, va_list args);
-void NONRET exec_command_v(const char *cmd, va_list args);
-void echo_command_v(char *buf, int size, const char *cmd, va_list args);
-
-/* carefulio.c */
-
-int careful_read(int fd, void *buf, int len);
-int careful_write(int fd, const void *buf, int len);
-
-/* sync.c */
-
-void sync_dir(const char *name);
-
-/* sighandler.c */
-
-typedef int (*ucw_sighandler_t)(int);  // gets signum, returns nonzero if abort() should be called
-
-void handle_signal(int signum);
-void unhandle_signal(int signum);
-ucw_sighandler_t set_signal_handler(int signum, ucw_sighandler_t newh);
-
-/* bigalloc.c */
-
-void *page_alloc(u64 len) LIKE_MALLOC; // allocates a multiple of CPU_PAGE_SIZE bytes with mmap
-void *page_alloc_zero(u64 len) LIKE_MALLOC;
-void page_free(void *start, u64 len);
-void *page_realloc(void *start, u64 old_len, u64 new_len);
-
-void *big_alloc(u64 len) LIKE_MALLOC; // allocate a large memory block in the most efficient way available
-void *big_alloc_zero(u64 len) LIKE_MALLOC;
-void big_free(void *start, u64 len);
-
 #endif