code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/charging/VMChargingBehavior.scala

   1 /*
   2  * Copyright 2011-2012 GRNET S.A. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or
   5  * without modification, are permitted provided that the following
   6  * conditions are met:
   7  *
   8  *   1. Redistributions of source code must retain the above
   9  *      copyright notice, this list of conditions and the following
  10  *      disclaimer.
  11  *
  12  *   2. Redistributions in binary form must reproduce the above
  13  *      copyright notice, this list of conditions and the following
  14  *      disclaimer in the documentation and/or other materials
  15  *      provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * The views and conclusions contained in the software and
  31  * documentation are those of the authors and should not be
  32  * interpreted as representing official policies, either expressed
  33  * or implied, of GRNET S.A.
  34  */
  35
  36 package gr.grnet.aquarium.charging
  37
  38 import gr.grnet.aquarium.{AquariumInternalError, AquariumException}
  39 import gr.grnet.aquarium.event.model.resource.ResourceEventModel
  40 import gr.grnet.aquarium.logic.accounting.dsl.Timeslot
  41 import scala.collection.mutable
  42 import VMChargingBehavior.Selectors.Power
  43 import gr.grnet.aquarium.policy.{FullPriceTable, EffectivePriceTable}
  44
  45 /**
  46  * The new [[gr.grnet.aquarium.charging.ChargingBehavior]] for VMs usage.
  47  *
  48  * @author Christos KK Loverdos <loverdos@gmail.com>
  49  */
  50 final class VMChargingBehavior
  51     extends ChargingBehavior(
  52       ChargingBehaviorAliases.vmtime,
  53       Set(ChargingBehaviorNameInput, UnitPriceInput, TimeDeltaInput),
  54       List(List(Power.powerOn, Power.powerOff))) {
  55
  56   protected def computeSelectorPath(
  57      chargingData: mutable.Map[String, Any],
  58      currentResourceEvent: ResourceEventModel,
  59      referenceTimeslot: Timeslot,
  60      previousValue: Double,
  61      totalCredits: Double,
  62      oldAccumulatingAmount: Double,
  63      newAccumulatingAmount: Double
  64  ): List[String] = {
  65     // FIXME
  66     List(Power.powerOn) // compute prices for power-on state
  67   }
  68   /**
  69    *
  70    * @param oldAmount is ignored
  71    * @param newEventValue
  72    * @return
  73    */
  74   def computeNewAccumulatingAmount(oldAmount: Double, newEventValue: Double, details: Map[String, String]): Double = {
  75     newEventValue
  76   }
  77
  78   def getResourceInstanceInitialAmount: Double = {
  79     0.0
  80   }
  81
  82   override def isBillableEvent(event: ResourceEventModel) = {
  83     // ON events do not contribute, only OFF ones.
  84     VMChargingBehaviorValues.isOFFValue(event.value)
  85   }
  86
  87   /**
  88    * This is called when we have the very first event for a particular resource instance, and we want to know
  89    * if it is billable or not.
  90    */
  91   def isBillableFirstEvent(event: ResourceEventModel) = {
  92     false
  93   }
  94
  95   def mustGenerateDummyFirstEvent = false // should be handled by the implicit OFFs
  96
  97   def supportsImplicitEvents = {
  98     true
  99   }
 100
 101   def mustConstructImplicitEndEventFor(resourceEvent: ResourceEventModel) = {
 102     // If we have ON events with no OFF companions at the end of the billing period,
 103     // then we must generate implicit OFF events.
 104     VMChargingBehaviorValues.isONValue(resourceEvent.value)
 105   }
 106
 107   def constructImplicitEndEventFor(resourceEvent: ResourceEventModel, newOccurredMillis: Long) = {
 108     assert(supportsImplicitEvents && mustConstructImplicitEndEventFor(resourceEvent))
 109     assert(VMChargingBehaviorValues.isONValue(resourceEvent.value))
 110
 111     val details = resourceEvent.details
 112     val newDetails = ResourceEventModel.setAquariumSyntheticAndImplicitEnd(details)
 113     val newValue   = VMChargingBehaviorValues.OFF
 114
 115     resourceEvent.withDetailsAndValue(newDetails, newValue, newOccurredMillis)
 116   }
 117
 118   def constructImplicitStartEventFor(resourceEvent: ResourceEventModel) = {
 119     throw new AquariumInternalError("constructImplicitStartEventFor() Not compliant with %s".format(this))
 120   }
 121 }
 122
 123 object VMChargingBehavior {
 124   object Selectors {
 125     object Power {
 126       // When the VM is powered on
 127       final val powerOn = "powerOn"
 128       // When the VM is powered off
 129       final val powerOff = "powerOff"
 130     }
 131   }
 132 }