IxEthDBAPI.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448
  1. /**
  2. * @file IxEthDBAPI.c
  3. *
  4. * @brief Implementation of the public API
  5. *
  6. * @par
  7. * IXP400 SW Release version 2.0
  8. *
  9. * -- Copyright Notice --
  10. *
  11. * @par
  12. * Copyright 2001-2005, Intel Corporation.
  13. * All rights reserved.
  14. *
  15. * @par
  16. * Redistribution and use in source and binary forms, with or without
  17. * modification, are permitted provided that the following conditions
  18. * are met:
  19. * 1. Redistributions of source code must retain the above copyright
  20. * notice, this list of conditions and the following disclaimer.
  21. * 2. Redistributions in binary form must reproduce the above copyright
  22. * notice, this list of conditions and the following disclaimer in the
  23. * documentation and/or other materials provided with the distribution.
  24. * 3. Neither the name of the Intel Corporation nor the names of its contributors
  25. * may be used to endorse or promote products derived from this software
  26. * without specific prior written permission.
  27. *
  28. * @par
  29. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
  30. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  31. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  32. * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
  33. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  34. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  35. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  36. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  37. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  38. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  39. * SUCH DAMAGE.
  40. *
  41. * @par
  42. * -- End of Copyright Notice --
  43. */
  44. #include "IxEthDB_p.h"
  45. #include "IxFeatureCtrl.h"
  46. extern HashTable dbHashtable;
  47. extern IxEthDBPortMap overflowUpdatePortList;
  48. extern BOOL ixEthDBPortUpdateRequired[IX_ETH_DB_MAX_RECORD_TYPE_INDEX + 1];
  49. IX_ETH_DB_PUBLIC
  50. IxEthDBStatus ixEthDBFilteringStaticEntryProvision(IxEthDBPortId portID, IxEthDBMacAddr *macAddr)
  51. {
  52. IX_ETH_DB_CHECK_PORT(portID);
  53. IX_ETH_DB_CHECK_SINGLE_NPE(portID);
  54. IX_ETH_DB_CHECK_REFERENCE(macAddr);
  55. IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_LEARNING);
  56. return ixEthDBTriggerAddPortUpdate(macAddr, portID, true);
  57. }
  58. IX_ETH_DB_PUBLIC
  59. IxEthDBStatus ixEthDBFilteringDynamicEntryProvision(IxEthDBPortId portID, IxEthDBMacAddr *macAddr)
  60. {
  61. IX_ETH_DB_CHECK_PORT(portID);
  62. IX_ETH_DB_CHECK_SINGLE_NPE(portID);
  63. IX_ETH_DB_CHECK_REFERENCE(macAddr);
  64. IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_LEARNING);
  65. return ixEthDBTriggerAddPortUpdate(macAddr, portID, false);
  66. }
  67. IX_ETH_DB_PUBLIC
  68. IxEthDBStatus ixEthDBFilteringEntryDelete(IxEthDBMacAddr *macAddr)
  69. {
  70. HashNode *searchResult;
  71. IX_ETH_DB_CHECK_REFERENCE(macAddr);
  72. searchResult = ixEthDBSearch(macAddr, IX_ETH_DB_ALL_FILTERING_RECORDS);
  73. if (searchResult == NULL)
  74. {
  75. return IX_ETH_DB_NO_SUCH_ADDR; /* not found */
  76. }
  77. ixEthDBReleaseHashNode(searchResult);
  78. /* build a remove event and place it on the event queue */
  79. return ixEthDBTriggerRemovePortUpdate(macAddr, ((MacDescriptor *) searchResult->data)->portID);
  80. }
  81. IX_ETH_DB_PUBLIC
  82. void ixEthDBDatabaseMaintenance()
  83. {
  84. HashIterator iterator;
  85. UINT32 portIndex;
  86. BOOL agingRequired = false;
  87. /* ports who will have deleted records and therefore will need updating */
  88. IxEthDBPortMap triggerPorts;
  89. if (IX_FEATURE_CTRL_SWCONFIG_ENABLED !=
  90. ixFeatureCtrlSwConfigurationCheck (IX_FEATURECTRL_ETH_LEARNING))
  91. {
  92. return;
  93. }
  94. SET_EMPTY_DEPENDENCY_MAP(triggerPorts);
  95. /* check if there's at least a port that needs aging */
  96. for (portIndex = 0 ; portIndex < IX_ETH_DB_NUMBER_OF_PORTS ; portIndex++)
  97. {
  98. if (ixEthDBPortInfo[portIndex].agingEnabled && ixEthDBPortInfo[portIndex].enabled)
  99. {
  100. agingRequired = true;
  101. }
  102. }
  103. if (agingRequired)
  104. {
  105. /* ask each NPE port to write back the database for aging inspection */
  106. for (portIndex = 0 ; portIndex < IX_ETH_DB_NUMBER_OF_PORTS ; portIndex++)
  107. {
  108. if (ixEthDBPortDefinitions[portIndex].type == IX_ETH_NPE
  109. && ixEthDBPortInfo[portIndex].agingEnabled
  110. && ixEthDBPortInfo[portIndex].enabled)
  111. {
  112. IxNpeMhMessage message;
  113. IX_STATUS result;
  114. /* send EDB_GetMACAddressDatabase message */
  115. FILL_GETMACADDRESSDATABASE(message,
  116. 0 /* unused */,
  117. IX_OSAL_MMU_VIRT_TO_PHYS(ixEthDBPortInfo[portIndex].updateMethod.npeUpdateZone));
  118. IX_ETHDB_SEND_NPE_MSG(IX_ETH_DB_PORT_ID_TO_NPE(portIndex), message, result);
  119. if (result == IX_SUCCESS)
  120. {
  121. /* analyze NPE copy */
  122. ixEthDBNPESyncScan(portIndex, ixEthDBPortInfo[portIndex].updateMethod.npeUpdateZone, FULL_ELT_BYTE_SIZE);
  123. IX_ETH_DB_SUPPORT_TRACE("DB: (API) Finished scanning NPE tree on port %d\n", portIndex);
  124. }
  125. else
  126. {
  127. ixEthDBPortInfo[portIndex].agingEnabled = false;
  128. ixEthDBPortInfo[portIndex].updateMethod.updateEnabled = false;
  129. ixEthDBPortInfo[portIndex].updateMethod.userControlled = true;
  130. ixOsalLog(IX_OSAL_LOG_LVL_FATAL,
  131. IX_OSAL_LOG_DEV_STDOUT,
  132. "EthDB: (Maintenance) warning, disabling aging and updates for port %d (assumed dead)\n",
  133. portIndex, 0, 0, 0, 0, 0);
  134. ixEthDBDatabaseClear(portIndex, IX_ETH_DB_ALL_RECORD_TYPES);
  135. }
  136. }
  137. }
  138. /* browse database and age entries */
  139. BUSY_RETRY(ixEthDBInitHashIterator(&dbHashtable, &iterator));
  140. while (IS_ITERATOR_VALID(&iterator))
  141. {
  142. MacDescriptor *descriptor = (MacDescriptor *) iterator.node->data;
  143. UINT32 *age = NULL;
  144. BOOL staticEntry = true;
  145. if (descriptor->type == IX_ETH_DB_FILTERING_RECORD)
  146. {
  147. age = &descriptor->recordData.filteringData.age;
  148. staticEntry = descriptor->recordData.filteringData.staticEntry;
  149. }
  150. else if (descriptor->type == IX_ETH_DB_FILTERING_VLAN_RECORD)
  151. {
  152. age = &descriptor->recordData.filteringVlanData.age;
  153. staticEntry = descriptor->recordData.filteringVlanData.staticEntry;
  154. }
  155. else
  156. {
  157. staticEntry = true;
  158. }
  159. if (ixEthDBPortInfo[descriptor->portID].agingEnabled && (staticEntry == false))
  160. {
  161. /* manually increment the age if the port has no such capability */
  162. if ((ixEthDBPortDefinitions[descriptor->portID].capabilities & IX_ETH_ENTRY_AGING) == 0)
  163. {
  164. *age += (IX_ETH_DB_MAINTENANCE_TIME / 60);
  165. }
  166. /* age entry if it exceeded the maximum time to live */
  167. if (*age >= (IX_ETH_DB_LEARNING_ENTRY_AGE_TIME / 60))
  168. {
  169. /* add port to the set of update trigger ports */
  170. JOIN_PORT_TO_MAP(triggerPorts, descriptor->portID);
  171. /* delete entry */
  172. BUSY_RETRY(ixEthDBRemoveEntryAtHashIterator(&dbHashtable, &iterator));
  173. }
  174. else
  175. {
  176. /* move to the next record */
  177. BUSY_RETRY(ixEthDBIncrementHashIterator(&dbHashtable, &iterator));
  178. }
  179. }
  180. else
  181. {
  182. /* move to the next record */
  183. BUSY_RETRY(ixEthDBIncrementHashIterator(&dbHashtable, &iterator));
  184. }
  185. }
  186. /* update ports which lost records */
  187. ixEthDBUpdatePortLearningTrees(triggerPorts);
  188. }
  189. }
  190. IX_ETH_DB_PUBLIC
  191. IxEthDBStatus ixEthDBDatabaseClear(IxEthDBPortId portID, IxEthDBRecordType recordType)
  192. {
  193. IxEthDBPortMap triggerPorts;
  194. HashIterator iterator;
  195. if (portID >= IX_ETH_DB_NUMBER_OF_PORTS && portID != IX_ETH_DB_ALL_PORTS)
  196. {
  197. return IX_ETH_DB_INVALID_PORT;
  198. }
  199. /* check if the user passes some extra bits */
  200. if ((recordType | IX_ETH_DB_ALL_RECORD_TYPES) != IX_ETH_DB_ALL_RECORD_TYPES)
  201. {
  202. return IX_ETH_DB_INVALID_ARG;
  203. }
  204. SET_EMPTY_DEPENDENCY_MAP(triggerPorts);
  205. /* browse database and age entries */
  206. BUSY_RETRY(ixEthDBInitHashIterator(&dbHashtable, &iterator));
  207. while (IS_ITERATOR_VALID(&iterator))
  208. {
  209. MacDescriptor *descriptor = (MacDescriptor *) iterator.node->data;
  210. if (((descriptor->portID == portID) || (portID == IX_ETH_DB_ALL_PORTS))
  211. && ((descriptor->type & recordType) != 0))
  212. {
  213. /* add to trigger if automatic updates are required */
  214. if (ixEthDBPortUpdateRequired[descriptor->type])
  215. {
  216. /* add port to the set of update trigger ports */
  217. JOIN_PORT_TO_MAP(triggerPorts, descriptor->portID);
  218. }
  219. /* delete entry */
  220. BUSY_RETRY(ixEthDBRemoveEntryAtHashIterator(&dbHashtable, &iterator));
  221. }
  222. else
  223. {
  224. /* move to the next record */
  225. BUSY_RETRY(ixEthDBIncrementHashIterator(&dbHashtable, &iterator));
  226. }
  227. }
  228. /* update ports which lost records */
  229. ixEthDBUpdatePortLearningTrees(triggerPorts);
  230. return IX_ETH_DB_SUCCESS;
  231. }
  232. IX_ETH_DB_PUBLIC
  233. IxEthDBStatus ixEthDBFilteringPortSearch(IxEthDBPortId portID, IxEthDBMacAddr *macAddr)
  234. {
  235. HashNode *searchResult;
  236. IxEthDBStatus result = IX_ETH_DB_NO_SUCH_ADDR;
  237. IX_ETH_DB_CHECK_PORT(portID);
  238. IX_ETH_DB_CHECK_SINGLE_NPE(portID);
  239. IX_ETH_DB_CHECK_REFERENCE(macAddr);
  240. IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_LEARNING);
  241. searchResult = ixEthDBSearch(macAddr, IX_ETH_DB_ALL_FILTERING_RECORDS);
  242. if (searchResult == NULL)
  243. {
  244. return IX_ETH_DB_NO_SUCH_ADDR; /* not found */
  245. }
  246. if (((MacDescriptor *) (searchResult->data))->portID == portID)
  247. {
  248. result = IX_ETH_DB_SUCCESS; /* address and port match */
  249. }
  250. ixEthDBReleaseHashNode(searchResult);
  251. return result;
  252. }
  253. IX_ETH_DB_PUBLIC
  254. IxEthDBStatus ixEthDBFilteringDatabaseSearch(IxEthDBPortId *portID, IxEthDBMacAddr *macAddr)
  255. {
  256. HashNode *searchResult;
  257. IX_ETH_DB_CHECK_REFERENCE(portID);
  258. IX_ETH_DB_CHECK_REFERENCE(macAddr);
  259. searchResult = ixEthDBSearch(macAddr, IX_ETH_DB_ALL_FILTERING_RECORDS);
  260. if (searchResult == NULL)
  261. {
  262. return IX_ETH_DB_NO_SUCH_ADDR; /* not found */
  263. }
  264. /* return the port ID */
  265. *portID = ((MacDescriptor *) searchResult->data)->portID;
  266. ixEthDBReleaseHashNode(searchResult);
  267. return IX_ETH_DB_SUCCESS;
  268. }
  269. IX_ETH_DB_PUBLIC
  270. IxEthDBStatus ixEthDBPortAgingDisable(IxEthDBPortId portID)
  271. {
  272. IX_ETH_DB_CHECK_PORT(portID);
  273. IX_ETH_DB_CHECK_SINGLE_NPE(portID);
  274. IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_LEARNING);
  275. ixEthDBPortInfo[portID].agingEnabled = false;
  276. return IX_ETH_DB_SUCCESS;
  277. }
  278. IX_ETH_DB_PUBLIC
  279. IxEthDBStatus ixEthDBPortAgingEnable(IxEthDBPortId portID)
  280. {
  281. IX_ETH_DB_CHECK_PORT(portID);
  282. IX_ETH_DB_CHECK_SINGLE_NPE(portID);
  283. IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_LEARNING);
  284. ixEthDBPortInfo[portID].agingEnabled = true;
  285. return IX_ETH_DB_SUCCESS;
  286. }
  287. IX_ETH_DB_PUBLIC
  288. IxEthDBStatus ixEthDBFilteringPortUpdatingSearch(IxEthDBPortId *portID, IxEthDBMacAddr *macAddr)
  289. {
  290. HashNode *searchResult;
  291. MacDescriptor *descriptor;
  292. IX_ETH_DB_CHECK_REFERENCE(portID);
  293. IX_ETH_DB_CHECK_REFERENCE(macAddr);
  294. searchResult = ixEthDBSearch(macAddr, IX_ETH_DB_ALL_FILTERING_RECORDS);
  295. if (searchResult == NULL)
  296. {
  297. return IX_ETH_DB_NO_SUCH_ADDR; /* not found */
  298. }
  299. descriptor = (MacDescriptor *) searchResult->data;
  300. /* return the port ID */
  301. *portID = descriptor->portID;
  302. /* reset entry age */
  303. if (descriptor->type == IX_ETH_DB_FILTERING_RECORD)
  304. {
  305. descriptor->recordData.filteringData.age = 0;
  306. }
  307. else
  308. {
  309. descriptor->recordData.filteringVlanData.age = 0;
  310. }
  311. ixEthDBReleaseHashNode(searchResult);
  312. return IX_ETH_DB_SUCCESS;
  313. }
  314. IX_ETH_DB_PUBLIC
  315. IxEthDBStatus ixEthDBPortDependencyMapSet(IxEthDBPortId portID, IxEthDBPortMap dependencyPortMap)
  316. {
  317. IX_ETH_DB_CHECK_PORT(portID);
  318. IX_ETH_DB_CHECK_SINGLE_NPE(portID);
  319. IX_ETH_DB_CHECK_REFERENCE(dependencyPortMap);
  320. IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_FILTERING);
  321. /* force bit at offset 255 to 0 (reserved) */
  322. dependencyPortMap[31] &= 0xFE;
  323. COPY_DEPENDENCY_MAP(ixEthDBPortInfo[portID].dependencyPortMap, dependencyPortMap);
  324. return IX_ETH_DB_SUCCESS;
  325. }
  326. IX_ETH_DB_PUBLIC
  327. IxEthDBStatus ixEthDBPortDependencyMapGet(IxEthDBPortId portID, IxEthDBPortMap dependencyPortMap)
  328. {
  329. IX_ETH_DB_CHECK_PORT(portID);
  330. IX_ETH_DB_CHECK_SINGLE_NPE(portID);
  331. IX_ETH_DB_CHECK_REFERENCE(dependencyPortMap);
  332. IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_FILTERING);
  333. COPY_DEPENDENCY_MAP(dependencyPortMap, ixEthDBPortInfo[portID].dependencyPortMap);
  334. return IX_ETH_DB_SUCCESS;
  335. }
  336. IX_ETH_DB_PUBLIC
  337. IxEthDBStatus ixEthDBPortUpdateEnableSet(IxEthDBPortId portID, BOOL enableUpdate)
  338. {
  339. IX_ETH_DB_CHECK_PORT(portID);
  340. IX_ETH_DB_CHECK_SINGLE_NPE(portID);
  341. IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_FILTERING);
  342. ixEthDBPortInfo[portID].updateMethod.updateEnabled = enableUpdate;
  343. ixEthDBPortInfo[portID].updateMethod.userControlled = true;
  344. return IX_ETH_DB_SUCCESS;
  345. }