1*7c478bd9Sstevel@tonic-gate /*
2*7c478bd9Sstevel@tonic-gate  * CDDL HEADER START
3*7c478bd9Sstevel@tonic-gate  *
4*7c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*7c478bd9Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*7c478bd9Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*7c478bd9Sstevel@tonic-gate  * with the License.
8*7c478bd9Sstevel@tonic-gate  *
9*7c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*7c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*7c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*7c478bd9Sstevel@tonic-gate  * and limitations under the License.
13*7c478bd9Sstevel@tonic-gate  *
14*7c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*7c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*7c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*7c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*7c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*7c478bd9Sstevel@tonic-gate  *
20*7c478bd9Sstevel@tonic-gate  * CDDL HEADER END
21*7c478bd9Sstevel@tonic-gate  */
22*7c478bd9Sstevel@tonic-gate /*
23*7c478bd9Sstevel@tonic-gate  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24*7c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
25*7c478bd9Sstevel@tonic-gate  *
26*7c478bd9Sstevel@tonic-gate  *ident	"%Z%%M%	%I%	%E% SMI"
27*7c478bd9Sstevel@tonic-gate  *
28*7c478bd9Sstevel@tonic-gate  */
29*7c478bd9Sstevel@tonic-gate 
30*7c478bd9Sstevel@tonic-gate package com.sun.solaris.domain.pools;
31*7c478bd9Sstevel@tonic-gate 
32*7c478bd9Sstevel@tonic-gate import java.util.Set;
33*7c478bd9Sstevel@tonic-gate 
34*7c478bd9Sstevel@tonic-gate import com.sun.solaris.service.pools.Configuration;
35*7c478bd9Sstevel@tonic-gate import com.sun.solaris.service.pools.Element;
36*7c478bd9Sstevel@tonic-gate import com.sun.solaris.service.pools.PoolsException;
37*7c478bd9Sstevel@tonic-gate 
38*7c478bd9Sstevel@tonic-gate /**
39*7c478bd9Sstevel@tonic-gate  * This interface specifies the contract between poold and the poold
40*7c478bd9Sstevel@tonic-gate  * allocation algorithms.
41*7c478bd9Sstevel@tonic-gate  */
42*7c478bd9Sstevel@tonic-gate 
43*7c478bd9Sstevel@tonic-gate public interface Solver {
44*7c478bd9Sstevel@tonic-gate 	/**
45*7c478bd9Sstevel@tonic-gate 	 * Initialize the solver.
46*7c478bd9Sstevel@tonic-gate 	 *
47*7c478bd9Sstevel@tonic-gate 	 * @param conf The configuration to be manipulated.
48*7c478bd9Sstevel@tonic-gate 	 * @throws PoolsException If the initialization fails.
49*7c478bd9Sstevel@tonic-gate 	 */
initialize(Configuration conf)50*7c478bd9Sstevel@tonic-gate 	public void initialize(Configuration conf) throws PoolsException;
51*7c478bd9Sstevel@tonic-gate 
52*7c478bd9Sstevel@tonic-gate 	/**
53*7c478bd9Sstevel@tonic-gate 	 * Evaluate whether a workload based reconfiguration is
54*7c478bd9Sstevel@tonic-gate 	 * required.
55*7c478bd9Sstevel@tonic-gate 	 *
56*7c478bd9Sstevel@tonic-gate 	 * @param mon The monitor to be used during examination.
57*7c478bd9Sstevel@tonic-gate 	 * @throws PoolsException If the examination fails.
58*7c478bd9Sstevel@tonic-gate 	 * @throws StaleMonitorException If the monitor is stale.
59*7c478bd9Sstevel@tonic-gate 	 */
examine(Monitor mon)60*7c478bd9Sstevel@tonic-gate 	public boolean examine(Monitor mon) throws PoolsException,
61*7c478bd9Sstevel@tonic-gate 	    StaleMonitorException;
62*7c478bd9Sstevel@tonic-gate 
63*7c478bd9Sstevel@tonic-gate 	/**
64*7c478bd9Sstevel@tonic-gate 	 * Allocate resources. Return true if a change was made.
65*7c478bd9Sstevel@tonic-gate 	 *
66*7c478bd9Sstevel@tonic-gate 	 * @throws Exception If the solve fails.
67*7c478bd9Sstevel@tonic-gate 	 */
solve()68*7c478bd9Sstevel@tonic-gate 	public boolean solve() throws Exception;
69*7c478bd9Sstevel@tonic-gate 
70*7c478bd9Sstevel@tonic-gate 	/**
71*7c478bd9Sstevel@tonic-gate 	 * Return true if all examined resources are capable of
72*7c478bd9Sstevel@tonic-gate 	 * providing statistically valid data.
73*7c478bd9Sstevel@tonic-gate 	 *
74*7c478bd9Sstevel@tonic-gate 	 * If any of the monitored resources have not accumulated
75*7c478bd9Sstevel@tonic-gate 	 * enough data to be statistically significant, then this
76*7c478bd9Sstevel@tonic-gate 	 * monitor is not ready to be used to obtain data for all
77*7c478bd9Sstevel@tonic-gate 	 * resources. In this case, false is returned.
78*7c478bd9Sstevel@tonic-gate 	 *
79*7c478bd9Sstevel@tonic-gate 	 */
isValid()80*7c478bd9Sstevel@tonic-gate 	public boolean isValid();
81*7c478bd9Sstevel@tonic-gate 
82*7c478bd9Sstevel@tonic-gate 	/**
83*7c478bd9Sstevel@tonic-gate 	 * Return a reference to the monitor which this solver is
84*7c478bd9Sstevel@tonic-gate 	 * using to provide statistics about the configuration which
85*7c478bd9Sstevel@tonic-gate 	 * is to be solved.
86*7c478bd9Sstevel@tonic-gate 	 */
getMonitor()87*7c478bd9Sstevel@tonic-gate 	public Monitor getMonitor();
88*7c478bd9Sstevel@tonic-gate 
89*7c478bd9Sstevel@tonic-gate 	/**
90*7c478bd9Sstevel@tonic-gate 	 * Return the set of objectives associated with the supplied
91*7c478bd9Sstevel@tonic-gate 	 * element.
92*7c478bd9Sstevel@tonic-gate 	 *
93*7c478bd9Sstevel@tonic-gate 	 * @param elem Retrieve objectives for this element.
94*7c478bd9Sstevel@tonic-gate 	 */
getObjectives(Element elem)95*7c478bd9Sstevel@tonic-gate 	public Set getObjectives(Element elem);
96*7c478bd9Sstevel@tonic-gate }
97