kupl_graph_submit

向kupl图中添加task任务，从而供KUPL底层executor获取任务进行执行。

接口定义

int kupl_graph_submit(kupl_graph_h graph, kupl_task_info_t *info);

参数

表1 参数定义
参数名	类型	描述	输入/输出
graph	kupl_graph_h	需要向其中添加task的kupl graph	输入


info	kupl_task_info_t *	需要添加的task的信息，具体见下表	输入

表2 kupl_task_info_t 的数据结构
参数名	类型	描述
type	kupl_task_type_t	task 的具体类型，可以设置为： KUPL_TASK_TYPE_SINGLE：动态图 task KUPL_TASK_TYPE_SGRAPH：静态图 task KUPL_TASK_TYPE_TASKLOOP: taskloop
desc	void *	task 类型所对应的描述，可以设置为： kupl_task_desc_t ：动态图 task 对应的描述，具体见下表 kupl_sgraph_task_desc_t ：静态图 task 对应的描述，具体见下表 kupl_taskloop_desc_t *: taskloop 对应的描述，具体见下表

表3 kupl_task_desc_t的数据结构
参数名	类型	描述
field_mask	uint32_t	掩码，用于指定结构体中哪些值有效，不设置掩码情况下仅func、args参数生效，其他需要设置掩码。具体可设置的掩码： KUPL_TASK_DESC_FIELD_PRIORITY：priority生效 KUPL_TASK_DESC_FIELD_NAME：name生效 KUPL_TASK_DESC_FIELD_FLAG：flag生效
func	void (kupl_task_func_t)(void args)	task的函数，task任务需要执行的具体函数
args	void *	func函数需要传入的参数
name	const char *	需要配置掩码KUPL_TASK_DESC_FIELD_NAME后才生效；task任务的名字
priority	int	需要配置掩码KUPL_TASK_DESC_FIELD_PRIORITY后才生效；task任务的优先级，数值越大，优先级越高
flag	uint32_t	需要配置掩码KUPL_TASK_DESC_FIELD_FLAG后才生效；task任务的flag，可设置为KUPL_TASK_FLAG_IMM，表示直接执行task，不需要调度

表4 kupl_sgraph_task_desc_t的数据结构
参数名	类型	描述
sgraph	kupl_sgraph_h	需要提交的静态图
name	const char *	需要配置掩码KUPL_SGRAPH_TASK_DESC_FIELD_NAME后才能生效；静态图task的名字
priority	int	需要配置掩码KUPL_SGRAPH_TASK_DESC_FIELD_PRIORITY后才能生效；静态图task的优先级，数值越大，优先级越高
flag	uint32_t	需要配置掩码KUPL_SGRAPH_TASK_DESC_FIELD_FLAG后才能生效；静态图task的flag，可设置为KUPL_SGRAPH_TASK_FLAG_IMM，表示直接执行静态图任务，不需要调度
field_mask	uint64_t	掩码，用于指定结构体中哪些值有效，不设置掩码情况下仅sgraph参数生效，其他需要设置掩码。具体可设置的掩码： KUPL_SGRAPH_TASK_DESC_FIELD_NAME：name生效 KUPL_SGRAPH_TASK_DESC_FIELD_PRIORITY：priority生效 KUPL_SGRAPH_TASK_DESC_FIELD_FLAG：flag生效

表5 kupl_taskloop_desc_t 的数据结构
参数名	类型	描述
field_mask	uint64_t	结构体中有效字段的掩码，使用 kupl_taskloop_desc_field 中的位标识。此掩码中未指定的字段将被忽略。当前所有字段都为必填项。具体可设置的掩码： KUPL_TASKLOOP_DESC_FIELD_RANGE：range生效 KUPL_TASKLOOP_DESC_FIELD_EGROUP：egroup生效 KUPL_TASKLOOP_DESC_FIELD_DEFAULT：上述字段都生效
func	void (kupl_taskloop_func_t)(kupl_nd_range_t nd_range, void *args)	taskloop 任务需要执行的具体函数
args	void *	func 函数需要传入的参数
range	kupl_nd_range_t *	taskloop 范围，详细使用方式见 kupl_parallel_for 章节
egroup	kupl_egroup_h	执行 taskloop 任务的 egroup，即能在哪个 egroup 中的 executor 执行器上执行

返回值

成功：返回KUPL_OK
失败：返回KUPL_ERROR

示例

#include <stdio.h> 
#include "kupl.h" 
#include <assert.h>

static inline void task_str(void *args)
{
    printf("graph task test.\n");
}

int main() 
{ 
    int executor_num = kupl_get_num_executors(); 
    int executors[executor_num]; 
    for (int i = 0; i < executor_num; i++) {
        executors[i] = i;
    } 
    kupl_egroup_h egroup = kupl_egroup_create(executors, executor_num);
    kupl_graph_h graph = kupl_graph_create(egroup); 
    kupl_task_desc_t task_desc = {
        .field_mask = KUPL_TASK_DESC_FIELD_FLAG,
        .func = task_str,
        .args = NULL, 
        .flag = KUPL_TASK_FLAG_IMM,
    };
    kupl_task_info_t info = {
        .type = KUPL_TASK_TYPE_SINGLE,
        .desc = &task_desc,
    };

    int ret = kupl_graph_submit(graph, &info);
    assert(ret == KUPL_OK);

    kupl_graph_wait(graph);
    kupl_graph_destroy(graph);
    kupl_egroup_destroy(egroup);
    return 0;         
}

运行结果如下。

graph task test.

上述示例演示了向graph图提交task的流程。上述kupl_graph_submit函数提交的task的函数为task_str，函数不需要参数，task设置了flag生效且flag值设置为KUPL_TASK_FLAG_IMM；不需要获取特定的task。

父主题： 计算图编程函数