blob: 8a304bef016849912b1c17297327c4f76d0b1218 [file] [log] [blame]
Scott Baker2c1c4822019-10-16 11:02:41 -07001/*
2 * Copyright 2019-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 */
16package techprofile
17
18import (
serkant.uluderyab38671c2019-11-01 09:35:38 -070019 "github.com/opencord/voltha-lib-go/v3/pkg/db"
Neha Sharma130ac6d2020-04-08 08:46:32 +000020 "time"
Scott Baker2c1c4822019-10-16 11:02:41 -070021)
22
23// tech profile default constants
24const (
25 defaultTechProfileName = "Default_1tcont_1gem_Profile"
26 DEFAULT_TECH_PROFILE_TABLE_ID = 64
27 defaultVersion = 1.0
28 defaultLogLevel = 0
29 defaultGemportsCount = 1
Scott Baker2c1c4822019-10-16 11:02:41 -070030 defaultPbits = "0b11111111"
31
Neha Sharma130ac6d2020-04-08 08:46:32 +000032 defaultKVStoreTimeout = 5 * time.Second //in seconds
Scott Baker2c1c4822019-10-16 11:02:41 -070033
34 // Tech profile path prefix in kv store
35 defaultKVPathPrefix = "service/voltha/technology_profiles"
36
37 // Tech profile path in kv store
38 defaultTechProfileKVPath = "%s/%d" // <technology>/<tech_profile_tableID>
39
40 // Tech profile instance path in kv store
41 // Format: <technology>/<tech_profile_tableID>/<uni_port_name>
42 defaultTPInstanceKVPath = "%s/%d/%s"
43)
44
45//Tech-Profile JSON String Keys
46// NOTE: Tech profile templeate JSON file should comply with below keys
47const (
48 NAME = "name"
49 PROFILE_TYPE = "profile_type"
50 VERSION = "version"
51 NUM_GEM_PORTS = "num_gem_ports"
52 INSTANCE_CONTROL = "instance_control"
53 US_SCHEDULER = "us_scheduler"
54 DS_SCHEDULER = "ds_scheduler"
55 UPSTREAM_GEM_PORT_ATTRIBUTE_LIST = "upstream_gem_port_attribute_list"
56 DOWNSTREAM_GEM_PORT_ATTRIBUTE_LIST = "downstream_gem_port_attribute_list"
57 ONU = "onu"
58 UNI = "uni"
59 MAX_GEM_PAYLOAD_SIZE = "max_gem_payload_size"
60 DIRECTION = "direction"
61 ADDITIONAL_BW = "additional_bw"
62 PRIORITY = "priority"
63 Q_SCHED_POLICY = "q_sched_policy"
64 WEIGHT = "weight"
65 PBIT_MAP = "pbit_map"
66 DISCARD_CONFIG = "discard_config"
67 MAX_THRESHOLD = "max_threshold"
68 MIN_THRESHOLD = "min_threshold"
69 MAX_PROBABILITY = "max_probability"
70 DISCARD_POLICY = "discard_policy"
71 PRIORITY_Q = "priority_q"
72 SCHEDULING_POLICY = "scheduling_policy"
73 MAX_Q_SIZE = "max_q_size"
74 AES_ENCRYPTION = "aes_encryption"
75)
76
77// TechprofileFlags represents the set of configurations used
78type TechProfileFlags struct {
79 KVStoreHost string
80 KVStorePort int
81 KVStoreType string
Neha Sharma130ac6d2020-04-08 08:46:32 +000082 KVStoreTimeout time.Duration
sbarbari1e3e29c2019-11-05 10:06:50 -050083 KVBackend *db.Backend
Scott Baker2c1c4822019-10-16 11:02:41 -070084 TPKVPathPrefix string
85 TPFileKVPath string
86 TPInstanceKVPath string
87 DefaultTPName string
88 TPVersion int
89 NumGemPorts uint32
Scott Baker2c1c4822019-10-16 11:02:41 -070090 DefaultPbits []string
91 LogLevel int
92 DefaultTechProfileID uint32
93 DefaultNumGemPorts uint32
Scott Baker2c1c4822019-10-16 11:02:41 -070094}
95
96func NewTechProfileFlags(KVStoreType string, KVStoreHost string, KVStorePort int) *TechProfileFlags {
97 // initialize with default values
98 var techProfileFlags = TechProfileFlags{
99 KVBackend: nil,
100 KVStoreHost: KVStoreHost,
101 KVStorePort: KVStorePort,
102 KVStoreType: KVStoreType,
103 KVStoreTimeout: defaultKVStoreTimeout,
104 DefaultTPName: defaultTechProfileName,
105 TPKVPathPrefix: defaultKVPathPrefix,
106 TPVersion: defaultVersion,
107 TPFileKVPath: defaultTechProfileKVPath,
108 TPInstanceKVPath: defaultTPInstanceKVPath,
109 DefaultTechProfileID: DEFAULT_TECH_PROFILE_TABLE_ID,
110 DefaultNumGemPorts: defaultGemportsCount,
Scott Baker2c1c4822019-10-16 11:02:41 -0700111 DefaultPbits: []string{defaultPbits},
112 LogLevel: defaultLogLevel,
113 }
114
115 return &techProfileFlags
116}