org.javades.jqueues.r5.entity.jq.queue.qos

Class HOL_PS<J extends SimJob,Q extends HOL_PS,P>

java.lang.Object

org.javades.jqueues.r5.entity.AbstractSimEntity

org.javades.jqueues.r5.entity.jq.AbstractSimJQ<J,Q>

org.javades.jqueues.r5.entity.jq.queue.AbstractSimQueue<J,Q>

org.javades.jqueues.r5.entity.jq.queue.AbstractClassicSimQueue<J,Q>

org.javades.jqueues.r5.entity.jq.queue.processorsharing.AbstractProcessorSharingSimQueue<J,Q>

org.javades.jqueues.r5.entity.jq.queue.processorsharing.AbstractEgalitarianProcessorSharingSimQueue<J,Q>

org.javades.jqueues.r5.entity.jq.queue.qos.HOL_PS<J,Q,P>

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

P - The type used for QoS.

All Implemented Interfaces:

SimQueue<J,Q>, SimQoS<J,Q>, SimEntity, SimQueueOrJobQoS<J,Q,P>, SimQueueQoS<J,Q,P>, org.javades.jsimulation.r5.SimEventListResetListener

public class HOL_PS<J extends SimJob,Q extends HOL_PS,P>
extends AbstractEgalitarianProcessorSharingSimQueue<J,Q>
implements SimQueueQoS<J,Q,P>

The single-server HOL_PS queue serves all jobs in the service area simultaneously, equally distributing its service capacity, but only admits a single job of each QoS class to the service area.

Head-of-the-Line Processor Sharing.

The Head-of-the-Line Processor-Sharing queueing system distributes its service capacity equally among the jobs in execution. Jobs start immediately upon arrival, provided that there are server-access credits left, AND no other job with the same QoS class is present (in execution). Upon regaining server-access credits, (eligible) jobs are started in arrival order.

XXX We do not really want P to be Comparable here... Any class/interface should do, including Object. This is a design failure in the QoS structure...

Author:

Jan de Jongh, TNO

Copyright (C) 2005-2017 Jan de Jongh, TNO

This file is covered by the LICENSE file in the root of this project.

See Also:

HOL, PS

Nested Class Summary

Nested classes/interfaces inherited from class org.javades.jqueues.r5.entity.AbstractSimEntity

AbstractSimEntity.Notifier, AbstractSimEntity.PreNotificationHook

Nested classes/interfaces inherited from interface org.javades.jqueues.r5.entity.jq.queue.SimQueue

SimQueue.AutoRevocationPolicy

Nested classes/interfaces inherited from interface org.javades.jqueues.r5.entity.SimEntity

SimEntity.Action, SimEntity.UnknownNotificationTypePolicy, SimEntity.UnknownOperationPolicy

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<P,Set<J>>	jobsQoSMap

Fields inherited from class org.javades.jqueues.r5.entity.jq.queue.processorsharing.AbstractEgalitarianProcessorSharingSimQueue

virtualDepartureTime

Fields inherited from class org.javades.jqueues.r5.entity.jq.queue.AbstractSimQueue

eventsScheduled, SANITY

Fields inherited from class org.javades.jqueues.r5.entity.AbstractSimEntity

USE_ARRAY_OPTIMIZATION

Constructor Summary

Constructors

Constructor and Description
HOL_PS(org.javades.jsimulation.r5.SimEventList eventList, Class<P> qosClass, P defaultJobQoS) Creates a single-server HOL-PS queue with infinite buffer size given an event list.

Method Summary

Modifier and Type	Method and Description
HOL_PS<J,Q,P>	getCopySimQueue() Returns a new HOL_PS object on the same SimEventList and the same QoS structure.
P	getDefaultJobQoS() Gets the default QoS value used by this queue for jobs that have null QoS value.
Map<P,Set<J>>	getJobsQoSMap() Gets the mapping QoS values onto jobs currently visiting this queue with that particular QoS value.
P	getQoS() Returns null, since the QoS value of a queue has no meaning.
Class<? extends P>	getQoSClass() Overridden in order to restrict the return type.
protected void	insertJobInQueueUponArrival(J job, double time) Inserts the job into jobsQoSMap.
boolean	isStartArmed() Returns true if there are no jobs in the queue.
protected void	removeJobFromQueueUponDrop(J job, double time) Throws IllegalStateException.
protected void	removeJobFromQueueUponRevokation(J job, double time, boolean auto) Removes the jobs from the internal data structures.
protected void	rescheduleAfterArrival(J job, double time) Starts the arrived job if server-access credits are available and there are no other jobs present with the same QoS value.
protected void	rescheduleAfterDeparture(J departedJob, double time) Calls rescheduleAfterRevokation(J, double, boolean).
protected void	rescheduleAfterDrop(J job, double time) Throws IllegalStateException.
protected void	rescheduleAfterRevokation(J job, double time, boolean auto) Attempts to start a job of the same QoS value as the job that was revoked (or departed); calls AbstractEgalitarianProcessorSharingSimQueue.rescheduleDepartureEvent() if that fails.
protected void	rescheduleForNewServerAccessCredits(double time) Starts jobs eligible to start in arrival order as long as there are server-access credits.
protected void	resetEntitySubClass() Calls super method and clears jobsQoSMap.
void	setQoS(P qos) Calls super method (in order to make implementation final).
void	setQoSClass(Class<? extends P> qosClass) Calls super method (in order to make implementation final).
protected void	setServerAccessCreditsSubClass() Calls super method (in order to make implementation final).
String	toStringDefault() Returns "HOL-PS".

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.processorsharing.AbstractEgalitarianProcessorSharingSimQueue

getServiceTimeForJob, getVirtualTime, insertJobInQueueUponStart, removeJobFromQueueUponDeparture, rescheduleAfterStart, rescheduleDepartureEvent, updateVirtualTime

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.processorsharing.AbstractProcessorSharingSimQueue

queueAccessVacationDropSubClass

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.AbstractClassicSimQueue

getBufferSize, getNumberOfServers

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.AbstractSimQueue

arrive, autoRevoke, cancelDepartureEvent, cancelDepartureEvent, depart, departureFromEventList, drop, getAutoRevocationPolicy, getDepartureEvents, getDepartureEvents, getFirstJob, getFirstJobInServiceArea, getFirstJobInWaitingArea, getJobs, getJobsInServiceArea, getJobsInWaitingArea, getNumberOfJobs, getNumberOfJobsInServiceArea, getNumberOfJobsInWaitingArea, getServerAccessCredits, hasJobs, hasJobsInServiceArea, hasJobsInWaitingArea, hasServerAcccessCredits, isJob, isJobInServiceArea, isJobInWaitingArea, isQueueAccessVacation, registerStdOutSimQueueListener, revoke, revoke, scheduleDepartureEvent, scheduleJobArrival, setAutoRevocationPolicy, setQueueAccessVacation, setServerAccessCredits, start, takeServerAccessCredit, triggerPotentialNewStartArmed, unregisterStdOutSimQueueListener

Methods inherited from class org.javades.jqueues.r5.entity.AbstractSimEntity

addPendingNotification, addPendingNotification, clearAndUnlockPendingNotificationsIfLocked, delegateOperation, doAfterNotifications, doOperation, fireAndLockPendingNotifications, getEventList, getLastUpdateTime, getRegisteredDelegatedOperations, getRegisteredNotificationTypes, getRegisteredOperations, getSimEntityListeners, getUnknownNotificationTypePolicy, getUnknownOperationPolicy, isIgnoreEventListReset, notifyEventListReset, registerDelegatedOperation, registerNotificationType, registerOperation, registerPreEventHook, registerPreNotificationHook, registerPreUpdateHook, registerSimEntityListener, registerStdOutSimEntityListener, removeDelegationForOperation, resetEntity, setIgnoreEventListReset, setName, setUnknownNotificationTypePolicy, setUnknownOperationPolicy, toString, unregisterSimEntityListener, unregisterStdOutSimEntityListener, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.javades.jqueues.r5.entity.jq.queue.SimQueue

arrive, getAutoRevocationPolicy, getJobs, getJobsInServiceArea, getJobsInWaitingArea, getNumberOfJobs, getNumberOfJobsInServiceArea, getNumberOfJobsInWaitingArea, getServerAccessCredits, isJob, isJobInServiceArea, isJobInWaitingArea, isQueueAccessVacation, revoke, revoke, setAutoRevocationPolicy, setQueueAccessVacation, setServerAccessCredits

Methods inherited from interface org.javades.jqueues.r5.entity.SimEntity

doAfterNotifications, doOperation, getEventList, getLastUpdateTime, getRegisteredNotificationTypes, getRegisteredOperations, getSimEntityListeners, getUnknownNotificationTypePolicy, getUnknownOperationPolicy, isIgnoreEventListReset, registerSimEntityListener, resetEntity, setIgnoreEventListReset, setName, setUnknownNotificationTypePolicy, setUnknownOperationPolicy, unregisterSimEntityListener, update

Methods inherited from interface org.javades.jsimulation.r5.SimEventListResetListener

notifyEventListReset

Field Detail

jobsQoSMap

protected final Map<P,Set<J extends SimJob>> jobsQoSMap

Constructor Detail

HOL_PS

public HOL_PS(org.javades.jsimulation.r5.SimEventList eventList,
              Class<P> qosClass,
              P defaultJobQoS)

Creates a single-server HOL-PS queue with infinite buffer size given an event list.

Parameters:

eventList - The event list to use.

qosClass - The Java class to use for QoS behavior, non-null.

defaultJobQoS - The default QoS value to use for non-QoS jobs, non-null.

Throws:

IllegalArgumentException - If any of the arguments is null.

Method Detail

getCopySimQueue

public HOL_PS<J,Q,P> getCopySimQueue()

Returns a new HOL_PS object on the same SimEventList and the same QoS structure.

Specified by:

getCopySimQueue in interface SimQueue<J extends SimJob,Q extends HOL_PS>

Specified by:

getCopySimQueue in interface SimQueueQoS<J extends SimJob,Q extends HOL_PS,P>

Returns:

A new HOL_PS object on the same SimEventList and the same QoS structure.

See Also:

AbstractSimEntity.getEventList(), getQoSClass(), getDefaultJobQoS()

toStringDefault

public String toStringDefault()

Returns "HOL-PS".

Specified by:

toStringDefault in interface SimEntity

Overrides:

toStringDefault in class AbstractSimQueue<J extends SimJob,Q extends HOL_PS>

Returns:

"HOL-PS".

See Also:

SimEntity.setName(java.lang.String), Object.toString()

getQoSClass

public final Class<? extends P> getQoSClass()

Description copied from interface: SimQueueOrJobQoS

Overridden in order to restrict the return type. Returns the Java class used for QoS behavior.

If the SimEntity does not support QoS, null should be returned.

The default implementation returns null.

Specified by:

getQoSClass in interface SimQoS<J extends SimJob,Q extends HOL_PS>

Specified by:

getQoSClass in interface SimQueueOrJobQoS<J extends SimJob,Q extends HOL_PS,P>

Returns:

The Java class used for QoS behavior, may be null.

setQoSClass

public final void setQoSClass(Class<? extends P> qosClass)

Calls super method (in order to make implementation final).

Specified by:

setQoSClass in interface SimQueueOrJobQoS<J extends SimJob,Q extends HOL_PS,P>

Parameters:

qosClass - The new Java class used for QoS behavior, may be null.

getQoS

public final P getQoS()

Returns null, since the QoS value of a queue has no meaning.

Specified by:

getQoS in interface SimQoS<J extends SimJob,Q extends HOL_PS>

Specified by:

getQoS in interface SimQueueOrJobQoS<J extends SimJob,Q extends HOL_PS,P>

Returns:

null.

setQoS

public final void setQoS(P qos)

Calls super method (in order to make implementation final).

Specified by:

setQoS in interface SimQueueOrJobQoS<J extends SimJob,Q extends HOL_PS,P>

Parameters:

qos - The new QoS value, may be null.

getDefaultJobQoS

public final P getDefaultJobQoS()

Description copied from interface: SimQueueQoS

Gets the default QoS value used by this queue for jobs that have null QoS value.

Specified by:

getDefaultJobQoS in interface SimQueueQoS<J extends SimJob,Q extends HOL_PS,P>

Returns:

The default QoS value used by this queue for jobs that have null QoS value.

See Also:

SimQoS.getQoS()

getJobsQoSMap

public final Map<P,Set<J>> getJobsQoSMap()

Description copied from interface: SimQueueQoS

Gets the mapping QoS values onto jobs currently visiting this queue with that particular QoS value.

Each SimJob present returning (valid) non-null QoS value from SimQoS.getQoS() must be in present in only that value set, and the union of these value sets must exactly match SimQueue.getJobs(). Jobs returning null from SimQoS.getQoS() must be put in a value set corresponding to SimQueueQoS.getDefaultJobQoS().

Note that many concrete subclasses will impose an ordering on the keys and/or on the value sets.

Specified by:

getJobsQoSMap in interface SimQueueQoS<J extends SimJob,Q extends HOL_PS,P>

Returns:

The mapping QoS values onto jobs currently visiting this queue with that particular QoS value.

See Also:

SimQueue.getJobs(), SimQoS.getQoS(), SimQueueQoS.getDefaultJobQoS()

resetEntitySubClass

protected void resetEntitySubClass()

Calls super method and clears jobsQoSMap.

Overrides:

resetEntitySubClass in class AbstractEgalitarianProcessorSharingSimQueue<J extends SimJob,Q extends HOL_PS>

See Also:

SimEntity.resetEntity()

insertJobInQueueUponArrival

protected final void insertJobInQueueUponArrival(J job,
                                                 double time)

Inserts the job into jobsQoSMap.

Specified by:

insertJobInQueueUponArrival in class AbstractSimQueue<J extends SimJob,Q extends HOL_PS>

Parameters:

job - The job that arrived.

time - The current time (i.e., arrival time of the job).

See Also:

AbstractSimQueue.arrive(double, J), jobsQoSMap, rescheduleAfterArrival(J, double)

rescheduleAfterArrival

protected final void rescheduleAfterArrival(J job,
                                            double time)

Starts the arrived job if server-access credits are available and there are no other jobs present with the same QoS value.

Specified by:

rescheduleAfterArrival in class AbstractSimQueue<J extends SimJob,Q extends HOL_PS>

Parameters:

job - The job that arrived (and is already present in AbstractSimQueue.getJobs()).

time - The current time (i.e., the arrival time of the job).

See Also:

AbstractSimQueue.hasServerAcccessCredits(), SimQueueQoSUtils.getAndCheckJobQoS(J, Q), jobsQoSMap, AbstractSimQueue.start(double, J), AbstractSimQueue.isJobInServiceArea(org.javades.jqueues.r5.entity.jq.job.SimJob), insertJobInQueueUponArrival(J, double)

removeJobFromQueueUponDrop

protected final void removeJobFromQueueUponDrop(J job,
                                                double time)

Throws IllegalStateException.

Specified by:

removeJobFromQueueUponDrop in class AbstractSimQueue<J extends SimJob,Q extends HOL_PS>

Parameters:

job - The job that is to be dropped.

time - The current time (i.e., drop time of the job).

Throws:

IllegalStateException - Always, as this SimQueue does not drop jobs.

See Also:

AbstractSimQueue.drop(J, double)

rescheduleAfterDrop

protected final void rescheduleAfterDrop(J job,
                                         double time)

Throws IllegalStateException.

Specified by:

rescheduleAfterDrop in class AbstractSimQueue<J extends SimJob,Q extends HOL_PS>

Parameters:

job - The jobs that was dropped.

time - The current time (i.e., drop time of the job).

Throws:

IllegalStateException - Always, as this SimQueue does not drop jobs.

See Also:

AbstractSimQueue.drop(J, double)

removeJobFromQueueUponRevokation

protected final void removeJobFromQueueUponRevokation(J job,
                                                      double time,
                                                      boolean auto)

Removes the jobs from the internal data structures.

Core method for removing a job for both revocations and departures from AbstractEgalitarianProcessorSharingSimQueue.

Removes the job from jobsQoSMap, and if needed AbstractEgalitarianProcessorSharingSimQueue.virtualDepartureTime.

Specified by:

removeJobFromQueueUponRevokation in class AbstractSimQueue<J extends SimJob,Q extends HOL_PS>

Parameters:

job - The job that is to be revoked.

time - The current time (i.e., revocation time of the job).

auto - Whether or not this applies to an auto-revocation.

See Also:

AbstractSimQueue.revoke(double, J, boolean), AbstractSimQueue.autoRevoke(double, J), AbstractSimQueue.isJobInServiceArea(org.javades.jqueues.r5.entity.jq.job.SimJob), jobsQoSMap, AbstractEgalitarianProcessorSharingSimQueue.virtualDepartureTime, rescheduleAfterRevokation(J, double, boolean)

rescheduleAfterRevokation

protected final void rescheduleAfterRevokation(J job,
                                               double time,
                                               boolean auto)

Attempts to start a job of the same QoS value as the job that was revoked (or departed); calls AbstractEgalitarianProcessorSharingSimQueue.rescheduleDepartureEvent() if that fails.

Core method for rescheduling after both revocations and departures (rescheduleAfterDeparture(J, double)).

Specified by:

rescheduleAfterRevokation in class AbstractSimQueue<J extends SimJob,Q extends HOL_PS>

Parameters:

job - The jobs that was successfully revoked.

time - The current time (i.e., revocation time of the job).

auto - Whether or not this applies to an auto-revocation.

See Also:

rescheduleAfterDeparture(J, double), SimQueueQoSUtils.getAndCheckJobQoS(J, Q), jobsQoSMap, AbstractSimQueue.hasServerAcccessCredits(), AbstractSimQueue.isJobInServiceArea(org.javades.jqueues.r5.entity.jq.job.SimJob), AbstractSimQueue.start(double, J), AbstractEgalitarianProcessorSharingSimQueue.rescheduleDepartureEvent(), removeJobFromQueueUponRevokation(J, double, boolean)

setServerAccessCreditsSubClass

protected final void setServerAccessCreditsSubClass()

Calls super method (in order to make implementation final).

Overrides:

setServerAccessCreditsSubClass in class AbstractSimQueue<J extends SimJob,Q extends HOL_PS>

See Also:

AbstractSimQueue.getServerAccessCredits(), AbstractSimQueue.setServerAccessCredits(double, int), AbstractSimQueue.rescheduleForNewServerAccessCredits(double)

rescheduleForNewServerAccessCredits

protected final void rescheduleForNewServerAccessCredits(double time)

Starts jobs eligible to start in arrival order as long as there are server-access credits.

A job is eligible to start if it resides in the waiting area and the service area currently does not contain a (another) job with the same QoS value.

Specified by:

rescheduleForNewServerAccessCredits in class AbstractSimQueue<J extends SimJob,Q extends HOL_PS>

Parameters:

time - The current time (i.e., the time at which new server-access credits became available).

See Also:

AbstractSimQueue.hasJobsInWaitingArea(), AbstractSimQueue.getJobsInWaitingArea(), SimQueueQoSUtils.getAndCheckJobQoS(J, Q), jobsQoSMap, AbstractSimQueue.isJobInServiceArea(org.javades.jqueues.r5.entity.jq.job.SimJob), AbstractSimQueue.start(double, J), AbstractSimQueue.hasServerAcccessCredits()

isStartArmed

public final boolean isStartArmed()

Returns true if there are no jobs in the queue.

Specified by:

isStartArmed in interface SimQueue<J extends SimJob,Q extends HOL_PS>

Returns:

True if there are no jobs in the queue.

See Also:

AbstractSimQueue.getNumberOfJobs()

rescheduleAfterDeparture

protected final void rescheduleAfterDeparture(J departedJob,
                                              double time)

Calls rescheduleAfterRevokation(J, double, boolean).

Overrides:

rescheduleAfterDeparture in class AbstractEgalitarianProcessorSharingSimQueue<J extends SimJob,Q extends HOL_PS>

Parameters:

departedJob - The departed job.

time - The departure (current) time.

See Also:

rescheduleAfterRevokation(J, double, boolean), AbstractEgalitarianProcessorSharingSimQueue.removeJobFromQueueUponDeparture(J, double)