sbase/util.h

92 lines
2.5 KiB
C
Raw Normal View History

2011-05-23 01:36:34 +00:00
/* See LICENSE file for copyright and license details. */
#include <sys/types.h>
2014-11-17 15:45:09 +00:00
#include <regex.h>
#include <stddef.h>
Add *fshut() functions to properly flush file streams This has been a known issue for a long time. Example: printf "word" > /dev/full wouldn't report there's not enough space on the device. This is due to the fact that every libc has internal buffers for stdout which store fragments of written data until they reach a certain size or on some callback to flush them all at once to the kernel. You can force the libc to flush them with fflush(). In case flushing fails, you can check the return value of fflush() and report an error. However, previously, sbase didn't have such checks and without fflush(), the libc silently flushes the buffers on exit without checking the errors. No offense, but there's no way for the libc to report errors in the exit- condition. GNU coreutils solve this by having onexit-callbacks to handle the flushing and report issues, but they have obvious deficiencies. After long discussions on IRC, we came to the conclusion that checking the return value of every io-function would be a bit too much, and having a general-purpose fclose-wrapper would be the best way to go. It turned out that fclose() alone is not enough to detect errors. The right way to do it is to fflush() + check ferror on the fp and then to a fclose(). This is what fshut does and that's how it's done before each return. The return value is obviously affected, reporting an error in case a flush or close failed, but also when reading failed for some reason, the error- state is caught. the !!( ... + ...) construction is used to call all functions inside the brackets and not "terminating" on the first. We want errors to be reported, but there's no reason to stop flushing buffers when one other file buffer has issues. Obviously, functionales come before the flush and ret-logic comes after to prevent early exits as well without reporting warnings if there are any. One more advantage of fshut() is that it is even able to report errors on obscure NFS-setups which the other coreutils are unable to detect, because they only check the return-value of fflush() and fclose(), not ferror() as well.
2015-04-04 19:25:17 +00:00
#include <stdio.h>
2014-11-17 15:45:09 +00:00
#include "arg.h"
#include "compat.h"
2011-06-08 20:30:33 +00:00
#define UTF8_POINT(c) (((c) & 0xc0) != 0x80)
#undef MIN
2012-05-10 18:20:16 +00:00
#define MIN(x,y) ((x) < (y) ? (x) : (y))
#undef MAX
2012-05-10 18:20:16 +00:00
#define MAX(x,y) ((x) > (y) ? (x) : (y))
#undef LIMIT
#define LIMIT(x, a, b) (x) = (x) < (a) ? (a) : (x) > (b) ? (b) : (x)
2012-05-10 18:20:16 +00:00
2012-05-14 20:28:41 +00:00
#define LEN(x) (sizeof (x) / sizeof *(x))
extern char *argv0;
2014-11-14 18:09:48 +00:00
void *ecalloc(size_t, size_t);
2015-02-11 00:40:52 +00:00
void *emalloc(size_t);
2014-11-14 18:09:48 +00:00
void *erealloc(void *, size_t);
#undef reallocarray
void *reallocarray(void *, size_t, size_t);
void *ereallocarray(void *, size_t, size_t);
2014-11-14 18:09:48 +00:00
char *estrdup(const char *);
2015-02-11 00:59:04 +00:00
char *estrndup(const char *, size_t);
2015-02-11 00:40:52 +00:00
void *encalloc(int, size_t, size_t);
void *enmalloc(int, size_t);
void *enrealloc(int, void *, size_t);
2019-04-17 00:41:39 +00:00
void *enreallocarray(int, void *, size_t, size_t);
2015-02-11 00:40:52 +00:00
char *enstrdup(int, const char *);
2015-02-11 00:59:04 +00:00
char *enstrndup(int, const char *, size_t);
2014-11-14 18:13:14 +00:00
Add *fshut() functions to properly flush file streams This has been a known issue for a long time. Example: printf "word" > /dev/full wouldn't report there's not enough space on the device. This is due to the fact that every libc has internal buffers for stdout which store fragments of written data until they reach a certain size or on some callback to flush them all at once to the kernel. You can force the libc to flush them with fflush(). In case flushing fails, you can check the return value of fflush() and report an error. However, previously, sbase didn't have such checks and without fflush(), the libc silently flushes the buffers on exit without checking the errors. No offense, but there's no way for the libc to report errors in the exit- condition. GNU coreutils solve this by having onexit-callbacks to handle the flushing and report issues, but they have obvious deficiencies. After long discussions on IRC, we came to the conclusion that checking the return value of every io-function would be a bit too much, and having a general-purpose fclose-wrapper would be the best way to go. It turned out that fclose() alone is not enough to detect errors. The right way to do it is to fflush() + check ferror on the fp and then to a fclose(). This is what fshut does and that's how it's done before each return. The return value is obviously affected, reporting an error in case a flush or close failed, but also when reading failed for some reason, the error- state is caught. the !!( ... + ...) construction is used to call all functions inside the brackets and not "terminating" on the first. We want errors to be reported, but there's no reason to stop flushing buffers when one other file buffer has issues. Obviously, functionales come before the flush and ret-logic comes after to prevent early exits as well without reporting warnings if there are any. One more advantage of fshut() is that it is even able to report errors on obscure NFS-setups which the other coreutils are unable to detect, because they only check the return-value of fflush() and fclose(), not ferror() as well.
2015-04-04 19:25:17 +00:00
void enfshut(int, FILE *, const char *);
void efshut(FILE *, const char *);
int fshut(FILE *, const char *);
2014-11-14 18:13:14 +00:00
void enprintf(int, const char *, ...);
void eprintf(const char *, ...);
void weprintf(const char *, ...);
double estrtod(const char *);
2014-11-14 18:09:48 +00:00
#undef strcasestr
#define strcasestr xstrcasestr
char *strcasestr(const char *, const char *);
#undef strlcat
#define strlcat xstrlcat
size_t strlcat(char *, const char *, size_t);
size_t estrlcat(char *, const char *, size_t);
#undef strlcpy
#define strlcpy xstrlcpy
size_t strlcpy(char *, const char *, size_t);
size_t estrlcpy(char *, const char *, size_t);
2015-01-25 17:48:11 +00:00
#undef strsep
#define strsep xstrsep
2015-01-25 17:48:11 +00:00
char *strsep(char **, const char *);
/* regex */
int enregcomp(int, regex_t *, const char *, int);
int eregcomp(regex_t *, const char *, int);
/* io */
ssize_t writeall(int, const void *, size_t);
int concat(int, const char *, int, const char *);
2014-11-14 18:13:14 +00:00
/* misc */
void enmasse(int, char **, int (*)(const char *, const char *, int));
void fnck(const char *, const char *, int (*)(const char *, const char *, int), int);
mode_t getumask(void);
char *humansize(off_t);
mode_t parsemode(const char *, mode_t, mode_t);
off_t parseoffset(const char *);
2015-04-21 16:40:57 +00:00
void putword(FILE *, const char *);
#undef strtonum
#define strtonum xstrtonum
long long strtonum(const char *, long long, long long, const char **);
long long enstrtonum(int, const char *, long long, long long);
2015-01-30 13:56:45 +00:00
long long estrtonum(const char *, long long, long long);
size_t unescape(char *);
int mkdirp(const char *, mode_t, mode_t);
#undef memmem
#define memmem xmemmem
void *memmem(const void *, size_t, const void *, size_t);