2014-06-19 09:08:03 +04:00
// Copyright 2014 The Gogs Authors. All rights reserved.
2019-10-12 03:13:27 +03:00
// Copyright 2019 The Gitea Authors. All rights reserved.
2022-11-27 21:20:29 +03:00
// SPDX-License-Identifier: MIT
2014-06-19 09:08:03 +04:00
package process
import (
2017-11-13 17:51:45 +03:00
"context"
2022-03-25 15:47:12 +03:00
"runtime/pprof"
2021-11-30 23:06:32 +03:00
"strconv"
2017-01-17 08:58:58 +03:00
"sync"
2023-05-27 13:55:24 +03:00
"sync/atomic"
2014-06-19 09:08:03 +04:00
"time"
)
2017-01-17 08:58:58 +03:00
// TODO: This packages still uses a singleton for the Manager.
// Once there's a decent web framework and dependencies are passed around like they should,
// then we delete the singleton.
2014-07-07 01:32:36 +04:00
var (
2021-04-09 10:40:34 +03:00
manager * Manager
managerInit sync . Once
2019-11-30 17:40:22 +03:00
// DefaultContext is the default context to run processing commands in
DefaultContext = context . Background ( )
2014-07-07 01:32:36 +04:00
)
2022-03-31 20:01:43 +03:00
// DescriptionPProfLabel is a label set on goroutines that have a process attached
const DescriptionPProfLabel = "process-description"
// PIDPProfLabel is a label set on goroutines that have a process attached
const PIDPProfLabel = "pid"
// PPIDPProfLabel is a label set on goroutines that have a process attached
const PPIDPProfLabel = "ppid"
// ProcessTypePProfLabel is a label set on goroutines that have a process attached
const ProcessTypePProfLabel = "process-type"
2021-11-30 23:06:32 +03:00
// IDType is a pid type
type IDType string
// FinishedFunc is a function that marks that the process is finished and can be removed from the process table
// - it is simply an alias for context.CancelFunc and is only for documentary purposes
type FinishedFunc = context . CancelFunc
2014-06-19 09:08:03 +04:00
2023-05-27 13:55:24 +03:00
var (
traceDisabled atomic . Int64
TraceCallback = defaultTraceCallback // this global can be overridden by particular logging packages - thus avoiding import cycles
)
// defaultTraceCallback is a no-op. Without a proper TraceCallback (provided by the logger system), this "Trace" level messages shouldn't be outputted.
func defaultTraceCallback ( skip int , start bool , pid IDType , description string , parentPID IDType , typ string ) {
}
2023-02-04 02:11:48 +03:00
2023-05-27 13:55:24 +03:00
// TraceLogDisable disables (or revert the disabling) the trace log for the process lifecycle.
// eg: the logger system shouldn't print the trace log for themselves, that's cycle dependency (Logger -> ProcessManager -> TraceCallback -> Logger ...)
// Theoretically, such trace log should only be enabled when the logger system is ready with a proper level, so the default TraceCallback is a no-op.
func TraceLogDisable ( v bool ) {
if v {
traceDisabled . Add ( 1 )
2023-02-04 02:11:48 +03:00
} else {
2023-05-27 13:55:24 +03:00
traceDisabled . Add ( - 1 )
}
}
func Trace ( start bool , pid IDType , description string , parentPID IDType , typ string ) {
if traceDisabled . Load ( ) != 0 {
// the traceDisabled counter is mainly for recursive calls, so no concurrency problem.
// because the counter can't be 0 since the caller function hasn't returned (decreased the counter) yet.
return
2023-02-04 02:11:48 +03:00
}
2023-05-27 13:55:24 +03:00
TraceCallback ( 1 , start , pid , description , parentPID , typ )
2023-02-04 02:11:48 +03:00
}
2021-11-30 23:06:32 +03:00
// Manager manages all processes and counts PIDs.
2017-01-17 08:58:58 +03:00
type Manager struct {
mutex sync . Mutex
2014-06-19 09:08:03 +04:00
2021-11-30 23:06:32 +03:00
next int64
lastTime int64
2022-03-31 20:01:43 +03:00
processMap map [ IDType ] * process
2017-01-17 08:58:58 +03:00
}
// GetManager returns a Manager and initializes one as singleton if there's none yet
func GetManager ( ) * Manager {
2021-02-04 00:36:38 +03:00
managerInit . Do ( func ( ) {
2017-01-17 08:58:58 +03:00
manager = & Manager {
2022-03-31 20:01:43 +03:00
processMap : make ( map [ IDType ] * process ) ,
next : 1 ,
2017-01-17 08:58:58 +03:00
}
2021-02-04 00:36:38 +03:00
} )
2017-01-17 08:58:58 +03:00
return manager
}
2021-11-30 23:06:32 +03:00
// AddContext creates a new context and adds it as a process. Once the process is finished, finished must be called
// to remove the process from the process table. It should not be called until the process is finished but must always be called.
//
// cancel should be used to cancel the returned context, however it will not remove the process from the process table.
// finished will cancel the returned context and remove it from the process table.
//
// Most processes will not need to use the cancel function but there will be cases whereby you want to cancel the process but not immediately remove it from the
// process table.
func ( pm * Manager ) AddContext ( parent context . Context , description string ) ( ctx context . Context , cancel context . CancelFunc , finished FinishedFunc ) {
ctx , cancel = context . WithCancel ( parent )
2022-03-31 20:01:43 +03:00
ctx , _ , finished = pm . Add ( ctx , description , cancel , NormalProcessType , true )
2021-11-30 23:06:32 +03:00
2022-03-31 20:01:43 +03:00
return ctx , cancel , finished
}
// AddTypedContext creates a new context and adds it as a process. Once the process is finished, finished must be called
// to remove the process from the process table. It should not be called until the process is finished but must always be called.
//
// cancel should be used to cancel the returned context, however it will not remove the process from the process table.
// finished will cancel the returned context and remove it from the process table.
//
// Most processes will not need to use the cancel function but there will be cases whereby you want to cancel the process but not immediately remove it from the
// process table.
func ( pm * Manager ) AddTypedContext ( parent context . Context , description , processType string , currentlyRunning bool ) ( ctx context . Context , cancel context . CancelFunc , finished FinishedFunc ) {
ctx , cancel = context . WithCancel ( parent )
ctx , _ , finished = pm . Add ( ctx , description , cancel , processType , currentlyRunning )
return ctx , cancel , finished
2021-11-30 23:06:32 +03:00
}
// AddContextTimeout creates a new context and add it as a process. Once the process is finished, finished must be called
2022-01-10 12:32:37 +03:00
// to remove the process from the process table. It should not be called until the process is finished but must always be called.
2021-11-30 23:06:32 +03:00
//
// cancel should be used to cancel the returned context, however it will not remove the process from the process table.
// finished will cancel the returned context and remove it from the process table.
//
// Most processes will not need to use the cancel function but there will be cases whereby you want to cancel the process but not immediately remove it from the
// process table.
2024-04-27 11:03:49 +03:00
func ( pm * Manager ) AddContextTimeout ( parent context . Context , timeout time . Duration , description string ) ( ctx context . Context , cancel context . CancelFunc , finished FinishedFunc ) {
2022-03-31 14:56:22 +03:00
if timeout <= 0 {
// it's meaningless to use timeout <= 0, and it must be a bug! so we must panic here to tell developers to make the timeout correct
panic ( "the timeout must be greater than zero, otherwise the context will be cancelled immediately" )
}
2022-03-31 20:01:43 +03:00
2021-11-30 23:06:32 +03:00
ctx , cancel = context . WithTimeout ( parent , timeout )
2024-04-27 11:03:49 +03:00
ctx , _ , finished = pm . Add ( ctx , description , cancel , NormalProcessType , true )
2021-11-30 23:06:32 +03:00
2024-04-27 11:03:49 +03:00
return ctx , cancel , finished
2021-11-30 23:06:32 +03:00
}
// Add create a new process
2022-03-31 20:01:43 +03:00
func ( pm * Manager ) Add ( ctx context . Context , description string , cancel context . CancelFunc , processType string , currentlyRunning bool ) ( context . Context , IDType , FinishedFunc ) {
2022-03-25 15:47:12 +03:00
parentPID := GetParentPID ( ctx )
2017-01-17 08:58:58 +03:00
pm . mutex . Lock ( )
2021-11-30 23:06:32 +03:00
start , pid := pm . nextPID ( )
2022-03-31 20:01:43 +03:00
parent := pm . processMap [ parentPID ]
2021-11-30 23:06:32 +03:00
if parent == nil {
parentPID = ""
}
2022-03-31 20:01:43 +03:00
process := & process {
2017-01-17 08:58:58 +03:00
PID : pid ,
2021-11-30 23:06:32 +03:00
ParentPID : parentPID ,
2017-01-17 08:58:58 +03:00
Description : description ,
2021-11-30 23:06:32 +03:00
Start : start ,
2019-11-30 17:40:22 +03:00
Cancel : cancel ,
2022-03-31 20:01:43 +03:00
Type : processType ,
2017-01-17 08:58:58 +03:00
}
2021-11-30 23:06:32 +03:00
2022-03-31 20:01:43 +03:00
var finished FinishedFunc
if currentlyRunning {
finished = func ( ) {
cancel ( )
pm . remove ( process )
pprof . SetGoroutineLabels ( ctx )
}
} else {
finished = func ( ) {
cancel ( )
pm . remove ( process )
}
2021-11-30 23:06:32 +03:00
}
2022-03-31 20:01:43 +03:00
pm . processMap [ pid ] = process
2017-01-17 08:58:58 +03:00
pm . mutex . Unlock ( )
Improve queue and logger context (#24924)
Before there was a "graceful function": RunWithShutdownFns, it's mainly
for some modules which doesn't support context.
The old queue system doesn't work well with context, so the old queues
need it.
After the queue refactoring, the new queue works with context well, so,
use Golang context as much as possible, the `RunWithShutdownFns` could
be removed (replaced by RunWithCancel for context cancel mechanism), the
related code could be simplified.
This PR also fixes some legacy queue-init problems, eg:
* typo : archiver: "unable to create codes indexer queue" => "unable to
create repo-archive queue"
* no nil check for failed queues, which causes unfriendly panic
After this PR, many goroutines could have better display name:
![image](https://github.com/go-gitea/gitea/assets/2114189/701b2a9b-8065-4137-aeaa-0bda2b34604a)
![image](https://github.com/go-gitea/gitea/assets/2114189/f1d5f50f-0534-40f0-b0be-f2c9daa5fe92)
2023-05-26 10:31:55 +03:00
2023-02-04 02:11:48 +03:00
Trace ( true , pid , description , parentPID , processType )
2017-01-17 08:58:58 +03:00
2022-03-31 20:01:43 +03:00
pprofCtx := pprof . WithLabels ( ctx , pprof . Labels ( DescriptionPProfLabel , description , PPIDPProfLabel , string ( parentPID ) , PIDPProfLabel , string ( pid ) , ProcessTypePProfLabel , processType ) )
if currentlyRunning {
pprof . SetGoroutineLabels ( pprofCtx )
}
2022-03-25 15:47:12 +03:00
2022-03-31 20:01:43 +03:00
return & Context {
Context : pprofCtx ,
pid : pid ,
} , pid , finished
2021-11-30 23:06:32 +03:00
}
// nextPID will return the next available PID. pm.mutex should already be locked.
func ( pm * Manager ) nextPID ( ) ( start time . Time , pid IDType ) {
start = time . Now ( )
startUnix := start . Unix ( )
if pm . lastTime == startUnix {
pm . next ++
} else {
pm . next = 1
}
pm . lastTime = startUnix
pid = IDType ( strconv . FormatInt ( start . Unix ( ) , 16 ) )
if pm . next == 1 {
2023-07-07 08:31:56 +03:00
return start , pid
2021-11-30 23:06:32 +03:00
}
pid = IDType ( string ( pid ) + "-" + strconv . FormatInt ( pm . next , 10 ) )
2022-06-20 13:02:49 +03:00
return start , pid
2014-06-19 09:08:03 +04:00
}
2022-03-31 20:01:43 +03:00
func ( pm * Manager ) remove ( process * process ) {
Improve queue and logger context (#24924)
Before there was a "graceful function": RunWithShutdownFns, it's mainly
for some modules which doesn't support context.
The old queue system doesn't work well with context, so the old queues
need it.
After the queue refactoring, the new queue works with context well, so,
use Golang context as much as possible, the `RunWithShutdownFns` could
be removed (replaced by RunWithCancel for context cancel mechanism), the
related code could be simplified.
This PR also fixes some legacy queue-init problems, eg:
* typo : archiver: "unable to create codes indexer queue" => "unable to
create repo-archive queue"
* no nil check for failed queues, which causes unfriendly panic
After this PR, many goroutines could have better display name:
![image](https://github.com/go-gitea/gitea/assets/2114189/701b2a9b-8065-4137-aeaa-0bda2b34604a)
![image](https://github.com/go-gitea/gitea/assets/2114189/f1d5f50f-0534-40f0-b0be-f2c9daa5fe92)
2023-05-26 10:31:55 +03:00
deleted := false
2021-11-30 23:06:32 +03:00
pm . mutex . Lock ( )
Improve queue and logger context (#24924)
Before there was a "graceful function": RunWithShutdownFns, it's mainly
for some modules which doesn't support context.
The old queue system doesn't work well with context, so the old queues
need it.
After the queue refactoring, the new queue works with context well, so,
use Golang context as much as possible, the `RunWithShutdownFns` could
be removed (replaced by RunWithCancel for context cancel mechanism), the
related code could be simplified.
This PR also fixes some legacy queue-init problems, eg:
* typo : archiver: "unable to create codes indexer queue" => "unable to
create repo-archive queue"
* no nil check for failed queues, which causes unfriendly panic
After this PR, many goroutines could have better display name:
![image](https://github.com/go-gitea/gitea/assets/2114189/701b2a9b-8065-4137-aeaa-0bda2b34604a)
![image](https://github.com/go-gitea/gitea/assets/2114189/f1d5f50f-0534-40f0-b0be-f2c9daa5fe92)
2023-05-26 10:31:55 +03:00
if pm . processMap [ process . PID ] == process {
2022-03-31 20:01:43 +03:00
delete ( pm . processMap , process . PID )
Improve queue and logger context (#24924)
Before there was a "graceful function": RunWithShutdownFns, it's mainly
for some modules which doesn't support context.
The old queue system doesn't work well with context, so the old queues
need it.
After the queue refactoring, the new queue works with context well, so,
use Golang context as much as possible, the `RunWithShutdownFns` could
be removed (replaced by RunWithCancel for context cancel mechanism), the
related code could be simplified.
This PR also fixes some legacy queue-init problems, eg:
* typo : archiver: "unable to create codes indexer queue" => "unable to
create repo-archive queue"
* no nil check for failed queues, which causes unfriendly panic
After this PR, many goroutines could have better display name:
![image](https://github.com/go-gitea/gitea/assets/2114189/701b2a9b-8065-4137-aeaa-0bda2b34604a)
![image](https://github.com/go-gitea/gitea/assets/2114189/f1d5f50f-0534-40f0-b0be-f2c9daa5fe92)
2023-05-26 10:31:55 +03:00
deleted = true
}
pm . mutex . Unlock ( )
if deleted {
2023-02-04 02:11:48 +03:00
Trace ( false , process . PID , process . Description , process . ParentPID , process . Type )
2021-11-30 23:06:32 +03:00
}
}
2019-11-30 17:40:22 +03:00
// Cancel a process in the ProcessManager.
2021-11-30 23:06:32 +03:00
func ( pm * Manager ) Cancel ( pid IDType ) {
2019-11-30 17:40:22 +03:00
pm . mutex . Lock ( )
2022-03-31 20:01:43 +03:00
process , ok := pm . processMap [ pid ]
2019-11-30 17:40:22 +03:00
pm . mutex . Unlock ( )
2022-03-31 20:01:43 +03:00
if ok && process . Type != SystemProcessType {
2019-11-30 17:40:22 +03:00
process . Cancel ( )
}
}