1 /*
2  * Copyright (c) 2023 Huawei Device Co., Ltd.
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 #include <pthread.h>
16 #include <random>
17 #include "core/task_io.h"
18 #ifdef FFRT_CO_BACKTRACE_OH_ENABLE
19 #include <dlfcn.h>
20 #endif
21 #include "util/slab.h"
22 #include "util/ffrt_facade.h"
23 #include "util/spmc_queue.h"
24 
25 #define ENABLE_LOCAL_QUEUE
26 
27 namespace {
28 const int INSERT_GLOBAL_QUEUE_FREQ = 5;
29 }
30 
31 namespace ffrt {
work_finish_callable(IOTaskExecutor * task)32 static void work_finish_callable(IOTaskExecutor* task)
33 {
34     task->status = ExecTaskStatus::ET_FINISH;
35     task->work.destroy(task->work.data);
36     delete task;
37 }
38 
ExecuteIOTask(ffrt_executor_task_t * data,ffrt_qos_t qos)39 static void ExecuteIOTask(ffrt_executor_task_t* data, ffrt_qos_t qos)
40 {
41     IOTaskExecutor* task = static_cast<IOTaskExecutor*>(data);
42     task->status = ExecTaskStatus::ET_EXECUTING;
43     (void)qos;
44     ffrt_coroutine_ptr_t coroutine = task->work.exec;
45     ffrt_coroutine_ret_t ret = coroutine(task->work.data);
46     if (ret == ffrt_coroutine_ready) {
47         FFRT_EXECUTOR_TASK_FINISH_MARKER(task);
48         work_finish_callable(task);
49         return;
50     }
51 
52     FFRT_EXECUTOR_TASK_BLOCK_MARKER(task);
53     task->status = ffrt::ExecTaskStatus::ET_PENDING;
54 #ifdef FFRT_BBOX_ENABLE
55     TaskPendingCounterInc();
56 #endif
57 }
58 
59 static pthread_once_t once = PTHREAD_ONCE_INIT;
60 
InitIOTaskExecutor()61 static void InitIOTaskExecutor()
62 {
63     ffrt_executor_task_register_func(ExecuteIOTask, ffrt_io_task);
64 }
65 } /* namespace ffrt */
66 
67 #ifdef __cplusplus
68 extern "C" {
69 #endif
70 API_ATTRIBUTE((visibility("default")))
71 void ffrt_submit_coroutine(void* co, ffrt_coroutine_ptr_t exec, ffrt_function_t destroy, const ffrt_deps_t* in_deps,
72     const ffrt_deps_t* out_deps, const ffrt_task_attr_t* attr)
73 {
74     FFRT_COND_DO_ERR((exec == nullptr), return, "input invalid, exec == nullptr");
75     pthread_once(&ffrt::once, ffrt::InitIOTaskExecutor);
76 
77     ffrt::task_attr_private *p = reinterpret_cast<ffrt::task_attr_private *>(const_cast<ffrt_task_attr_t *>(attr));
78     ffrt::QoS qos = (p == nullptr ? ffrt::QoS() : ffrt::QoS(p->qos_));
79 
80     (void)in_deps;
81     (void)out_deps;
82     ffrt::IOTaskExecutor* task = new (std::nothrow) ffrt::IOTaskExecutor(qos);
83     FFRT_COND_RETURN_VOID(task == nullptr, "new IOTaskExecutor failed");
84 
85     task->work.exec = exec;
86     task->work.destroy = destroy;
87     task->work.data = co;
88     task->status = ffrt::ExecTaskStatus::ET_READY;
89 
90     ffrt_executor_task_submit(dynamic_cast<ffrt_executor_task_t*>(task), attr);
91 }
92 
93 API_ATTRIBUTE((visibility("default")))
94 void* ffrt_get_current_task()
95 {
96     return reinterpret_cast<void*>(ffrt::ExecuteCtx::Cur()->exec_task);
97 }
98 
99 // API used to schedule stackless coroutine task
100 API_ATTRIBUTE((visibility("default")))
101 void ffrt_wake_coroutine(void* task)
102 {
103     if (task == nullptr) {
104         FFRT_LOGE("Task is nullptr.");
105         return;
106     }
107 
108 #ifdef FFRT_BBOX_ENABLE
109     TaskWakeCounterInc();
110 #endif
111 
112     ffrt::IOTaskExecutor* wakedTask = static_cast<ffrt::IOTaskExecutor*>(task);
113     wakedTask->status = ffrt::ExecTaskStatus::ET_READY;
114 
115     // in self-wakeup scenario, tasks are placed in local fifo to delay scheduling, implementing the yeild function
116     bool selfWakeup = (ffrt::ExecuteCtx::Cur()->exec_task == task);
117     if (!selfWakeup) {
118         if (ffrt::ExecuteCtx::Cur()->PushTaskToPriorityStack(wakedTask)) {
119             return;
120         }
121 
122         if (rand() % INSERT_GLOBAL_QUEUE_FREQ) {
123             if (ffrt::ExecuteCtx::Cur()->localFifo != nullptr &&
124                 ffrt::ExecuteCtx::Cur()->localFifo->PushTail(task) == 0) {
125                 ffrt::FFRTFacade::GetEUInstance().NotifyLocalTaskAdded(wakedTask->qos);
126                 return;
127             }
128         }
129     }
130 
131     ffrt::LinkedList* node = reinterpret_cast<ffrt::LinkedList *>(&wakedTask->wq);
132     if (!ffrt::FFRTFacade::GetSchedInstance()->InsertNode(node, wakedTask->qos)) {
133         FFRT_LOGE("Submit io task failed!");
134     }
135 }
136 #ifdef __cplusplus
137 }
138 #endif
139 
140