1 /* 2 * util.h 3 * 4 * Copyright (c) 2006-2018 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 "alpm_list.h" 28 #include "alpm.h" 29 #include "package.h" /* alpm_pkg_t */ 30 #include "handle.h" /* alpm_handle_t */ 31 #include "util-common.h" 32 33 #include <stdio.h> 34 #include <string.h> 35 #include <stdarg.h> 36 #include <stddef.h> /* size_t */ 37 #include <sys/types.h> 38 #include <math.h> /* fabs */ 39 #include <float.h> /* DBL_EPSILON */ 40 #include <fcntl.h> /* open, close */ 41 42 #include <archive.h> /* struct archive */ 43 44 #ifdef ENABLE_NLS 45 #include <libintl.h> /* here so it doesn't need to be included elsewhere */ 46 /* define _() as shortcut for gettext() */ 47 #define _(str) dgettext ("libalpm", str) 48 #else 49 #define _(s) (char *)s 50 #endif 51 52 void _alpm_alloc_fail(size_t size); 53 54 #define MALLOC(p, s, action) do { p = malloc(s); if(p == NULL) { _alpm_alloc_fail(s); action; } } while(0) 55 #define CALLOC(p, l, s, action) do { p = calloc(l, s); if(p == NULL) { _alpm_alloc_fail(l * s); action; } } while(0) 56 /* This strdup macro is NULL safe- copying NULL will yield NULL */ 57 #define STRDUP(r, s, action) do { if(s != NULL) { r = strdup(s); if(r == NULL) { _alpm_alloc_fail(strlen(s)); action; } } else { r = NULL; } } while(0) 58 #define STRNDUP(r, s, l, action) do { if(s != NULL) { r = strndup(s, l); if(r == NULL) { _alpm_alloc_fail(l); action; } } else { r = NULL; } } while(0) 59 60 #define FREE(p) do { free(p); p = NULL; } while(0) 61 62 #define ASSERT(cond, action) do { if(!(cond)) { action; } } while(0) 63 64 #define RET_ERR_VOID(handle, err) do { \ 65 _alpm_log(handle, ALPM_LOG_DEBUG, "returning error %d from %s : %s\n", err, __func__, alpm_strerror(err)); \ 66 (handle)->pm_errno = (err); \ 67 return; } while(0) 68 69 #define RET_ERR(handle, err, ret) do { \ 70 _alpm_log(handle, ALPM_LOG_DEBUG, "returning error %d from %s : %s\n", err, __func__, alpm_strerror(err)); \ 71 (handle)->pm_errno = (err); \ 72 return (ret); } while(0) 73 74 #define RET_ERR_ASYNC_SAFE(handle, err, ret) do { \ 75 (handle)->pm_errno = (err); \ 76 return (ret); } while(0) 77 78 #define DOUBLE_EQ(x, y) (fabs((x) - (y)) < DBL_EPSILON) 79 80 #define CHECK_HANDLE(handle, action) do { if(!(handle)) { action; } (handle)->pm_errno = ALPM_ERR_OK; } while(0) 81 82 /** Standard buffer size used throughout the library. */ 83 #ifdef BUFSIZ 84 #define ALPM_BUFFER_SIZE BUFSIZ 85 #else 86 #define ALPM_BUFFER_SIZE 8192 87 #endif 88 89 #ifndef O_BINARY 90 #define O_BINARY 0 91 #endif 92 93 #define OPEN(fd, path, flags) do { fd = open(path, flags | O_BINARY); } while(fd == -1 && errno == EINTR) 94 95 /** 96 * Used as a buffer/state holder for _alpm_archive_fgets(). 97 */ 98 struct archive_read_buffer { 99 char *line; 100 char *line_offset; 101 size_t line_size; 102 size_t max_line_size; 103 size_t real_line_size; 104 105 char *block; 106 char *block_offset; 107 size_t block_size; 108 109 int ret; 110 }; 111 112 int _alpm_makepath(const char *path); 113 int _alpm_makepath_mode(const char *path, mode_t mode); 114 int _alpm_copyfile(const char *src, const char *dest); 115 size_t _alpm_strip_newline(char *str, size_t len); 116 117 int _alpm_open_archive(alpm_handle_t *handle, const char *path, 118 struct stat *buf, struct archive **archive, alpm_errno_t error); 119 int _alpm_unpack_single(alpm_handle_t *handle, const char *archive, 120 const char *prefix, const char *filename); 121 int _alpm_unpack(alpm_handle_t *handle, const char *archive, const char *prefix, 122 alpm_list_t *list, int breakfirst); 123 124 ssize_t _alpm_files_in_directory(alpm_handle_t *handle, const char *path, int full_count); 125 126 typedef ssize_t (*_alpm_cb_io)(void *buf, ssize_t len, void *ctx); 127 128 int _alpm_run_chroot(alpm_handle_t *handle, const char *cmd, char *const argv[], 129 _alpm_cb_io in_cb, void *in_ctx); 130 int _alpm_ldconfig(alpm_handle_t *handle); 131 int _alpm_str_cmp(const void *s1, const void *s2); 132 char *_alpm_filecache_find(alpm_handle_t *handle, const char *filename); 133 const char *_alpm_filecache_setup(alpm_handle_t *handle); 134 /* Unlike many uses of alpm_pkgvalidation_t, _alpm_test_checksum expects 135 * an enum value rather than a bitfield. */ 136 int _alpm_test_checksum(const char *filepath, const char *expected, alpm_pkgvalidation_t 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_patterns(alpm_list_t *patterns, const char *string); 147 int _alpm_fnmatch(const void *pattern, const void *string); 148 void *_alpm_realloc(void **data, size_t *current, const size_t required); 149 void *_alpm_greedy_grow(void **data, size_t *current, const size_t required); 150 151 #ifndef HAVE_STRSEP 152 char *strsep(char **, const char *); 153 #endif 154 155 /* check exported library symbols with: nm -C -D <lib> */ 156 #define SYMEXPORT __attribute__((visibility("default"))) 157 #define SYMHIDDEN __attribute__((visibility("internal"))) 158 159 #define UNUSED __attribute__((unused)) 160 161 #endif /* ALPM_UTIL_H */ 162