pkg/control/registry.go

   1 /*
   2 ==================================================================================
   3   Copyright (c) 2019 AT&T Intellectual Property.
   4   Copyright (c) 2019 Nokia
   5
   6    Licensed under the Apache License, Version 2.0 (the "License");
   7    you may not use this file except in compliance with the License.
   8    You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================================
  18 */
  19
  20 package control
  21
  22 import (
  23         "fmt"
  24         "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp"
  25         "sync"
  26 )
  27
  28 //-----------------------------------------------------------------------------
  29 //
  30 //-----------------------------------------------------------------------------
  31 type Registry struct {
  32         mutex       sync.Mutex
  33         register    map[uint16]*Subscription
  34         counter     uint16
  35         rtmgrClient *RtmgrClient
  36 }
  37
  38 // This method should run as a constructor
  39 func (r *Registry) Initialize(seedsn uint16) {
  40         r.register = make(map[uint16]*Subscription)
  41         r.counter = seedsn
  42 }
  43
  44 // Reserves and returns the next free sequence number
  45 func (r *Registry) ReserveSubscription(endPoint RmrEndpoint, meid *xapp.RMRMeid) (*Subscription, error) {
  46         // Check is current SequenceNumber valid
  47         // Allocate next SequenceNumber value and retry N times
  48         r.mutex.Lock()
  49         defer r.mutex.Unlock()
  50         var subs *Subscription = nil
  51         var retrytimes uint16 = 1000
  52         for ; subs == nil && retrytimes > 0; retrytimes-- {
  53                 sequenceNumber := r.counter
  54                 if r.counter == 65535 {
  55                         r.counter = 0
  56                 } else {
  57                         r.counter++
  58                 }
  59                 if _, ok := r.register[sequenceNumber]; ok == false {
  60                         subs := &Subscription{
  61                                 Seq:         sequenceNumber,
  62                                 Active:      false,
  63                                 RmrEndpoint: endPoint,
  64                                 Meid:        meid,
  65                                 Trans:       nil,
  66                         }
  67                         r.register[sequenceNumber] = subs
  68
  69                         // Update routing
  70                         r.mutex.Unlock()
  71                         err := subs.UpdateRoute(CREATE, r.rtmgrClient)
  72                         r.mutex.Lock()
  73                         if err != nil {
  74                                 if _, ok := r.register[sequenceNumber]; ok {
  75                                         delete(r.register, sequenceNumber)
  76                                 }
  77                                 return nil, err
  78                         }
  79                         return subs, nil
  80                 }
  81         }
  82         return nil, fmt.Errorf("Registry: Failed to reserves subcription. RmrEndpoint: %s, Meid: %s", endPoint, meid.RanName)
  83 }
  84
  85 func (r *Registry) GetSubscription(sn uint16) *Subscription {
  86         r.mutex.Lock()
  87         defer r.mutex.Unlock()
  88         xapp.Logger.Debug("Registry map: %v", r.register)
  89         if _, ok := r.register[sn]; ok {
  90                 return r.register[sn]
  91         }
  92         return nil
  93 }
  94
  95 func (r *Registry) DelSubscription(sn uint16) bool {
  96         r.mutex.Lock()
  97         defer r.mutex.Unlock()
  98         if _, ok := r.register[sn]; ok {
  99                 subs := r.register[sn]
 100                 delete(r.register, sn)
 101
 102                 // Update routing
 103                 r.mutex.Unlock()
 104                 err := subs.UpdateRoute(DELETE, r.rtmgrClient)
 105                 r.mutex.Lock()
 106                 if err != nil {
 107                         xapp.Logger.Error("Registry: Failed to del route. SubId: %d, RmrEndpoint: %s", subs.Seq, subs.RmrEndpoint)
 108                 }
 109                 return true
 110         }
 111         return false
 112 }