summaryrefslogtreecommitdiffhomepage
path: root/pkg/shim/proc/init_state.go
blob: d65020e76be5b95d3509bfb04ca0f7e704dabd86 (plain)
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
// Copyright 2018 The containerd Authors.
// Copyright 2018 The gVisor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package proc

import (
	"context"
	"fmt"

	"github.com/containerd/containerd/errdefs"
	"github.com/containerd/containerd/pkg/process"
	runc "github.com/containerd/go-runc"
	"golang.org/x/sys/unix"
)

type stateTransition int

const (
	running stateTransition = iota
	stopped
	deleted
)

func (s stateTransition) String() string {
	switch s {
	case running:
		return "running"
	case stopped:
		return "stopped"
	case deleted:
		return "deleted"
	default:
		panic(fmt.Sprintf("unknown state: %d", s))
	}
}

type initState interface {
	Start(context.Context) error
	Delete(context.Context) error
	Exec(context.Context, string, *ExecConfig) (process.Process, error)
	State(ctx context.Context) (string, error)
	Stats(context.Context, string) (*runc.Stats, error)
	Kill(context.Context, uint32, bool) error
	SetExited(int)
}

type createdState struct {
	p *Init
}

func (s *createdState) name() string {
	return "created"
}

func (s *createdState) transition(transition stateTransition) {
	switch transition {
	case running:
		s.p.initState = &runningState{p: s.p}
	case stopped:
		s.p.initState = &stoppedState{process: s.p}
	case deleted:
		s.p.initState = &deletedState{}
	default:
		panic(fmt.Sprintf("invalid state transition %q to %q", s.name(), transition))
	}
}

func (s *createdState) Start(ctx context.Context) error {
	if err := s.p.start(ctx); err != nil {
		// Containerd doesn't allow deleting container in created state.
		// However, for gvisor, a non-root container in created state can
		// only go to running state. If the container can't be started,
		// it can only stay in created state, and never be deleted.
		// To work around that, we treat non-root container in start failure
		// state as stopped.
		if !s.p.Sandbox {
			s.p.io.Close()
			s.p.setExited(internalErrorCode)
			s.transition(stopped)
		}
		return err
	}
	s.transition(running)
	return nil
}

func (s *createdState) Delete(ctx context.Context) error {
	if err := s.p.delete(ctx); err != nil {
		return err
	}
	s.transition(deleted)
	return nil
}

func (s *createdState) Kill(ctx context.Context, sig uint32, all bool) error {
	return s.p.kill(ctx, sig, all)
}

func (s *createdState) SetExited(status int) {
	s.p.setExited(status)
	s.transition(stopped)
}

func (s *createdState) Exec(ctx context.Context, path string, r *ExecConfig) (process.Process, error) {
	return s.p.exec(path, r)
}

func (s *createdState) State(ctx context.Context) (string, error) {
	state, err := s.p.state(ctx)
	if err == nil && state == statusStopped {
		s.transition(stopped)
	}
	return state, err
}

func (s *createdState) Stats(ctx context.Context, id string) (*runc.Stats, error) {
	return s.p.stats(ctx, id)
}

type runningState struct {
	p *Init
}

func (s *runningState) name() string {
	return "running"
}

func (s *runningState) transition(transition stateTransition) {
	switch transition {
	case stopped:
		s.p.initState = &stoppedState{process: s.p}
	default:
		panic(fmt.Sprintf("invalid state transition %q to %q", s.name(), transition))
	}
}

func (s *runningState) Start(ctx context.Context) error {
	return fmt.Errorf("cannot start a running container")
}

func (s *runningState) Delete(ctx context.Context) error {
	return fmt.Errorf("cannot delete a running container")
}

func (s *runningState) Kill(ctx context.Context, sig uint32, all bool) error {
	return s.p.kill(ctx, sig, all)
}

func (s *runningState) SetExited(status int) {
	s.p.setExited(status)
	s.transition(stopped)
}

func (s *runningState) Exec(_ context.Context, path string, r *ExecConfig) (process.Process, error) {
	return s.p.exec(path, r)
}

func (s *runningState) State(ctx context.Context) (string, error) {
	state, err := s.p.state(ctx)
	if err == nil && state == "stopped" {
		s.transition(stopped)
	}
	return state, err
}

func (s *runningState) Stats(ctx context.Context, id string) (*runc.Stats, error) {
	return s.p.stats(ctx, id)
}

type stoppedState struct {
	process *Init
}

func (s *stoppedState) name() string {
	return "stopped"
}

func (s *stoppedState) transition(transition stateTransition) {
	switch transition {
	case deleted:
		s.process.initState = &deletedState{}
	default:
		panic(fmt.Sprintf("invalid state transition %q to %q", s.name(), transition))
	}
}

func (s *stoppedState) Start(context.Context) error {
	return fmt.Errorf("cannot start a stopped container")
}

func (s *stoppedState) Delete(ctx context.Context) error {
	if err := s.process.delete(ctx); err != nil {
		return err
	}
	s.transition(deleted)
	return nil
}

func (s *stoppedState) Kill(_ context.Context, signal uint32, _ bool) error {
	return handleStoppedKill(signal)
}

func (s *stoppedState) SetExited(status int) {
	s.process.setExited(status)
}

func (s *stoppedState) Exec(context.Context, string, *ExecConfig) (process.Process, error) {
	return nil, fmt.Errorf("cannot exec in a stopped state")
}

func (s *stoppedState) State(context.Context) (string, error) {
	return "stopped", nil
}

func (s *stoppedState) Stats(context.Context, string) (*runc.Stats, error) {
	return nil, fmt.Errorf("cannot stat a stopped container")
}

func handleStoppedKill(signal uint32) error {
	switch unix.Signal(signal) {
	case unix.SIGTERM, unix.SIGKILL:
		// Container is already stopped, so everything inside the container has
		// already been killed.
		return nil
	default:
		return errdefs.ToGRPCf(errdefs.ErrNotFound, "process not found")
	}
}