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(sd_event_source *s, int fd, uint32_t revents, void *userdata)
  56 {
  57         can_signal_t* sig= (can_signal_t*)userdata;
  58         if(sig->read_socket() != can_message_format_t::ERROR)
  59                 return 0;
  60         return -1;
  61 }
  62
  63 ///******************************************************************************
  64 ///
  65 ///             Subscription and unsubscription
  66 ///
  67 ///*******************************************************************************/
  68
  69 static int make_subscription_unsubscription(struct afb_req request, const std::string& sig_name, std::map<std::string, struct afb_event>& s, bool subscribe)
  70 {
  71         /* Make the subscription or unsubscription to the event */
  72         if (((subscribe ? afb_req_subscribe : afb_req_unsubscribe)(request, s[sig_name])) < 0)
  73         {
  74                 ERROR(binder_interface, "%s: Operation goes wrong for signal: %s", __FUNCTION__, sig_name.c_str());
  75                 return 0;
  76         }
  77         return 1;
  78 }
  79
  80 static int create_event_handle(const std::string& sig_name, std::map<std::string, struct afb_event>& s)
  81 {
  82         s[sig_name] = afb_daemon_make_event(binder_interface->daemon, sig_name.c_str());
  83         if (!afb_event_is_valid(s[sig_name]))
  84         {
  85                 ERROR(binder_interface, "%s: Can't create an event for %s, something goes wrong.", __FUNCTION__, sig_name.c_str());
  86                 return 0;
  87         }
  88         return 1;
  89 }
  90
  91 /// @brief Will determine if it is needed or not to create the event handle and checks it to be sure that
  92 /// we got a valid afb_event to get subscribe or unsubscribe. Then launch the subscription or unsubscription
  93 /// against the application framework using that event handle.
  94 static int subscribe_unsubscribe_signal(struct afb_req request, bool subscribe, const std::string& sig)
  95 {
  96         int ret;
  97
  98         utils::signals_manager_t& sm = utils::signals_manager_t::instance();
  99
 100         std::lock_guard<std::mutex> subscribed_signals_lock(sm.get_subscribed_signals_mutex());
 101         std::map<std::string, struct afb_event>& s = sm.get_subscribed_signals();
 102         if (s.find(sig) != s.end())
 103         {
 104                 if (!afb_event_is_valid(s[sig]) && !subscribe)
 105                 {
 106                         NOTICE(binder_interface, "%s: Event isn't valid, no need to unsubscribed.", __FUNCTION__);
 107                         ret = -1;
 108                 }
 109                 else
 110                 {
 111                         // Event it isn't valid annymore, recreate it
 112                         ret = create_event_handle(sig, s);
 113                 }
 114         }
 115         else
 116         {
 117                 /* Event doesn't exist , so let's create it */
 118                 struct afb_event empty_event = {nullptr, nullptr};
 119                 s[sig] = empty_event;
 120                 ret = create_event_handle(sig, s);
 121         }
 122
 123         // Check whether or not the event handler has been correctly created and
 124         // make the subscription/unsubscription operation is so.
 125         if (ret <= 0)
 126                 return ret;
 127         return make_subscription_unsubscription(request, sig, s, subscribe);
 128 }
 129
 130 ///
 131 /// @brief subscribe to all signals in the vector signals
 132 ///
 133 /// @param[in] afb_req request : contain original request use to subscribe or unsubscribe
 134 /// @param[in] subscribe boolean value used to chose between a subscription operation or an unsubscription
 135 /// @param[in] signals -  struct containing vectors with can_signal_t and diagnostic_messages to subscribe
 136 ///
 137 /// @return Number of correctly subscribed signal
 138 ///
 139 static int subscribe_unsubscribe_signals(struct afb_req request, bool subscribe, const struct utils::signals_found& signals)
 140 {
 141         int ret,  rets = 0;
 142
 143         //TODO: Implement way to dynamically call the right function no matter
 144         // how much signals types we have.
 145         configuration_t& conf = configuration_t::instance();
 146
 147         for(const auto& sig : signals.diagnostic_messages)
 148         {
 149                 diagnostic_manager_t& diag_m = conf.get_diagnostic_manager();
 150                 DiagnosticRequest* diag_req = conf.get_request_from_diagnostic_message(sig->get_name());
 151
 152                 // If the requested diagnostic message isn't supported by the car then unsubcribe it
 153                 // no matter what we want, worse case will be a fail unsubscription but at least we don't
 154                 // poll a PID for nothing.
 155                 if(sig->get_supported() && subscribe)
 156                 {
 157                                 float frequency = sig->get_frequency();
 158                                 subscribe = diag_m.add_recurring_request(
 159                                         diag_req, sig->get_name().c_str(), false, sig->get_decoder(), sig->get_callback(), (float)frequency);
 160                                         //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);
 161                 }
 162                 else
 163                 {
 164                         diag_m.cleanup_request(
 165                                 diag_m.find_recurring_request(diag_req), true);
 166                         WARNING(binder_interface, "%s: signal: %s isn't supported. Canceling operation.", __FUNCTION__, sig->get_name().c_str());
 167                         return -1;
 168                 }
 169
 170                 ret = subscribe_unsubscribe_signal(request, subscribe, sig->get_name());
 171                 if(ret <= 0)
 172                         return ret;
 173                 rets++;
 174                 DEBUG(binder_interface, "%s: Signal: %s subscribed", __FUNCTION__, sig->get_name().c_str());
 175         }
 176
 177         for(const auto& sig: signals.can_signals)
 178         {
 179                 if(sig->create_rx_filter() <= 0 &&
 180                         subscribe_unsubscribe_signal(request, subscribe, sig->get_name()) <=0)
 181                 {
 182                         return -1;
 183                 }
 184                 struct sd_event_source* e_source;
 185                 sd_event_add_io(afb_daemon_get_event_loop(binder_interface->daemon), &e_source, sig->get_socket().socket(), EPOLLIN, read, sig);
 186                 rets++;
 187                 DEBUG(binder_interface, "%s: signal: %s subscribed", __FUNCTION__, sig->get_name().c_str());
 188         }
 189         return rets;
 190 }
 191
 192 static const std::vector<std::string> parse_args_from_request(struct afb_req request, bool subscribe)
 193 {
 194         int i, n;
 195         std::vector<std::string> ret;
 196         struct json_object *args, *a, *x;
 197
 198         /* retrieve signals to subscribe */
 199         args = afb_req_json(request);
 200         if (args == NULL || !json_object_object_get_ex(args, "event", &a))
 201         {
 202                 ret.push_back("*");
 203         }
 204         else if (json_object_get_type(a) != json_type_array)
 205         {
 206                 ret.push_back(json_object_get_string(a));
 207         }
 208         else
 209         {
 210                 n = json_object_array_length(a);
 211                 for (i = 0 ; i < n ; i++)
 212                 {
 213                         x = json_object_array_get_idx(a, i);
 214                         ret.push_back(json_object_get_string(x));
 215                 }
 216         }
 217
 218         return ret;
 219 }
 220
 221 void subscribe(struct afb_req request)
 222 {
 223         std::vector<std::string> args;
 224         struct utils::signals_found sf;
 225         int ok = 0, total = 0;
 226         bool subscribe = true;
 227
 228         args = parse_args_from_request(request, subscribe);
 229
 230         for(const auto& sig: args)
 231         {
 232                 openxc_DynamicField search_key = build_DynamicField(sig);
 233                 sf = utils::signals_manager_t::instance().find_signals(search_key);
 234                 total = (int)sf.can_signals.size() + (int)sf.diagnostic_messages.size();
 235
 236                 if (sf.can_signals.empty() && sf.diagnostic_messages.empty())
 237                         NOTICE(binder_interface, "%s: No signal(s) found for %s.", __FUNCTION__, sig.c_str());
 238                 else
 239                         ok = subscribe_unsubscribe_signals(request, subscribe, sf);
 240         }
 241
 242         NOTICE(binder_interface, "%s: Subscribed/unsubscribe correctly to %d/%d signal(s).", __FUNCTION__, ok, total);
 243         if (ok > 0)
 244                 afb_req_success(request, NULL, NULL);
 245         else
 246                 afb_req_fail(request, "error", NULL);
 247 }
 248
 249         void unsubscribe(struct afb_req request)
 250 {
 251         parse_args_from_request(request, false);
 252 }