src/low-can-binding.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-binding.hpp"
  20
  21 #include <queue>
  22 #include <mutex>
  23 #include <vector>
  24 #include <thread>
  25 #include <time.h>
  26 #include <linux/can.h>
  27 #include <json-c/json.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 "obd2/obd2-signals.hpp"
  37 #include "utils/openxc-utils.hpp"
  38
  39 extern "C"
  40 {
  41         #include <afb/afb-service-itf.h>
  42 };
  43
  44 // Interface between the daemon and the binding
  45 const struct afb_binding_interface *binder_interface;
  46
  47 /********************************************************************************
  48 *
  49 *               Subscription and unsubscription
  50 *
  51 *********************************************************************************/
  52
  53 static int make_subscription_unsubscription(struct afb_req request, const std::string& sig_name, std::map<std::string, struct afb_event>& s, bool subscribe)
  54 {
  55         /* Make the subscription or unsubscription to the event */
  56         if (((subscribe ? afb_req_subscribe : afb_req_unsubscribe)(request, s[sig_name])) < 0)
  57         {
  58                 ERROR(binder_interface, "Operation goes wrong for signal: %s", sig_name.c_str());
  59                 return 0;
  60         }
  61         return 1;
  62
  63 }
  64
  65 static int create_event_handle(const std::string& sig_name, std::map<std::string, struct afb_event>& s)
  66 {
  67         s[sig_name] = afb_daemon_make_event(binder_interface->daemon, sig_name.c_str());
  68         if (!afb_event_is_valid(s[sig_name]))
  69         {
  70                 ERROR(binder_interface, "Can't create an event for %s, something goes wrong.", sig_name.c_str());
  71                 return 0;
  72         }
  73         return 1;
  74 }
  75
  76 static int subscribe_unsubscribe_signal(struct afb_req request, bool subscribe, const std::string& sig)
  77 {
  78         int ret;
  79
  80         std::lock_guard<std::mutex> subscribed_signals_lock(get_subscribed_signals_mutex());
  81         std::map<std::string, struct afb_event>& s = get_subscribed_signals();
  82         if (s.find(sig) != s.end() && !afb_event_is_valid(s[sig]))
  83         {
  84                 if(!subscribe)
  85                 {
  86                         NOTICE(binder_interface, "Event isn't valid, it can't be unsubscribed.");
  87                         ret = -1;
  88                 }
  89                 else
  90                 {
  91                         /* Event it isn't valid annymore, recreate it */
  92                         ret = create_event_handle(sig, s);
  93                 }
  94         }
  95         else
  96         {
  97                 /* Event doesn't exist , so let's create it */
  98                 struct afb_event empty_event = {nullptr, nullptr};
  99                 subscribed_signals[sig] = empty_event;
 100                 ret = create_event_handle(sig, s);
 101         }
 102
 103         /* Check whether or not the event handler has been correctly created and
 104          * make the subscription/unsubscription operation is so.
 105          */
 106         if (ret <= 0)
 107                 return ret;
 108         return make_subscription_unsubscription(request, sig, s, subscribe);
 109 }
 110
 111 /**
 112  * @fn static int subscribe_unsubscribe_signals(struct afb_req request, bool subscribe, const std::vector<can_signal_t>& signals)
 113  * @brief subscribe to all signals in the vector signals
 114  *
 115  * @param[in] afb_req request : contain original request use to subscribe or unsubscribe
 116  * @param[in] subscribe boolean value used to chose between a subscription operation or an unsubscription
 117  * @param[in] can_signal_t  vector with can_signal_t to subscribe
 118  *
 119  * @return Number of correctly subscribed signal
 120  */
 121 static int subscribe_unsubscribe_signals(struct afb_req request, bool subscribe, const std::vector<std::string>& signals)
 122 {
 123         int rets = 0;
 124
 125         //TODO: Implement way to dynamically call the right function no matter
 126         // how much signals types we have.
 127
 128         for(const std::string& sig : signals)
 129         {
 130                 int ret;
 131                 if (active_diagnostic_request_t::is_diagnostic_signal(sig) && subscribe)
 132                 {
 133                         std::vector<diagnostic_message_t*> found;
 134                         configuration_t::instance().find_diagnostic_messages(build_DynamicField(sig), found);
 135                         float frequency = found.front()->get_frequency();
 136                         DiagnosticRequest* diag_req = new DiagnosticRequest(found.front()->build_diagnostic_request());
 137                         configuration_t::instance().get_diagnostic_manager().add_recurring_request(
 138                                 diag_req, sig.c_str(), false, found.front()->get_decoder(), found.front()->get_callback(), (float)frequency);
 139                                 //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);
 140                 }
 141
 142                 ret = subscribe_unsubscribe_signal(request, subscribe, sig);
 143                 if(ret <= 0)
 144                         return ret;
 145
 146                 rets++;
 147                 DEBUG(binder_interface, "Signal: %s subscribed", sig.c_str());
 148         }
 149         return rets;
 150 }
 151
 152 static int subscribe_unsubscribe_name(struct afb_req request, bool subscribe, const char *name)
 153 {
 154         std::vector<std::string> signals;
 155         int ret = 0;
 156
 157         openxc_DynamicField search_key = build_DynamicField(std::string(name));
 158         signals = find_signals(search_key);
 159         if (signals.empty())
 160                 ret = 0;
 161
 162         ret = subscribe_unsubscribe_signals(request, subscribe, signals);
 163         NOTICE(binder_interface, "Subscribed/unsubscribe correctly to %d/%d signal(s).", ret, (int)signals.size());
 164
 165         return ret;
 166 }
 167
 168 static void subscribe_unsubscribe(struct afb_req request, bool subscribe)
 169 {
 170         int ok, i, n;
 171         struct json_object *args, *a, *x;
 172
 173         /* makes the subscription/unsubscription */
 174         args = afb_req_json(request);
 175         if (args == NULL || !json_object_object_get_ex(args, "event", &a)) {
 176                 ok = subscribe_unsubscribe_name(request, subscribe, "*");
 177         } else if (json_object_get_type(a) != json_type_array) {
 178                 ok = subscribe_unsubscribe_name(request, subscribe, json_object_get_string(a));
 179         } else {
 180                 n = json_object_array_length(a);
 181                 ok = 0;
 182                 for (i = 0 ; i < n ; i++) {
 183                         x = json_object_array_get_idx(a, i);
 184                         if (subscribe_unsubscribe_name(request, subscribe, json_object_get_string(x)))
 185                                 ok++;
 186                 }
 187                 ok = (ok == n);
 188         }
 189
 190         /* send the report */
 191         if (ok)
 192                 afb_req_success(request, NULL, NULL);
 193         else
 194                 afb_req_fail(request, "error", NULL);
 195 }
 196
 197 extern "C"
 198 {
 199         static void subscribe(struct afb_req request)
 200         {
 201                 subscribe_unsubscribe(request, true);
 202         }
 203
 204         static void unsubscribe(struct afb_req request)
 205         {
 206                 subscribe_unsubscribe(request, false);
 207         }
 208
 209         static const struct afb_verb_desc_v1 verbs[]=
 210         {
 211                 { .name= "subscribe",   .session= AFB_SESSION_NONE, .callback= subscribe,       .info= "subscribe to notification of CAN bus messages." },
 212                 { .name= "unsubscribe", .session= AFB_SESSION_NONE, .callback= unsubscribe,     .info= "unsubscribe a previous subscription." }
 213         };
 214
 215         static const struct afb_binding binding_desc {
 216                 AFB_BINDING_VERSION_1,
 217                 {
 218                         "Low level CAN bus service",
 219                         "low-can",
 220                         verbs
 221                 }
 222         };
 223
 224         const struct afb_binding *afbBindingV1Register (const struct afb_binding_interface *itf)
 225         {
 226                 binder_interface = itf;
 227
 228                 return &binding_desc;
 229         }
 230
 231         /**
 232         * @brief Initialize the binding.
 233         *
 234         * @param[in] service Structure which represent the Application Framework Binder.
 235         *
 236         * @return Exit code, zero if success.
 237         */
 238         int afbBindingV1ServiceInit(struct afb_service service)
 239         {
 240                 can_bus_t& can_bus_manager = configuration_t::instance().get_can_bus_manager();
 241
 242                 /// Initialize CAN socket
 243                 if(can_bus_manager.init_can_dev() == 0)
 244                         can_bus_manager.start_threads();
 245
 246                 /// Initialize Diagnostic manager that will handle obd2 requests.
 247                 /// We pass by default the first CAN bus device to its Initialization.
 248                 /// TODO: be able to choose the CAN bus device that will be use as Diagnostic bus.
 249                 if(configuration_t::instance().get_diagnostic_manager().initialize())
 250                         return 0;
 251
 252                 ERROR(binder_interface, "There was something wrong with CAN device Initialization. Check your config file maybe");
 253                 return 1;
 254         }
 255 };