src/util/dag.h

   1 /*
   2  * Copyright © 2019 Broadcom
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23
  24 #ifndef DAG_H
  25 #define DAG_H
  26
  27 #include <stdint.h>
  28 #include "util/list.h"
  29 #include "util/u_dynarray.h"
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 struct dag_edge {
  36    struct dag_node *child;
  37    /* User-defined data associated with the edge. */
  38    void *data;
  39 };
  40
  41 struct dag_node {
  42    /* Position in the DAG heads list (or a self-link) */
  43    struct list_head link;
  44    /* Array struct edge to the children. */
  45    struct util_dynarray edges;
  46    uint32_t parent_count;
  47 };
  48
  49 struct dag {
  50    struct list_head heads;
  51 };
  52
  53 struct dag *dag_create(void *mem_ctx);
  54 void dag_init_node(struct dag *dag, struct dag_node *node);
  55 void dag_add_edge(struct dag_node *parent, struct dag_node *child, void *data);
  56 void dag_remove_edge(struct dag *dag, struct dag_edge *edge);
  57 void dag_traverse_bottom_up(struct dag *dag, void (*cb)(struct dag_node *node,
  58                                                         void *data), void *data);
  59 void dag_prune_head(struct dag *dag, struct dag_node *node);
  60
  61 #ifdef __cplusplus
  62 }
  63 #endif
  64
  65 #endif