CAN-binder/low-can-binding/binding/low-can-cb.cpp

   1 /*
   2  * Copyright (C) 2015, 2016 "IoT.bzh"
   3  * Author "Romain Forlot" <romain.forlot@iot.bzh>
   4  * Author "Loic Collignon" <loic.collignon@iot.bzh>
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *       http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 #include "low-can-hat.hpp"
  20
  21 #include <map>
  22 #include <queue>
  23 #include <mutex>
  24 #include <vector>
  25 #include <thread>
  26 #include <json-c/json.h>
  27 #include <systemd/sd-event.h>
  28
  29 #include "openxc.pb.h"
  30 #include "configuration.hpp"
  31 #include "../can/can-bus.hpp"
  32 #include "../can/can-signals.hpp"
  33 #include "../can/can-message.hpp"
  34 #include "../utils/timer.hpp"
  35 #include "../utils/signals.hpp"
  36 #include "../diagnostic/diagnostic-message.hpp"
  37 #include "../utils/openxc-utils.hpp"
  38
  39 extern "C"
  40 {
  41         #include <afb/afb-service-itf.h>
  42 };
  43
  44 void on_no_clients(std::string message)
  45 {
  46         DiagnosticRequest* diag_req = configuration_t::instance().get_request_from_diagnostic_message(message);
  47         if(diag_req != nullptr)
  48         {
  49                 active_diagnostic_request_t* adr = configuration_t::instance().get_diagnostic_manager().find_recurring_request(diag_req);
  50                 if( adr != nullptr)
  51                         configuration_t::instance().get_diagnostic_manager().cleanup_request(adr, true);
  52         }
  53 }
  54
  55 int read_can_signal(sd_event_source *s, int fd, uint32_t revents, void *userdata)
  56 {
  57         can_signal_t* sig= (can_signal_t*)userdata;
  58         sig->read_socket();
  59
  60         /* check if error or hangup */
  61         if ((revents & (EPOLLERR|EPOLLRDHUP|EPOLLHUP)) != 0)
  62         {
  63                 sd_event_source_unref(s);
  64                 sig->get_socket().close();
  65                 sig->create_rx_filter();
  66         }
  67         return 0;
  68 }
  69
  70 int read_diagnostic_message(sd_event_source *s, int fd, uint32_t revents, void *userdata)
  71 {
  72         diagnostic_manager_t& diag_m = configuration_t::instance().get_diagnostic_manager();
  73         diag_m.read_socket();
  74
  75         /* check if error or hangup */
  76         if ((revents & (EPOLLERR|EPOLLRDHUP|EPOLLHUP)) != 0)
  77         {
  78                 sd_event_source_unref(s);
  79                 diag_m.get_socket().close();
  80                 diag_m.cleanup_active_requests(true);
  81                 ERROR(binder_interface, "%s: Error on diagnostic manager socket, cancelling active requests.", __FUNCTION__);
  82                 return -1;
  83         }
  84
  85         return 0;
  86 }
  87
  88
  89 ///******************************************************************************
  90 ///
  91 ///             Subscription and unsubscription
  92 ///
  93 ///*******************************************************************************/
  94
  95 static int make_subscription_unsubscription(struct afb_req request, const std::string& sig_name, std::map<std::string, struct afb_event>& s, bool subscribe)
  96 {
  97         /* Make the subscription or unsubscription to the event */
  98         if (((subscribe ? afb_req_subscribe : afb_req_unsubscribe)(request, s[sig_name])) < 0)
  99         {
 100                 ERROR(binder_interface, "%s: Operation goes wrong for signal: %s", __FUNCTION__, sig_name.c_str());
 101                 return 0;
 102         }
 103         return 1;
 104 }
 105
 106 static int create_event_handle(const std::string& sig_name, std::map<std::string, struct afb_event>& s)
 107 {
 108         s[sig_name] = afb_daemon_make_event(binder_interface->daemon, sig_name.c_str());
 109         if (!afb_event_is_valid(s[sig_name]))
 110         {
 111                 ERROR(binder_interface, "%s: Can't create an event for %s, something goes wrong.", __FUNCTION__, sig_name.c_str());
 112                 return 0;
 113         }
 114         return 1;
 115 }
 116
 117 /// @brief Will determine if it is needed or not to create the event handle and checks it to be sure that
 118 /// we got a valid afb_event to get subscribe or unsubscribe. Then launch the subscription or unsubscription
 119 /// against the application framework using that event handle.
 120 static int subscribe_unsubscribe_signal(struct afb_req request, bool subscribe, const std::string& sig)
 121 {
 122         int ret;
 123
 124         utils::signals_manager_t& sm = utils::signals_manager_t::instance();
 125
 126         std::lock_guard<std::mutex> subscribed_signals_lock(sm.get_subscribed_signals_mutex());
 127         std::map<std::string, struct afb_event>& s = sm.get_subscribed_signals();
 128         if (s.find(sig) != s.end())
 129         {
 130                 if (!afb_event_is_valid(s[sig]) && !subscribe)
 131                 {
 132                         NOTICE(binder_interface, "%s: Event isn't valid, no need to unsubscribed.", __FUNCTION__);
 133                         ret = -1;
 134                 }
 135                 else
 136                 {
 137                         // Event it isn't valid annymore, recreate it
 138                         ret = create_event_handle(sig, s);
 139                 }
 140         }
 141         else
 142         {
 143                 /* Event doesn't exist , so let's create it */
 144                 struct afb_event empty_event = {nullptr, nullptr};
 145                 s[sig] = empty_event;
 146                 ret = create_event_handle(sig, s);
 147         }
 148
 149         // Check whether or not the event handler has been correctly created and
 150         // make the subscription/unsubscription operation is so.
 151         if (ret <= 0)
 152                 return ret;
 153         return make_subscription_unsubscription(request, sig, s, subscribe);
 154 }
 155
 156 ///
 157 /// @brief subscribe to all signals in the vector signals
 158 ///
 159 /// @param[in] afb_req request : contain original request use to subscribe or unsubscribe
 160 /// @param[in] subscribe boolean value used to chose between a subscription operation or an unsubscription
 161 /// @param[in] signals -  struct containing vectors with can_signal_t and diagnostic_messages to subscribe
 162 ///
 163 /// @return Number of correctly subscribed signal
 164 ///
 165 static int subscribe_unsubscribe_signals(struct afb_req request, bool subscribe, const struct utils::signals_found& signals)
 166 {
 167         int ret,  rets = 0;
 168
 169         //TODO: Implement way to dynamically call the right function no matter
 170         // how much signals types we have.
 171         configuration_t& conf = configuration_t::instance();
 172
 173         for(const auto& sig : signals.diagnostic_messages)
 174         {
 175                 diagnostic_manager_t& diag_m = conf.get_diagnostic_manager();
 176                 DiagnosticRequest* diag_req = conf.get_request_from_diagnostic_message(sig->get_name());
 177
 178                 // If the requested diagnostic message isn't supported by the car then unsubcribe it
 179                 // no matter what we want, worse case will be a fail unsubscription but at least we don't
 180                 // poll a PID for nothing.
 181                 if(sig->get_supported() && subscribe)
 182                 {
 183                         float frequency = sig->get_frequency();
 184                         diag_m.add_recurring_request(diag_req, sig->get_name().c_str(), false, sig->get_decoder(), sig->get_callback(), (float)frequency);
 185                                 //TODO: Adding callback requesting ignition status:     diag_req, sig.c_str(), false, diagnostic_message_t::decode_obd2_response, diagnostic_message_t::check_ignition_status, frequency);
 186                 }
 187                 else
 188                 {
 189                         diag_m.cleanup_request(
 190                                 diag_m.find_recurring_request(diag_req), true);
 191                         WARNING(binder_interface, "%s: signal: %s isn't supported. Canceling operation.", __FUNCTION__, sig->get_name().c_str());
 192                         return -1;
 193                 }
 194
 195                 ret = subscribe_unsubscribe_signal(request, subscribe, sig->get_name());
 196                 if(ret <= 0)
 197                         return ret;
 198                 rets++;
 199                 DEBUG(binder_interface, "%s: Signal: %s subscribed", __FUNCTION__, sig->get_name().c_str());
 200         }
 201
 202         for(const auto& sig: signals.can_signals)
 203         {
 204                 if(sig->create_rx_filter() <= 0 &&
 205                         subscribe_unsubscribe_signal(request, subscribe, sig->get_name()) <=0)
 206                 {
 207                         return -1;
 208                 }
 209                 sd_event_add_io(afb_daemon_get_event_loop(binder_interface->daemon), &e_source, sig->get_socket().socket(), EPOLLIN, read_can_signal, sig.get());
 210                 rets++;
 211                 DEBUG(binder_interface, "%s: signal: %s subscribed", __FUNCTION__, sig->get_name().c_str());
 212         }
 213         return rets;
 214 }
 215
 216 static int process_args(struct afb_req request, const std::vector<std::string>& args, bool subscribe)
 217 {
 218         struct utils::signals_found sf;
 219         int ok = 0, total = 0;
 220
 221         for(const auto& sig: args)
 222         {
 223                 openxc_DynamicField search_key = build_DynamicField(sig);
 224                 sf = utils::signals_manager_t::instance().find_signals(search_key);
 225                 total = (int)sf.can_signals.size() + (int)sf.diagnostic_messages.size();
 226
 227                 if (sf.can_signals.empty() && sf.diagnostic_messages.empty())
 228                         NOTICE(binder_interface, "%s: No signal(s) found for %s.", __FUNCTION__, sig.c_str());
 229                 else
 230                         ok = subscribe_unsubscribe_signals(request, subscribe, sf);
 231         }
 232         NOTICE(binder_interface, "%s: Subscribed/unsubscribe correctly to %d/%d signal(s).", __FUNCTION__, ok, total);
 233         return ok;
 234 }
 235
 236 static const std::vector<std::string> parse_args_from_request(struct afb_req request)
 237 {
 238         int i, n;
 239         std::vector<std::string> ret;
 240         struct json_object *args, *a, *x;
 241
 242         /* retrieve signals to subscribe */
 243         args = afb_req_json(request);
 244         if (args == NULL || !json_object_object_get_ex(args, "event", &a))
 245         {
 246                 ret.push_back("*");
 247         }
 248         else if (json_object_get_type(a) != json_type_array)
 249         {
 250                 ret.push_back(json_object_get_string(a));
 251         }
 252         else
 253         {
 254                 n = json_object_array_length(a);
 255                 for (i = 0 ; i < n ; i++)
 256                 {
 257                         x = json_object_array_get_idx(a, i);
 258                         ret.push_back(json_object_get_string(x));
 259                 }
 260         }
 261
 262         return ret;
 263 }
 264
 265 void subscribe(struct afb_req request)
 266 {
 267         bool subscribe = true;
 268
 269         const std::vector<std::string> args = parse_args_from_request(request);
 270
 271         if (process_args(request, args, subscribe) > 0)
 272                 afb_req_success(request, NULL, NULL);
 273         else
 274                 afb_req_fail(request, "error", NULL);
 275 }
 276
 277 void unsubscribe(struct afb_req request)
 278 {
 279         std::vector<std::string> args;
 280         bool subscribe = false;
 281
 282         args = parse_args_from_request(request);
 283
 284         if (process_args(request, args, subscribe) > 0)
 285                 afb_req_success(request, NULL, NULL);
 286         else
 287                 afb_req_fail(request, "error", NULL);
 288 }