-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
ghttp_server_admin_process.go
296 lines (275 loc) · 8.2 KB
/
ghttp_server_admin_process.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package ghttp
import (
"bytes"
"context"
"fmt"
"os"
"runtime"
"strings"
"sync"
"time"
"github.com/gogf/gf/v2/container/gtype"
"github.com/gogf/gf/v2/encoding/gjson"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/v2/internal/intlog"
"github.com/gogf/gf/v2/os/glog"
"github.com/gogf/gf/v2/os/gproc"
"github.com/gogf/gf/v2/os/gtime"
"github.com/gogf/gf/v2/os/gtimer"
"github.com/gogf/gf/v2/text/gstr"
"github.com/gogf/gf/v2/util/gconv"
)
const (
// Allow executing management command after server starts after this interval in milliseconds.
adminActionIntervalLimit = 2000
adminActionNone = 0
adminActionRestarting = 1
adminActionShuttingDown = 2
adminActionReloadEnvKey = "GF_SERVER_RELOAD"
adminActionRestartEnvKey = "GF_SERVER_RESTART"
adminGProcCommGroup = "GF_GPROC_HTTP_SERVER"
)
var (
// serverActionLocker is the locker for server administration operations.
serverActionLocker sync.Mutex
// serverActionLastTime is timestamp in milliseconds of last administration operation.
serverActionLastTime = gtype.NewInt64(gtime.TimestampMilli())
// serverProcessStatus is the server status for operation of current process.
serverProcessStatus = gtype.NewInt()
)
// RestartAllServer restarts all the servers of the process gracefully.
// The optional parameter `newExeFilePath` specifies the new binary file for creating process.
func RestartAllServer(ctx context.Context, newExeFilePath string) error {
if !gracefulEnabled {
return gerror.NewCode(gcode.CodeInvalidOperation, "graceful reload feature is disabled")
}
serverActionLocker.Lock()
defer serverActionLocker.Unlock()
if err := checkProcessStatus(); err != nil {
return err
}
if err := checkActionFrequency(); err != nil {
return err
}
return restartWebServers(ctx, nil, newExeFilePath)
}
// ShutdownAllServer shuts down all servers of current process gracefully.
func ShutdownAllServer(ctx context.Context) error {
serverActionLocker.Lock()
defer serverActionLocker.Unlock()
if err := checkProcessStatus(); err != nil {
return err
}
if err := checkActionFrequency(); err != nil {
return err
}
shutdownWebServersGracefully(ctx, nil)
return nil
}
// checkProcessStatus checks the server status of current process.
func checkProcessStatus() error {
status := serverProcessStatus.Val()
if status > 0 {
switch status {
case adminActionRestarting:
return gerror.NewCode(gcode.CodeInvalidOperation, "server is restarting")
case adminActionShuttingDown:
return gerror.NewCode(gcode.CodeInvalidOperation, "server is shutting down")
}
}
return nil
}
// checkActionFrequency checks the operation frequency.
// It returns error if it is too frequency.
func checkActionFrequency() error {
interval := gtime.TimestampMilli() - serverActionLastTime.Val()
if interval < adminActionIntervalLimit {
return gerror.NewCodef(
gcode.CodeInvalidOperation,
"too frequent action, please retry in %d ms",
adminActionIntervalLimit-interval,
)
}
serverActionLastTime.Set(gtime.TimestampMilli())
return nil
}
// forkReloadProcess creates a new child process and copies the fd to child process.
func forkReloadProcess(ctx context.Context, newExeFilePath ...string) error {
var (
path = os.Args[0]
)
if len(newExeFilePath) > 0 {
path = newExeFilePath[0]
}
var (
p = gproc.NewProcess(path, os.Args, os.Environ())
sfm = getServerFdMap()
)
for name, m := range sfm {
for fdk, fdv := range m {
if len(fdv) > 0 {
s := ""
for _, item := range gstr.SplitAndTrim(fdv, ",") {
array := strings.Split(item, "#")
fd := uintptr(gconv.Uint(array[1]))
if fd > 0 {
s += fmt.Sprintf("%s#%d,", array[0], 3+len(p.ExtraFiles))
p.ExtraFiles = append(p.ExtraFiles, os.NewFile(fd, ""))
} else {
s += fmt.Sprintf("%s#%d,", array[0], 0)
}
}
sfm[name][fdk] = strings.TrimRight(s, ",")
}
}
}
buffer, _ := gjson.Encode(sfm)
p.Env = append(p.Env, adminActionReloadEnvKey+"="+string(buffer))
if _, err := p.Start(ctx); err != nil {
glog.Errorf(
ctx,
"%d: fork process failed, error:%s, %s",
gproc.Pid(), err.Error(), string(buffer),
)
return err
}
return nil
}
// forkRestartProcess creates a new server process.
func forkRestartProcess(ctx context.Context, newExeFilePath string) error {
var (
path = os.Args[0]
)
if newExeFilePath != "" {
path = newExeFilePath
}
if err := os.Unsetenv(adminActionReloadEnvKey); err != nil {
intlog.Errorf(ctx, `%+v`, err)
}
env := os.Environ()
env = append(env, adminActionRestartEnvKey+"=1")
p := gproc.NewProcess(path, os.Args, env)
if _, err := p.Start(ctx); err != nil {
glog.Errorf(
ctx,
`%d: fork process failed, error:%s, are you running using "go run"?`,
gproc.Pid(), err.Error(),
)
return err
}
return nil
}
// getServerFdMap returns all the servers name to file descriptor mapping as map.
func getServerFdMap() map[string]listenerFdMap {
sfm := make(map[string]listenerFdMap)
serverMapping.RLockFunc(func(m map[string]interface{}) {
for k, v := range m {
sfm[k] = v.(*Server).getListenerFdMap()
}
})
return sfm
}
// bufferToServerFdMap converts binary content to fd map.
func bufferToServerFdMap(buffer []byte) map[string]listenerFdMap {
sfm := make(map[string]listenerFdMap)
if len(buffer) > 0 {
j, _ := gjson.LoadContent(buffer)
for k := range j.Var().Map() {
m := make(map[string]string)
for mapKey, mapValue := range j.Get(k).MapStrStr() {
m[mapKey] = mapValue
}
sfm[k] = m
}
}
return sfm
}
// restartWebServers restarts all servers.
func restartWebServers(ctx context.Context, signal os.Signal, newExeFilePath string) error {
serverProcessStatus.Set(adminActionRestarting)
if runtime.GOOS == "windows" {
if signal != nil {
// Controlled by signal.
forceCloseWebServers(ctx)
if err := forkRestartProcess(ctx, newExeFilePath); err != nil {
intlog.Errorf(ctx, `%+v`, err)
}
return nil
}
// Controlled by web page.
// It should ensure the response wrote to client and then close all servers gracefully.
gtimer.SetTimeout(ctx, time.Second, func(ctx context.Context) {
forceCloseWebServers(ctx)
if err := forkRestartProcess(ctx, newExeFilePath); err != nil {
intlog.Errorf(ctx, `%+v`, err)
}
})
return nil
}
if err := forkReloadProcess(ctx, newExeFilePath); err != nil {
glog.Printf(ctx, "%d: server restarts failed", gproc.Pid())
serverProcessStatus.Set(adminActionNone)
return err
} else {
if signal != nil {
glog.Printf(ctx, "%d: server restarting by signal: %s", gproc.Pid(), signal)
} else {
glog.Printf(ctx, "%d: server restarting by web admin", gproc.Pid())
}
}
return nil
}
// shutdownWebServersGracefully gracefully shuts down all servers.
func shutdownWebServersGracefully(ctx context.Context, signal os.Signal) {
serverProcessStatus.Set(adminActionShuttingDown)
if signal != nil {
glog.Printf(
ctx,
"%d: server gracefully shutting down by signal: %s",
gproc.Pid(), signal.String(),
)
} else {
glog.Printf(ctx, "%d: server gracefully shutting down by api", gproc.Pid())
}
serverMapping.RLockFunc(func(m map[string]interface{}) {
for _, v := range m {
for _, s := range v.(*Server).servers {
s.shutdown(ctx)
}
}
})
}
// forceCloseWebServers forced shuts down all servers.
func forceCloseWebServers(ctx context.Context) {
serverMapping.RLockFunc(func(m map[string]interface{}) {
for _, v := range m {
for _, s := range v.(*Server).servers {
s.close(ctx)
}
}
})
}
// handleProcessMessage receives and handles the message from processes,
// which are commonly used for graceful reloading feature.
func handleProcessMessage() {
var (
ctx = context.TODO()
)
for {
if msg := gproc.Receive(adminGProcCommGroup); msg != nil {
if bytes.EqualFold(msg.Data, []byte("exit")) {
intlog.Printf(ctx, "%d: process message: exit", gproc.Pid())
shutdownWebServersGracefully(ctx, nil)
allShutdownChan <- struct{}{}
intlog.Printf(ctx, "%d: process message: exit done", gproc.Pid())
return
}
}
}
}