4 * @brief Implementation of the public API
7 * IXP400 SW Release version 2.0
9 * -- Copyright Notice --
12 * Copyright 2001-2005, Intel Corporation.
13 * All rights reserved.
16 * SPDX-License-Identifier: BSD-3-Clause
18 * -- End of Copyright Notice --
21 #include "IxEthDB_p.h"
22 #include "IxFeatureCtrl.h"
24 extern HashTable dbHashtable;
25 extern IxEthDBPortMap overflowUpdatePortList;
26 extern BOOL ixEthDBPortUpdateRequired[IX_ETH_DB_MAX_RECORD_TYPE_INDEX + 1];
29 IxEthDBStatus ixEthDBFilteringStaticEntryProvision(IxEthDBPortId portID, IxEthDBMacAddr *macAddr)
31 IX_ETH_DB_CHECK_PORT(portID);
33 IX_ETH_DB_CHECK_SINGLE_NPE(portID);
35 IX_ETH_DB_CHECK_REFERENCE(macAddr);
37 IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_LEARNING);
39 return ixEthDBTriggerAddPortUpdate(macAddr, portID, true);
43 IxEthDBStatus ixEthDBFilteringDynamicEntryProvision(IxEthDBPortId portID, IxEthDBMacAddr *macAddr)
45 IX_ETH_DB_CHECK_PORT(portID);
47 IX_ETH_DB_CHECK_SINGLE_NPE(portID);
49 IX_ETH_DB_CHECK_REFERENCE(macAddr);
51 IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_LEARNING);
53 return ixEthDBTriggerAddPortUpdate(macAddr, portID, false);
57 IxEthDBStatus ixEthDBFilteringEntryDelete(IxEthDBMacAddr *macAddr)
59 HashNode *searchResult;
61 IX_ETH_DB_CHECK_REFERENCE(macAddr);
63 searchResult = ixEthDBSearch(macAddr, IX_ETH_DB_ALL_FILTERING_RECORDS);
65 if (searchResult == NULL)
67 return IX_ETH_DB_NO_SUCH_ADDR; /* not found */
70 ixEthDBReleaseHashNode(searchResult);
72 /* build a remove event and place it on the event queue */
73 return ixEthDBTriggerRemovePortUpdate(macAddr, ((MacDescriptor *) searchResult->data)->portID);
77 void ixEthDBDatabaseMaintenance()
79 HashIterator iterator;
81 BOOL agingRequired = false;
83 /* ports who will have deleted records and therefore will need updating */
84 IxEthDBPortMap triggerPorts;
86 if (IX_FEATURE_CTRL_SWCONFIG_ENABLED !=
87 ixFeatureCtrlSwConfigurationCheck (IX_FEATURECTRL_ETH_LEARNING))
92 SET_EMPTY_DEPENDENCY_MAP(triggerPorts);
94 /* check if there's at least a port that needs aging */
95 for (portIndex = 0 ; portIndex < IX_ETH_DB_NUMBER_OF_PORTS ; portIndex++)
97 if (ixEthDBPortInfo[portIndex].agingEnabled && ixEthDBPortInfo[portIndex].enabled)
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++)
108 if (ixEthDBPortDefinitions[portIndex].type == IX_ETH_NPE
109 && ixEthDBPortInfo[portIndex].agingEnabled
110 && ixEthDBPortInfo[portIndex].enabled)
112 IxNpeMhMessage message;
115 /* send EDB_GetMACAddressDatabase message */
116 FILL_GETMACADDRESSDATABASE(message,
118 IX_OSAL_MMU_VIRT_TO_PHYS(ixEthDBPortInfo[portIndex].updateMethod.npeUpdateZone));
120 IX_ETHDB_SEND_NPE_MSG(IX_ETH_DB_PORT_ID_TO_NPE(portIndex), message, result);
122 if (result == IX_SUCCESS)
124 /* analyze NPE copy */
125 ixEthDBNPESyncScan(portIndex, ixEthDBPortInfo[portIndex].updateMethod.npeUpdateZone, FULL_ELT_BYTE_SIZE);
127 IX_ETH_DB_SUPPORT_TRACE("DB: (API) Finished scanning NPE tree on port %d\n", portIndex);
131 ixEthDBPortInfo[portIndex].agingEnabled = false;
132 ixEthDBPortInfo[portIndex].updateMethod.updateEnabled = false;
133 ixEthDBPortInfo[portIndex].updateMethod.userControlled = true;
135 ixOsalLog(IX_OSAL_LOG_LVL_FATAL,
136 IX_OSAL_LOG_DEV_STDOUT,
137 "EthDB: (Maintenance) warning, disabling aging and updates for port %d (assumed dead)\n",
138 portIndex, 0, 0, 0, 0, 0);
140 ixEthDBDatabaseClear(portIndex, IX_ETH_DB_ALL_RECORD_TYPES);
145 /* browse database and age entries */
146 BUSY_RETRY(ixEthDBInitHashIterator(&dbHashtable, &iterator));
148 while (IS_ITERATOR_VALID(&iterator))
150 MacDescriptor *descriptor = (MacDescriptor *) iterator.node->data;
152 BOOL staticEntry = true;
154 if (descriptor->type == IX_ETH_DB_FILTERING_RECORD)
156 age = &descriptor->recordData.filteringData.age;
157 staticEntry = descriptor->recordData.filteringData.staticEntry;
159 else if (descriptor->type == IX_ETH_DB_FILTERING_VLAN_RECORD)
161 age = &descriptor->recordData.filteringVlanData.age;
162 staticEntry = descriptor->recordData.filteringVlanData.staticEntry;
169 if (ixEthDBPortInfo[descriptor->portID].agingEnabled && (staticEntry == false))
171 /* manually increment the age if the port has no such capability */
172 if ((ixEthDBPortDefinitions[descriptor->portID].capabilities & IX_ETH_ENTRY_AGING) == 0)
174 *age += (IX_ETH_DB_MAINTENANCE_TIME / 60);
177 /* age entry if it exceeded the maximum time to live */
178 if (*age >= (IX_ETH_DB_LEARNING_ENTRY_AGE_TIME / 60))
180 /* add port to the set of update trigger ports */
181 JOIN_PORT_TO_MAP(triggerPorts, descriptor->portID);
184 BUSY_RETRY(ixEthDBRemoveEntryAtHashIterator(&dbHashtable, &iterator));
188 /* move to the next record */
189 BUSY_RETRY(ixEthDBIncrementHashIterator(&dbHashtable, &iterator));
194 /* move to the next record */
195 BUSY_RETRY(ixEthDBIncrementHashIterator(&dbHashtable, &iterator));
199 /* update ports which lost records */
200 ixEthDBUpdatePortLearningTrees(triggerPorts);
205 IxEthDBStatus ixEthDBDatabaseClear(IxEthDBPortId portID, IxEthDBRecordType recordType)
207 IxEthDBPortMap triggerPorts;
208 HashIterator iterator;
210 if (portID >= IX_ETH_DB_NUMBER_OF_PORTS && portID != IX_ETH_DB_ALL_PORTS)
212 return IX_ETH_DB_INVALID_PORT;
215 /* check if the user passes some extra bits */
216 if ((recordType | IX_ETH_DB_ALL_RECORD_TYPES) != IX_ETH_DB_ALL_RECORD_TYPES)
218 return IX_ETH_DB_INVALID_ARG;
221 SET_EMPTY_DEPENDENCY_MAP(triggerPorts);
223 /* browse database and age entries */
224 BUSY_RETRY(ixEthDBInitHashIterator(&dbHashtable, &iterator));
226 while (IS_ITERATOR_VALID(&iterator))
228 MacDescriptor *descriptor = (MacDescriptor *) iterator.node->data;
230 if (((descriptor->portID == portID) || (portID == IX_ETH_DB_ALL_PORTS))
231 && ((descriptor->type & recordType) != 0))
233 /* add to trigger if automatic updates are required */
234 if (ixEthDBPortUpdateRequired[descriptor->type])
236 /* add port to the set of update trigger ports */
237 JOIN_PORT_TO_MAP(triggerPorts, descriptor->portID);
241 BUSY_RETRY(ixEthDBRemoveEntryAtHashIterator(&dbHashtable, &iterator));
245 /* move to the next record */
246 BUSY_RETRY(ixEthDBIncrementHashIterator(&dbHashtable, &iterator));
250 /* update ports which lost records */
251 ixEthDBUpdatePortLearningTrees(triggerPorts);
253 return IX_ETH_DB_SUCCESS;
257 IxEthDBStatus ixEthDBFilteringPortSearch(IxEthDBPortId portID, IxEthDBMacAddr *macAddr)
259 HashNode *searchResult;
260 IxEthDBStatus result = IX_ETH_DB_NO_SUCH_ADDR;
262 IX_ETH_DB_CHECK_PORT(portID);
264 IX_ETH_DB_CHECK_SINGLE_NPE(portID);
266 IX_ETH_DB_CHECK_REFERENCE(macAddr);
268 IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_LEARNING);
270 searchResult = ixEthDBSearch(macAddr, IX_ETH_DB_ALL_FILTERING_RECORDS);
272 if (searchResult == NULL)
274 return IX_ETH_DB_NO_SUCH_ADDR; /* not found */
277 if (((MacDescriptor *) (searchResult->data))->portID == portID)
279 result = IX_ETH_DB_SUCCESS; /* address and port match */
282 ixEthDBReleaseHashNode(searchResult);
288 IxEthDBStatus ixEthDBFilteringDatabaseSearch(IxEthDBPortId *portID, IxEthDBMacAddr *macAddr)
290 HashNode *searchResult;
292 IX_ETH_DB_CHECK_REFERENCE(portID);
294 IX_ETH_DB_CHECK_REFERENCE(macAddr);
296 searchResult = ixEthDBSearch(macAddr, IX_ETH_DB_ALL_FILTERING_RECORDS);
298 if (searchResult == NULL)
300 return IX_ETH_DB_NO_SUCH_ADDR; /* not found */
303 /* return the port ID */
304 *portID = ((MacDescriptor *) searchResult->data)->portID;
306 ixEthDBReleaseHashNode(searchResult);
308 return IX_ETH_DB_SUCCESS;
312 IxEthDBStatus ixEthDBPortAgingDisable(IxEthDBPortId portID)
314 IX_ETH_DB_CHECK_PORT(portID);
316 IX_ETH_DB_CHECK_SINGLE_NPE(portID);
318 IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_LEARNING);
320 ixEthDBPortInfo[portID].agingEnabled = false;
322 return IX_ETH_DB_SUCCESS;
326 IxEthDBStatus ixEthDBPortAgingEnable(IxEthDBPortId portID)
328 IX_ETH_DB_CHECK_PORT(portID);
330 IX_ETH_DB_CHECK_SINGLE_NPE(portID);
332 IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_LEARNING);
334 ixEthDBPortInfo[portID].agingEnabled = true;
336 return IX_ETH_DB_SUCCESS;
340 IxEthDBStatus ixEthDBFilteringPortUpdatingSearch(IxEthDBPortId *portID, IxEthDBMacAddr *macAddr)
342 HashNode *searchResult;
343 MacDescriptor *descriptor;
345 IX_ETH_DB_CHECK_REFERENCE(portID);
347 IX_ETH_DB_CHECK_REFERENCE(macAddr);
349 searchResult = ixEthDBSearch(macAddr, IX_ETH_DB_ALL_FILTERING_RECORDS);
351 if (searchResult == NULL)
353 return IX_ETH_DB_NO_SUCH_ADDR; /* not found */
356 descriptor = (MacDescriptor *) searchResult->data;
358 /* return the port ID */
359 *portID = descriptor->portID;
361 /* reset entry age */
362 if (descriptor->type == IX_ETH_DB_FILTERING_RECORD)
364 descriptor->recordData.filteringData.age = 0;
368 descriptor->recordData.filteringVlanData.age = 0;
371 ixEthDBReleaseHashNode(searchResult);
373 return IX_ETH_DB_SUCCESS;
377 IxEthDBStatus ixEthDBPortDependencyMapSet(IxEthDBPortId portID, IxEthDBPortMap dependencyPortMap)
379 IX_ETH_DB_CHECK_PORT(portID);
381 IX_ETH_DB_CHECK_SINGLE_NPE(portID);
383 IX_ETH_DB_CHECK_REFERENCE(dependencyPortMap);
385 IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_FILTERING);
387 /* force bit at offset 255 to 0 (reserved) */
388 dependencyPortMap[31] &= 0xFE;
390 COPY_DEPENDENCY_MAP(ixEthDBPortInfo[portID].dependencyPortMap, dependencyPortMap);
392 return IX_ETH_DB_SUCCESS;
396 IxEthDBStatus ixEthDBPortDependencyMapGet(IxEthDBPortId portID, IxEthDBPortMap dependencyPortMap)
398 IX_ETH_DB_CHECK_PORT(portID);
400 IX_ETH_DB_CHECK_SINGLE_NPE(portID);
402 IX_ETH_DB_CHECK_REFERENCE(dependencyPortMap);
404 IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_FILTERING);
406 COPY_DEPENDENCY_MAP(dependencyPortMap, ixEthDBPortInfo[portID].dependencyPortMap);
408 return IX_ETH_DB_SUCCESS;
412 IxEthDBStatus ixEthDBPortUpdateEnableSet(IxEthDBPortId portID, BOOL enableUpdate)
414 IX_ETH_DB_CHECK_PORT(portID);
416 IX_ETH_DB_CHECK_SINGLE_NPE(portID);
418 IX_ETH_DB_CHECK_FEATURE(portID, IX_ETH_DB_FILTERING);
420 ixEthDBPortInfo[portID].updateMethod.updateEnabled = enableUpdate;
421 ixEthDBPortInfo[portID].updateMethod.userControlled = true;
423 return IX_ETH_DB_SUCCESS;