map.go (4167B)
1 /* 2 * 3 * Copyright 2021 gRPC authors. 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 * 17 */ 18 19 package resolver 20 21 type addressMapEntry struct { 22 addr Address 23 value interface{} 24 } 25 26 // AddressMap is a map of addresses to arbitrary values taking into account 27 // Attributes. BalancerAttributes are ignored, as are Metadata and Type. 28 // Multiple accesses may not be performed concurrently. Must be created via 29 // NewAddressMap; do not construct directly. 30 type AddressMap struct { 31 // The underlying map is keyed by an Address with fields that we don't care 32 // about being set to their zero values. The only fields that we care about 33 // are `Addr`, `ServerName` and `Attributes`. Since we need to be able to 34 // distinguish between addresses with same `Addr` and `ServerName`, but 35 // different `Attributes`, we cannot store the `Attributes` in the map key. 36 // 37 // The comparison operation for structs work as follows: 38 // Struct values are comparable if all their fields are comparable. Two 39 // struct values are equal if their corresponding non-blank fields are equal. 40 // 41 // The value type of the map contains a slice of addresses which match the key 42 // in their `Addr` and `ServerName` fields and contain the corresponding value 43 // associated with them. 44 m map[Address]addressMapEntryList 45 } 46 47 func toMapKey(addr *Address) Address { 48 return Address{Addr: addr.Addr, ServerName: addr.ServerName} 49 } 50 51 type addressMapEntryList []*addressMapEntry 52 53 // NewAddressMap creates a new AddressMap. 54 func NewAddressMap() *AddressMap { 55 return &AddressMap{m: make(map[Address]addressMapEntryList)} 56 } 57 58 // find returns the index of addr in the addressMapEntry slice, or -1 if not 59 // present. 60 func (l addressMapEntryList) find(addr Address) int { 61 for i, entry := range l { 62 // Attributes are the only thing to match on here, since `Addr` and 63 // `ServerName` are already equal. 64 if entry.addr.Attributes.Equal(addr.Attributes) { 65 return i 66 } 67 } 68 return -1 69 } 70 71 // Get returns the value for the address in the map, if present. 72 func (a *AddressMap) Get(addr Address) (value interface{}, ok bool) { 73 addrKey := toMapKey(&addr) 74 entryList := a.m[addrKey] 75 if entry := entryList.find(addr); entry != -1 { 76 return entryList[entry].value, true 77 } 78 return nil, false 79 } 80 81 // Set updates or adds the value to the address in the map. 82 func (a *AddressMap) Set(addr Address, value interface{}) { 83 addrKey := toMapKey(&addr) 84 entryList := a.m[addrKey] 85 if entry := entryList.find(addr); entry != -1 { 86 entryList[entry].value = value 87 return 88 } 89 a.m[addrKey] = append(entryList, &addressMapEntry{addr: addr, value: value}) 90 } 91 92 // Delete removes addr from the map. 93 func (a *AddressMap) Delete(addr Address) { 94 addrKey := toMapKey(&addr) 95 entryList := a.m[addrKey] 96 entry := entryList.find(addr) 97 if entry == -1 { 98 return 99 } 100 if len(entryList) == 1 { 101 entryList = nil 102 } else { 103 copy(entryList[entry:], entryList[entry+1:]) 104 entryList = entryList[:len(entryList)-1] 105 } 106 a.m[addrKey] = entryList 107 } 108 109 // Len returns the number of entries in the map. 110 func (a *AddressMap) Len() int { 111 ret := 0 112 for _, entryList := range a.m { 113 ret += len(entryList) 114 } 115 return ret 116 } 117 118 // Keys returns a slice of all current map keys. 119 func (a *AddressMap) Keys() []Address { 120 ret := make([]Address, 0, a.Len()) 121 for _, entryList := range a.m { 122 for _, entry := range entryList { 123 ret = append(ret, entry.addr) 124 } 125 } 126 return ret 127 } 128 129 // Values returns a slice of all current map values. 130 func (a *AddressMap) Values() []interface{} { 131 ret := make([]interface{}, 0, a.Len()) 132 for _, entryList := range a.m { 133 for _, entry := range entryList { 134 ret = append(ret, entry.value) 135 } 136 } 137 return ret 138 }