graphvent/resource.go

package graphvent

import (
  "fmt"
  "sync"
  "errors"
)

// Resources propagate update up to multiple parents, and not downwards
// (subscriber to team won't get update to alliance, but subscriber to alliance will get update to team)
func (resource * BaseResource) PropagateUpdate(signal GraphSignal) {

  if signal.Downwards() == false {
    // Child->Parent, resource updates parent resources
    resource.connection_lock.Lock()
    defer resource.connection_lock.Unlock()
    for _, parent := range resource.Parents() {
      SendUpdate(parent, signal)
    }
  } else {
    // Parent->Child, resource updates lock holder
    resource.lock_holder_lock.Lock()
    defer resource.lock_holder_lock.Unlock()
    if resource.lock_holder != nil {
      SendUpdate(resource.lock_holder, signal)
    }

    resource.connection_lock.Lock()
    defer resource.connection_lock.Unlock()
    for _, child := range(resource.children) {
      SendUpdate(child, signal)
    }
  }
}

// Resource is the interface that DAG nodes are made from
// A resource needs to be able to represent Logical entities and connections to physical entities.
// A resource lock could be aborted at any time if this connection is broken, if that happens the event locking it must be aborted
// The device connection should be maintained as much as possible(requiring some reconnection behaviour in the background)
type Resource interface {
  GraphNode
  Owner() GraphNode
  Children() []Resource
  Parents() []Resource

  AddParent(parent Resource)
  AddChild(child Resource)
  LockConnections()
  UnlockConnections()

  SetOwner(owner GraphNode)
  LockState()
  UnlockState()

  String() string

  lock(node GraphNode) error
  unlock(node GraphNode) error
}

func (resource * BaseResource) String() string {
  return resource.Name()
}

// Recurse up cur's parents to ensure r is not present
func checkIfParent(r Resource, cur Resource) bool {
  if r == nil || cur == nil {
    panic("Cannot recurse DAG with nil")
  }

  if r.ID() == cur.ID() {
    return true
  }

  cur.LockConnections()
  defer cur.UnlockConnections()
  for _, p := range(cur.Parents()) {
    if checkIfParent(r, p) == true {
      return true
    }
  }

  return false
}

// Recurse doen cur's children to ensure r is not present
func checkIfChild(r Resource, cur Resource) bool {
  if r == nil || cur == nil {
    panic("Cannot recurse DAG with nil")
  }

  if r.ID() == cur.ID() {
    return true
  }

  cur.LockConnections()
  defer cur.UnlockConnections()
  for _, c := range(cur.Children()) {
    if checkIfChild(r, c) == true {
      return true
    }
  }

  return false
}

func UnlockResource(resource Resource, node GraphNode) error {
  var err error = nil
  resource.LockState()
  defer resource.UnlockState()
  if resource.Owner() == nil {
    return errors.New("Resource already unlocked")
  }

  if resource.Owner().ID() != node.ID() {
    return errors.New("Resource not locked by parent, unlock failed")
  }

  var lock_err error = nil
  for _, child := range resource.Children() {
    err := UnlockResource(child, node)
    if err != nil {
      lock_err = err
      break
    }
  }

  if lock_err != nil {
    return fmt.Errorf("Resource failed to unlock: %s", lock_err)
  }

  resource.SetOwner(node.Delegator(resource.ID()))

  err = resource.unlock(node)
  if err != nil {
    return errors.New("Failed to unlock resource")
  }

  return nil
}

func isAllowedToTakeLock(node GraphNode, current_owner GraphNode) bool {
  for _, allowed := range(current_owner.Allowed()) {
    if allowed.ID() == node.ID() {
      return true
    }
  }
  return false
}

func LockResource(resource Resource, node GraphNode) error {
  resource.LockState()
  defer resource.UnlockState()

  if resource.Owner() != nil {
    // Check if node is allowed to take a lock from resource.Owner()
    if isAllowedToTakeLock(node, resource.Owner()) == false {
      return fmt.Errorf("%s is not allowed to take a lock from %s, allowed: %+v", node.Name(), resource.Owner().Name(), resource.Owner().Allowed())
    }
  }

  err := resource.lock(node)
  if err != nil {
    return fmt.Errorf("Failed to lock resource: %s", err)
  }

  var lock_err error = nil
  locked_resources := []Resource{}
  for _, child := range resource.Children() {
    err := LockResource(child, node)
    if err != nil{
      lock_err = err
      break
    }
    locked_resources = append(locked_resources, child)
  }

  if lock_err != nil {
    return fmt.Errorf("Resource failed to lock: %s", lock_err)
  }

  Log.Logf("resource", "Locked %s", resource.Name())
  node.TakeLock(resource)
  resource.SetOwner(node)

  return nil
}

// BaseResource is the most basic resource that can exist in the DAG
// It holds a single state variable, which contains a pointer to the event that is locking it
type BaseResource struct {
  BaseNode
  parents []Resource
  children []Resource
  connection_lock sync.Mutex
  lock_holder GraphNode
  lock_holder_lock sync.Mutex
  state_lock sync.Mutex
}

func (resource * BaseResource) SetOwner(owner GraphNode) {
  resource.lock_holder_lock.Lock()
  resource.lock_holder = owner
  resource.lock_holder_lock.Unlock()
}

func (resource * BaseResource) LockState() {
  resource.state_lock.Lock()
}

func (resource * BaseResource) UnlockState() {
  resource.state_lock.Unlock()
}

func (resource * BaseResource) Owner() GraphNode {
  return resource.lock_holder
}

//BaseResources don't check anything special when locking/unlocking
func (resource * BaseResource) lock(node GraphNode) error {
  return nil
}

func (resource * BaseResource) unlock(node GraphNode) error {
  return nil
}

func (resource * BaseResource) Children() []Resource {
  return resource.children
}

func (resource * BaseResource) Parents() []Resource {
  return resource.parents
}

func (resource * BaseResource) LockConnections() {
  resource.connection_lock.Lock()
}

func (resource * BaseResource) UnlockConnections() {
  resource.connection_lock.Unlock()
}

func (resource * BaseResource) AddParent(parent Resource) {
  resource.parents = append(resource.parents, parent)
}

func (resource * BaseResource) AddChild(child Resource) {
  resource.children = append(resource.children, child)
}

func NewBaseResource(name string, description string) BaseResource {
  resource := BaseResource{
    BaseNode: NewBaseNode(name, description, randid()),
    parents: []Resource{},
    children: []Resource{},
  }

  return resource
}

func LinkResource(resource Resource, child Resource) error {
  if child == nil || resource == nil {
    return fmt.Errorf("Will not connect nil to resource DAG")
  } else if child.ID() == resource.ID() {
    return fmt.Errorf("Will not connect resource to itself")
  }

  if checkIfChild(resource, child) {
    return fmt.Errorf("%s is a child of %s, cannot add as parent", resource.Name(), child.Name())
  }

  for _, p := range(resource.Parents()) {
    if checkIfParent(child, p) {
      return fmt.Errorf("Will not add %s as a parent of itself", child.Name())
    }
  }

  child.AddParent(resource)
  resource.AddChild(child)
  return nil
}

func LinkResources(resource Resource, children []Resource) error {
  for _, c := range(children) {
    err := LinkResource(resource, c)
    if err != nil {
      return err
    }
  }
  return nil
}

func NewResource(name string, description string, children []Resource) (* BaseResource, error) {
  resource := NewBaseResource(name, description)
  resource_ptr := &resource

  err := LinkResources(resource_ptr, children)
  if err != nil {
    return nil, err
  }

  return resource_ptr, nil
}