github.com/nicocha30/gvisor-ligolo@v0.0.0-20230726075806-989fa2c0a413/pkg/sentry/kernel/task_work.go (about)

     1  // Copyright 2020 The gVisor Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package kernel
    16  
    17  // TaskWorker is a deferred task.
    18  //
    19  // This must be savable.
    20  type TaskWorker interface {
    21  	// TaskWork will be executed prior to returning to user space. Note that
    22  	// TaskWork may call RegisterWork again, but this will not be executed until
    23  	// the next return to user space, unlike in Linux. This effectively allows
    24  	// registration of indefinite user return hooks, but not by default.
    25  	TaskWork(t *Task)
    26  }
    27  
    28  // RegisterWork can be used to register additional task work that will be
    29  // performed prior to returning to user space. See TaskWorker.TaskWork for
    30  // semantics regarding registration.
    31  func (t *Task) RegisterWork(work TaskWorker) {
    32  	t.taskWorkMu.Lock()
    33  	defer t.taskWorkMu.Unlock()
    34  	t.taskWorkCount.Add(1)
    35  	t.taskWork = append(t.taskWork, work)
    36  }