Restructure modules (#1572)
* Move portbase into monorepo * Add new simple module mgr * [WIP] Switch to new simple module mgr * Add StateMgr and more worker variants * [WIP] Switch more modules * [WIP] Switch more modules * [WIP] swtich more modules * [WIP] switch all SPN modules * [WIP] switch all service modules * [WIP] Convert all workers to the new module system * [WIP] add new task system to module manager * [WIP] Add second take for scheduling workers * [WIP] Add FIXME for bugs in new scheduler * [WIP] Add minor improvements to scheduler * [WIP] Add new worker scheduler * [WIP] Fix more bug related to new module system * [WIP] Fix start handing of the new module system * [WIP] Improve startup process * [WIP] Fix minor issues * [WIP] Fix missing subsystem in settings * [WIP] Initialize managers in constructor * [WIP] Move module event initialization to constrictors * [WIP] Fix setting for enabling and disabling the SPN module * [WIP] Move API registeration into module construction * [WIP] Update states mgr for all modules * [WIP] Add CmdLine operation support * Add state helper methods to module group and instance * Add notification and module status handling to status package * Fix starting issues * Remove pilot widget and update security lock to new status data * Remove debug logs * Improve http server shutdown * Add workaround for cleanly shutting down firewall+netquery * Improve logging * Add syncing states with notifications for new module system * Improve starting, stopping, shutdown; resolve FIXMEs/TODOs * [WIP] Fix most unit tests * Review new module system and fix minor issues * Push shutdown and restart events again via API * Set sleep mode via interface * Update example/template module * [WIP] Fix spn/cabin unit test * Remove deprecated UI elements * Make log output more similar for the logging transition phase * Switch spn hub and observer cmds to new module system * Fix log sources * Make worker mgr less error prone * Fix tests and minor issues * Fix observation hub * Improve shutdown and restart handling * Split up big connection.go source file * Move varint and dsd packages to structures repo * Improve expansion test * Fix linter warnings * Fix interception module on windows * Fix linter errors --------- Co-authored-by: Vladimir Stoilov <vladimir@safing.io>
This commit is contained in:
Daniel Hååvi
226
service/mgr/manager.go
Normal file
226
service/mgr/manager.go
Normal file
@@ -0,0 +1,226 @@
|
||||
package mgr
|
||||
|
||||
import (
|
||||
"context"
|
||||
"log/slog"
|
||||
"runtime"
|
||||
"sync/atomic"
|
||||
"time"
|
||||
)
|
||||
|
||||
// ManagerNameSLogKey is used as the logging key for the name of the manager.
|
||||
var ManagerNameSLogKey = "manager"
|
||||
|
||||
// Manager manages workers.
|
||||
type Manager struct {
|
||||
name string
|
||||
logger *slog.Logger
|
||||
|
||||
ctx context.Context
|
||||
cancelCtx context.CancelFunc
|
||||
|
||||
workerCnt atomic.Int32
|
||||
workersDone chan struct{}
|
||||
}
|
||||
|
||||
// New returns a new manager.
|
||||
func New(name string) *Manager {
|
||||
return newManager(name)
|
||||
}
|
||||
|
||||
func newManager(name string) *Manager {
|
||||
m := &Manager{
|
||||
name: name,
|
||||
logger: slog.Default().With(ManagerNameSLogKey, name),
|
||||
workersDone: make(chan struct{}),
|
||||
}
|
||||
m.ctx, m.cancelCtx = context.WithCancel(context.Background())
|
||||
return m
|
||||
}
|
||||
|
||||
// Name returns the manager name.
|
||||
func (m *Manager) Name() string {
|
||||
return m.name
|
||||
}
|
||||
|
||||
// setName sets the manager name and resets the logger to use that name.
|
||||
// Not safe for concurrent use with any other module methods.
|
||||
func (m *Manager) setName(newName string) {
|
||||
m.name = newName
|
||||
m.logger = slog.Default().With(ManagerNameSLogKey, m.name)
|
||||
}
|
||||
|
||||
// Ctx returns the worker context.
|
||||
func (m *Manager) Ctx() context.Context {
|
||||
return m.ctx
|
||||
}
|
||||
|
||||
// Cancel cancels the worker context.
|
||||
func (m *Manager) Cancel() {
|
||||
m.cancelCtx()
|
||||
}
|
||||
|
||||
// Done returns the context Done channel.
|
||||
func (m *Manager) Done() <-chan struct{} {
|
||||
return m.ctx.Done()
|
||||
}
|
||||
|
||||
// IsDone checks whether the manager context is done.
|
||||
func (m *Manager) IsDone() bool {
|
||||
return m.ctx.Err() != nil
|
||||
}
|
||||
|
||||
// LogEnabled reports whether the logger emits log records at the given level.
|
||||
// The manager context is automatically supplied.
|
||||
func (m *Manager) LogEnabled(level slog.Level) bool {
|
||||
return m.logger.Enabled(m.ctx, level)
|
||||
}
|
||||
|
||||
// Debug logs at LevelDebug.
|
||||
// The manager context is automatically supplied.
|
||||
func (m *Manager) Debug(msg string, args ...any) {
|
||||
if !m.logger.Enabled(m.ctx, slog.LevelDebug) {
|
||||
return
|
||||
}
|
||||
m.writeLog(slog.LevelDebug, msg, args...)
|
||||
}
|
||||
|
||||
// Info logs at LevelInfo.
|
||||
// The manager context is automatically supplied.
|
||||
func (m *Manager) Info(msg string, args ...any) {
|
||||
if !m.logger.Enabled(m.ctx, slog.LevelInfo) {
|
||||
return
|
||||
}
|
||||
m.writeLog(slog.LevelInfo, msg, args...)
|
||||
}
|
||||
|
||||
// Warn logs at LevelWarn.
|
||||
// The manager context is automatically supplied.
|
||||
func (m *Manager) Warn(msg string, args ...any) {
|
||||
if !m.logger.Enabled(m.ctx, slog.LevelWarn) {
|
||||
return
|
||||
}
|
||||
m.writeLog(slog.LevelWarn, msg, args...)
|
||||
}
|
||||
|
||||
// Error logs at LevelError.
|
||||
// The manager context is automatically supplied.
|
||||
func (m *Manager) Error(msg string, args ...any) {
|
||||
if !m.logger.Enabled(m.ctx, slog.LevelError) {
|
||||
return
|
||||
}
|
||||
m.writeLog(slog.LevelError, msg, args...)
|
||||
}
|
||||
|
||||
// Log emits a log record with the current time and the given level and message.
|
||||
// The manager context is automatically supplied.
|
||||
func (m *Manager) Log(level slog.Level, msg string, args ...any) {
|
||||
if !m.logger.Enabled(m.ctx, level) {
|
||||
return
|
||||
}
|
||||
m.writeLog(level, msg, args...)
|
||||
}
|
||||
|
||||
// LogAttrs is a more efficient version of Log() that accepts only Attrs.
|
||||
// The manager context is automatically supplied.
|
||||
func (m *Manager) LogAttrs(level slog.Level, msg string, attrs ...slog.Attr) {
|
||||
if !m.logger.Enabled(m.ctx, level) {
|
||||
return
|
||||
}
|
||||
|
||||
var pcs [1]uintptr
|
||||
runtime.Callers(2, pcs[:]) // skip "Callers" and "LogAttrs".
|
||||
r := slog.NewRecord(time.Now(), level, msg, pcs[0])
|
||||
r.AddAttrs(attrs...)
|
||||
_ = m.logger.Handler().Handle(m.ctx, r)
|
||||
}
|
||||
|
||||
func (m *Manager) writeLog(level slog.Level, msg string, args ...any) {
|
||||
var pcs [1]uintptr
|
||||
runtime.Callers(3, pcs[:]) // skip "Callers", "writeLog" and the calling function.
|
||||
r := slog.NewRecord(time.Now(), level, msg, pcs[0])
|
||||
r.Add(args...)
|
||||
_ = m.logger.Handler().Handle(m.ctx, r)
|
||||
}
|
||||
|
||||
// WaitForWorkers waits for all workers of this manager to be done.
|
||||
// The default maximum waiting time is one minute.
|
||||
func (m *Manager) WaitForWorkers(max time.Duration) (done bool) {
|
||||
return m.waitForWorkers(max, 0)
|
||||
}
|
||||
|
||||
// WaitForWorkersFromStop is a special version of WaitForWorkers, meant to be called from the stop routine.
|
||||
// It waits for all workers of this manager to be done, except for the Stop function.
|
||||
// The default maximum waiting time is one minute.
|
||||
func (m *Manager) WaitForWorkersFromStop(max time.Duration) (done bool) {
|
||||
return m.waitForWorkers(max, 1)
|
||||
}
|
||||
|
||||
func (m *Manager) waitForWorkers(max time.Duration, limit int32) (done bool) {
|
||||
// Return immediately if there are no workers.
|
||||
if m.workerCnt.Load() <= limit {
|
||||
return true
|
||||
}
|
||||
|
||||
// Setup timers.
|
||||
reCheckDuration := 10 * time.Millisecond
|
||||
if max <= 0 {
|
||||
max = time.Minute
|
||||
}
|
||||
reCheck := time.NewTimer(reCheckDuration)
|
||||
maxWait := time.NewTimer(max)
|
||||
defer reCheck.Stop()
|
||||
defer maxWait.Stop()
|
||||
|
||||
// Wait for workers to finish, plus check the count in intervals.
|
||||
for {
|
||||
if m.workerCnt.Load() <= limit {
|
||||
return true
|
||||
}
|
||||
|
||||
select {
|
||||
case <-m.workersDone:
|
||||
if m.workerCnt.Load() <= limit {
|
||||
return true
|
||||
}
|
||||
|
||||
case <-reCheck.C:
|
||||
// Check worker count again.
|
||||
// This is a dead simple and effective way to avoid all the channel race conditions.
|
||||
reCheckDuration *= 2
|
||||
reCheck.Reset(reCheckDuration)
|
||||
|
||||
case <-maxWait.C:
|
||||
return m.workerCnt.Load() <= limit
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (m *Manager) workerStart() {
|
||||
m.workerCnt.Add(1)
|
||||
}
|
||||
|
||||
func (m *Manager) workerDone() {
|
||||
if m.workerCnt.Add(-1) <= 1 {
|
||||
// Notify all waiters.
|
||||
for {
|
||||
select {
|
||||
case m.workersDone <- struct{}{}:
|
||||
default:
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Reset resets the manager in order to be able to be used again.
|
||||
// In the process, the current context is canceled.
|
||||
// As part of a module (in a group), the module might be stopped and started again.
|
||||
// This method is not goroutine-safe. The caller must make sure the manager is
|
||||
// not being used in any way during execution.
|
||||
func (m *Manager) Reset() {
|
||||
m.cancelCtx()
|
||||
m.ctx, m.cancelCtx = context.WithCancel(context.Background())
|
||||
m.workerCnt.Store(0)
|
||||
m.workersDone = make(chan struct{})
|
||||
}
|
||||
Reference in New Issue
Block a user