Dobby  3.0
Dobby “Docker based Thingy” is a tool for managing and running OCI containers using crun
IDobbyEnv.h
1 /*
2 * If not stated otherwise in this file or this component's LICENSE file the
3 * following copyright and licenses apply:
4 *
5 * Copyright 2016 Sky UK
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 */
19 /*
20  * File: IDobbyEnv.h
21  *
22  */
23 #ifndef IDOBBYENV_H
24 #define IDOBBYENV_H
25 
26 #include <cstdint>
27 #include <string>
28 
29 
30 // -----------------------------------------------------------------------------
45 class IDobbyEnv
46 {
47 public:
48  virtual ~IDobbyEnv() = default;
49 
50 public:
51 
52  // -------------------------------------------------------------------------
62  virtual std::string workspaceMountPath() const = 0;
63 
64  // -------------------------------------------------------------------------
75  virtual std::string flashMountPath() const = 0;
76 
77  // -------------------------------------------------------------------------
88  virtual std::string pluginsWorkspacePath() const = 0;
89 
90  // -------------------------------------------------------------------------
109  virtual uint16_t platformIdent() const = 0;
110 
111 
112  enum class Cgroup
113  { Freezer, Memory, Cpu, CpuAcct, CpuSet, Devices, Gpu, NetCls, Blkio, Ion };
114 
115  // -------------------------------------------------------------------------
123  virtual std::string cgroupMountPath(Cgroup cgroup) const = 0;
124 
125 };
126 
127 
128 #endif // !defined(IDOBBYENV_H)
Interface that exports the environment of the daemon to plugins.
Definition: IDobbyEnv.h:46
virtual std::string cgroupMountPath(Cgroup cgroup) const =0
Returns the absolute path to the cgroup mount point for the given cgroup.
virtual std::string workspaceMountPath() const =0
Returns the absolute AI workspace mount point path.
virtual std::string flashMountPath() const =0
Returns the absolute path to the AI area on flash.
virtual uint16_t platformIdent() const =0
Returns the two byte platform identification number.
virtual std::string pluginsWorkspacePath() const =0
Returns the path to directory that plugins can write to.