1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
|
/**
* @file oven.c
* @author Michal Vasko <mvasko@cesnet.cz>
* @brief oven example plugin
*
* @copyright
* Copyright (c) 2019 CESNET, z.s.p.o.
*
* This source code is licensed under BSD 3-Clause License (the "License").
* You may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://opensource.org/licenses/BSD-3-Clause
*/
#define _QNX_SOURCE /* sleep() */
#include <pthread.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <libyang/libyang.h>
#include <sysrepo.h>
/* no synchronization is used in this example even though most of these
* variables are shared between 2 threads, but the chances of encountering
* problems is low enough to ignore them in this case */
/* session of our plugin, can be used until cleanup is called */
sr_session_ctx_t *sess;
/* structure holding all the subscriptions */
sr_subscription_ctx_t *subscription;
/* thread ID of the oven (thread) */
volatile pthread_t oven_tid;
/* oven state value determining whether the food is inside the oven or not */
volatile int food_inside;
/* oven state value determining whether the food is waiting for the oven to be ready */
volatile int insert_food_on_ready;
/* oven state value determining the current temperature of the oven */
volatile unsigned int oven_temperature;
/* oven config value stored locally just so that it is not needed to ask sysrepo for it all the time */
volatile unsigned int config_temperature;
static void *
oven_thread(void *arg)
{
int rc;
unsigned int desired_temperature;
(void)arg;
while (oven_tid) {
sleep(1);
if (oven_temperature < config_temperature) {
/* oven is heating up 50 degrees per second until the set temperature */
if (oven_temperature + 50 < config_temperature) {
oven_temperature += 50;
} else {
oven_temperature = config_temperature;
/* oven reached the desired temperature, create a notification */
rc = sr_notif_send(sess, "/oven:oven-ready", NULL, 0, 0, 0);
if (rc != SR_ERR_OK) {
SRPLG_LOG_ERR("oven", "Oven-ready notification generation failed: %s.", sr_strerror(rc));
}
}
} else if (oven_temperature > config_temperature) {
/* oven is cooling down but it will never be colder than the room temperature */
desired_temperature = (config_temperature < 25 ? 25 : config_temperature);
if (oven_temperature - 20 > desired_temperature) {
oven_temperature -= 20;
} else {
oven_temperature = desired_temperature;
}
}
if (insert_food_on_ready && (oven_temperature >= config_temperature)) {
/* food is inserted once the oven is ready */
insert_food_on_ready = 0;
food_inside = 1;
SRPLG_LOG_DBG("oven", "Food put into the oven.");
}
}
return NULL;
}
static int
oven_config_change_cb(sr_session_ctx_t *session, uint32_t sub_id, const char *module_name, const char *xpath,
sr_event_t event, uint32_t request_id, void *private_data)
{
int rc;
sr_val_t *val;
pthread_t tid;
(void)sub_id;
(void)module_name;
(void)xpath;
(void)event;
(void)request_id;
(void)private_data;
/* get the value from sysrepo, we do not care if the value did not change in our case */
rc = sr_get_item(session, "/oven:oven/temperature", 0, &val);
if (rc != SR_ERR_OK) {
goto sr_error;
}
config_temperature = val->data.uint8_val;
sr_free_val(val);
rc = sr_get_item(session, "/oven:oven/turned-on", 0, &val);
if (rc != SR_ERR_OK) {
goto sr_error;
}
if (val->data.bool_val && (oven_tid == 0)) {
/* the oven should be turned on and is not (create the oven thread) */
rc = pthread_create((pthread_t *)&oven_tid, NULL, oven_thread, NULL);
if (rc != 0) {
goto sys_error;
}
} else if (!val->data.bool_val && (oven_tid != 0)) {
/* the oven should be turned off but is on (stop the oven thread) */
tid = oven_tid;
oven_tid = 0;
rc = pthread_join(tid, NULL);
if (rc != 0) {
goto sys_error;
}
/* we pretend the oven cooled down immediately after being turned off */
oven_temperature = 25;
}
sr_free_val(val);
return SR_ERR_OK;
sr_error:
SRPLG_LOG_ERR("oven", "Oven config change callback failed: %s.", sr_strerror(rc));
return rc;
sys_error:
sr_free_val(val);
SRPLG_LOG_ERR("oven", "Oven config change callback failed: %s.", strerror(rc));
return SR_ERR_OPERATION_FAILED;
}
static int
oven_state_cb(sr_session_ctx_t *session, uint32_t sub_id, const char *module_name, const char *path,
const char *request_xpath, uint32_t request_id, struct lyd_node **parent, void *private_data)
{
const struct ly_ctx *ly_ctx;
char str[32];
(void)session;
(void)sub_id;
(void)module_name;
(void)path;
(void)request_xpath;
(void)request_id;
(void)private_data;
ly_ctx = sr_acquire_context(sr_session_get_connection(sess));
sprintf(str, "%u", oven_temperature);
lyd_new_path(NULL, ly_ctx, "/oven:oven-state/temperature", str, 0, parent);
lyd_new_path(*parent, NULL, "/oven:oven-state/food-inside", food_inside ? "true" : "false", 0, NULL);
sr_release_context(sr_session_get_connection(sess));
return SR_ERR_OK;
}
static int
oven_insert_food_cb(sr_session_ctx_t *session, uint32_t sub_id, const char *path, const sr_val_t *input,
const size_t input_cnt, sr_event_t event, uint32_t request_id, sr_val_t **output, size_t *output_cnt,
void *private_data)
{
(void)session;
(void)sub_id;
(void)path;
(void)input;
(void)input_cnt;
(void)event;
(void)request_id;
(void)output;
(void)output_cnt;
(void)private_data;
if (food_inside) {
SRPLG_LOG_ERR("oven", "Food already in the oven.");
return SR_ERR_OPERATION_FAILED;
}
if (strcmp(input[0].data.enum_val, "on-oven-ready") == 0) {
if (insert_food_on_ready) {
SRPLG_LOG_ERR("oven", "Food already waiting for the oven to be ready.");
return SR_ERR_OPERATION_FAILED;
}
insert_food_on_ready = 1;
return SR_ERR_OK;
}
insert_food_on_ready = 0;
food_inside = 1;
SRPLG_LOG_DBG("oven", "Food put into the oven.");
return SR_ERR_OK;
}
static int
oven_remove_food_cb(sr_session_ctx_t *session, uint32_t sub_id, const char *path, const sr_val_t *input,
const size_t input_cnt, sr_event_t event, uint32_t request_id, sr_val_t **output, size_t *output_cnt,
void *private_data)
{
(void)session;
(void)sub_id;
(void)path;
(void)input;
(void)input_cnt;
(void)event;
(void)request_id;
(void)output;
(void)output_cnt;
(void)private_data;
if (!food_inside) {
SRPLG_LOG_ERR("oven", "Food not in the oven.");
return SR_ERR_OPERATION_FAILED;
}
food_inside = 0;
SRPLG_LOG_DBG("oven", "Food taken out of the oven.");
return SR_ERR_OK;
}
int
sr_plugin_init_cb(sr_session_ctx_t *session, void **private_data)
{
int rc;
(void)private_data;
/* remember the session of our plugin */
sess = session;
/* initialize the oven state */
food_inside = 0;
insert_food_on_ready = 0;
/* room temperature */
oven_temperature = 25;
/* subscribe for oven module changes - also causes startup oven data to be copied into running and enabling the module */
rc = sr_module_change_subscribe(session, "oven", NULL, oven_config_change_cb, NULL, 0,
SR_SUBSCR_ENABLED | SR_SUBSCR_DONE_ONLY, &subscription);
if (rc != SR_ERR_OK) {
goto error;
}
/* subscribe as state data provider for the oven state data */
rc = sr_oper_get_subscribe(session, "oven", "/oven:oven-state", oven_state_cb, NULL, 0, &subscription);
if (rc != SR_ERR_OK) {
goto error;
}
/* subscribe for insert-food RPC calls */
rc = sr_rpc_subscribe(session, "/oven:insert-food", oven_insert_food_cb, NULL, 0, 0, &subscription);
if (rc != SR_ERR_OK) {
goto error;
}
/* subscribe for remove-food RPC calls */
rc = sr_rpc_subscribe(session, "/oven:remove-food", oven_remove_food_cb, NULL, 0, 0, &subscription);
if (rc != SR_ERR_OK) {
goto error;
}
/* sysrepo/plugins.h provides an interface for logging */
SRPLG_LOG_DBG("oven", "Oven plugin initialized successfully.");
return SR_ERR_OK;
error:
SRPLG_LOG_ERR("oven", "Oven plugin initialization failed: %s.", sr_strerror(rc));
sr_unsubscribe(subscription);
return rc;
}
void
sr_plugin_cleanup_cb(sr_session_ctx_t *session, void *private_data)
{
(void)session;
(void)private_data;
/* nothing to cleanup except freeing the subscriptions */
sr_unsubscribe(subscription);
SRPLG_LOG_DBG("oven", "Oven plugin cleanup finished.");
}
|