1 /* pkg.h - the opkg package management system
5 Copyright (C) 2001 University of Southern California
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.
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.
21 #include <sys/types.h>
22 #include <libubox/blob.h>
26 #include "active_list.h"
29 #include "opkg_conf.h"
30 #include "conffile_list.h"
35 #define ARRAY_SIZE(array) sizeof(array) / sizeof((array)[0])
38 /* I think "Size" is currently the shortest field name */
39 #define PKG_MINIMUM_FIELD_NAME_LEN 4
48 typedef enum pkg_state_want pkg_state_want_t
;
53 SF_HOLD
= 2, /* do not upgrade version */
54 SF_REPLACE
= 4, /* replace this package */
55 SF_NOPRUNE
= 8, /* do not remove obsolete files */
56 SF_PREFER
= 16, /* prefer this version */
57 SF_OBSOLETE
= 32, /* old package in upgrade pair */
58 SF_MARKED
= 64, /* temporary mark */
59 SF_FILELIST_CHANGED
= 128, /* needs filelist written */
64 typedef enum pkg_state_flag pkg_state_flag_t
;
65 #define SF_NONVOLATILE_FLAGS (SF_HOLD|SF_NOPRUNE|SF_PREFER|SF_OBSOLETE|SF_USER)
67 enum pkg_state_status
{
78 typedef enum pkg_state_status pkg_state_status_t
;
106 struct abstract_pkg
{
108 int dependencies_checked
;
110 pkg_state_status_t state_status
;
111 pkg_state_flag_t state_flag
;
113 /* XXX: This should be abstract_pkg_vec_t for consistency. */
114 struct abstract_pkg
**depended_upon_by
;
116 abstract_pkg_vec_t
*provided_by
;
117 abstract_pkg_vec_t
*replaced_by
;
120 #include "pkg_depends.h"
122 enum pkg_alternative_field
{
129 struct pkg_alternative
{
135 struct pkg_alternatives
{
137 struct pkg_alternative
**alts
;
140 /* XXX: CLEANUP: I'd like to clean up pkg_t in several ways:
142 The 3 version fields should go into a single version struct. (This
143 is especially important since, currently, pkg->version can easily
144 be mistaken for pkg_verson_str_alloc(pkg) although they are very
145 distinct. This has been the source of multiple bugs.
147 The 3 state fields could possibly also go into their own struct.
149 All fields which deal with lists of packages, (Depends,
150 Pre-Depends, Provides, Suggests, Recommends, Enhances), should each
151 be handled by a single struct in pkg_t
153 All string fields for which there is a small set of possible
154 values, (section, maintainer, architecture, maybe version?), that
155 are reused among different packages -- for all such packages we
156 should move from "char *"s to some atom datatype to share data
157 storage and use less memory. We might even do reference counting,
158 but probably not since most often we only create new pkg_t structs,
159 we don't often free them. */
164 pkg_state_want_t state_want
:3;
165 pkg_state_flag_t state_flag
:11;
166 pkg_state_status_t state_status
:4;
168 abstract_pkg_t
*parent
;
170 /* As pointer for lazy evaluation */
171 str_list_t
*installed_files
;
172 /* XXX: CLEANUP: I'd like to perhaps come up with a better
173 mechanism to avoid the problem here, (which is that the
174 installed_files list was being freed from an inner loop while
175 still being used within an outer loop. */
176 int installed_files_ref_cnt
;
178 unsigned int essential
:1;
179 /* Adding this flag, to "force" opkg to choose a "provided_by_hand" package, if there are multiple choice */
180 unsigned int provided_by_hand
:1;
182 /* this flag specifies whether the package was installed to satisfy another
183 * package's dependancies */
184 unsigned int auto_installed
:1;
185 unsigned int is_upgrade
:1;
187 unsigned int arch_index
:3;
189 struct blob_buf blob
;
192 pkg_t
*pkg_new(void);
193 void pkg_deinit(pkg_t
* pkg
);
194 int pkg_init_from_file(pkg_t
* pkg
, const char *filename
);
196 void *pkg_set_raw(pkg_t
*pkg
, int id
, const void *val
, size_t len
);
197 void *pkg_get_raw(const pkg_t
*pkg
, int id
);
199 static inline int pkg_set_int(pkg_t
*pkg
, int id
, int val
)
201 int *res
= pkg_set_raw(pkg
, id
, &val
, sizeof(val
));
202 return res
? *res
: 0;
205 static inline int pkg_get_int(const pkg_t
*pkg
, int id
)
207 int *ptr
= pkg_get_raw(pkg
, id
);
208 return ptr
? *ptr
: 0;
211 char *pkg_set_string(pkg_t
*pkg
, int id
, const char *s
);
213 static inline char *pkg_get_string(const pkg_t
*pkg
, int id
)
215 return (char *) pkg_get_raw(pkg
, id
);
218 static inline void * pkg_set_ptr(pkg_t
*pkg
, int id
, void *ptr
)
220 void **res
= pkg_set_raw(pkg
, id
, &ptr
, sizeof(ptr
));
221 return res
? *res
: NULL
;
224 static inline void * pkg_get_ptr(const pkg_t
*pkg
, int id
)
226 void **ptr
= pkg_get_raw(pkg
, id
);
227 return ptr
? *ptr
: NULL
;
230 char *pkg_set_architecture(pkg_t
*pkg
, const char *architecture
, ssize_t len
);
231 char *pkg_get_architecture(const pkg_t
*pkg
);
232 int pkg_get_arch_priority(const pkg_t
*pkg
);
234 char *pkg_get_md5(const pkg_t
*pkg
);
235 char *pkg_set_md5(pkg_t
*pkg
, const char *cksum
);
237 char *pkg_get_sha256(const pkg_t
*pkg
);
238 char *pkg_set_sha256(pkg_t
*pkg
, const char *cksum
);
240 abstract_pkg_t
*abstract_pkg_new(void);
243 * merges fields from newpkg into oldpkg.
244 * Forcibly sets oldpkg state_status, state_want and state_flags
246 int pkg_merge(pkg_t
* oldpkg
, pkg_t
* newpkg
);
248 char *pkg_version_str_alloc(pkg_t
* pkg
);
250 int pkg_compare_versions(const pkg_t
*pkg
, const pkg_t
*ref_pkg
);
251 int pkg_name_version_and_architecture_compare(const void *a
, const void *b
);
252 int abstract_pkg_name_compare(const void *a
, const void *b
);
254 void pkg_formatted_info(FILE * fp
, pkg_t
* pkg
);
255 void pkg_formatted_field(FILE * fp
, pkg_t
* pkg
, const char *field
);
257 void pkg_print_status(pkg_t
* pkg
, FILE * file
);
258 str_list_t
*pkg_get_installed_files(pkg_t
* pkg
);
259 void pkg_free_installed_files(pkg_t
* pkg
);
260 void pkg_remove_installed_files_list(pkg_t
* pkg
);
261 conffile_t
*pkg_get_conffile(pkg_t
* pkg
, const char *file_name
);
262 int pkg_run_script(pkg_t
* pkg
, const char *script
, const char *args
);
265 pkg_state_want_t
pkg_state_want_from_str(char *str
);
266 pkg_state_flag_t
pkg_state_flag_from_str(const char *str
);
267 pkg_state_status_t
pkg_state_status_from_str(const char *str
);
269 int pkg_version_satisfied(pkg_t
* it
, pkg_t
* ref
, const char *op
);
271 int pkg_arch_supported(pkg_t
* pkg
);
272 void pkg_info_preinstall_check(void);
274 int pkg_write_filelist(pkg_t
* pkg
);
275 int pkg_write_changed_filelists(void);