vx_graph.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2016 The Khronos Group Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */



#ifndef VX_GRAPH_H_
#define VX_GRAPH_H_


#ifdef __cplusplus
extern "C" {
#endif

#define TIVX_DEFAULT_GRAPH_TIMEOUT         (TIVX_EVENT_TIMEOUT_WAIT_FOREVER)

#define TIVX_GRAPH_PARAMETER_ENQUEUE_FLAG_PIPEUP (0x00000001u)

typedef struct {
    vx_node node;
    uint32_t  index;
    vx_bool queue_enable;
    uint32_t num_buf;
    tivx_data_ref_queue data_ref_queue;
    vx_reference refs_list[TIVX_OBJ_DESC_QUEUE_MAX_DEPTH];
    vx_bool is_enable_send_ref_consumed_event;
    uint32_t graph_consumed_app_value;
    vx_enum type;
} tivx_parameters_t;

typedef struct {
    vx_node node;
    uint32_t  index;
    uint32_t num_buf;
    tivx_data_ref_queue data_ref_queue;
    vx_reference refs_list[TIVX_OBJ_DESC_QUEUE_MAX_DEPTH];
} tivx_data_ref_q_list_t;

typedef struct {
    vx_node node;
    uint32_t  index;
    tivx_data_ref_queue data_ref_queue;
    vx_delay delay_ref;
    uint32_t delay_slot_index;
} tivx_delay_data_ref_q_list_t;

typedef struct _vx_graph {

    tivx_reference_t      base;

    vx_bool verified;

    vx_bool reverify;

    vx_node nodes[TIVX_GRAPH_MAX_NODES];

    /* \brief Number of nodes in a graph */
    uint32_t num_nodes;

    vx_node head_nodes[TIVX_GRAPH_MAX_HEAD_NODES];

    /* \brief Number of head nodes in a graph */
    uint32_t num_head_nodes;

    vx_node leaf_nodes[TIVX_GRAPH_MAX_LEAF_NODES];

    /* \brief Number of leaf nodes in a graph */
    uint32_t num_leaf_nodes;

    tivx_parameters_t parameters[TIVX_GRAPH_MAX_PARAMS];

    uint32_t      num_params;

    tivx_data_ref_q_list_t data_ref_q_list[TIVX_GRAPH_MAX_DATA_REF_QUEUE];

    uint32_t      num_data_ref_q;

    tivx_delay_data_ref_q_list_t delay_data_ref_q_list[TIVX_GRAPH_MAX_DATA_REF_QUEUE];
    uint32_t      num_delay_data_ref_q;

    vx_enum        state;

    vx_perf_t      perf;

    vx_delay       delays[TIVX_GRAPH_MAX_DELAYS];

    vx_rectangle_t in_valid_rect[TIVX_KERNEL_MAX_PARAMS];

    vx_rectangle_t *in_valid_rect_ptr[TIVX_KERNEL_MAX_PARAMS];


    vx_rectangle_t out_valid_rect[TIVX_PYRAMID_MAX_LEVEL_OBJECTS];

    vx_rectangle_t *out_valid_rect_ptr[TIVX_PYRAMID_MAX_LEVEL_OBJECTS];

    uint32_t pipeline_depth;

    uint32_t streaming_executions;

    vx_bool is_streaming;

    vx_bool is_streaming_enabled;

    vx_bool is_streaming_alloc;

    vx_bool trigger_node_set;

    vx_uint32 trigger_node_index;

    tivx_event  delete_done;

    tivx_event  stop_done;

    tivx_obj_desc_graph_t *obj_desc[TIVX_GRAPH_MAX_PIPELINE_DEPTH];

    tivx_queue free_q;

    uintptr_t free_q_mem[TIVX_GRAPH_MAX_PIPELINE_DEPTH];

    vx_enum schedule_mode;

    vx_bool is_pipelining_enabled;

    vx_bool is_pipeline_depth_set;

    uint32_t schedule_pending_count;

    vx_bool is_enable_send_complete_event;

    tivx_event  all_graph_completed_event;

    uint32_t submitted_count;

    uint32_t num_data_ref;

    vx_reference data_ref[TIVX_GRAPH_MAX_DATA_REF];

    uint8_t data_ref_num_in_nodes[TIVX_GRAPH_MAX_DATA_REF];

    uint8_t data_ref_num_out_nodes[TIVX_GRAPH_MAX_DATA_REF];

    tivx_event_queue_t event_queue;

    tivx_task streaming_task_handle;

    uint32_t graph_completed_app_value;

    tivx_super_node supernodes[TIVX_GRAPH_MAX_SUPER_NODES];

    uint32_t num_supernodes;

    vx_uint32 timeout_val;

} tivx_graph_t;



int32_t ownGraphGetFreeNodeIndex(vx_graph graph);

vx_status ownGraphAddNode(vx_graph graph, vx_node node, int32_t idx);

#if defined(BUILD_BAM)

vx_status ownGraphAddSuperNode(vx_graph graph, tivx_super_node super_node);

#endif

vx_status ownGraphRemoveNode(vx_graph graph, vx_node node);


void ownGraphTopologicalSort(tivx_graph_sort_context *context, vx_node *nodes, uint32_t num_nodes, vx_bool *has_cycle);

vx_uint32 ownGraphGetPipeDepth(vx_graph graph);


vx_bool ownGraphCheckIsRefMatch(vx_graph graph, vx_reference ref1, vx_reference ref2);

#if defined(BUILD_BAM)

void ownGraphCheckContinuityOfSupernode(tivx_graph_sort_context *context, tivx_super_node super_node, uint32_t num_nodes, vx_bool *is_continuous);

void ownGraphCheckSupernodeCycles(tivx_graph_sort_context *context, const vx_node *nodes, uint32_t num_nodes, vx_bool *has_cycle);

vx_status ownGraphSuperNodeConfigure(vx_graph graph);

#endif

void ownGraphSetReverify(vx_graph graph);


tivx_data_ref_queue ownGraphGetParameterDataRefQueue(vx_graph graph, vx_uint32 graph_parameter_index);


vx_status ownGraphAllocAndEnqueueObjDescForPipeline(vx_graph graph);

vx_status ownGraphAllocForStreaming(vx_graph graph);

vx_status ownGraphVerifyStreamingMode(vx_graph graph);

vx_status ownGraphFreeObjDesc(vx_graph graph);

vx_status ownGraphFreeStreaming(vx_graph graph);

vx_status ownGraphCreateQueues(vx_graph graph);

vx_status ownGraphDeleteQueues(vx_graph graph);


vx_status ownGraphScheduleGraph(vx_graph graph, uint32_t num_schedule);

vx_status ownGraphScheduleGraphWrapper(vx_graph graph);

vx_bool ownCheckGraphCompleted(vx_graph graph, uint32_t pipeline_id);


vx_bool ownGraphDoScheduleGraphAfterEnqueue(vx_graph graph, uint32_t graph_parameter_index);

vx_status ownUpdateGraphPerf(vx_graph graph, uint32_t pipeline_id);


void ownGraphClearState(vx_graph graph, uint32_t pipeline_id);

void ownSetGraphState(vx_graph graph, uint32_t pipeline_id, vx_enum state);

vx_status ownGraphRegisterCompletionEvent(vx_graph graph, vx_uint32 app_value);

vx_status ownGraphRegisterParameterConsumedEvent(vx_graph graph, uint32_t graph_parameter_index, vx_uint32 app_value);


void ownSendGraphCompletedEvent(vx_graph graph);

vx_status ownGraphParameterCheckValidEnqueueRef(vx_graph graph, uint32_t graph_parameter_index, vx_reference ref);

uint32_t ownGraphGetNumSchedule(vx_graph graph);

vx_status ownGraphValidatePipelineParameters(vx_graph graph);

void ownGraphDetectAndSetNumBuf(vx_graph graph);

vx_status tivxSendUserGraphEvent(vx_graph graph, vx_uint32 app_value, const void *parameter);

vx_status tivxWaitGraphEvent(
                    vx_graph graph, vx_event_t *event,
                    vx_bool do_not_block);

vx_status tivxGraphParameterEnqueueReadyRef(vx_graph graph,
                vx_uint32 graph_parameter_index,
                vx_reference *refs,
                vx_uint32 num_refs,
                vx_uint32 flags);

#ifdef __cplusplus
}
#endif

#endif