tlk: 6/19 update
[3rdparty/ote_partner/tlk.git] / include / kernel / task_unload.h
1 /*
2  * Copyright (c) 2014, NVIDIA CORPORATION. All rights reserved
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files
6  * (the "Software"), to deal in the Software without restriction,
7  * including without limitation the rights to use, copy, modify, merge,
8  * publish, distribute, sublicense, and/or sell copies of the Software,
9  * and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22  */
23 #ifndef __KERNEL_TASK_UNLOAD_H
24 #define __KERNEL_TASK_UNLOAD_H
25
26 #include <kernel/task.h>
27
28 /*!
29  * Define this nonzero if unloading of tasks is allowed at all.
30  * If defined zero: no tasks can be unloaded.
31  */
32 #ifndef HAVE_UNLOAD_TASKS
33 #define HAVE_UNLOAD_TASKS       1
34 #endif
35
36 /*!
37  * Define this nonzero if unloading of static tasks is allowed.
38  * If defined zero: only post-loaded tasks can be unloaded.
39  *
40  * The static task image memory is not reclaimed/reused after unloading.
41  * [ For static tasks the memory is not allocated from TLK heap but rather
42  *   baked into the TLK image itself ]
43  */
44 #ifndef HAVE_UNLOAD_STATIC_TASKS
45 #define HAVE_UNLOAD_STATIC_TASKS        1
46 #endif
47
48 void task_unload_init(void);
49
50 /*! Remove a dead thread from the thread list of a task.
51  *
52  * Called by thread cleanup (if the thread belongs to a task)
53  * before the thread resources are deallocated.
54  */
55 struct thread;
56
57 void task_thread_killed(struct thread *thread);
58
59 /*! Initiate unloading of a task.
60  *
61  * Called by task load syscall handler.
62  */
63 status_t task_unload(task_t **taskp_p);
64
65 /*! Get number of tasks unloaded since boot.
66  */
67 uint32_t task_get_unload_counter();
68
69 #endif /* __KERNEL_TASK_UNLOAD_H */