src/rm_tree.c

   1 /**
   2  *   @file  rm_tree.c
   3  *
   4  *   @brief
   5  *      Resource Manager Tree Manipulation Source.
   6  *
   7  *  \par
   8  *  ============================================================================
   9  *  @n   (C) Copyright 2012-2013, Texas Instruments, Inc.
  10  *
  11  *  Redistribution and use in source and binary forms, with or without
  12  *  modification, are permitted provided that the following conditions
  13  *  are met:
  14  *
  15  *    Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  *
  18  *    Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the
  21  *    distribution.
  22  *
  23  *    Neither the name of Texas Instruments Incorporated nor the names of
  24  *    its contributors may be used to endorse or promote products derived
  25  *    from this software without specific prior written permission.
  26  *
  27  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  30  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  31  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  32  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  33  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  34  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  35  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  36  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  37  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38  *
  39  *  \par
  40 */
  41
  42 /* Standard includes */
  43 #include <string.h>
  44 #include <stdbool.h>
  45
  46 /* RM external API includes */
  47 #include <ti/drv/rm/rm.h>
  48
  49 /* RM internal API includes */
  50 #include <ti/drv/rm/include/rm_treeloc.h>
  51
  52 /* RM OSAL layer */
  53 #include <rm_osal.h>
  54
  55 /**********************************************************************
  56  ********************* NameServer Tree Functions **********************
  57  **********************************************************************/
  58
  59 /* FUNCTION PURPOSE: Creates a new NameServer tree node
  60  ***********************************************************************
  61  * DESCRIPTION: Creates a new NameServer tree node with the
  62  *              specified name and the resource values it is
  63  *              tied to.
  64  */
  65 Rm_NameServerNode *rmNameServerNodeNew(Rm_NameServerNodeCfg *nodeCfg)
  66 {
  67     Rm_NameServerNode *newNode = NULL;
  68
  69     newNode = Rm_osalMalloc(sizeof(Rm_NameServerNode));
  70     if (newNode) {
  71         strncpy(newNode->objName, nodeCfg->objName, RM_NAME_MAX_CHARS);
  72         strncpy(newNode->resourceName, nodeCfg->resourceName, RM_NAME_MAX_CHARS);
  73         newNode->resourceBase = nodeCfg->resourceBase;
  74         newNode->resourceLength = nodeCfg->resourceLength;
  75     }
  76
  77     return(newNode);
  78 }
  79
  80 /* FUNCTION PURPOSE: Deletes a NameServer tree node
  81  ***********************************************************************
  82  * DESCRIPTION: Deletes the specified NameServer tree node.
  83  */
  84 void rmNameServerNodeFree(Rm_NameServerNode *node)
  85 {
  86     if (node) {
  87         Rm_osalFree((void *)node, sizeof(Rm_NameServerNode));
  88     }
  89 }
  90
  91 /* FUNCTION PURPOSE: Compares two NameServer tree nodes
  92  ***********************************************************************
  93  * DESCRIPTION: Returns the result of a comparison of two
  94  *              NameServer tree node names.
  95  *              node1 name < node2 name --> return < 0
  96  *              node1 name = node2 name --> return 0
  97  *              node1 name > node2 name --> return > 0
  98  */
  99 int rmNameServerNodeCompare(Rm_NameServerNode *node1, Rm_NameServerNode *node2)
 100 {
 101     return(strncmp(node1->objName, node2->objName, RM_NAME_MAX_CHARS));
 102 }
 103
 104 /* Generate the NameServer tree manipulation functions */
 105 RB_GENERATE(_Rm_NameServerTree, _Rm_NameServerNode, linkage, rmNameServerNodeCompare);
 106
 107 /**********************************************************************
 108  *************** Policy Valid Instance Tree Functions *****************
 109  **********************************************************************/
 110
 111 /* FUNCTION PURPOSE: Creates a new valid instance tree node
 112  ***********************************************************************
 113  * DESCRIPTION: Creates a new valid instance tree node with the
 114  *              specified name.
 115  */
 116 Rm_PolicyValidInstNode *rmPolicyValidInstNodeNew(char *instName)
 117 {
 118     Rm_PolicyValidInstNode *newNode = NULL;
 119
 120     newNode = Rm_osalMalloc(sizeof(Rm_PolicyValidInstNode));
 121
 122     strncpy(newNode->name, instName, RM_NAME_MAX_CHARS);
 123     newNode->allocRefCount = 0;
 124     newNode->deletePending = false;
 125
 126     return(newNode);
 127 }
 128
 129 /* FUNCTION PURPOSE: Deletes a valid instance tree node
 130  ***********************************************************************
 131  * DESCRIPTION: Deletes the specified valind instance tree node
 132  *              if it has zero allocation references.
 133  */
 134 void rmPolicyValidInstNodeFree(Rm_PolicyValidInstNode *node)
 135 {
 136  /* TODO: Add allocation reference count check when reference count addition/subtraction
 137   *       bugs are resolved */
 138  //   if (node->allocRefCount == 0) {
 139         Rm_osalFree((void *)node, sizeof(Rm_PolicyValidInstNode));
 140  //   }
 141 }
 142
 143 /* FUNCTION PURPOSE: Compares two valid instance tree nodes
 144  ***********************************************************************
 145  * DESCRIPTION: Returns the result of a comparison of two
 146  *              valid instance tree node names.
 147  *              node1 name < node2 name --> return < 0
 148  *              node1 name = node2 name --> return 0
 149  *              node1 name > node2 name --> return > 0
 150  */
 151 int rmPolicyValidInstNodeCompare(Rm_PolicyValidInstNode *node1, Rm_PolicyValidInstNode *node2)
 152 {
 153     return(strncmp(node1->name, node2->name, RM_NAME_MAX_CHARS));
 154 }
 155
 156 /* Generate the valid instance tree manipulation functions */
 157 RB_GENERATE(_Rm_PolicyValidInstTree, _Rm_PolicyValidInstNode, linkage, rmPolicyValidInstNodeCompare);
 158
 159 /**********************************************************************
 160  ***************** Allocator Resource Tree Functions ******************
 161  **********************************************************************/
 162
 163 /* FUNCTION PURPOSE: Creates a new resource tree node
 164  ***********************************************************************
 165  * DESCRIPTION: Creates a new resource tree node with the
 166  *              specified name resource values.
 167  */
 168 Rm_ResourceNode *rmResourceNodeNew(uint32_t resourceBase, uint32_t resourceLength)
 169 {
 170     Rm_ResourceNode *newNode = NULL;
 171
 172     newNode = Rm_osalMalloc(sizeof(Rm_ResourceNode));
 173     memset((void *)newNode, 0, sizeof(Rm_ResourceNode));
 174
 175     newNode->base = resourceBase;
 176     newNode->length = resourceLength;
 177     newNode->allocationCount = 0;
 178     newNode->ownerList = NULL;
 179
 180     return(newNode);
 181 }
 182
 183 /* FUNCTION PURPOSE: Deletes a resource tree node
 184  ***********************************************************************
 185  * DESCRIPTION: Deletes the specified resource tree node
 186  *              if its allocation count is zero.
 187  */
 188 void rmResourceNodeFree(Rm_ResourceNode *node)
 189 {
 190     if (node->allocationCount == 0) {
 191         Rm_osalFree((void *)node, sizeof(Rm_ResourceNode));
 192     }
 193 }
 194
 195 /* FUNCTION PURPOSE: Compares two resource tree nodes
 196  ***********************************************************************
 197  * DESCRIPTION: Returns the result of a comparison of two
 198  *              resource tree node value ranges.
 199  *              |node1 range||node2 range| --> return < 0
 200  *                 |node1 range|
 201  *                   |node2 range| --> return 0 (any overlap in ranges)
 202  *              |node2 range||node1 range| --> return > 0
 203  */
 204 int rmResourceNodeCompare(Rm_ResourceNode *node1, Rm_ResourceNode *node2)
 205 {
 206     uint32_t node1End = node1->base + node1->length - 1;
 207     uint32_t node2End = node2->base + node2->length - 1;
 208
 209     if (node1End < node2->base) {
 210         /* End of node1 range is less than the start of node2's range.  Return a negative
 211          * value */
 212         return (-1);
 213     }
 214     else if (node1->base > node2End) {
 215         /* Start of node1 range is after end of node2's range.  Return a positive value */
 216         return (1);
 217     }
 218     else {
 219         /* If neither of the latter conditions were satisfied there is some overlap between
 220          * node1 and node2.  Return 0 since the application must handle this overlap. */
 221         return (0);
 222     }
 223 }
 224
 225 /* Generate the resource tree manipulation functions */
 226 RB_GENERATE(_Rm_AllocatorResourceTree, _Rm_ResourceNode, linkage, rmResourceNodeCompare)
 227