sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2018-present Open Networking Foundation |
| 3 | |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | // gRPC affinity router with active/active backends |
| 17 | |
| 18 | package afrouter |
| 19 | |
| 20 | import ( |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 21 | "errors" |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 22 | "fmt" |
| 23 | "github.com/opencord/voltha-go/common/log" |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 24 | "google.golang.org/grpc" |
| 25 | "google.golang.org/grpc/metadata" |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 26 | ) |
| 27 | |
| 28 | type BindingRouter struct { |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 29 | name string |
| 30 | routerType int // TODO: This is probably not needed |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 31 | association int |
| 32 | //routingField string |
| 33 | grpcService string |
| 34 | //protoDescriptor *pb.FileDescriptorSet |
| 35 | //methodMap map[string]byte |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 36 | bkndClstr *backendCluster |
| 37 | bindings map[string]*backend |
| 38 | bindingType string |
| 39 | bindingField string |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 40 | bindingMethod string |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 41 | curBknd **backend |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 42 | } |
| 43 | |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 44 | func (br BindingRouter) BackendCluster(s string, metaKey string) (*backendCluster, error) { |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 45 | return br.bkndClstr, nil |
| 46 | //return nil,errors.New("Not implemented yet") |
| 47 | } |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 48 | func (br BindingRouter) Name() string { |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 49 | return br.name |
| 50 | } |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 51 | func (br BindingRouter) Service() string { |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 52 | return br.grpcService |
| 53 | } |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 54 | func (br BindingRouter) GetMetaKeyVal(serverStream grpc.ServerStream) (string, string, error) { |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 55 | var rtrnK string = "" |
| 56 | var rtrnV string = "" |
| 57 | |
| 58 | // Get the metadata from the server stream |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 59 | md, ok := metadata.FromIncomingContext(serverStream.Context()) |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 60 | if !ok { |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 61 | return rtrnK, rtrnV, errors.New("Could not get a server stream metadata") |
| 62 | } |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 63 | |
| 64 | // Determine if one of the method routing keys exists in the metadata |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 65 | if _, ok := md[br.bindingField]; ok == true { |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 66 | rtrnV = md[br.bindingField][0] |
| 67 | rtrnK = br.bindingField |
| 68 | } |
| 69 | |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 70 | return rtrnK, rtrnV, nil |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 71 | } |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 72 | func (br BindingRouter) FindBackendCluster(becName string) *backendCluster { |
| 73 | if becName == br.bkndClstr.name { |
sslobodr | 360c8d7 | 2019-02-05 12:47:56 -0500 | [diff] [blame] | 74 | return br.bkndClstr |
| 75 | } |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 76 | return nil |
| 77 | } |
| 78 | func (br BindingRouter) ReplyHandler(v interface{}) error { |
| 79 | return nil |
| 80 | } |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 81 | func (br BindingRouter) Route(sel interface{}) *backend { |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 82 | var err error |
| 83 | switch sl := sel.(type) { |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 84 | case *nbFrame: |
| 85 | if b, ok := br.bindings[sl.metaVal]; ok == true { // binding exists, just return it |
| 86 | return b |
| 87 | } else { // establish a new binding or error. |
| 88 | if sl.metaVal != "" { |
| 89 | err = errors.New(fmt.Sprintf("Attempt to route on non-existent metadata value '%s' in key '%s'", |
| 90 | sl.metaVal, sl.metaKey)) |
| 91 | log.Error(err) |
| 92 | sl.err = err |
| 93 | return nil |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 94 | } |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 95 | if sl.mthdSlice[REQ_METHOD] != br.bindingMethod { |
| 96 | err = errors.New(fmt.Sprintf("Binding must occur with method %s but attempted with method %s", |
| 97 | br.bindingMethod, sl.mthdSlice[REQ_METHOD])) |
| 98 | log.Error(err) |
| 99 | sl.err = err |
| 100 | return nil |
| 101 | } |
| 102 | log.Debugf("MUST CREATE A NEW BINDING MAP ENTRY!!") |
| 103 | if len(br.bindings) < len(br.bkndClstr.backends) { |
| 104 | if *br.curBknd, err = br.bkndClstr.nextBackend(*br.curBknd, BE_SEQ_RR); err == nil { |
| 105 | // Use the name of the backend as the metaVal for this new binding |
| 106 | br.bindings[(*br.curBknd).name] = *br.curBknd |
| 107 | return *br.curBknd |
| 108 | } else { |
| 109 | log.Error(err) |
| 110 | sl.err = err |
| 111 | return nil |
| 112 | } |
| 113 | } else { |
| 114 | err = errors.New(fmt.Sprintf("Backends exhausted in attempt to bind for metakey '%s' with value '%s'", |
| 115 | sl.metaKey, sl.metaVal)) |
| 116 | log.Error(err) |
| 117 | sl.err = err |
| 118 | } |
| 119 | } |
| 120 | return nil |
| 121 | default: |
| 122 | return nil |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 123 | } |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 124 | } |
| 125 | |
sslobodr | cd37bc5 | 2019-01-24 11:47:16 -0500 | [diff] [blame] | 126 | func newBindingRouter(rconf *RouterConfig, config *RouteConfig) (Router, error) { |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 127 | var rtrn_err bool = false |
| 128 | var err error = nil |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 129 | log.Debugf("Creating binding router %s", config.Name) |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 130 | // A name must exist |
| 131 | if config.Name == "" { |
| 132 | log.Error("A router 'name' must be specified") |
| 133 | rtrn_err = true |
| 134 | } |
| 135 | |
| 136 | if rconf.ProtoPackage == "" { |
| 137 | log.Error("A 'package' must be specified") |
| 138 | rtrn_err = true |
| 139 | } |
| 140 | |
| 141 | if rconf.ProtoService == "" { |
| 142 | log.Error("A 'service' must be specified") |
| 143 | rtrn_err = true |
| 144 | } |
| 145 | |
| 146 | //if config.RouteField == "" { |
| 147 | // log.Error("A 'routing_field' must be specified") |
| 148 | // rtrn_err = true |
| 149 | //} |
| 150 | |
| 151 | // TODO: Using the specified service, the imported proto |
| 152 | // descriptor file should be scanned for all methods provided |
| 153 | // for this router to ensure that this field exists in |
| 154 | // the message(s) passed to the method. This will avoid run |
| 155 | // time failures that might not be detected for long periods |
| 156 | // of time. |
| 157 | |
| 158 | // TODO The routes section is currently not being used |
| 159 | // so the router will route all methods based on the |
| 160 | // routing_field. This needs to be done. |
| 161 | var bptr *backend |
| 162 | bptr = nil |
| 163 | br := BindingRouter{ |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 164 | name: config.Name, |
| 165 | grpcService: rconf.ProtoService, |
| 166 | bindings: make(map[string]*backend), |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 167 | //methodMap:make(map[string]byte), |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 168 | curBknd: &bptr, |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 169 | //serialNo:0, |
| 170 | } |
| 171 | |
| 172 | // A binding association must exist |
| 173 | br.association = strIndex(rAssnNames, config.Binding.Association) |
| 174 | if br.association == 0 { |
| 175 | if config.Binding.Association == "" { |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 176 | log.Error("An binding association must be specified") |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 177 | } else { |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 178 | log.Errorf("The binding association '%s' is not valid", config.Binding.Association) |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 179 | } |
| 180 | rtrn_err = true |
| 181 | } |
| 182 | // A binding type must exist |
| 183 | // TODO: This is parsed but ignored and a header based type is used. |
| 184 | if config.Binding.Type != "header" { |
| 185 | log.Error("The binding type must be set to header") |
| 186 | rtrn_err = true |
| 187 | } else { |
| 188 | br.bindingType = config.Binding.Type |
| 189 | } |
| 190 | // A binding method must exist |
| 191 | if config.Binding.Method == "" { |
| 192 | log.Error("The binding method must be specified") |
| 193 | rtrn_err = true |
| 194 | } else { |
| 195 | br.bindingMethod = config.Binding.Method |
| 196 | } |
| 197 | // A binding field must exxist |
| 198 | if config.Binding.Field == "" { |
| 199 | log.Error("The binding field must be specified") |
| 200 | rtrn_err = true |
| 201 | } else { |
| 202 | br.bindingField = config.Binding.Field |
| 203 | } |
| 204 | |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 205 | // This has already been validated bfore this function |
| 206 | // is called so just use it. |
sslobodr | 5f0b5a3 | 2019-01-24 07:45:19 -0500 | [diff] [blame] | 207 | for idx := range rTypeNames { |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 208 | if config.Type == rTypeNames[idx] { |
| 209 | br.routerType = idx |
| 210 | break |
| 211 | } |
| 212 | } |
| 213 | |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 214 | // Create the backend cluster or link to an existing one |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 215 | ok := true |
| 216 | if br.bkndClstr, ok = bClusters[config.backendCluster.Name]; ok == false { |
sslobodr | cd37bc5 | 2019-01-24 11:47:16 -0500 | [diff] [blame] | 217 | if br.bkndClstr, err = newBackendCluster(config.backendCluster); err != nil { |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 218 | log.Errorf("Could not create a backend for router %s", config.Name) |
| 219 | rtrn_err = true |
| 220 | } |
| 221 | } |
| 222 | |
| 223 | // HERE HERE HERE |
| 224 | |
| 225 | if rtrn_err { |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 226 | return br, errors.New(fmt.Sprintf("Failed to create a new router '%s'", br.name)) |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 227 | } |
| 228 | |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame^] | 229 | return br, nil |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 230 | } |