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

Class AbstractEgalitarianProcessorSharingSimQueue<J extends SimJob,Q extends AbstractEgalitarianProcessorSharingSimQueue>

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>

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

All Implemented Interfaces:

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

Direct Known Subclasses:

HOL_PS, PS

public abstract class AbstractEgalitarianProcessorSharingSimQueue<J extends SimJob,Q extends AbstractEgalitarianProcessorSharingSimQueue>
extends AbstractProcessorSharingSimQueue<J,Q>
implements SimQueue<J,Q>

An abstract base class for egalitarian processor-sharing queueing disciplines.

In egalitarian processor-sharing queueing disciplines, all jobs in the service area are served simultaneously at equal rates, until completion of one of them. The service rate, naturally, is inversely proportional to the number of jobs in the service area.

The remaining degrees of freedom to sub-classes are when to start which jobs.

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:

PS, 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 HashMapWithPreImageAndOrderedValueSet<J,Double>	virtualDepartureTime The mapping from jobs in AbstractSimQueue.getJobsInServiceArea() to their respective virtual departure times.

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

Modifier	Constructor and Description
protected	AbstractEgalitarianProcessorSharingSimQueue(org.javades.jsimulation.r5.SimEventList eventList, int bufferSize, int numberOfServers) Creates a egalitarian processor-sharing queue given an event list, buffer size and number of servers.

Method Summary

Modifier and Type	Method and Description
protected double	getServiceTimeForJob(J job) Calls super method (in order to make implementation final).
protected double	getVirtualTime() Returns the current virtual time.
protected void	insertJobInQueueUponStart(J job, double time) Performs sanity checks, and administers the job's virtual departure time.
protected void	removeJobFromQueueUponDeparture(J departingJob, double time) Calls AbstractSimQueue.removeJobFromQueueUponRevokation(J, double, boolean) for the departed job.
protected void	rescheduleAfterDeparture(J departedJob, double time) Calls rescheduleDepartureEvent().
protected void	rescheduleAfterStart(J job, double time) Reschedules due to the start of a job.
protected void	rescheduleDepartureEvent() Reschedules the single departure event for this queue.
protected void	resetEntitySubClass() Calls super method, resets the virtual time to zero and clears the virtual departure time map.
protected void	updateVirtualTime(double newTime) Updates the virtual time.

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, insertJobInQueueUponArrival, isJob, isJobInServiceArea, isJobInWaitingArea, isQueueAccessVacation, registerStdOutSimQueueListener, removeJobFromQueueUponDrop, removeJobFromQueueUponRevokation, rescheduleAfterArrival, rescheduleAfterDrop, rescheduleAfterRevokation, rescheduleForNewServerAccessCredits, revoke, revoke, scheduleDepartureEvent, scheduleJobArrival, setAutoRevocationPolicy, setQueueAccessVacation, setServerAccessCredits, setServerAccessCreditsSubClass, start, takeServerAccessCredit, toStringDefault, 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, getCopySimQueue, getJobs, getJobsInServiceArea, getJobsInWaitingArea, getNumberOfJobs, getNumberOfJobsInServiceArea, getNumberOfJobsInWaitingArea, getServerAccessCredits, isJob, isJobInServiceArea, isJobInWaitingArea, isQueueAccessVacation, isStartArmed, 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, toStringDefault, unregisterSimEntityListener, update

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

notifyEventListReset

Methods inherited from interface org.javades.jqueues.r5.entity.jq.SimQoS

getQoS, getQoSClass

Field Detail

virtualDepartureTime

protected final HashMapWithPreImageAndOrderedValueSet<J extends SimJob,Double> virtualDepartureTime

The mapping from jobs in AbstractSimQueue.getJobsInServiceArea() to their respective virtual departure times.

The special extensions to TreeMap allow for efficient determination of the pre-images of virtual departure times.

Constructor Detail

AbstractEgalitarianProcessorSharingSimQueue

protected AbstractEgalitarianProcessorSharingSimQueue(org.javades.jsimulation.r5.SimEventList eventList,
                                                      int bufferSize,
                                                      int numberOfServers)

Creates a egalitarian processor-sharing queue given an event list, buffer size and number of servers.

The constructor registers a pre-update hook that sets the virtual time upon updates.

Parameters:

eventList - The event list to use.

bufferSize - The buffer size (non-negative), Integer.MAX_VALUE is interpreted as infinity.

numberOfServers - The number of servers (non-negative), Integer.MAX_VALUE is interpreted as infinity.

See Also:

AbstractSimEntity.registerPreUpdateHook(java.util.function.DoubleConsumer), updateVirtualTime(double)

Method Detail

getVirtualTime

protected final double getVirtualTime()

Returns the current virtual time.

The virtual time for an AbstractEgalitarianProcessorSharingSimQueue is zero when no jobs are being executed, and increases in time inversely proportional to the number of jobs in execution. Hence, if there is only one job in execution, the virtual time increases at the same rate as the ("real") time, but if N > 1 jobs are being executed, the virtual time increases linearly with slope 1/N in time.

The virtual time is kept consistent in AbstractSimEntity.update(double).

Note that with an AbstractEgalitarianProcessorSharingSimQueue, the virtual departure time of a job can be calculated at the time the job is taken into service; it does not change afterwards (as the required service time cannot change during a queue visit, by contract of SimQueue).

Returns:

The current virtual time.

See Also:

AbstractSimEntity.update(double)

resetEntitySubClass

protected void resetEntitySubClass()

Calls super method, resets the virtual time to zero and clears the virtual departure time map.

Overrides:

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

See Also:

SimEntity.resetEntity()

updateVirtualTime

protected final void updateVirtualTime(double newTime)

Updates the virtual time.

This method is called as an update hook, and not meant to be called from user code (in sub-classes). It is left protected for javadoc.

Parameters:

newTime - The new time.

See Also:

AbstractSimQueue.getNumberOfJobsInServiceArea(), getVirtualTime(), AbstractSimEntity.getLastUpdateTime(), AbstractSimEntity.registerPreUpdateHook(java.util.function.DoubleConsumer)

insertJobInQueueUponStart

protected final void insertJobInQueueUponStart(J job,
                                               double time)

Performs sanity checks, and administers the job's virtual departure time.

Specified by:

insertJobInQueueUponStart in class AbstractSimQueue<J extends SimJob,Q extends AbstractEgalitarianProcessorSharingSimQueue>

Parameters:

job - The job that starts.

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

See Also:

getServiceTimeForJob(J), getVirtualTime(), virtualDepartureTime

rescheduleAfterStart

protected final void rescheduleAfterStart(J job,
                                          double time)

Reschedules due to the start of a job.

• If the requested service time of the job is zero, the job departs immediately.
• If the requested service time of the job is finite and the current time is positive of negative infinity, the job departs immediately.
• Otherwise, if the requested service time is finite, a single departure event for the job is scheduled.
• (If the required service time is infinite, this method does nothing.)

Specified by:

rescheduleAfterStart in class AbstractSimQueue<J extends SimJob,Q extends AbstractEgalitarianProcessorSharingSimQueue>

Parameters:

job - The job that started (and is already present in AbstractSimQueue.getJobsInServiceArea().

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

See Also:

virtualDepartureTime, getServiceTimeForJob(J), rescheduleDepartureEvent(), AbstractSimQueue.depart(double, J)

getServiceTimeForJob

protected final double getServiceTimeForJob(J job)

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

Overrides:

getServiceTimeForJob in class AbstractSimQueue<J extends SimJob,Q extends AbstractEgalitarianProcessorSharingSimQueue>

Parameters:

job - The job, non-null.

Returns:

The result from the super method.

removeJobFromQueueUponDeparture

protected final void removeJobFromQueueUponDeparture(J departingJob,
                                                     double time)

Calls AbstractSimQueue.removeJobFromQueueUponRevokation(J, double, boolean) for the departed job.

Specified by:

removeJobFromQueueUponDeparture in class AbstractSimQueue<J extends SimJob,Q extends AbstractEgalitarianProcessorSharingSimQueue>

Parameters:

departingJob - The job that departs.

time - The departure (current) time.

See Also:

AbstractSimQueue.removeJobFromQueueUponRevokation(J, double, boolean), rescheduleAfterDeparture(J, double)

rescheduleAfterDeparture

protected void rescheduleAfterDeparture(J departedJob,
                                        double time)

Calls rescheduleDepartureEvent().

May be overridden/augmented by sub-classes if additional actions/checks are required upon a departure (e.g., in HOL_PS.

Specified by:

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

Parameters:

departedJob - The departed job.

time - The departure (current) time.

See Also:

rescheduleDepartureEvent(), removeJobFromQueueUponDeparture(J, double)

rescheduleDepartureEvent

protected final void rescheduleDepartureEvent()

Reschedules the single departure event for this queue.

First, cancels a pending departure event. Then, determines which job in the service area (if any) is to depart first through virtualDepartureTime, and what its remaining service time is.

• If the remaining service time of the job is zero, the job departs immediately.
• If the remaining service time of the job is finite and the current time is positive of negative infinity, the job departs immediately.
• Otherwise, if the remaining service time is finite, a single departure event for the job is scheduled.
• (If the remaining service time is infinite, this method does nothing.)

See Also:

AbstractSimEntity.getLastUpdateTime(), AbstractSimQueue.getDepartureEvents(), AbstractSimQueue.cancelDepartureEvent(org.javades.jqueues.r5.entity.jq.SimJQEvent.Departure<J, Q>), AbstractSimQueue.getJobsInServiceArea(), virtualDepartureTime, getVirtualTime(), AbstractSimQueue.depart(double, J), AbstractSimQueue.scheduleDepartureEvent(double, J)