solver.c 17 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
/* solver.c - Alpine Package Keeper (APK)
 * A backtracking, forward checking dependency graph solver.
 *
 * Copyright (C) 2011 Timo Teräs <timo.teras@iki.fi>
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published
 * by the Free Software Foundation. See http://www.gnu.org/ for details.
 */

#include <stdlib.h>
#include "apk_defines.h"
#include "apk_database.h"
#include "apk_package.h"
#include "apk_solver.h"

#if 0
#include <stdio.h>
#define dbg_printf(args...) fprintf(stderr, args)
#else
#define dbg_printf(args...)
#endif

#define APK_PKGSTF_NOINSTALL		0
#define APK_PKGSTF_INSTALL		1
#define APK_PKGSTF_BRANCH		2
#define APK_PKGSTF_ALT_BRANCH		4

struct apk_package_state {
	struct apk_package *backtrack;
32
	unsigned int topology_depends;
33 34
	unsigned short flags;
	unsigned short conflicts;
35
	unsigned short cur_unsatisfiable;
36 37
};

38
#define APK_NAMESTF_AVAILABILITY_CHECKED	1
39 40
#define APK_NAMESTF_LOCKED			2
#define APK_NAMESTF_NO_OPTIONS			4
41 42 43
struct apk_name_state {
	struct list_head unsolved_list;
	struct apk_package *chosen;
44
	unsigned short flags;
45 46 47 48 49 50
	unsigned short requirers;
};

struct apk_solver_state {
	struct apk_database *db;
	struct apk_name_state *name_state;
51 52
	unsigned num_topology_positions;

53 54 55 56
	struct list_head unsolved_list_head;
	struct apk_package *latest_decision;
	unsigned int topology_position;
	unsigned int assigned_names;
57 58
	unsigned short cur_unsatisfiable;
	unsigned short allow_errors;
59 60

	struct apk_package_array *best_solution;
61
	unsigned short best_unsatisfiable;
62 63
};

64 65 66 67
static void apply_constraint(struct apk_solver_state *ss, struct apk_dependency *dep);
static void undo_constraint(struct apk_solver_state *ss, struct apk_dependency *dep);
static void push_decision(struct apk_solver_state *ss, struct apk_package *pkg,
			  int flags);
68

69 70 71 72 73
static inline struct apk_package_state *pkg_to_ps(struct apk_package *pkg)
{
	return (struct apk_package_state*) pkg->state_ptr;
}

74 75 76 77 78 79 80 81 82 83 84
static inline int pkg_available(struct apk_database *db, struct apk_package *pkg)
{
	if (pkg->installed_size == 0)
		return TRUE;
	if (pkg->filename != NULL)
		return TRUE;
	if (apk_db_select_repo(db, pkg) != NULL)
		return TRUE;
	return FALSE;
}

85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
static void sort_pkg(struct apk_solver_state *ss, struct apk_package *pkg)
{
	struct apk_package_state *ps;
	int i, j;

	/* Avoid recursion to same package */
	if (pkg->state_ptr != NULL)
		return;

	pkg->state_ptr = calloc(1, sizeof(struct apk_package_state));
	ps = pkg_to_ps(pkg);

	/* Sort all dependants before self */
	for (i = 0; i < pkg->depends->num; i++) {
		struct apk_dependency *dep = &pkg->depends->item[i];
		struct apk_name *name0 = dep->name;

		for (j = 0; j < name0->pkgs->num; j++) {
			struct apk_package *pkg0 = name0->pkgs->item[j];
			/* conflict depends on all to be not installed */
			if (dep->result_mask != APK_DEPMASK_CONFLICT &&
			    !apk_dep_is_satisfied(dep, pkg0))
				continue;
			sort_pkg(ss, pkg0);
		}
	}

	/* Assign a topology sorting order */
	ps->topology_depends = ++ss->num_topology_positions;

	/* FIXME: install_if */
}

static void sort_name(struct apk_solver_state *ss, struct apk_name *name)
{
	int i;

	for (i = 0; i < name->pkgs->num; i++)
		sort_pkg(ss, name->pkgs->item[i]);
}

126 127 128 129 130 131 132 133 134 135
static void prepare_name(struct apk_solver_state *ss, struct apk_name *name,
			 struct apk_name_state *ns)
{
	int i;

	if (ns->flags & APK_NAMESTF_AVAILABILITY_CHECKED)
		return;

	for (i = 0; i < name->pkgs->num; i++) {
		struct apk_package *pkg = name->pkgs->item[i];
136
		struct apk_package_state *ps = pkg_to_ps(pkg);
137 138 139 140 141 142 143 144 145 146 147 148

		/* if package is needed for (re-)install */
		if ((name->flags & APK_NAME_REINSTALL) || (pkg->ipkg == NULL)) {
			/* and it's not available, we can't use it */
			if (!pkg_available(ss->db, pkg))
				ps->conflicts++;
		}
	}

	ns->flags |= APK_NAMESTF_AVAILABILITY_CHECKED;
}

149 150
static void foreach_dependency(struct apk_solver_state *ss, struct apk_dependency_array *deps,
			       void (*func)(struct apk_solver_state *ss, struct apk_dependency *dep))
151
{
152
	int i;
153
	for (i = 0; i < deps->num; i++)
154
		func(ss, &deps->item[i]);
155 156
}

157
static int inline can_consider_package(struct apk_solver_state *ss, struct apk_package_state *ps)
158
{
159 160 161
	if (ps == NULL)
		return FALSE;
	if (ps->topology_depends > ss->topology_position)
162 163 164 165 166 167
		return FALSE;
	if (ps->conflicts)
		return FALSE;
	return TRUE;
}

168
static int get_pkg_expansion_flags(struct apk_solver_state *ss, struct apk_package *pkg)
169 170
{
	struct apk_name *name = pkg->name;
171
	int i, options = 0;
172 173 174

	/* check if the suggested package is the most preferred one of
	 * available packages for the name */
175
	for (i = 0; i < name->pkgs->num; i++) {
176
		struct apk_package *pkg0 = name->pkgs->item[i];
177
		struct apk_package_state *ps0 = pkg_to_ps(pkg0);
178

179
		if (pkg0 == pkg || !can_consider_package(ss, ps0))
180 181
			continue;

182 183 184
		if (apk_flags & APK_PREFER_AVAILABLE) {
			/* pkg available, pkg0 not */
			if (pkg->repos != 0 && pkg0->repos == 0)
185
				continue;
186 187
			/* pkg0 available, pkg not */
			if (pkg0->repos != 0 && pkg->repos == 0)
188
				return APK_PKGSTF_NOINSTALL | APK_PKGSTF_BRANCH;
189 190
		}

191 192
		if (!(apk_flags & APK_UPGRADE)) {
			/* not upgrading, prefer the installed package */
193 194
			if (pkg->ipkg == NULL && pkg0->ipkg != NULL)
				return APK_PKGSTF_NOINSTALL | APK_PKGSTF_BRANCH;
195 196 197 198
		}

		/* upgrading, or neither of the package is installed, so
		 * we just fall back comparing to versions */
199
		options++;
200
		if (apk_pkg_version_compare(pkg0, pkg) == APK_VERSION_GREATER)
201
			return APK_PKGSTF_NOINSTALL | APK_PKGSTF_BRANCH;
202 203
	}

204
	/* no package greater than the selected */
205 206 207 208 209
	if (options)
		return APK_PKGSTF_INSTALL | APK_PKGSTF_BRANCH;

	/* no other choice */
	return APK_PKGSTF_INSTALL;
210 211 212
}

static int update_name_state(struct apk_solver_state *ss,
213 214
			     struct apk_name *name, struct apk_name_state *ns,
			     int requirers_adjustment)
215
{
216 217
	struct apk_package *best_pkg = NULL;
	unsigned int best_topology = 0;
218 219
	int i, options = 0;

220 221
	ns->requirers += requirers_adjustment;

222 223
	for (i = 0; i < name->pkgs->num; i++) {
		struct apk_package *pkg0 = name->pkgs->item[i];
224
		struct apk_package_state *ps0 = pkg_to_ps(pkg0);
225

226
		if (!can_consider_package(ss, ps0))
227 228 229
			continue;

		options++;
230 231 232
		if (best_pkg == NULL ||
		    ps0->topology_depends > best_topology)
			best_pkg = pkg0, best_topology = ps0->topology_depends;
233
	}
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254

	if (options == 0) {
		if (!(ns->flags & APK_NAMESTF_NO_OPTIONS)) {
			ss->cur_unsatisfiable += ns->requirers;
			ns->flags |= APK_NAMESTF_NO_OPTIONS;
		} else if (requirers_adjustment > 0) {
			ss->cur_unsatisfiable += requirers_adjustment;
		}
	} else
		ns->flags &= ~APK_NAMESTF_NO_OPTIONS;

	if (options == 0 || ns->requirers == 0) {
		if (list_hashed(&ns->unsolved_list)) {
			list_del(&ns->unsolved_list);
			list_init(&ns->unsolved_list);
			ns->chosen = NULL;
		}
		dbg_printf("%s: deleted from unsolved: %d requirers, %d options\n",
			   name->name, ns->requirers, options);
	} else {
		dbg_printf("%s: added to unsolved: %d requirers, %d options (next topology %d)\n",
255
			   name->name, ns->requirers, options, best_topology);
256 257
		if (!list_hashed(&ns->unsolved_list))
			list_add(&ns->unsolved_list, &ss->unsolved_list_head);
258
		ns->chosen = best_pkg;
259 260
	}

261 262 263
	return options;
}

264 265 266
static void apply_decision(struct apk_solver_state *ss,
			   struct apk_package *pkg,
			   struct apk_package_state *ps)
267 268 269 270 271 272 273 274 275
{
	struct apk_name_state *ns = &ss->name_state[pkg->name->id];

	dbg_printf("apply_decision: " PKG_VER_FMT " %s\n", PKG_VER_PRINTF(pkg),
		   (ps->flags & APK_PKGSTF_INSTALL) ? "INSTALL" : "NO_INSTALL");

	if (ps->flags & APK_PKGSTF_INSTALL) {
		ss->assigned_names++;
		ns->chosen = pkg;
276 277 278 279 280 281 282 283
		ns->flags |= APK_NAMESTF_LOCKED;

		list_del(&ns->unsolved_list);
		list_init(&ns->unsolved_list);
		dbg_printf("%s: deleting from unsolved list\n",
			   pkg->name->name);

		foreach_dependency(ss, pkg->depends, apply_constraint);
284
	} else {
285 286
		ps->conflicts++;
		update_name_state(ss, pkg->name, ns, 0);
287 288 289 290 291 292 293 294 295 296 297 298
	}
}

static void undo_decision(struct apk_solver_state *ss,
			  struct apk_package *pkg,
			  struct apk_package_state *ps)
{
	struct apk_name_state *ns = &ss->name_state[pkg->name->id];

	dbg_printf("undo_decision: " PKG_VER_FMT " %s\n", PKG_VER_PRINTF(pkg),
		   (ps->flags & APK_PKGSTF_INSTALL) ? "INSTALL" : "NO_INSTALL");

299 300
	ss->cur_unsatisfiable = ps->cur_unsatisfiable;
	if (ps->flags & APK_PKGSTF_BRANCH)
301
		ss->topology_position = ps->topology_depends;
302

303 304 305 306
	if (ps->flags & APK_PKGSTF_INSTALL) {
		ss->assigned_names--;
		foreach_dependency(ss, pkg->depends, undo_constraint);

307 308 309 310
		ns->flags &= ~APK_NAMESTF_LOCKED;
		ns->chosen = NULL;
	} else {
		ps->conflicts--;
311
	}
312 313

	update_name_state(ss, pkg->name, ns, 0);
314 315
}

316 317
static void push_decision(struct apk_solver_state *ss, struct apk_package *pkg,
			  int flags)
318
{
319
	struct apk_package_state *ps = pkg_to_ps(pkg);
320 321 322

	ps->backtrack = ss->latest_decision;
	ps->flags = flags;
323
	ps->cur_unsatisfiable = ss->cur_unsatisfiable;
324
	ss->latest_decision = pkg;
325

326
	if (flags & APK_PKGSTF_BRANCH) {
327
		ss->topology_position = ps->topology_depends;
328 329 330 331 332
		dbg_printf("push_decision: adding new BRANCH at topology_position %d\n",
			   ss->topology_position);
	} else
		ps->flags |= APK_PKGSTF_ALT_BRANCH;

333
	apply_decision(ss, pkg, ps);
334 335 336 337 338 339 340
}

static int next_branch(struct apk_solver_state *ss)
{
	struct apk_package *pkg;
	struct apk_package_state *ps;

341
	while (ss->latest_decision != NULL) {
342
		pkg = ss->latest_decision;
343
		ps = pkg_to_ps(pkg);
344 345 346 347 348 349 350 351 352 353 354 355 356 357
		undo_decision(ss, pkg, ps);

		if (ps->flags & APK_PKGSTF_ALT_BRANCH) {
			pkg = ps->backtrack;
			ss->latest_decision = pkg;
			dbg_printf("next_branch: undo decision at topology_position %d\n",
				   ss->topology_position);
		} else {
			dbg_printf("next_branch: swapping BRANCH at topology_position %d\n",
				   ss->topology_position);

			ps->flags |= APK_PKGSTF_ALT_BRANCH;
			ps->flags ^= APK_PKGSTF_INSTALL;

358 359
			apply_decision(ss, pkg, ps);
			return 0;
360 361
		}
	}
362 363 364

	dbg_printf("next_branch: no more branches\n");
	return 1;
365 366
}

367
static void apply_constraint(struct apk_solver_state *ss, struct apk_dependency *dep)
368 369 370
{
	struct apk_name *name = dep->name;
	struct apk_name_state *ns = &ss->name_state[name->id];
371
	int i;
372

373
	prepare_name(ss, name, ns);
374 375 376 377 378 379 380 381 382

	if (ns->flags & APK_NAMESTF_LOCKED) {
		dbg_printf(PKG_VER_FMT " selected already for %s\n",
			   PKG_VER_PRINTF(ns->chosen), dep->name->name);
		if (!apk_dep_is_satisfied(dep, ns->chosen))
			ss->cur_unsatisfiable += 200;
		return;
	}

383 384
	for (i = 0; i < name->pkgs->num; i++) {
		struct apk_package *pkg0 = name->pkgs->item[i];
385
		struct apk_package_state *ps0 = pkg_to_ps(pkg0);
386

387 388
		if (ps0 == NULL ||
		    ps0->topology_depends >= ss->topology_position)
389 390 391 392 393 394 395 396 397 398
			continue;

		if (!apk_dep_is_satisfied(dep, pkg0)) {
			ps0->conflicts++;
			dbg_printf(PKG_VER_FMT ": conflicts++ -> %d\n",
				   PKG_VER_PRINTF(pkg0),
				   ps0->conflicts);
		}
	}

399 400
	update_name_state(ss, name, ns,
			  (dep->result_mask != APK_DEPMASK_CONFLICT) ? 1 : 0);
401 402
}

403
static void undo_constraint(struct apk_solver_state *ss, struct apk_dependency *dep)
404 405 406
{
	struct apk_name *name = dep->name;
	struct apk_name_state *ns = &ss->name_state[name->id];
407 408 409 410 411 412 413
	int i;

	if (ns->flags & APK_NAMESTF_LOCKED) {
		dbg_printf(PKG_VER_FMT " selected already for %s\n",
			   PKG_VER_PRINTF(ns->chosen), dep->name->name);
		return;
	}
414 415 416

	for (i = 0; i < name->pkgs->num; i++) {
		struct apk_package *pkg0 = name->pkgs->item[i];
417
		struct apk_package_state *ps0 = pkg_to_ps(pkg0);
418

419
		if (ps0->topology_depends >= ss->topology_position)
420 421 422 423 424 425 426 427 428 429
			continue;

		if (!apk_dep_is_satisfied(dep, pkg0)) {
			ps0->conflicts--;
			dbg_printf(PKG_VER_FMT ": conflicts-- -> %d\n",
				   PKG_VER_PRINTF(pkg0),
				   ps0->conflicts);
		}
	}

430 431
	update_name_state(ss, name, ns,
		(dep->result_mask != APK_DEPMASK_CONFLICT) ? -1 : 0);
432 433 434 435
}

static int expand_branch(struct apk_solver_state *ss)
{
436 437
	struct apk_name_state *ns;
	struct apk_package *pkg0 = NULL;
438
	unsigned int topology0 = 0;
439 440 441 442

	/* FIXME: change unsolved_list to a priority queue */
	list_for_each_entry(ns, &ss->unsolved_list_head, unsolved_list) {
		if (pkg0 == NULL ||
443 444
		    pkg_to_ps(ns->chosen)->topology_depends > topology0)
			pkg0 = ns->chosen, topology0 = pkg_to_ps(pkg0)->topology_depends;
445 446 447 448 449 450
	}
	if (pkg0 == NULL) {
		dbg_printf("expand_branch: list is empty (%d unsatisfied)\n",
			   ss->cur_unsatisfiable);
		return 1;
	}
451

452 453 454
	/* someone needs to provide this name -- find next eligible
	 * provider candidate */
	ns = &ss->name_state[pkg0->name->id];
455
	dbg_printf("expand_branch: %s\n", pkg0->name->name);
456

457 458 459 460 461 462
	push_decision(ss, pkg0, get_pkg_expansion_flags(ss, pkg0));
	#if 0
		      is_pkg_preferred(ss, pkg0) ?
			(APK_PKGSTF_INSTALL | APK_PKGSTF_BRANCH) :
			(APK_PKGSTF_NOINSTALL | APK_PKGSTF_BRANCH));
			#endif
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477

	return 0;
}

static void record_solution(struct apk_solver_state *ss)
{
	struct apk_package *pkg;
	struct apk_package_state *ps;
	int i;

	apk_package_array_resize(&ss->best_solution, ss->assigned_names);

	i = 0;
	pkg = ss->latest_decision;
	while (pkg != NULL) {
478
		ps = pkg_to_ps(pkg);
479 480
		if ((ps->flags & APK_PKGSTF_INSTALL) &&
		    (ps->conflicts == 0))
481 482 483 484 485 486 487 488
			ss->best_solution->item[i++] = pkg;

		dbg_printf("record_solution: " PKG_VER_FMT ": %sINSTALL\n",
			   PKG_VER_PRINTF(pkg),
			   (ps->flags & APK_PKGSTF_INSTALL) ? "" : "NO_");

		pkg = ps->backtrack;
	}
489 490 491 492 493 494 495 496 497 498
	apk_package_array_resize(&ss->best_solution, i);
	ss->best_unsatisfiable = ss->cur_unsatisfiable;
}

static int compare_package_name(const void *p1, const void *p2)
{
	const struct apk_package **c1 = (const struct apk_package **) p1;
	const struct apk_package **c2 = (const struct apk_package **) p2;

	return strcmp((*c1)->name->name, (*c2)->name->name);
499 500 501
}

int apk_solver_solve(struct apk_database *db, struct apk_dependency_array *world,
502
		     struct apk_package_array **solution, int allow_errors)
503 504
{
	struct apk_solver_state *ss;
505
	int i, r;
506 507 508 509

	ss = calloc(1, sizeof(struct apk_solver_state));
	ss->db = db;
	ss->topology_position = -1;
510 511
	ss->best_unsatisfiable = -1;
	ss->allow_errors = allow_errors;
512
	list_init(&ss->unsolved_list_head);
513 514 515 516
	ss->name_state = calloc(db->available.names.num_items + 1, sizeof(struct apk_name_state));

	for (i = 0; i < world->num; i++)
		sort_name(ss, world->item[i].name);
517

518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
	foreach_dependency(ss, world, apply_constraint);
	do {
		if (ss->allow_errors || ss->cur_unsatisfiable < ss->best_unsatisfiable) {
			r = expand_branch(ss);
			if (r) {
				if (ss->cur_unsatisfiable == 0) {
					/* found solution - it is optimal because we permutate
					 * each preferred local option first, and permutations
					 * happen in topologally sorted order. */
					r = 0;
					break;
				}
				if (ss->cur_unsatisfiable < ss->best_unsatisfiable)
					record_solution(ss);
				r = next_branch(ss);
			}
		} else {
			r = next_branch(ss);
536
		}
537
	} while (r == 0);
538 539

	/* collect packages */
540
	if (r == 0 && ss->cur_unsatisfiable == 0) {
541 542
		record_solution(ss);
		*solution = ss->best_solution;
543 544 545 546 547 548 549 550
		r = 0;
	} else if (ss->allow_errors) {
		*solution = ss->best_solution;
		qsort(ss->best_solution->item, ss->best_solution->num,
		      sizeof(struct apk_package *), compare_package_name);
		r = ss->best_unsatisfiable;
	} else
		r = -1;
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565

	free(ss->name_state);
	free(ss);

	return r;
}

static int compare_change(const void *p1, const void *p2)
{
	const struct apk_change *c1 = (const struct apk_change *) p1;
	const struct apk_change *c2 = (const struct apk_change *) p2;

	if (c1->newpkg == NULL) {
		if (c2->newpkg == NULL)
			/* both deleted - reverse topology order */
566 567
			return  pkg_to_ps(c1->oldpkg)->topology_depends -
				pkg_to_ps(c2->oldpkg)->topology_depends;
568 569 570 571 572 573 574 575

		/* c1 deleted, c2 installed -> c2 first*/
		return -1;
	}
	if (c2->newpkg == NULL)
		/* c1 installed, c2 deleted -> c1 first*/
		return 1;

576 577
	return  pkg_to_ps(c2->newpkg)->topology_depends -
		pkg_to_ps(c1->newpkg)->topology_depends;
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
}

int apk_solver_generate_changeset(struct apk_database *db,
				  struct apk_package_array *solution,
				  struct apk_changeset *changeset)
{
	struct apk_name *name;
	struct apk_package *pkg, *pkg0;
	struct apk_installed_package *ipkg;
	int num_installs = 0, num_removed = 0, ci = 0;
	int i, j;

	/* calculate change set size */
	for (i = 0; i < solution->num; i++) {
		pkg = solution->item[i];
		name = pkg->name;
		if (pkg->ipkg == NULL || (name->flags & APK_NAME_REINSTALL))
			num_installs++;
		name->flags |= APK_NAME_VISITED;
	}

	list_for_each_entry(ipkg, &db->installed.packages, installed_pkgs_list) {
		if (!(ipkg->pkg->name->flags & APK_NAME_VISITED))
			num_removed++;
	}

	/* construct changeset */
	apk_change_array_resize(&changeset->changes, num_installs + num_removed);
	list_for_each_entry(ipkg, &db->installed.packages, installed_pkgs_list) {
		if (ipkg->pkg->name->flags & APK_NAME_VISITED)
			continue;
		changeset->changes->item[ci].oldpkg = ipkg->pkg;
		ci++;
	}
	for (i = 0; i < solution->num; i++) {
		pkg = solution->item[i];
		name = pkg->name;

		if (pkg->ipkg == NULL || (name->flags & APK_NAME_REINSTALL)) {
			for (j = 0; j < name->pkgs->num; j++) {
				pkg0 = name->pkgs->item[j];
				if (pkg0->ipkg == NULL)
					continue;
				changeset->changes->item[ci].oldpkg = pkg0;
				break;
			}
			changeset->changes->item[ci].newpkg = pkg;
			ci++;
		}
		name->flags &= ~APK_NAME_VISITED;
	}

	/* sort changeset to topology order */
	qsort(changeset->changes->item, changeset->changes->num,
	      sizeof(struct apk_change), compare_change);

	return 0;
}