• source navigation  • diff markup  • identifier search  • freetext search  • 

Sources/opkg-lede/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 <sys/types.h>
 22 #include <libubox/blob.h>
 23 
 24 #include "pkg_vec.h"
 25 #include "str_list.h"
 26 #include "active_list.h"
 27 #include "pkg_src.h"
 28 #include "pkg_dest.h"
 29 #include "opkg_conf.h"
 30 #include "conffile_list.h"
 31 
 32 struct opkg_conf;
 33 
 34 #ifndef ARRAY_SIZE
 35 #define ARRAY_SIZE(array) sizeof(array) / sizeof((array)[0])
 36 #endif
 37 
 38 /* I think "Size" is currently the shortest field name */
 39 #define PKG_MINIMUM_FIELD_NAME_LEN 4
 40 
 41 enum pkg_state_want {
 42         SW_UNKNOWN = 1,
 43         SW_INSTALL,
 44         SW_DEINSTALL,
 45         SW_PURGE,
 46         SW_LAST_STATE_WANT
 47 };
 48 typedef enum pkg_state_want pkg_state_want_t;
 49 
 50 enum pkg_state_flag {
 51         SF_OK = 0,
 52         SF_REINSTREQ = 1,
 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 */
 60         SF_USER = 256,
 61         SF_NEED_DETAIL = 512,
 62         SF_LAST_STATE_FLAG
 63 };
 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)
 66 
 67 enum pkg_state_status {
 68         SS_NOT_INSTALLED = 1,
 69         SS_UNPACKED,
 70         SS_HALF_CONFIGURED,
 71         SS_INSTALLED,
 72         SS_HALF_INSTALLED,
 73         SS_CONFIG_FILES,
 74         SS_POST_INST_FAILED,
 75         SS_REMOVAL_FAILED,
 76         SS_LAST_STATE_STATUS
 77 };
 78 typedef enum pkg_state_status pkg_state_status_t;
 79 
 80 enum pkg_fields {
 81         PKG_MAINTAINER,
 82         PKG_PRIORITY,
 83         PKG_SOURCE,
 84         PKG_TAGS,
 85         PKG_SECTION,
 86         PKG_EPOCH,
 87         PKG_FILENAME,
 88         PKG_LOCAL_FILENAME,
 89         PKG_VERSION,
 90         PKG_REVISION,
 91         PKG_DESCRIPTION,
 92         PKG_MD5SUM,
 93         PKG_SHA256SUM,
 94         PKG_SIZE,
 95         PKG_INSTALLED_SIZE,
 96         PKG_INSTALLED_TIME,
 97         PKG_TMP_UNPACK_DIR,
 98         PKG_REPLACES,
 99         PKG_PROVIDES,
100         PKG_DEPENDS,
101         PKG_CONFLICTS,
102         PKG_CONFFILES,
103         PKG_ALTERNATIVES,
104 };
105 
106 struct abstract_pkg {
107         char *name;
108         pkg_vec_t *pkgs;
109 
110         /* XXX: This should be abstract_pkg_vec_t for consistency. */
111         struct abstract_pkg **depended_upon_by;
112 
113         abstract_pkg_vec_t *provided_by;
114         abstract_pkg_vec_t *replaced_by;
115 
116         char dependencies_checked;
117         char pre_dependencies_checked;
118         pkg_state_status_t state_status:4;
119         pkg_state_flag_t state_flag:11;
120 };
121 
122 #include "pkg_depends.h"
123 
124 enum pkg_alternative_field {
125         PAF_PRIO,
126         PAF_PATH,
127         PAF_ALTPATH,
128         __PAF_MAX,
129 };
130 
131 struct pkg_alternative {
132         int prio;
133         char *path;
134         char *altpath;
135 };
136 
137 struct pkg_alternatives {
138         int nalts;
139         struct pkg_alternative **alts;
140 };
141 
142 /* XXX: CLEANUP: I'd like to clean up pkg_t in several ways:
143 
144    The 3 version fields should go into a single version struct. (This
145    is especially important since, currently, pkg->version can easily
146    be mistaken for pkg_verson_str_alloc(pkg) although they are very
147    distinct. This has been the source of multiple bugs.
148 
149    The 3 state fields could possibly also go into their own struct.
150 
151    All fields which deal with lists of packages, (Depends,
152    Pre-Depends, Provides, Suggests, Recommends, Enhances), should each
153    be handled by a single struct in pkg_t
154 
155    All string fields for which there is a small set of possible
156    values, (section, maintainer, architecture, maybe version?), that
157    are reused among different packages -- for all such packages we
158    should move from "char *"s to some atom datatype to share data
159    storage and use less memory. We might even do reference counting,
160    but probably not since most often we only create new pkg_t structs,
161    we don't often free them.  */
162 struct pkg {
163         char *name;
164         pkg_src_t *src;
165         pkg_dest_t *dest;
166         pkg_state_want_t state_want:3;
167         pkg_state_flag_t state_flag:11;
168         pkg_state_status_t state_status:4;
169 
170         abstract_pkg_t *parent;
171 
172         /* As pointer for lazy evaluation */
173         str_list_t *installed_files;
174         /* XXX: CLEANUP: I'd like to perhaps come up with a better
175            mechanism to avoid the problem here, (which is that the
176            installed_files list was being freed from an inner loop while
177            still being used within an outer loop. */
178         int installed_files_ref_cnt;
179 
180         unsigned int essential:1;
181 /* Adding this flag, to "force" opkg to choose a "provided_by_hand" package, if there are multiple choice */
182         unsigned int provided_by_hand:1;
183 
184         /* this flag specifies whether the package was installed to satisfy another
185          * package's dependancies */
186         unsigned int auto_installed:1;
187         unsigned int is_upgrade:1;
188 
189         unsigned int arch_index:3;
190 
191         struct blob_buf blob;
192 };
193 
194 pkg_t *pkg_new(void);
195 void pkg_deinit(pkg_t * pkg);
196 int pkg_init_from_file(pkg_t * pkg, const char *filename);
197 
198 void *pkg_set_raw(pkg_t *pkg, int id, const void *val, size_t len);
199 void *pkg_get_raw(const pkg_t *pkg, int id);
200 
201 static inline int pkg_set_int(pkg_t *pkg, int id, int val)
202 {
203         int *res = pkg_set_raw(pkg, id, &val, sizeof(val));
204         return res ? *res : 0;
205 }
206 
207 static inline int pkg_get_int(const pkg_t *pkg, int id)
208 {
209         int *ptr = pkg_get_raw(pkg, id);
210         return ptr ? *ptr : 0;
211 }
212 
213 char *pkg_set_string(pkg_t *pkg, int id, const char *s);
214 
215 static inline char *pkg_get_string(const pkg_t *pkg, int id)
216 {
217         return (char *) pkg_get_raw(pkg, id);
218 }
219 
220 static inline void * pkg_set_ptr(pkg_t *pkg, int id, void *ptr)
221 {
222         void **res = pkg_set_raw(pkg, id, &ptr, sizeof(ptr));
223         return res ? *res : NULL;
224 }
225 
226 static inline void * pkg_get_ptr(const pkg_t *pkg, int id)
227 {
228         void **ptr = pkg_get_raw(pkg, id);
229         return ptr ? *ptr : NULL;
230 }
231 
232 char *pkg_set_architecture(pkg_t *pkg, const char *architecture, ssize_t len);
233 char *pkg_get_architecture(const pkg_t *pkg);
234 int pkg_get_arch_priority(const pkg_t *pkg);
235 
236 char *pkg_get_md5(const pkg_t *pkg);
237 char *pkg_set_md5(pkg_t *pkg, const char *cksum);
238 
239 char *pkg_get_sha256(const pkg_t *pkg);
240 char *pkg_set_sha256(pkg_t *pkg, const char *cksum);
241 
242 abstract_pkg_t *abstract_pkg_new(void);
243 
244 /*
245  * merges fields from newpkg into oldpkg.
246  * Forcibly sets oldpkg state_status, state_want and state_flags
247  */
248 int pkg_merge(pkg_t * oldpkg, pkg_t * newpkg);
249 
250 char *pkg_version_str_alloc(pkg_t * pkg);
251 
252 int pkg_compare_versions(const pkg_t *pkg, const pkg_t *ref_pkg);
253 int pkg_name_version_and_architecture_compare(const void *a, const void *b);
254 int abstract_pkg_name_compare(const void *a, const void *b);
255 
256 void pkg_formatted_info(FILE * fp, pkg_t * pkg);
257 void pkg_formatted_field(FILE * fp, pkg_t * pkg, const char *field);
258 
259 void pkg_print_status(pkg_t * pkg, FILE * file);
260 str_list_t *pkg_get_installed_files(pkg_t * pkg);
261 void pkg_free_installed_files(pkg_t * pkg);
262 void pkg_remove_installed_files_list(pkg_t * pkg);
263 conffile_t *pkg_get_conffile(pkg_t * pkg, const char *file_name);
264 int pkg_run_script(pkg_t * pkg, const char *script, const char *args);
265 
266 /* enum mappings */
267 pkg_state_want_t pkg_state_want_from_str(char *str);
268 pkg_state_flag_t pkg_state_flag_from_str(const char *str);
269 pkg_state_status_t pkg_state_status_from_str(const char *str);
270 
271 int pkg_version_satisfied(pkg_t * it, pkg_t * ref, const char *op);
272 
273 int pkg_arch_supported(pkg_t * pkg);
274 void pkg_info_preinstall_check(void);
275 
276 int pkg_write_filelist(pkg_t * pkg);
277 int pkg_write_changed_filelists(void);
278 
279 #endif
280 

This page was automatically generated by LXR 0.3.1.  •  OpenWrt