lib/libalpm/util.h

   1 /*
   2  *  util.h
   3  *
   4  *  Copyright (c) 2006-2011 Pacman Development Team <pacman-dev@archlinux.org>
   5  *  Copyright (c) 2002-2006 by Judd Vinet <jvinet@zeroflux.org>
   6  *  Copyright (c) 2005 by Aurelien Foret <orelien@chez.com>
   7  *  Copyright (c) 2005 by Christian Hamar <krics@linuxforum.hu>
   8  *  Copyright (c) 2006 by David Kimpe <dnaku@frugalware.org>
   9  *  Copyright (c) 2005, 2006 by Miklos Vajna <vmiklos@frugalware.org>
  10  *
  11  *  This program is free software; you can redistribute it and/or modify
  12  *  it under the terms of the GNU General Public License as published by
  13  *  the Free Software Foundation; either version 2 of the License, or
  14  *  (at your option) any later version.
  15  *
  16  *  This program is distributed in the hope that it will be useful,
  17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  *  GNU General Public License for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License
  22  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 #ifndef _ALPM_UTIL_H
  25 #define _ALPM_UTIL_H
  26
  27 #include "config.h"
  28
  29 #include "alpm_list.h"
  30 #include "alpm.h"
  31 #include "package.h" /* alpm_pkg_t */
  32 #include "handle.h" /* alpm_handle_t */
  33
  34 #include <stdio.h>
  35 #include <string.h>
  36 #include <stdarg.h>
  37 #include <stddef.h> /* size_t */
  38 #include <sys/types.h>
  39 #include <sys/stat.h> /* struct stat */
  40 #include <math.h> /* fabs */
  41 #include <float.h> /* DBL_EPSILON */
  42 #include <fcntl.h> /* open, close */
  43
  44 #include <archive.h> /* struct archive */
  45
  46 #ifdef ENABLE_NLS
  47 #include <libintl.h> /* here so it doesn't need to be included elsewhere */
  48 /* define _() as shortcut for gettext() */
  49 #define _(str) dgettext ("libalpm", str)
  50 #else
  51 #define _(s) s
  52 #endif
  53
  54 #define ALLOC_FAIL(s) do { fprintf(stderr, "alloc failure: could not allocate %zd bytes\n", s); } while(0)
  55
  56 #define MALLOC(p, s, action) do { p = malloc(s); if(p == NULL) { ALLOC_FAIL(s); action; } } while(0)
  57 #define CALLOC(p, l, s, action) do { p = calloc(l, s); if(p == NULL) { ALLOC_FAIL(l * s); action; } } while(0)
  58 /* This strdup macro is NULL safe- copying NULL will yield NULL */
  59 #define STRDUP(r, s, action) do { if(s != NULL) { r = strdup(s); if(r == NULL) { ALLOC_FAIL(strlen(s)); action; } } else { r = NULL; } } while(0)
  60 #define STRNDUP(r, s, l, action) do { if(s != NULL) { r = strndup(s, l); if(r == NULL) { ALLOC_FAIL(strlen(s)); action; } } else { r = NULL; } } while(0)
  61
  62 #define FREE(p) do { free(p); p = NULL; } while(0)
  63
  64 #define ASSERT(cond, action) do { if(!(cond)) { action; } } while(0)
  65
  66 #define RET_ERR_VOID(handle, err) do { \
  67         _alpm_log(handle, ALPM_LOG_DEBUG, "returning error %d from %s : %s\n", err, __func__, alpm_strerror(err)); \
  68         (handle)->pm_errno = (err); \
  69         return; } while(0)
  70
  71 #define RET_ERR(handle, err, ret) do { \
  72         _alpm_log(handle, ALPM_LOG_DEBUG, "returning error %d from %s : %s\n", err, __func__, alpm_strerror(err)); \
  73         (handle)->pm_errno = (err); \
  74         return (ret); } while(0)
  75
  76 #define DOUBLE_EQ(x, y) (fabs((x) - (y)) < DBL_EPSILON)
  77
  78 #define CHECK_HANDLE(handle, action) do { if(!(handle)) { action; } (handle)->pm_errno = 0; } while(0)
  79
  80 /** Standard buffer size used throughout the library. */
  81 #ifdef BUFSIZ
  82 #define ALPM_BUFFER_SIZE BUFSIZ
  83 #else
  84 #define ALPM_BUFFER_SIZE 8192
  85 #endif
  86
  87 #ifndef O_BINARY
  88 #define O_BINARY 0
  89 #endif
  90
  91 #define OPEN(fd, path, flags) do { fd = open(path, flags | O_BINARY); } while(fd == -1 && errno == EINTR)
  92 #define CLOSE(fd) do { int ret; do { ret = close(fd); } while(ret == -1 && errno == EINTR); } while(0)
  93
  94 /**
  95  * Used as a buffer/state holder for _alpm_archive_fgets().
  96  */
  97 struct archive_read_buffer {
  98         char *line;
  99         char *line_offset;
 100         size_t line_size;
 101         size_t max_line_size;
 102
 103         char *block;
 104         char *block_offset;
 105         size_t block_size;
 106
 107         int ret;
 108 };
 109
 110 enum _alpm_csum {
 111         ALPM_CSUM_MD5,
 112         ALPM_CSUM_SHA256,
 113 };
 114
 115 int _alpm_makepath(const char *path);
 116 int _alpm_makepath_mode(const char *path, mode_t mode);
 117 int _alpm_copyfile(const char *src, const char *dest);
 118 char *_alpm_strtrim(char *str);
 119 size_t _alpm_strip_newline(char *str);
 120
 121 int _alpm_open_archive(alpm_handle_t *handle, const char *path,
 122                 struct stat *buf, struct archive **archive, alpm_errno_t error);
 123 int _alpm_unpack_single(alpm_handle_t *handle, const char *archive,
 124                 const char *prefix, const char *filename);
 125 int _alpm_unpack(alpm_handle_t *handle, const char *archive, const char *prefix,
 126                 alpm_list_t *list, int breakfirst);
 127 int _alpm_rmrf(const char *path);
 128 ssize_t _alpm_files_in_directory(alpm_handle_t *handle, const char *path, int full_count);
 129 int _alpm_logaction(alpm_handle_t *handle, const char *fmt, va_list args);
 130 int _alpm_run_chroot(alpm_handle_t *handle, const char *cmd, char *const argv[]);
 131 int _alpm_ldconfig(alpm_handle_t *handle);
 132 int _alpm_str_cmp(const void *s1, const void *s2);
 133 char *_alpm_filecache_find(alpm_handle_t *handle, const char *filename);
 134 const char *_alpm_filecache_setup(alpm_handle_t *handle);
 135 int _alpm_lstat(const char *path, struct stat *buf);
 136 int _alpm_test_checksum(const char *filepath, const char *expected, enum _alpm_csum type);
 137 int _alpm_archive_fgets(struct archive *a, struct archive_read_buffer *b);
 138 int _alpm_splitname(const char *target, char **name, char **version,
 139                 unsigned long *name_hash);
 140 unsigned long _alpm_hash_sdbm(const char *str);
 141 off_t _alpm_strtoofft(const char *line);
 142 alpm_time_t _alpm_parsedate(const char *line);
 143 int _alpm_raw_cmp(const char *first, const char *second);
 144 int _alpm_raw_ncmp(const char *first, const char *second, size_t max);
 145 int _alpm_access(alpm_handle_t *handle, const char *dir, const char *file, int amode);
 146 int _alpm_fnmatch(const void *pattern, const void *string);
 147
 148 #ifndef HAVE_STRSEP
 149 char *strsep(char **, const char *);
 150 #endif
 151
 152 #ifndef HAVE_STRNDUP
 153 char *strndup(const char *s, size_t n);
 154 #endif
 155
 156 /* check exported library symbols with: nm -C -D <lib> */
 157 #define SYMEXPORT __attribute__((visibility("default")))
 158 #define SYMHIDDEN __attribute__((visibility("internal")))
 159
 160 #define UNUSED __attribute__((unused))
 161
 162 #endif /* _ALPM_UTIL_H */
 163
 164 /* vim: set ts=2 sw=2 noet: */