libopkg: store checksums in binary form, use integer index for architecture
[oweals/opkg-lede.git] / libopkg / pkg.h
1 /* pkg.h - the opkg package management system
2
3    Carl D. Worth
4
5    Copyright (C) 2001 University of Southern California
6
7    This program is free software; you can redistribute it and/or
8    modify it under the terms of the GNU General Public License as
9    published by the Free Software Foundation; either version 2, or (at
10    your option) any later version.
11
12    This program is distributed in the hope that it will be useful, but
13    WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15    General Public License for more details.
16 */
17
18 #ifndef PKG_H
19 #define PKG_H
20
21 #include "config.h"
22
23 #include <sys/types.h>
24 #include <libubox/blob.h>
25
26 #include "pkg_vec.h"
27 #include "str_list.h"
28 #include "active_list.h"
29 #include "pkg_src.h"
30 #include "pkg_dest.h"
31 #include "opkg_conf.h"
32 #include "conffile_list.h"
33
34 struct opkg_conf;
35
36 #ifndef ARRAY_SIZE
37 #define ARRAY_SIZE(array) sizeof(array) / sizeof((array)[0])
38 #endif
39
40 /* I think "Size" is currently the shortest field name */
41 #define PKG_MINIMUM_FIELD_NAME_LEN 4
42
43 enum pkg_state_want {
44         SW_UNKNOWN = 1,
45         SW_INSTALL,
46         SW_DEINSTALL,
47         SW_PURGE,
48         SW_LAST_STATE_WANT
49 };
50 typedef enum pkg_state_want pkg_state_want_t;
51
52 enum pkg_state_flag {
53         SF_OK = 0,
54         SF_REINSTREQ = 1,
55         SF_HOLD = 2,            /* do not upgrade version */
56         SF_REPLACE = 4,         /* replace this package */
57         SF_NOPRUNE = 8,         /* do not remove obsolete files */
58         SF_PREFER = 16,         /* prefer this version */
59         SF_OBSOLETE = 32,       /* old package in upgrade pair */
60         SF_MARKED = 64,         /* temporary mark */
61         SF_FILELIST_CHANGED = 128,      /* needs filelist written */
62         SF_USER = 256,
63         SF_LAST_STATE_FLAG
64 };
65 typedef enum pkg_state_flag pkg_state_flag_t;
66 #define SF_NONVOLATILE_FLAGS (SF_HOLD|SF_NOPRUNE|SF_PREFER|SF_OBSOLETE|SF_USER)
67
68 enum pkg_state_status {
69         SS_NOT_INSTALLED = 1,
70         SS_UNPACKED,
71         SS_HALF_CONFIGURED,
72         SS_INSTALLED,
73         SS_HALF_INSTALLED,
74         SS_CONFIG_FILES,
75         SS_POST_INST_FAILED,
76         SS_REMOVAL_FAILED,
77         SS_LAST_STATE_STATUS
78 };
79 typedef enum pkg_state_status pkg_state_status_t;
80
81 enum pkg_fields {
82         PKG_MAINTAINER,
83         PKG_PRIORITY,
84         PKG_SOURCE,
85         PKG_TAGS,
86         PKG_SECTION,
87         PKG_EPOCH,
88         PKG_FILENAME,
89         PKG_LOCAL_FILENAME,
90         PKG_VERSION,
91         PKG_REVISION,
92         PKG_DESCRIPTION,
93         PKG_MD5SUM,
94         PKG_SHA256SUM,
95         PKG_SIZE,
96         PKG_INSTALLED_SIZE,
97         PKG_INSTALLED_TIME,
98         PKG_TMP_UNPACK_DIR,
99         PKG_REPLACES,
100         PKG_PROVIDES,
101         PKG_DEPENDS,
102         PKG_CONFLICTS,
103         PKG_CONFFILES,
104 };
105
106 struct abstract_pkg {
107         char *name;
108         int dependencies_checked;
109         pkg_vec_t *pkgs;
110         pkg_state_status_t state_status;
111         pkg_state_flag_t state_flag;
112
113         /* XXX: This should be abstract_pkg_vec_t for consistency. */
114         struct abstract_pkg **depended_upon_by;
115
116         abstract_pkg_vec_t *provided_by;
117         abstract_pkg_vec_t *replaced_by;
118 };
119
120 #include "pkg_depends.h"
121
122 /* XXX: CLEANUP: I'd like to clean up pkg_t in several ways:
123
124    The 3 version fields should go into a single version struct. (This
125    is especially important since, currently, pkg->version can easily
126    be mistaken for pkg_verson_str_alloc(pkg) although they are very
127    distinct. This has been the source of multiple bugs.
128
129    The 3 state fields could possibly also go into their own struct.
130
131    All fields which deal with lists of packages, (Depends,
132    Pre-Depends, Provides, Suggests, Recommends, Enhances), should each
133    be handled by a single struct in pkg_t
134
135    All string fields for which there is a small set of possible
136    values, (section, maintainer, architecture, maybe version?), that
137    are reused among different packages -- for all such packages we
138    should move from "char *"s to some atom datatype to share data
139    storage and use less memory. We might even do reference counting,
140    but probably not since most often we only create new pkg_t structs,
141    we don't often free them.  */
142 struct pkg {
143         char *name;
144         pkg_src_t *src;
145         pkg_dest_t *dest;
146         pkg_state_want_t state_want:3;
147         pkg_state_flag_t state_flag:10;
148         pkg_state_status_t state_status:4;
149
150         abstract_pkg_t *parent;
151
152         /* As pointer for lazy evaluation */
153         str_list_t *installed_files;
154         /* XXX: CLEANUP: I'd like to perhaps come up with a better
155            mechanism to avoid the problem here, (which is that the
156            installed_files list was being freed from an inner loop while
157            still being used within an outer loop. */
158         int installed_files_ref_cnt;
159
160         int essential:1;
161 /* Adding this flag, to "force" opkg to choose a "provided_by_hand" package, if there are multiple choice */
162         int provided_by_hand:1;
163
164         /* this flag specifies whether the package was installed to satisfy another
165          * package's dependancies */
166         int auto_installed:1;
167         int is_upgrade:1;
168
169         int arch_index:3;
170
171         struct blob_buf blob;
172 };
173
174 pkg_t *pkg_new(void);
175 void pkg_deinit(pkg_t * pkg);
176 int pkg_init_from_file(pkg_t * pkg, const char *filename);
177
178 void *pkg_set_raw(pkg_t *pkg, int id, const void *val, size_t len);
179 void *pkg_get_raw(const pkg_t *pkg, int id);
180
181 static inline int pkg_set_int(pkg_t *pkg, int id, int val)
182 {
183         return (intptr_t) pkg_set_raw(pkg, id, &val, sizeof(val));
184 }
185
186 static inline int pkg_get_int(const pkg_t *pkg, int id)
187 {
188         return (intptr_t) pkg_get_raw(pkg, id);
189 }
190
191 char *pkg_set_string(pkg_t *pkg, int id, const char *s);
192
193 static inline char *pkg_get_string(const pkg_t *pkg, int id)
194 {
195         return (char *) pkg_get_raw(pkg, id);
196 }
197
198 static inline void * pkg_set_ptr(pkg_t *pkg, int id, void *ptr)
199 {
200         return ptr ? *(void **) pkg_set_raw(pkg, id, &ptr, sizeof(ptr)) : NULL;
201 }
202
203 static inline void * pkg_get_ptr(const pkg_t *pkg, int id)
204 {
205         void **ptr = pkg_get_raw(pkg, id);
206         return ptr ? *ptr : NULL;
207 }
208
209 char *pkg_set_architecture(pkg_t *pkg, const char *architecture, ssize_t len);
210 char *pkg_get_architecture(const pkg_t *pkg);
211 int pkg_get_arch_priority(const pkg_t *pkg);
212
213
214 abstract_pkg_t *abstract_pkg_new(void);
215
216 /*
217  * merges fields from newpkg into oldpkg.
218  * Forcibly sets oldpkg state_status, state_want and state_flags
219  */
220 int pkg_merge(pkg_t * oldpkg, pkg_t * newpkg);
221
222 char *pkg_version_str_alloc(pkg_t * pkg);
223
224 int pkg_compare_versions(const pkg_t *pkg, const pkg_t *ref_pkg);
225 int pkg_name_version_and_architecture_compare(const void *a, const void *b);
226 int abstract_pkg_name_compare(const void *a, const void *b);
227
228 void pkg_formatted_info(FILE * fp, pkg_t * pkg);
229 void pkg_formatted_field(FILE * fp, pkg_t * pkg, const char *field);
230
231 void set_flags_from_control(pkg_t * pkg);
232
233 void pkg_print_status(pkg_t * pkg, FILE * file);
234 str_list_t *pkg_get_installed_files(pkg_t * pkg);
235 void pkg_free_installed_files(pkg_t * pkg);
236 void pkg_remove_installed_files_list(pkg_t * pkg);
237 conffile_t *pkg_get_conffile(pkg_t * pkg, const char *file_name);
238 int pkg_run_script(pkg_t * pkg, const char *script, const char *args);
239
240 /* enum mappings */
241 pkg_state_want_t pkg_state_want_from_str(char *str);
242 pkg_state_flag_t pkg_state_flag_from_str(const char *str);
243 pkg_state_status_t pkg_state_status_from_str(const char *str);
244
245 int pkg_version_satisfied(pkg_t * it, pkg_t * ref, const char *op);
246
247 int pkg_arch_supported(pkg_t * pkg);
248 void pkg_info_preinstall_check(void);
249
250 int pkg_write_filelist(pkg_t * pkg);
251 int pkg_write_changed_filelists(void);
252
253 #endif