librazor/razor-internal.h
author J. Ali Harlow <ali@juiblex.co.uk>
Tue Apr 24 19:27:53 2018 +0100 (2018-04-24)
changeset 497 6fbb686d919f
parent 476 48e45439fd9a
child 498 5a49f274ab2d
permissions -rw-r--r--
Added tag Release 0.6.3.112 for changeset 203fa998c6df
     1 /*
     2  * Copyright (C) 2008  Kristian Høgsberg <krh@redhat.com>
     3  * Copyright (C) 2008  Red Hat, Inc
     4  * Copyright (C) 2009, 2011-2012, 2014, 2016  J. Ali Harlow <ali@juiblex.co.uk>
     5  *
     6  * This program is free software; you can redistribute it and/or modify
     7  * it under the terms of the GNU General Public License as published by
     8  * the Free Software Foundation; either version 2 of the License, or
     9  * (at your option) any later version.
    10  *
    11  * This program is distributed in the hope that it will be useful,
    12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    14  * GNU General Public License for more details.
    15  *
    16  * You should have received a copy of the GNU General Public License along
    17  * with this program; if not, write to the Free Software Foundation, Inc.,
    18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
    19  */
    20 
    21 #ifndef _RAZOR_INTERNAL_H_
    22 #define _RAZOR_INTERNAL_H_
    23 
    24 #ifdef MSWIN_API
    25 #include <windows.h>
    26 #endif
    27 #include <stdlib.h>
    28 #include <stdint.h>
    29 #include <stdarg.h>
    30 #include <unistd.h>
    31 
    32 #include "razor.h"
    33 #include "types/types.h"
    34 
    35 /* GCC extensions */
    36 #if defined(__GNUC__) && __GNUC__ >= 4
    37 #define RAZOR_EXPORT __attribute__ ((visibility("default")))
    38 #else
    39 #define RAZOR_EXPORT
    40 #endif
    41 
    42 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
    43 #define PADDING(value, base) (-(value) & (base - 1))
    44 #define ALIGN(value, base) ((value) + PADDING(value, base))
    45 
    46 #define str_has_prefix(s, prefix)	(!strncmp(s, prefix, strlen(prefix)))
    47 
    48 void *zalloc(size_t size);
    49 
    50 struct razor_set_section {
    51 	uint32_t name;
    52 	uint32_t offset;
    53 	uint32_t size;
    54 };
    55 
    56 struct razor_set_header {
    57 	uint32_t magic;
    58 	uint32_t version;
    59 	uint32_t num_sections;
    60 };
    61 
    62 #define RAZOR_MAGIC 	0x525a4442
    63 
    64 #define RAZOR_STRING_POOL		"string_pool"
    65 #define RAZOR_PACKAGES			"packages"
    66 #define RAZOR_PROPERTIES		"properties"
    67 #define RAZOR_PACKAGE_POOL		"package_pool"
    68 #define RAZOR_PROPERTY_POOL		"property_pool"
    69 #define RAZOR_PREFIX_POOL		"prefix_pool"
    70 
    71 #define RAZOR_DETAILS_STRING_POOL	"details_string_pool"
    72 
    73 #define RAZOR_FILES			"files"
    74 #define RAZOR_FILE_POOL			"file_pool"
    75 #define RAZOR_FILE_STRING_POOL		"file_string_pool"
    76 
    77 struct razor_script {
    78 	uint32_t program;
    79 	uint32_t body;
    80 };
    81 
    82 struct razor_package {
    83 	unsigned int name  : 24;
    84 	unsigned int flags : 8;
    85 	uint32_t version;
    86 	uint32_t arch;
    87 	uint32_t summary;
    88 	uint32_t description;
    89 	uint32_t url;
    90 	uint32_t license;
    91 	struct list_head properties;
    92 	struct list_head files;
    93 	struct list_head install_prefixes;
    94 	struct razor_script preun;
    95 	struct razor_script postun;
    96 };
    97 
    98 
    99 struct razor_property {
   100 	uint32_t name;
   101 	uint32_t flags;
   102 	uint32_t version;
   103 	struct list_head packages;
   104 };
   105 
   106 struct razor_entry {
   107 	uint32_t name  : 24;
   108 	uint32_t flags : 8;
   109 	uint32_t start;
   110 	struct list_head packages;
   111 };
   112 
   113 #define RAZOR_ENTRY_LAST	0x80
   114 
   115 struct razor_set {
   116 	uint32_t header_version;
   117 	struct array string_pool;
   118  	struct array packages;
   119  	struct array properties;
   120  	struct array files;
   121 	struct array package_pool;
   122  	struct array property_pool;
   123  	struct array file_pool;
   124  	struct array prefix_pool;
   125 	struct array file_string_pool;
   126 	struct array details_string_pool;
   127 	struct razor_mapped_file *mapped_files;
   128 	int lock_fd, ref_count;
   129 	enum razor_set_flags flags;
   130 };
   131 
   132 struct import_entry {
   133 	uint32_t package;
   134 	char *name;
   135 };
   136 
   137 struct import_directory {
   138 	uint32_t name, count;
   139 	struct array files;
   140 	struct array packages;
   141 	struct import_directory *last;
   142 };
   143 
   144 struct razor_importer {
   145 	struct razor_set *set;
   146 	struct hashtable table;
   147 	struct hashtable file_table;
   148 	struct hashtable details_table;
   149 	struct razor_package *package;
   150 	struct array properties;
   151 	struct array files;
   152 	struct array file_requires;
   153 	struct array install_prefixes;
   154 };
   155 
   156 struct razor_package_iterator {
   157 	struct razor_set *set;
   158 	struct razor_package *package, *end;
   159 	struct list *index;
   160 	void *alloced_index;
   161 };
   162 
   163 void
   164 razor_package_iterator_init_for_property(struct razor_package_iterator *pi,
   165 					 struct razor_set *set,
   166 					 struct razor_property *property);
   167 
   168 struct razor_property_iterator {
   169 	struct razor_set *set;
   170 	struct razor_property *property, *end;
   171 	struct list *index;
   172 };
   173 
   174 struct razor_file_iterator {
   175 	struct razor_set *set;
   176 	struct array path;
   177 	struct list *index;
   178 	int post_order;
   179 };
   180 
   181 struct razor_string_iterator {
   182 	struct razor_set *set;
   183 	struct list *index;
   184 };
   185 
   186 int
   187 razor_set_acquire_lock(struct razor_set *set, const char *path, int exclusive);
   188 
   189 struct razor_entry *
   190 razor_set_find_entry(struct razor_set *set,
   191 		     struct razor_entry *dir, const char *pattern);
   192 
   193 struct razor_merger *
   194 razor_merger_create(struct razor_set *set1, struct razor_set *set2);
   195 void
   196 razor_merger_add_package(struct razor_merger *merger,
   197 			 struct razor_package *package);
   198 struct razor_set *
   199 razor_merger_commit(struct razor_merger *merger);
   200 void
   201 razor_merger_package_add_script(struct razor_merger *merger,
   202 				struct razor_package *package,
   203 				enum razor_property_flags script,
   204 				const char *program, const char *body);
   205 void
   206 razor_merger_destroy(struct razor_merger *merger);
   207 
   208 int run_lua_script(const char *root, const char *name, const char *body,
   209 		   ssize_t len, int arg1);
   210 
   211 int razor_run_script(const char *root, enum razor_property_flags script,
   212 		     const char *program, const char *body, int arg1,
   213 		     struct razor_error **error);
   214 
   215 /* URI functions */
   216 
   217 struct razor_uri {
   218 	char *scheme;
   219 	char *userinfo;
   220 	char *host;
   221 	char *port;
   222 	char *path;
   223 	char *query;
   224 	char *fragment;
   225 };
   226 
   227 void razor_uri_destroy(struct razor_uri *ru);
   228 int razor_uri_parse_uri(struct razor_uri *ru, const char *uri, int absolute,
   229 			struct razor_error **error);
   230 int razor_uri_parse_relative_ref(struct razor_uri *ru, const char *uri,
   231 				 struct razor_error **error);
   232 int razor_uri_parse(struct razor_uri *ru, const char *uri,
   233 		    struct razor_error **error);
   234 void razor_uri_normalize(struct razor_uri *ru);
   235 char *razor_uri_get_authority(const struct razor_uri *ru) RAZOR_MALLOC;
   236 char *razor_uri_recompose(const struct razor_uri *ru) RAZOR_MALLOC;
   237 void razor_uri_resolve(struct razor_uri *T, const struct razor_uri *base,
   238 		       const struct razor_uri *R);
   239 
   240 char *razor_resolve_uri_root(const char *root_uri, const char *relative_uri,
   241 			     int is_relative, struct razor_error **error)
   242       RAZOR_MALLOC;
   243 
   244 int razor_file_mkdir(const char *path, mode_t mode, struct razor_error **error);
   245 int razor_file_unlink(const char *path, struct razor_error **error);
   246 int razor_file_open(const char *path, int flags, mode_t mode,
   247 		    struct razor_error **error);
   248 int razor_file_move(const char *path, const char *dest,
   249 		    struct razor_error **error);
   250 void *razor_file_get_contents(const char *path, size_t *length, int _private,
   251 			      struct razor_error **error);
   252 int razor_file_free_contents(void *addr, size_t length);
   253 int razor_file_is_directory(const char *path, struct razor_error **error);
   254 char *razor_file_mkdtemp_near(const char *path, const char *_template,
   255 			      struct razor_error **error);
   256 void *razor_file_opendir(const char *path, struct razor_error **error);
   257 char *razor_file_readdir(void *dir, struct razor_error **error);
   258 int razor_file_closedir(void *dir, struct razor_error **error);
   259 
   260 char *razor_path_from_parsed_uri(const struct razor_uri *ru,
   261   struct razor_error **error);
   262 
   263 /* Utility functions */
   264 
   265 void
   266 razor_package_get_details_varg(struct razor_set *set,
   267 			       struct razor_package *package,
   268 			       va_list args);
   269 void razor_rpm_get_details_varg(struct razor_rpm *rpm, va_list args);
   270 
   271 typedef int (*razor_compare_with_data_func_t)(const void *p1,
   272 					      const void *p,
   273 					      void *data);
   274 uint32_t *
   275 razor_qsort_with_data(void *base, size_t nelem, size_t size,
   276 		      razor_compare_with_data_func_t compare, void *data);
   277 
   278 struct environment {
   279 	int is_set;
   280 	struct array vars, string_pool;
   281 };
   282 
   283 void environment_init(struct environment *env);
   284 void environment_add_variable(struct environment *env,
   285 			      const char *variable, const char *value);
   286 void environment_set(struct environment *env);
   287 void environment_unset(struct environment *env);
   288 void environment_release(struct environment *env);
   289 
   290 #ifdef MSWIN_API
   291 char *razor_utf16_to_utf8(const wchar_t *utf16, int len);
   292 wchar_t *razor_utf8_to_utf16(const char *utf8, int len);
   293 #endif
   294 
   295 char *razor_abspath(const char *path);
   296 
   297 /* Error functions */
   298 struct razor_error {
   299 	int domain;
   300 	int code;
   301 	char *object;
   302 	char *str;
   303 	char *obj_str;
   304 	char *summary;
   305 	char *msg;
   306 };
   307 
   308 #define razor_error_new_posix(object) \
   309 	razor_error_new_str(RAZOR_POSIX_ERROR, errno, object, strerror(errno))
   310 #define razor_set_error_posix(error, object) \
   311 	if (error) \
   312 		*(error) = razor_error_new_posix(object); \
   313 	else
   314 #define razor_set_error(error, domain, code, object, str) \
   315 	if (error) \
   316 		*(error) = razor_error_new_str(domain, code, object, str); \
   317 	else
   318 
   319 #ifdef MSWIN_API
   320 struct razor_error *razor_error_new_mswin(const wchar_t *object, DWORD error);
   321 struct razor_error *razor_error_new_str2(int domain, int code,
   322 					 const wchar_t *object,
   323 					 const char *str);
   324 
   325 #define razor_set_error_mswin(error, object, err) \
   326 	if (error) \
   327 		*(error) = razor_error_new_mswin(object, err); \
   328 	else
   329 #define razor_set_error2(error, domain, code, object, str) \
   330 	if (error) \
   331 		*(error) = razor_error_new_str2(domain, code, object, str); \
   332 	else
   333 #endif	/* MSWIN_API */
   334 
   335 /* Atomic functions */
   336 
   337 #if HAVE_WINDOWS_KTM
   338 struct razor_atomic {
   339 	HANDLE transaction;
   340 	int n_files;
   341 	struct razor_atomic_file {
   342 		wchar_t *path;
   343 		HANDLE h;
   344 	} *files;
   345 	int in_undo;
   346 	struct razor_error *error;
   347 };
   348 #elif ENABLE_ATOMIC
   349 struct atomic_action {
   350 	struct atomic_action *next;
   351 	enum atomic_action_type {
   352 		/* Complex actions */
   353 		ACTION_MAKE_DIRS,
   354 		ACTION_REMOVE,
   355 		/* Primitive actions */
   356 		ACTION_CREATE_DIR,
   357 #if HAVE_SYMLINK
   358 		ACTION_CREATE_SYMLINK,
   359 #endif
   360 		ACTION_MOVE,
   361 	} type;
   362 	struct {
   363 		char *uri;
   364 		union atomic_action_args {
   365 			struct {
   366 				char *root;
   367 			} make_dirs;
   368 			struct {
   369 				mode_t mode;
   370 			} create_dir;
   371 #if HAVE_SYMLINK
   372 			struct {
   373 				char *target;
   374 			} create_symlink;
   375 #endif
   376 			struct {
   377 				char *dest;
   378 			} move;
   379 		} u;
   380 	} args;
   381 };
   382 
   383 struct razor_atomic {
   384 	struct atomic_action *actions;
   385 	char *description;
   386 	char *toplevel;
   387 	unsigned next_file_tag;
   388 	int in_undo;
   389 	struct razor_error *error;
   390 };
   391 
   392 char *atomic_action_attic_tmpnam(struct razor_atomic *atomic);
   393 struct atomic_action *
   394 atomic_action_list_prepend(struct atomic_action *list,
   395 			   struct atomic_action *action);
   396 struct atomic_action *atomic_action_new(enum atomic_action_type type);
   397 void atomic_action_free(struct atomic_action *action);
   398 struct atomic_action *atomic_action_list_reverse(struct atomic_action *list);
   399 struct atomic_action *
   400 atomic_action_do(struct razor_atomic *atomic, struct atomic_action *action);
   401 void
   402 atomic_action_undo(struct razor_atomic *atomic, struct atomic_action *action);
   403 #else	/* !HAVE_WINDOWS_KTM && !ENABLE_ATOMIC */
   404 struct razor_atomic {
   405 	int in_undo;
   406 	struct razor_error *error;
   407 };
   408 #endif
   409 
   410 char *razor_resolve_database_file(const char *root_uri, const char *filename,
   411 				  struct razor_error **error);
   412 
   413 int razor_allow_all_root_names(void);
   414 int razor_valid_root_name(const char *name);
   415 
   416 #define RAZOR_ASCII_ISALPHA(c) \
   417 	((c) >= 'A' && (c) <= 'Z' || (c) >= 'a' && (c) <= 'z')
   418 
   419 #ifdef MSWIN_API
   420 #define SKIP_DRIVE_LETTER(path) \
   421 	((RAZOR_ASCII_ISALPHA(path[0]) && (path)[1] == ':') ? \
   422 	   (path) + 2 : (path))
   423 #else
   424 #define SKIP_DRIVE_LETTER(path) (path)
   425 #endif /* MSWIN_API */
   426 
   427 #endif /* _RAZOR_INTERNAL_H_ */