MAC address assignment improvements

sureshanaparti · sureshanaparti · commit 3672fcd4d005 · 2025-12-29T23:54:04.000+05:30
diff --git a/api/src/main/java/com/cloud/network/NetworkModel.java b/api/src/main/java/com/cloud/network/NetworkModel.java
@@ -125,6 +125,10 @@ public interface NetworkModel {
      */
     String getNextAvailableMacAddressInNetwork(long networkConfigurationId) throws InsufficientAddressCapacityException;
 
+    default boolean isMACUnique(String mac, long networkId) {
+        return true;
+    }
+
     PublicIpAddress getPublicIpAddress(long ipAddressId);
 
     List<? extends Vlan> listPodVlans(long podId);
@@ -362,4 +366,8 @@ List<String[]> generateVmData(String userData, String userDataDetails, String se
 
     boolean checkSecurityGroupSupportForNetwork(Account account, DataCenter zone, List<Long> networkIds,
                                                 List<Long> securityGroupsIds);
+
+    default long getMacIdentifier(Long dataCenterId) {
+        return 0;
+    }
 }
diff --git a/engine/components-api/src/main/java/com/cloud/network/addr/PublicIp.java b/engine/components-api/src/main/java/com/cloud/network/addr/PublicIp.java
@@ -40,7 +40,11 @@ public PublicIp(IPAddressVO addr, VlanVO vlan, long macAddress) {
     }
 
     public static PublicIp createFromAddrAndVlan(IPAddressVO addr, VlanVO vlan) {
-        return new PublicIp(addr, vlan, NetUtils.createSequenceBasedMacAddress(addr.getMacAddress(), NetworkModel.MACIdentifier.value()));
+        long macIdentifier = NetworkModel.MACIdentifier.valueIn(addr.getDataCenterId());
+        if (macIdentifier == 0) {
+            macIdentifier = addr.getDataCenterId();
+        }
+        return new PublicIp(addr, vlan, NetUtils.createSequenceBasedMacAddress(addr.getMacAddress(), macIdentifier));
     }
 
     @Override
@@ -274,6 +278,4 @@ public void setRuleState(State ruleState) {
     public boolean isForSystemVms() {
         return false;
     }
-
-
 }
diff --git a/engine/orchestration/src/main/java/org/apache/cloudstack/engine/orchestration/NetworkOrchestrator.java b/engine/orchestration/src/main/java/org/apache/cloudstack/engine/orchestration/NetworkOrchestrator.java
@@ -1270,7 +1270,7 @@ protected void configureNicProfileBasedOnRequestedIp(NicProfile requestedNicProf
         nicProfile.setIPv4Gateway(ipv4Gateway);
         nicProfile.setIPv4Netmask(ipv4Netmask);
 
-        if (nicProfile.getMacAddress() == null) {
+        if (nicProfile.getMacAddress() == null || !_networkModel.isMACUnique(nicProfile.getMacAddress(), network.getId())) {
             try {
                 String macAddress = _networkModel.getNextAvailableMacAddressInNetwork(network.getId());
                 nicProfile.setMacAddress(macAddress);
diff --git a/engine/schema/src/main/java/com/cloud/network/dao/NetworkDaoImpl.java b/engine/schema/src/main/java/com/cloud/network/dao/NetworkDaoImpl.java
@@ -432,8 +432,8 @@ public List<NetworkVO> getAllPersistentNetworksFromZone(long dataCenterId) {
     public String getNextAvailableMacAddress(final long networkConfigId, Integer zoneMacIdentifier) {
         final SequenceFetcher fetch = SequenceFetcher.getInstance();
         long seq = fetch.getNextSequence(Long.class, _tgMacAddress, networkConfigId);
-        if(zoneMacIdentifier != null && zoneMacIdentifier.intValue() != 0 ){
-            seq = seq | _prefix << 40 | (long)zoneMacIdentifier << 32 | networkConfigId << 16 & 0x00000000ffff0000l;
+        if (zoneMacIdentifier != null && zoneMacIdentifier != 0 ) {
+            seq = seq | _prefix << 40 | (long)zoneMacIdentifier << 32 | networkConfigId << 16 & 0x00000000ffff0000L;
         }
         return NetUtils.long2Mac(seq);
     }
diff --git a/engine/schema/src/main/java/com/cloud/vm/dao/NicDao.java b/engine/schema/src/main/java/com/cloud/vm/dao/NicDao.java
@@ -91,7 +91,7 @@ public interface NicDao extends GenericDao<NicVO, Long> {
 
     List<NicVO> listByVmIdAndKeyword(long instanceId, String keyword);
 
-    NicVO findByMacAddress(String macAddress);
+    NicVO findByMacAddress(String macAddress, long networkId);
 
     NicVO findByNetworkIdAndMacAddressIncludingRemoved(long networkId, String mac);
 
diff --git a/engine/schema/src/main/java/com/cloud/vm/dao/NicDaoImpl.java b/engine/schema/src/main/java/com/cloud/vm/dao/NicDaoImpl.java
@@ -400,9 +400,10 @@ public List<NicVO> listByVmIdAndKeyword(long instanceId, String keyword) {
     }
 
     @Override
-    public NicVO findByMacAddress(String macAddress) {
+    public NicVO findByMacAddress(String macAddress, long networkId) {
         SearchCriteria<NicVO> sc = AllFieldsSearch.create();
         sc.setParameters("macAddress", macAddress);
+        sc.setParameters("networkId", networkId);
         return findOneBy(sc);
     }
 
diff --git a/server/src/main/java/com/cloud/network/IpAddressManagerImpl.java b/server/src/main/java/com/cloud/network/IpAddressManagerImpl.java
@@ -2372,7 +2372,7 @@ public void doInTransactionWithoutResult(TransactionStatus status) throws Insuff
 
                         nic.setBroadcastUri(network.getBroadcastUri());
                         nic.setFormat(AddressFormat.Ip4);
-                        if(nic.getMacAddress() == null) {
+                        if (nic.getMacAddress() == null || !_networkModel.isMACUnique(nic.getMacAddress(), network.getId())) {
                             nic.setMacAddress(_networkModel.getNextAvailableMacAddressInNetwork(network.getId()));
                         }
                     }
diff --git a/server/src/main/java/com/cloud/network/Ipv6AddressManagerImpl.java b/server/src/main/java/com/cloud/network/Ipv6AddressManagerImpl.java
@@ -241,7 +241,7 @@ private void setNicPropertiesFromNetwork(NicProfile nic, Network network) throws
         if (nic.getBroadCastUri() == null) {
             nic.setBroadcastUri(network.getBroadcastUri());
         }
-        if (nic.getMacAddress() == null) {
+        if (nic.getMacAddress() == null || !_networkModel.isMACUnique(nic.getMacAddress(), network.getId())) {
             nic.setMacAddress(_networkModel.getNextAvailableMacAddressInNetwork(network.getId()));
         }
     }
diff --git a/server/src/main/java/com/cloud/network/NetworkModelImpl.java b/server/src/main/java/com/cloud/network/NetworkModelImpl.java
@@ -593,22 +593,23 @@ public List<? extends Nic> getNics(long vmId) {
     @Override
     public String getNextAvailableMacAddressInNetwork(long networkId) throws InsufficientAddressCapacityException {
         NetworkVO network = _networksDao.findById(networkId);
-        Integer zoneIdentifier = MACIdentifier.value();
-        if (zoneIdentifier.intValue() == 0) {
-            zoneIdentifier = Long.valueOf(network.getDataCenterId()).intValue();
+        if (network == null) {
+            throw new CloudRuntimeException("Could not find network with id " + networkId);
         }
+
+        Integer zoneMacIdentifier = Long.valueOf(getMacIdentifier(network.getDataCenterId())).intValue();
         String mac;
         do {
-            mac = _networksDao.getNextAvailableMacAddress(networkId, zoneIdentifier);
+            mac = _networksDao.getNextAvailableMacAddress(networkId, zoneMacIdentifier);
             if (mac == null) {
                 throw new InsufficientAddressCapacityException("Unable to create another mac address", Network.class, networkId);
             }
-        } while(! isMACUnique(mac));
+        } while(! isMACUnique(mac, networkId));
         return mac;
     }
 
-    private boolean isMACUnique(String mac) {
-        return (_nicDao.findByMacAddress(mac) == null);
+    public boolean isMACUnique(String mac, long networkId) {
+        return (_nicDao.findByMacAddress(mac, networkId) == null);
     }
 
     @Override
@@ -2815,4 +2816,18 @@ public boolean checkSecurityGroupSupportForNetwork(Account account, DataCenter z
         }
         return false;
     }
+
+    @Override
+    public long getMacIdentifier(Long dataCenterId) {
+        long macAddress = 0;
+        if (dataCenterId == null) {
+            macAddress = NetworkModel.MACIdentifier.value();
+        } else {
+            macAddress = NetworkModel.MACIdentifier.valueIn(dataCenterId);
+            if (macAddress == 0) {
+                macAddress = dataCenterId;
+            }
+        }
+        return macAddress;
+    }
 }
diff --git a/server/src/main/java/com/cloud/network/guru/DirectNetworkGuru.java b/server/src/main/java/com/cloud/network/guru/DirectNetworkGuru.java
@@ -293,7 +293,7 @@ public NicProfile allocate(Network network, NicProfile nic, VirtualMachineProfil
         allocateDirectIp(nic, network, vm, dc, nic.getRequestedIPv4(), nic.getRequestedIPv6());
         nic.setReservationStrategy(ReservationStrategy.Create);
 
-        if (nic.getMacAddress() == null) {
+        if (nic.getMacAddress() == null || !_networkModel.isMACUnique(nic.getMacAddress(), network.getId())) {
             nic.setMacAddress(_networkModel.getNextAvailableMacAddressInNetwork(network.getId()));
             if (nic.getMacAddress() == null) {
                 throw new InsufficientAddressCapacityException("Unable to allocate more mac addresses", Network.class, network.getId());
diff --git a/server/src/main/java/com/cloud/network/guru/PodBasedNetworkGuru.java b/server/src/main/java/com/cloud/network/guru/PodBasedNetworkGuru.java
@@ -53,6 +53,8 @@ public class PodBasedNetworkGuru extends AdapterBase implements NetworkGuru {
     DataCenterDao _dcDao;
     @Inject
     StorageNetworkManager _sNwMgr;
+    @Inject
+    NetworkModel _networkModel;
 
     Random _rand = new Random(System.currentTimeMillis());
 
@@ -131,7 +133,11 @@ public void reserve(NicProfile nic, Network config, VirtualMachineProfile vm, De
         Integer vlan = result.getVlan();
 
         nic.setIPv4Address(result.getIpAddress());
-        nic.setMacAddress(NetUtils.long2Mac(NetUtils.createSequenceBasedMacAddress(result.getMacAddress(), NetworkModel.MACIdentifier.value())));
+        String macAddress = NetUtils.long2Mac(NetUtils.createSequenceBasedMacAddress(result.getMacAddress(), _networkModel.getMacIdentifier(dest.getDataCenter().getId())));
+        if (!_networkModel.isMACUnique(macAddress, config.getId())) {
+            macAddress =  _networkModel.getNextAvailableMacAddressInNetwork(config.getId());
+        }
+        nic.setMacAddress(macAddress);
         nic.setIPv4Gateway(pod.getGateway());
         nic.setFormat(AddressFormat.Ip4);
         String netmask = NetUtils.getCidrNetmask(pod.getCidrSize());
diff --git a/server/src/main/java/com/cloud/network/guru/PrivateNetworkGuru.java b/server/src/main/java/com/cloud/network/guru/PrivateNetworkGuru.java
@@ -189,8 +189,12 @@ protected void getIp(NicProfile nic, DataCenter dc, Network network) throws Insu
             PrivateIpVO ipVO = _privateIpDao.allocateIpAddress(network.getDataCenterId(), network.getId(), null);
             String vlanTag = BroadcastDomainType.getValue(network.getBroadcastUri());
             String netmask = NetUtils.getCidrNetmask(network.getCidr());
+            String macAddress = NetUtils.long2Mac(NetUtils.createSequenceBasedMacAddress(ipVO.getMacAddress(), networkModel.getMacIdentifier(network.getDataCenterId())));
+            if (!networkModel.isMACUnique(macAddress, network.getId())) {
+                macAddress =  networkModel.getNextAvailableMacAddressInNetwork(network.getId());
+            }
             PrivateIpAddress ip =
-                new PrivateIpAddress(ipVO, vlanTag, network.getGateway(), netmask, NetUtils.long2Mac(NetUtils.createSequenceBasedMacAddress(ipVO.getMacAddress(), NetworkModel.MACIdentifier.value())));
+                new PrivateIpAddress(ipVO, vlanTag, network.getGateway(), netmask, macAddress);
 
             nic.setIPv4Address(ip.getIpAddress());
             nic.setIPv4Gateway(ip.getGateway());
diff --git a/server/src/main/java/com/cloud/network/guru/StorageNetworkGuru.java b/server/src/main/java/com/cloud/network/guru/StorageNetworkGuru.java
@@ -47,6 +47,8 @@ public class StorageNetworkGuru extends PodBasedNetworkGuru implements NetworkGu
     @Inject
     StorageNetworkManager _sNwMgr;
     @Inject
+    NetworkModel _networkModel;
+    @Inject
     NetworkDao _nwDao;
 
     protected StorageNetworkGuru() {
@@ -130,7 +132,11 @@ public void reserve(NicProfile nic, Network network, VirtualMachineProfile vm, D
 
         vlan = ip.getVlan();
         nic.setIPv4Address(ip.getIpAddress());
-        nic.setMacAddress(NetUtils.long2Mac(NetUtils.createSequenceBasedMacAddress(ip.getMac(), NetworkModel.MACIdentifier.value())));
+        String macAddress = NetUtils.long2Mac(NetUtils.createSequenceBasedMacAddress(ip.getMac(), _networkModel.getMacIdentifier(dest.getDataCenter().getId())));
+        if (!_networkModel.isMACUnique(macAddress, network.getId())) {
+            macAddress =  _networkModel.getNextAvailableMacAddressInNetwork(network.getId());
+        }
+        nic.setMacAddress(macAddress);
         nic.setFormat(AddressFormat.Ip4);
         nic.setIPv4Netmask(ip.getNetmask());
         nic.setBroadcastType(BroadcastDomainType.Storage);
diff --git a/server/src/main/java/com/cloud/network/router/NicProfileHelper.java b/server/src/main/java/com/cloud/network/router/NicProfileHelper.java
@@ -16,6 +16,7 @@
 // under the License.
 package com.cloud.network.router;
 
+import com.cloud.exception.InsufficientAddressCapacityException;
 import org.apache.cloudstack.network.router.deployment.RouterDeploymentDefinition;
 
 import com.cloud.network.Network;
@@ -24,7 +25,7 @@
 
 public interface NicProfileHelper {
 
-    public abstract NicProfile createPrivateNicProfileForGateway(final VpcGateway privateGateway, final VirtualRouter router);
+    public abstract NicProfile createPrivateNicProfileForGateway(final VpcGateway privateGateway, final VirtualRouter router) throws InsufficientAddressCapacityException;
 
     public abstract NicProfile createGuestNicProfileForVpcRouter(final RouterDeploymentDefinition vpcRouterDeploymentDefinition,
             Network guestNetwork);
diff --git a/server/src/main/java/com/cloud/network/router/NicProfileHelperImpl.java b/server/src/main/java/com/cloud/network/router/NicProfileHelperImpl.java
@@ -21,6 +21,7 @@
 
 import javax.inject.Inject;
 
+import com.cloud.exception.InsufficientAddressCapacityException;
 import com.cloud.vm.NicVO;
 import com.cloud.vm.VirtualMachine;
 import org.apache.cloudstack.network.router.deployment.RouterDeploymentDefinition;
@@ -61,7 +62,7 @@ public class NicProfileHelperImpl implements NicProfileHelper {
 
     @Override
     @DB
-    public NicProfile createPrivateNicProfileForGateway(final VpcGateway privateGateway, final VirtualRouter router) {
+    public NicProfile createPrivateNicProfileForGateway(final VpcGateway privateGateway, final VirtualRouter router) throws InsufficientAddressCapacityException {
         final Network privateNetwork = _networkModel.getNetwork(privateGateway.getNetworkId());
 
         PrivateIpVO ipVO = _privateIpDao.allocateIpAddress(privateNetwork.getDataCenterId(), privateNetwork.getId(), privateGateway.getIp4Address());
@@ -90,14 +91,20 @@ public NicProfile createPrivateNicProfileForGateway(final VpcGateway privateGate
             privateNicProfile.setDeviceId(null);
 
             if (router.getIsRedundantRouter()) {
-              String newMacAddress = NetUtils.long2Mac(NetUtils.createSequenceBasedMacAddress(ipVO.getMacAddress(), NetworkModel.MACIdentifier.value()));
+              String newMacAddress = NetUtils.long2Mac(NetUtils.createSequenceBasedMacAddress(ipVO.getMacAddress(), _networkModel.getMacIdentifier(privateNetwork.getDataCenterId())));
+              if (!_networkModel.isMACUnique(newMacAddress, privateNetwork.getId())) {
+                  newMacAddress =  _networkModel.getNextAvailableMacAddressInNetwork(privateNetwork.getId());
+              }
               privateNicProfile.setMacAddress(newMacAddress);
             }
         } else {
             final String netmask = NetUtils.getCidrNetmask(privateNetwork.getCidr());
+            String newMacAddress = NetUtils.long2Mac(NetUtils.createSequenceBasedMacAddress(ipVO.getMacAddress(), _networkModel.getMacIdentifier(privateNetwork.getDataCenterId())));
+            if (!_networkModel.isMACUnique(newMacAddress, privateNetwork.getId())) {
+                newMacAddress =  _networkModel.getNextAvailableMacAddressInNetwork(privateNetwork.getId());
+            }
             final PrivateIpAddress ip =
-                    new PrivateIpAddress(ipVO, privateNetwork.getBroadcastUri().toString(), privateNetwork.getGateway(), netmask,
-                            NetUtils.long2Mac(NetUtils.createSequenceBasedMacAddress(ipVO.getMacAddress(), NetworkModel.MACIdentifier.value())));
+                    new PrivateIpAddress(ipVO, privateNetwork.getBroadcastUri().toString(), privateNetwork.getGateway(), netmask, newMacAddress);
 
             final URI netUri = BroadcastDomainType.fromString(ip.getBroadcastUri());
             privateNicProfile.setIPv4Address(ip.getIpAddress());
diff --git a/utils/src/main/java/com/cloud/utils/net/NetUtils.java b/utils/src/main/java/com/cloud/utils/net/NetUtils.java
@@ -131,17 +131,17 @@ public static boolean isIpv6EnabledProtocol(InternetProtocol protocol) {
         }
     }
 
-    public static long createSequenceBasedMacAddress(final long macAddress, long globalConfig) {
+    public static long createSequenceBasedMacAddress(final long macAddress, long macIdentifier) {
         /*
             Logic for generating MAC address:
             Mac = B1:B2:B3:B4:B5:B6 (Bx is a byte).
             B1 -> Presently controlled by prefix variable. The value should be such that the MAC is local and unicast.
-            B2 -> This will be configurable for each deployment/installation. Controlled by the global config MACIdentifier
+            B2 -> This will be configurable for each deployment/installation. Controlled by the 'mac.identifier' zone-level config
             B3 -> A randomly generated number between 0 - 255
             B4,5,6 -> These bytes are based on the unique DB identifier associated with the IP address for which MAC is generated (refer to mac_address field in user_ip_address table).
          */
 
-        return macAddress | prefix<<40 | globalConfig << 32 & 0x00ff00000000l | (long)s_rand.nextInt(255) << 24;
+        return macAddress | prefix << 40 | macIdentifier << 32 & 0x00ff00000000L | (long)s_rand.nextInt(255) << 24;
     }
 
     public static String getHostName() {

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,11 @@ public PublicIp(IPAddressVO addr, VlanVO vlan, long macAddress) {`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`public static PublicIp createFromAddrAndVlan(IPAddressVO addr, VlanVO vlan) {`
`43`		`- return new PublicIp(addr, vlan, NetUtils.createSequenceBasedMacAddress(addr.getMacAddress(), NetworkModel.MACIdentifier.value()));`
	`43`	`+ long macIdentifier = NetworkModel.MACIdentifier.valueIn(addr.getDataCenterId());`
	`44`	`+ if (macIdentifier == 0) {`
	`45`	`+ macIdentifier = addr.getDataCenterId();`
	`46`	`+ }`
	`47`	`+ return new PublicIp(addr, vlan, NetUtils.createSequenceBasedMacAddress(addr.getMacAddress(), macIdentifier));`
`44`	`48`	`}`
`45`	`49`
`46`	`50`	`@Override`
`@@ -274,6 +278,4 @@ public void setRuleState(State ruleState) {`
`274`	`278`	`public boolean isForSystemVms() {`
`275`	`279`	`return false;`
`276`	`280`	`}`
`277`		`-`
`278`		`-`
`279`	`281`	`}`
Original file line number	Diff line number	Diff line change
`@@ -432,8 +432,8 @@ public List<NetworkVO> getAllPersistentNetworksFromZone(long dataCenterId) {`
`432`	`432`	`public String getNextAvailableMacAddress(final long networkConfigId, Integer zoneMacIdentifier) {`
`433`	`433`	`final SequenceFetcher fetch = SequenceFetcher.getInstance();`
`434`	`434`	`long seq = fetch.getNextSequence(Long.class, _tgMacAddress, networkConfigId);`
`435`		`- if(zoneMacIdentifier != null && zoneMacIdentifier.intValue() != 0 ){`
`436`		`- seq = seq \| _prefix << 40 \| (long)zoneMacIdentifier << 32 \| networkConfigId << 16 & 0x00000000ffff0000l;`
	`435`	`+ if (zoneMacIdentifier != null && zoneMacIdentifier != 0 ) {`
	`436`	`+ seq = seq \| _prefix << 40 \| (long)zoneMacIdentifier << 32 \| networkConfigId << 16 & 0x00000000ffff0000L;`
`437`	`437`	`}`
`438`	`438`	`return NetUtils.long2Mac(seq);`
`439`	`439`	`}`
Original file line number	Diff line number	Diff line change
`@@ -400,9 +400,10 @@ public List<NicVO> listByVmIdAndKeyword(long instanceId, String keyword) {`
`400`	`400`	`}`
`401`	`401`
`402`	`402`	`@Override`
`403`		`- public NicVO findByMacAddress(String macAddress) {`
	`403`	`+ public NicVO findByMacAddress(String macAddress, long networkId) {`
`404`	`404`	`SearchCriteria<NicVO> sc = AllFieldsSearch.create();`
`405`	`405`	`sc.setParameters("macAddress", macAddress);`
	`406`	`+ sc.setParameters("networkId", networkId);`
`406`	`407`	`return findOneBy(sc);`
`407`	`408`	`}`
`408`	`409`
Original file line number	Diff line number	Diff line change
`@@ -2372,7 +2372,7 @@ public void doInTransactionWithoutResult(TransactionStatus status) throws Insuff`
`2372`	`2372`
`2373`	`2373`	`nic.setBroadcastUri(network.getBroadcastUri());`
`2374`	`2374`	`nic.setFormat(AddressFormat.Ip4);`
`2375`		`- if(nic.getMacAddress() == null) {`
	`2375`	`+ if (nic.getMacAddress() == null \|\| !_networkModel.isMACUnique(nic.getMacAddress(), network.getId())) {`
`2376`	`2376`	`nic.setMacAddress(_networkModel.getNextAvailableMacAddressInNetwork(network.getId()));`
`2377`	`2377`	`}`
`2378`	`2378`	`}`
Original file line number	Diff line number	Diff line change
`@@ -241,7 +241,7 @@ private void setNicPropertiesFromNetwork(NicProfile nic, Network network) throws`
`241`	`241`	`if (nic.getBroadCastUri() == null) {`
`242`	`242`	`nic.setBroadcastUri(network.getBroadcastUri());`
`243`	`243`	`}`
`244`		`- if (nic.getMacAddress() == null) {`
	`244`	`+ if (nic.getMacAddress() == null \|\| !_networkModel.isMACUnique(nic.getMacAddress(), network.getId())) {`
`245`	`245`	`nic.setMacAddress(_networkModel.getNextAvailableMacAddressInNetwork(network.getId()));`
`246`	`246`	`}`
`247`	`247`	`}`