FixedResourcePool upgraded

Added pool destroy method.
Added idle connections validation (When needed)
Added metrics log every 10 seconds.
This commit is contained in:
Dario
2010-09-07 12:24:17 +08:00
committed by Jonathan Leibiusky
parent 9fb41cfce4
commit d3be2f629d

View File

@@ -1,6 +1,8 @@
package redis.clients.util;
import java.util.HashMap;
import java.util.Timer;
import java.util.TimerTask;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
@@ -8,317 +10,524 @@ import java.util.concurrent.TimeoutException;
/**
* Abstract resource pool of type T.
*
* Needs implementation for creation, validation and destruction of the
* resources.
* Needs implementation for creation, validation and destruction of the resources.
*
* @author Luis Darío Simonassi
* Keeps a fixed amount of resources
*
* @param <T>
* The type of the resource to be managed.
* @author Luis Dario Simonassi
*
* @param <T> The type of the resource to be managed.
*/
public abstract class FixedResourcePool<T> {
public abstract class FixedResourcePool <T> {
/*
* Generic Inner Control Classes ------- ----- ------- ------- * Wrapper *
* RepairThread
*/
/*
* Generic Inner Control Classes
* ------- ----- ------- -------
* * Wrapper
* * RepairThread
*/
/**
* Generic Resource Wrapper
*/
private static class Wrapper<T>{
long timestamp;
T wrapped;
/**
* Generic Resource Wrapper
*/
private static class Wrapper<T> {
long timestamp;
T wrapped;
public Wrapper(T wrapped){
this.wrapped=wrapped;
mark();
}
public void mark(){
timestamp= System.currentTimeMillis();
}
public long getLastMark(){
return timestamp;
}
}
/**
* Generic Repair Thread
*/
protected class RepairThread extends Thread{
public void run(){
// Contribute to the repairing and validation effort until the pool is destroyed (finishig=true)
while(!finishing){
Wrapper<T> wrapper;
try {
// Remove the oldest element from the repair queue.
wrapper = repairQueue.poll(timeBetweenValidation, TimeUnit.MILLISECONDS);
if(wrapper==null){
// If I've been waiting too much, i'll check the idle pool if connections need
// validation and move them to the repair queue
checkIdles();
continue;
}
} catch (InterruptedException e) {
e.printStackTrace();
continue;
}
// Now, I have something to repair!
T resource= wrapper.wrapped;
boolean valid= false;
// Resources are null right after initialization, it means the same as being an invalid resource
if(resource!=null){
valid= isResourceValid(resource); // Validate the resource.
if(!valid) fails ++;
}
public Wrapper(T wrapped) {
this.wrapped = wrapped;
mark();
// If resource is invalid or null, create a new resource and destroy the invalid one.
if(!valid){
T replace= createResource();
resourcesCreated++;
wrapper.wrapped= replace;
if(resource!=null)
destroyResource(resource);
}
// Mark the resource as fresh!
wrapper.mark();
// Offer the resource to the available resources pool.
if(!availableQueue.offer(wrapper)){
System.err.println("This shouldn't happen, offering to available was rejected.");
}
}
System.out.println("Ending thread ["+Thread.currentThread().getName()+"]");
}
/**
* Check if resources in the idle queue needs to be repaired
*/
private void checkIdles() {
// Get a sample without removing it
Wrapper<T> wrapper= availableQueue.peek();
// If no available items, nothing to repair.
if(wrapper==null)
return;
// Check if the sampled resource needs to be repaired
boolean repairNeeded= isValidationNeeded(wrapper);
if(!repairNeeded)
return;
// Move available resources from the available queue to the repair queue until no repair is needed.
while(repairNeeded){
// Get the connection from the available queue and check again.
wrapper= availableQueue.poll();
// No resources in the available queue, nothing to do
if(wrapper==null){
repairNeeded= false;
return ;
}
// Add the resource to the corresponding queue, depending on weather the resource needs to be repaired or not.
repairNeeded= isValidationNeeded(wrapper);
if(repairNeeded) {
if(!repairQueue.offer(wrapper)){
System.err.print("FATAL: This shouldn't happen, offering to repairing was rejected.");
}
}else{
if(!availableQueue.offer(wrapper)){
System.err.print("FATAL: This shouldn't happen, offering to available was rejected.");
}
}
}
}
}
public void mark() {
timestamp = System.currentTimeMillis();
/*
* Pool metrics
*/
private volatile long failsReported = 0;
private volatile long fails = 0;
private volatile long resourcesCreated = 0;
private volatile long resourcesProvided= 0;
private volatile long resourcesReturned= 0;
/*
* Pool metrics accessing methods.
*/
public long getFailsReported() {
return failsReported;
}
public long getLastMark() {
return timestamp;
public long getFails() {
return fails;
}
}
/**
* Generic Repair Thread
*/
public class RepairThread extends Thread {
public void run() {
while (true) {
public long getResourcesCreated() {
return resourcesCreated;
}
public long getResourcesProvided() {
return resourcesProvided;
}
public long getResourcesReturned() {
return resourcesReturned;
}
/*
* Pool status structures
*/
private LinkedBlockingQueue<Wrapper<T>> availableQueue;
private LinkedBlockingQueue<Wrapper<T>> repairQueue;
private HashMap<T, Wrapper<T>> inUse= new HashMap<T, Wrapper<T>>();
private RepairThread[] repairThreads;
private Timer t;
private boolean initializated = false;
private boolean finishing = false;
/*
* Pool configuration parameters
*/
private String name;
private long defaultPoolWait=50;
private int resourcesNumber = 10;
private int repairThreadsNumber = 3;
private long timeBetweenValidation = 150000;
/*
* Bean pool configuration
*/
public int getResourcesNumber() {
return resourcesNumber;
}
public void setResourcesNumber(int resourcesNumber) {
this.resourcesNumber = resourcesNumber;
}
public int getRepairThreadsNumber() {
return repairThreadsNumber;
}
public void setRepairThreadsNumber(int repairThreadsNumber) {
if(initializated) throw new IllegalStateException("Repair threads should be setted up before init()");
this.repairThreadsNumber = repairThreadsNumber;
}
public long getTimeBetweenValidation() {
return timeBetweenValidation;
}
public void setTimeBetweenValidation(long timeBetweenValidation) {
this.timeBetweenValidation = timeBetweenValidation;
}
public void setName(String name) {
if(initializated) throw new IllegalStateException("Name should be setted up before init()");
this.name = name;
}
public String getName() {
return name;
}
public void setDefaultPoolWait(long defaultPoolWait) {
this.defaultPoolWait = defaultPoolWait;
}
public long getDefaultPoolWait() {
return defaultPoolWait;
}
/**
* Pool initialization & destruction
*/
public void destroy() {
checkInit();
System.out.println("Destroying ["+getName()+"]...");
// Signal al threads to end
finishing=true;
System.out.println("Destroying ["+getName()+"] threads");
// Wait for the Repair Threas
for(int i=0; i < repairThreads.length; i++){
boolean joined= false;
do {
try {
repairThreads[i].interrupt();
repairThreads[i].join();
joined= true;
} catch (InterruptedException e) {
e.printStackTrace();
}
} while(!joined);
}
System.out.println("Waiting for ["+getName()+"] resources to be returned.");
// Wait for all resources to be returned to the pool
synchronized (this) {
while(!inUse.isEmpty()){
try {
this.wait();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
System.out.println("Destroying ["+getName()+"] resources.");
// Destroy resources
for (Wrapper<T> resource : availableQueue) {
destroyResource(resource.wrapped);
}
availableQueue.clear();
availableQueue= null;
for (Wrapper<T> resource : repairQueue) {
destroyResource(resource.wrapped);
}
repairQueue.clear();
repairQueue= null;
// Destroy metrics timer
System.out.println("Shuting metrics timer for ["+getName()+"] down.");
t.cancel();
t=null;
// Reset metrics
failsReported= 0;
fails= 0;
resourcesCreated= 0;
resourcesProvided= 0;
resourcesReturned= 0;
// Set states to initial values
initializated= false;
finishing=false;
System.out.println("Pool ["+getName()+"] successfully destroyed.");
}
/**
* Initialize the pool
*/
@SuppressWarnings("unchecked")
public void init(){
if(initializated==true){
System.err.println("Warning, double initialization of ["+this+"]");
return;
}
initializated=true;
// Create queues with maximum possible capacity
availableQueue= new LinkedBlockingQueue<Wrapper<T>>(resourcesNumber);
repairQueue= new LinkedBlockingQueue<Wrapper<T>>(resourcesNumber);
// Create and start the repair threads.
repairThreads= new FixedResourcePool.RepairThread[repairThreadsNumber];
for(int i=0; i < repairThreads.length; i++){
repairThreads[i]= new RepairThread();
repairThreads[i].setName("REPAIR["+i+"]:"+name);
repairThreads[i].start();
}
// Create resource wrappers with null content.
for(int i=0; i < resourcesNumber; i++){
if(!repairQueue.offer(new Wrapper<T>(null)))
throw new IllegalStateException("What!? not enough space in the repairQueue to offer the element. This shouldn't happen!");
}
// Schedule a status report every 10 seconds.
t= new Timer();
t.schedule(new TimerTask() {
@Override
public void run() {
System.out.println("**********************************");
System.out.println("* Pool name:["+name+"]");
System.out.println("* resourcesCreated....:"+getResourcesCreated());
System.out.println("* failsReported.......:"+getFailsReported());
System.out.println("* fails...............:"+getFails());
System.out.println("* resourcesCreated....:"+getResourcesCreated());
System.out.println("* resourcesProvided...:"+getResourcesProvided());
System.out.println("* resourcesReturned...:"+getResourcesReturned());
System.out.println("* available size......:"+availableQueue.size());
System.out.println("* repair size.........:"+repairQueue.size());
System.out.println("**********************************");
}
}, 10000, 10000);
System.out.println("Initialized ["+name+"]");
}
protected void checkInit(){
if(!initializated) throw new IllegalStateException("Call the init() method first!");
}
/**
* Returns true if wrapped resource needs validation
* @param wrapper
* @return
*/
private boolean isValidationNeeded(Wrapper<T> wrapper){
//Add noise to the check times to avoid simultaneous resource checking.
long noisyTimeBetweenCheck= (timeBetweenValidation - (long)((Math.random()-0.5)*(timeBetweenValidation/10)));
//Check if the resource need to be checked.
return wrapper.getLastMark()+noisyTimeBetweenCheck < System.currentTimeMillis();
}
/**
* Return a resource to the pool. When no longer needed.
* @param resource
*/
public void returnResource(T resource){
checkInit();
Wrapper<T> wrapper;
try {
wrapper = repairQueue.poll(timeBetweenCheck,
TimeUnit.MILLISECONDS);
if (wrapper == null) {
System.err
.println("Warning!, maybe there are too many repair threads. Check configuration.["
+ FixedResourcePool.this + "]");
continue;
}
} catch (InterruptedException e) {
e.printStackTrace();
continue;
if(resource==null) throw new IllegalArgumentException("The resource shouldn't be null.");
//Delete the resource from the inUse list.
synchronized (inUse) {
wrapper= inUse.remove(resource);
}
T wrapped = wrapper.wrapped;
boolean valid = false;
if (wrapped != null) {
valid = isResourceValid(wrapped);
if (!valid)
fails++;
if(wrapper==null) throw new IllegalArgumentException("The resource ["+resource+"] isn't in the busy resources list.");
if(isValidationNeeded(wrapper)){
if(!repairQueue.offer(wrapper)) throw new IllegalStateException("This shouldn't happen. Offering to repair queue rejected.");
}else{
if(!availableQueue.offer(wrapper)) throw new IllegalStateException("This shouldn't happen. Offering to available queue rejected.");
}
if (!valid) {
T replace = createResource();
resourcesCreated++;
wrapper.wrapped = replace;
if (wrapped != null)
destroyResource(wrapped);
resourcesReturned++;
if(finishing){
synchronized (this) {
this.notify();
}
}
wrapper.mark();
if (!availableQueue.offer(wrapper)) {
System.err
.println("This shouldn't happen, offering to available was rejected.");
}
/**
* Return a broken resource to the pool. If the application detects a malfunction of the resource.
* This resources will go directly to the repair queue.
* @param resource
*/
public void returnBrokenResource(T resource){
checkInit();
Wrapper<T> wrapper;
//Delete the resource from the inUse list.
synchronized (inUse) {
wrapper= inUse.remove(resource);
}
}
}
}
if(wrapper==null) throw new IllegalArgumentException("The resource ["+resource+"] isn't in the busy resources list.");
if(!repairQueue.offer(wrapper)) throw new IllegalStateException("This shouldn't happen. Offering to repair queue rejected.");
resourcesReturned++;
/*
* Pool statistics
*/
volatile long failsReported = 0;
volatile long fails = 0;
volatile long resourcesCreated = 0;
volatile long resourcesProvided = 0;
volatile long resourcesReturned = 0;
public long getFailsReported() {
return failsReported;
}
public long getFails() {
return fails;
}
public long getResourcesCreated() {
return resourcesCreated;
}
public long getResourcesProvided() {
return resourcesProvided;
}
public long getResourcesReturned() {
return resourcesReturned;
}
/*
* Pool status structures
*/
private LinkedBlockingQueue<Wrapper<T>> availableQueue;
private LinkedBlockingQueue<Wrapper<T>> repairQueue;
private HashMap<T, Wrapper<T>> inUse = new HashMap<T, Wrapper<T>>();
private RepairThread[] repairThreads;
/*
* Pool parameters
*/
int resourcesNumber = 10;
int repairThreadsNumber = 3;
long timeBetweenCheck = 150000;
private boolean init = false;
public int getResourcesNumber() {
return resourcesNumber;
}
public void setResourcesNumber(int resourcesNumber) {
this.resourcesNumber = resourcesNumber;
}
public int getRepairThreadsNumber() {
return repairThreadsNumber;
}
public void setRepairThreadsNumber(int repairThreadsNumber) {
this.repairThreadsNumber = repairThreadsNumber;
}
public long getTimeBetweenCheck() {
return timeBetweenCheck;
}
public void setTimeBetweenCheck(long timeBetweenCheck) {
this.timeBetweenCheck = timeBetweenCheck;
}
/**
* Initialize the pool
*/
@SuppressWarnings("unchecked")
public void init() {
if (init == true) {
System.err.println("Warning, double initialization of [" + this
+ "]");
return;
}
init = true;
// Create queues with maximum possible capacity
availableQueue = new LinkedBlockingQueue<Wrapper<T>>(resourcesNumber);
repairQueue = new LinkedBlockingQueue<Wrapper<T>>(resourcesNumber);
// Create and start the repair threads.
repairThreads = new FixedResourcePool.RepairThread[repairThreadsNumber];
for (int i = 0; i < repairThreads.length; i++) {
repairThreads[i] = new RepairThread();
repairThreads[i].setName("REPAIR[" + i + "]:" + this.toString());
repairThreads[i].start();
}
// Create resource wrappers with null content.
for (int i = 0; i < resourcesNumber; i++) {
if (!repairQueue.offer(new Wrapper<T>(null)))
throw new IllegalStateException(
"What!? not enough space in the repairQueue to offer the element. This shouldn't happen!");
}
}
/**
* Return a resource to the pool. When no longer needed.
*
* @param resource
*/
public void returnResource(T resource) {
if (!init)
throw new IllegalStateException("Call the init() method first!");
Wrapper<T> wrapper;
if (resource == null)
throw new IllegalArgumentException(
"The resource shouldn't be null.");
// Delete the resource from the inUse list.
synchronized (inUse) {
wrapper = inUse.remove(resource);
}
if (wrapper == null)
throw new IllegalArgumentException("El recurso [" + resource
+ "] no est<73> en la lista de recursos en uso de este pool.");
// Add noise to the check times to avoid simultaneous resource checking.
long noisyTimeBetweenCheck = (timeBetweenCheck - (long) ((Math.random() - 0.5) * (timeBetweenCheck / 10)));
// Check if the resource need to be checked.
if (wrapper.getLastMark() + noisyTimeBetweenCheck < System
.currentTimeMillis()) {
if (!repairQueue.offer(wrapper))
throw new IllegalStateException(
"This shouldn't happen. Offering to repair queue rejected.");
} else {
if (!availableQueue.offer(wrapper))
throw new IllegalStateException(
"This shouldn't happen. Offering to available queue rejected.");
}
resourcesReturned++;
}
/**
* Return a broken resource to the pool. If the application detects a
* malfunction of the resource. This resources will go directly to the
* repair queue.
*
* @param resource
*/
public void returnBrokenResource(T resource) {
if (!init)
throw new IllegalStateException("Call the init() method first!");
Wrapper<T> wrapper;
// Delete the resource from the inUse list.
synchronized (inUse) {
wrapper = inUse.remove(resource);
}
if (wrapper == null)
throw new IllegalArgumentException("El recurso [" + resource
+ "] no est<73> en la lista de recursos en uso de este pool.");
if (!repairQueue.offer(wrapper))
throw new IllegalStateException(
"This shouldn't happen. Offering to repair queue rejected.");
resourcesReturned++;
}
/**
* Get a resource from the pool.
*
* @param maxTime
* Max time you would like to wait for the resource
* @return
* @throws TimeoutException
*/
public T getResource(long maxTime) throws TimeoutException {
if (!init)
throw new IllegalStateException("Call the init() method first!");
final long tInit = System.currentTimeMillis();
do {
try {
long timeSpent = System.currentTimeMillis() - tInit;
long timeToSleep = maxTime - timeSpent;
timeToSleep = timeToSleep > 0 ? timeToSleep : 0;
if (timeToSleep == 0)
throw new TimeoutException("" + timeSpent + ">" + maxTime);
Wrapper<T> ret = availableQueue.poll(timeToSleep,
TimeUnit.MILLISECONDS);
if (ret != null) {
synchronized (inUse) {
inUse.put(ret.wrapped, ret);
}
resourcesProvided++;
return ret.wrapped;
if(finishing){
synchronized (this) {
this.notify();
}
}
} catch (InterruptedException e1) {
e1.printStackTrace();
} // If the wait gets interrupted, doesn't matter but print it (just
// in case).
} while (true);
}
}
/**
* Get a resource from the pool waiting the default time.
* {@link #setDefaultPoolWait(long)}
* @return the resource of type T
* @throws TimeoutException
*/
public T getResource() throws TimeoutException{
return getResource(defaultPoolWait);
}
/**
* Get a resource from the pool.
* @param maxTime Max time you would like to wait for the resource
* @return
* @throws TimeoutException
*/
public T getResource(long maxTime) throws TimeoutException{
if(finishing)
throw new IllegalStateException("Pool ["+getName()+"] is currently being destroyed.");
checkInit();
final long tInit= System.currentTimeMillis();
do{
try {
long timeSpent= System.currentTimeMillis()-tInit;
long timeToSleep= maxTime-timeSpent;
timeToSleep= timeToSleep>0?timeToSleep:0;
if(timeToSleep == 0) throw new TimeoutException(""+timeSpent+">"+maxTime);
Wrapper<T> ret= availableQueue.poll(timeToSleep, TimeUnit.MILLISECONDS);
if(ret!=null){
synchronized (inUse) {
inUse.put(ret.wrapped, ret);
}
resourcesProvided++;
return ret.wrapped;
}
} catch (InterruptedException e1) { e1.printStackTrace(); } //If the wait gets interrupted, doesn't matter but print it (just in case).
} while(true);
}
/*
* Implementation dependent methods. To be implemented.
*/
/*
* Implementation dependent methods. To be implemented.
*/
/**
* Create a resource for the pool
*/
protected abstract T createResource();
/**
* Create a resource for the pool
*/
protected abstract T createResource();
/**
* Check if the resource is still valid.
* @param resource
* @return
*/
protected abstract boolean isResourceValid(T resource);
/**
* Check if the resource is still valid.
*
* @param resource
* @return
*/
protected abstract boolean isResourceValid(T resource);
/**
* Destroy a resource.
* @param resource
*/
protected abstract void destroyResource(T resource);
/**
* Destroy a resource.
*
* @param resource
*/
protected abstract void destroyResource(T resource);
@Override
public String toString() {
return getName()+"["+super.toString()+"]";
}
/**
* Coming features: TODO Pool destruction. Down resources/threads and wait.
* TODO Busy time check. Cron to check when a resource is being taken for a
* long time. TODO Validation of long time idle objects
*/
/**
* Coming features:
* TODO Busy time check. Cron to check when a resource is being taken for a long time.
*/
}
}