2 * Copyright (c) 2020 AT&T Intellectual Property.
3 * Copyright (c) 2020 Nokia.
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * This source code is part of the near-RT RIC (RAN Intelligent Controller)
18 * platform project (RICP).
38 #cgo LDFLAGS: -lrmr_si
44 // InitAlarm is the init routine which returns a new alarm instance.
45 // The MO and APP identities are given as a parameters.
46 // The identities are used when raising/clearing alarms, unless provided by the applications.
47 func InitAlarm(mo, id string) (*RICAlarm, error) {
51 managerUrl: ALARM_MANAGER_HTTP_URL,
54 if os.Getenv("ALARM_MANAGER_URL") != "" {
55 r.managerUrl = os.Getenv("ALARM_MANAGER_URL")
58 if os.Getenv("ALARM_IF_RMR") == "" {
61 go InitRMR(r, ALARM_MANAGER_RMR_URL)
67 // Create a new Alarm instance
68 func (r *RICAlarm) NewAlarm(sp int, severity Severity, ainfo, iinfo string) Alarm {
70 ManagedObjectId: r.moId,
71 ApplicationId: r.appId,
73 PerceivedSeverity: severity,
74 AdditionalInfo: ainfo,
75 IdentifyingInfo: iinfo,
79 // Create a new AlarmMessage instance
80 func (r *RICAlarm) NewAlarmMessage(a Alarm, alarmAction AlarmAction) AlarmMessage {
81 alarmTime := time.Now().UnixNano()
82 return AlarmMessage{a, alarmAction, alarmTime}
85 func (r *RICAlarm) SetManagedObjectId(mo string) {
89 func (r *RICAlarm) SetApplicationId(app string) {
94 func (r *RICAlarm) Raise(a Alarm) error {
96 defer r.mutex.Unlock()
98 m := r.NewAlarmMessage(a, AlarmActionRaise)
99 return r.sendAlarmUpdateReq(m)
103 func (r *RICAlarm) Clear(a Alarm) error {
105 defer r.mutex.Unlock()
107 m := r.NewAlarmMessage(a, AlarmActionClear)
108 return r.sendAlarmUpdateReq(m)
111 // Re-raise a RIC alarm
112 func (r *RICAlarm) Reraise(a Alarm) error {
114 defer r.mutex.Unlock()
116 m := r.NewAlarmMessage(a, AlarmActionClear)
117 if err := r.sendAlarmUpdateReq(m); err != nil {
118 return errors.New(fmt.Sprintf("Reraise failed: %v", err))
121 return r.sendAlarmUpdateReq(r.NewAlarmMessage(a, AlarmActionRaise))
124 // Clear all alarms raised by the application
125 func (r *RICAlarm) ClearAll() error {
127 defer r.mutex.Unlock()
129 a := r.NewAlarm(0, SeverityDefault, "", "")
130 m := r.NewAlarmMessage(a, AlarmActionClearAll)
132 return r.sendAlarmUpdateReq(m)
135 func (r *RICAlarm) AlarmString(a AlarmMessage) string {
136 s := "MOId=%s AppId=%s SP=%d severity=%s IA=%s"
137 return fmt.Sprintf(s, a.ManagedObjectId, a.ApplicationId, a.SpecificProblem, a.PerceivedSeverity, a.IdentifyingInfo)
140 func (r *RICAlarm) sendAlarmUpdateReq(a AlarmMessage) error {
142 payload, err := json.Marshal(a)
144 log.Println("json.Marshal failed with error: ", err)
147 log.Println("Sending alarm: ", fmt.Sprintf("%s", payload))
149 if r.rmrCtx == nil || !r.rmrReady {
150 url := fmt.Sprintf("%s/%s", r.managerUrl, "ric/v1/alarms")
151 resp, err := http.Post(url, "application/json", bytes.NewReader(payload))
152 if err != nil || resp == nil {
153 return fmt.Errorf("Unable to send alarm: %v", err)
155 log.Printf("Alarm posted to %s [status=%d]", url, resp.StatusCode)
159 datap := C.CBytes(payload)
161 meid := C.CString("ric")
162 defer C.free(unsafe.Pointer(meid))
164 if state := C.rmrSend(r.rmrCtx, RIC_ALARM_UPDATE, datap, C.int(len(payload)), meid); state != C.RMR_OK {
165 log.Println("rmrSend failed with error: ", state)
166 return errors.New(fmt.Sprintf("rmrSend failed with error: %d", state))
172 func (r *RICAlarm) ReceiveMessage(cb func(AlarmMessage)) error {
173 if rbuf := C.rmrRcv(r.rmrCtx); rbuf != nil {
174 payload := C.GoBytes(unsafe.Pointer(rbuf.payload), C.int(rbuf.len))
176 if err := json.Unmarshal(payload, &a); err == nil {
180 return errors.New("rmrRcv failed!")
183 func InitRMR(r *RICAlarm, endpoint string) error {
184 // Setup static RT for alarm system
186 if r.moId == "my-pod" {
187 endpoint = "127.0.0.1:4560"
188 } else if r.moId == "my-pod-lib" {
189 endpoint = "127.0.0.1:4588"
193 alarmRT := fmt.Sprintf("newrt|start\nrte|13111|%s\nnewrt|end\n", endpoint)
194 alarmRTFile := "/tmp/alarm.rt"
196 if err := ioutil.WriteFile(alarmRTFile, []byte(alarmRT), 0644); err != nil {
197 log.Println("ioutil.WriteFile failed with error: ", err)
201 os.Setenv("RMR_SEED_RT", alarmRTFile)
202 os.Setenv("RMR_RTG_SVC", "-1")
204 if ctx := C.rmrInit(); ctx != nil {
210 return errors.New("rmrInit failed!")
213 func (r *RICAlarm) IsRMRReady() bool {