cgrates/services/cores.go

/*
Real-time Online/Offline Charging System (OCS) for Telecom & ISP environments
Copyright (C) ITsysCOM GmbH

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>
*/

package services

import (
	"fmt"
	"os"
	"sync"

	"github.com/cgrates/birpc"
	"github.com/cgrates/birpc/context"
	"github.com/cgrates/cgrates/commonlisteners"
	"github.com/cgrates/cgrates/config"
	"github.com/cgrates/cgrates/cores"
	"github.com/cgrates/cgrates/engine"
	"github.com/cgrates/cgrates/servmanager"
	"github.com/cgrates/cgrates/utils"
)

// NewCoreService returns the Core Service
func NewCoreService(cfg *config.CGRConfig, caps *engine.Caps, clSChan chan *commonlisteners.CommonListenerS,
	internalCoreSChan chan birpc.ClientConnector, anzChan chan *AnalyzerService,
	fileCPU *os.File, shdWg *sync.WaitGroup,
	srvDep map[string]*sync.WaitGroup,
	srvIndexer *servmanager.ServiceIndexer) *CoreService {
	return &CoreService{
		shdWg:      shdWg,
		connChan:   internalCoreSChan,
		cfg:        cfg,
		caps:       caps,
		fileCPU:    fileCPU,
		clSChan:    clSChan,
		anzChan:    anzChan,
		srvDep:     srvDep,
		csCh:       make(chan *cores.CoreS, 1),
		srvIndexer: srvIndexer,
		stateDeps:  NewStateDependencies([]string{utils.StateServiceUP}),
	}
}

// CoreService implements Service interface
type CoreService struct {
	mu sync.RWMutex

	anzChan chan *AnalyzerService
	clSChan chan *commonlisteners.CommonListenerS

	cS *cores.CoreS
	cl *commonlisteners.CommonListenerS

	fileCPU  *os.File
	caps     *engine.Caps
	csCh     chan *cores.CoreS
	stopChan chan struct{}
	shdWg    *sync.WaitGroup
	connChan chan birpc.ClientConnector
	cfg      *config.CGRConfig
	srvDep   map[string]*sync.WaitGroup

	intRPCconn birpc.ClientConnector       // expose API methods over internal connection
	srvIndexer *servmanager.ServiceIndexer // access directly services from here
	stateDeps  *StateDependencies          // channel subscriptions for state changes
}

// Start should handle the service start
func (cS *CoreService) Start(ctx *context.Context, shtDw context.CancelFunc) error {
	if cS.IsRunning() {
		return utils.ErrServiceAlreadyRunning
	}

	cS.cl = <-cS.clSChan
	cS.clSChan <- cS.cl
	anz := <-cS.anzChan
	cS.anzChan <- anz

	cS.mu.Lock()
	defer cS.mu.Unlock()
	utils.Logger.Info(fmt.Sprintf("<%s> starting <%s> subsystem", utils.CoreS, utils.CoreS))
	cS.stopChan = make(chan struct{})
	cS.cS = cores.NewCoreService(cS.cfg, cS.caps, cS.fileCPU, cS.stopChan, cS.shdWg, shtDw)
	cS.csCh <- cS.cS
	srv, err := engine.NewService(cS.cS)
	if err != nil {
		return err
	}
	if !cS.cfg.DispatcherSCfg().Enabled {
		for _, s := range srv {
			cS.cl.RpcRegister(s)
		}
	}

	cS.intRPCconn = anz.GetInternalCodec(srv, utils.CoreS)
	cS.connChan <- cS.intRPCconn
	close(cS.stateDeps.StateChan(utils.StateServiceUP))
	return nil
}

// Reload handles the change of config
func (cS *CoreService) Reload(*context.Context, context.CancelFunc) error {
	return nil
}

// Shutdown stops the service
func (cS *CoreService) Shutdown() error {
	cS.mu.Lock()
	defer cS.mu.Unlock()
	cS.cS.Shutdown()
	close(cS.stopChan)
	cS.cS.StopCPUProfiling()
	cS.cS.StopMemoryProfiling()
	cS.cS = nil
	<-cS.connChan
	<-cS.csCh
	cS.cl.RpcUnregisterName(utils.CoreSv1)
	return nil
}

// IsRunning returns if the service is running
func (cS *CoreService) IsRunning() bool {
	cS.mu.RLock()
	defer cS.mu.RUnlock()
	return cS.cS != nil
}

// ServiceName returns the service name
func (cS *CoreService) ServiceName() string {
	return utils.CoreS
}

// ShouldRun returns if the service should be running
func (cS *CoreService) ShouldRun() bool {
	return true
}

// GetCoreS returns the coreS
func (cS *CoreService) WaitForCoreS(ctx *context.Context) (cs *cores.CoreS, err error) {
	cS.mu.RLock()
	cSCh := cS.csCh
	cS.mu.RUnlock()
	select {
	case <-ctx.Done():
		err = ctx.Err()
	case cs = <-cSCh:
		cSCh <- cs
	}
	return
}

// StateChan returns signaling channel of specific state
func (cS *CoreService) StateChan(stateID string) chan struct{} {
	return cS.stateDeps.StateChan(stateID)
}

// IntRPCConn returns the internal connection used by RPCClient
func (cS *CoreService) IntRPCConn() birpc.ClientConnector {
	return cS.intRPCconn
}

func (cS *CoreService) GetCoreS() *cores.CoreS {
	cS.mu.RLock()
	defer cS.mu.RUnlock()
	return cS.cS
}