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 "application.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 #include "canutil/write.h"
  39
  40 extern "C"
  41 {
  42         #include <afb/afb-service-itf.h>
  43 };
  44
  45 ///******************************************************************************
  46 ///
  47 ///     low_can_subscription_t object
  48 ///
  49 ///*******************************************************************************/
  50
  51 low_can_subscription_t::low_can_subscription_t()
  52         : index_{-1},
  53         event_filter_{event_filter_t()},
  54         socket_{}
  55 {}
  56
  57 low_can_subscription_t::low_can_subscription_t(struct event_filter_t event_filter)
  58         : event_filter_{event_filter}
  59 {}
  60
  61 low_can_subscription_t::low_can_subscription_t( low_can_subscription_t&& s)
  62         : index_{s.index_},
  63         event_filter_{s.event_filter_},
  64         socket_{std::move(s.socket_)}
  65 {}
  66
  67         low_can_subscription_t& low_can_subscription_t::operator=(const low_can_subscription_t& s)
  68 {
  69         socket_ = std::move(s.socket_);
  70         return *this;
  71 }
  72
  73 low_can_subscription_t::operator bool() const
  74 {
  75         return socket_.socket() != INVALID_SOCKET;
  76 }
  77
  78 int low_can_subscription_t::get_index() const
  79 {
  80         return index_;
  81 }
  82
  83 const std::shared_ptr<can_signal_t> low_can_subscription_t::get_can_signal() const
  84 {
  85         return can_signal_;
  86 }
  87
  88 const std::string low_can_subscription_t::get_sig_name() const
  89 {
  90         return can_signal_->get_name();
  91 }
  92
  93 float low_can_subscription_t::get_frequency() const
  94 {
  95         return event_filter_.frequency;
  96 }
  97
  98 float low_can_subscription_t::get_min() const
  99 {
 100         return event_filter_.min;
 101 }
 102
 103 float low_can_subscription_t::get_max() const
 104 {
 105         return event_filter_.max;
 106 }
 107
 108 utils::socketcan_bcm_t& low_can_subscription_t::get_socket()
 109 {
 110         return socket_;
 111 }
 112
 113 void low_can_subscription_t::set_frequency(float freq)
 114 {
 115         event_filter_.frequency = freq;
 116 }
 117
 118 void low_can_subscription_t::set_min(float min)
 119 {
 120         event_filter_.min = min;
 121 }
 122
 123 void low_can_subscription_t::set_max(float max)
 124 {
 125         event_filter_.max = max;
 126 }
 127
 128 /// @brief Create a RX_SETUP receive job used by the BCM socket.
 129 ///
 130 /// @return 0 if ok else -1
 131 int low_can_subscription_t::create_rx_filter(std::shared_ptr<can_signal_t> sig)
 132 {
 133         can_signal_= sig;
 134         return create_rx_filter();
 135 }
 136
 137 /// @brief Create a RX_SETUP receive job used by the BCM socket.
 138 ///
 139 /// @return 0 if ok else -1
 140 int low_can_subscription_t::create_rx_filter()
 141 {
 142         if (can_signal_ == nullptr)
 143                 {return -1;}
 144
 145         // Make sure that socket has been opened.
 146         if(! socket_)
 147         {
 148                 socket_.open(can_signal_->get_message()->get_bus_device_name());
 149                 index_ = (int)socket_.socket();
 150         }
 151
 152         struct utils::simple_bcm_msg bcm_msg;
 153         struct can_frame cfd;
 154
 155         memset(&cfd, 0, sizeof(cfd));
 156         memset(&bcm_msg.msg_head, 0, sizeof(bcm_msg.msg_head));
 157         float val = (float)(1 << can_signal_->get_bit_size()) - 1;
 158
 159         struct timeval freq;
 160         frequency_clock_t f = event_filter_.frequency > 0.0f ? frequency_clock_t(event_filter_.frequency) : can_signal_->get_frequency();
 161         freq = f.get_timeval_from_period();
 162
 163         bcm_msg.msg_head.opcode  = RX_SETUP;
 164         bcm_msg.msg_head.can_id  = can_signal_->get_message()->get_id();
 165         bcm_msg.msg_head.flags = SETTIMER|RX_NO_AUTOTIMER;
 166         bcm_msg.msg_head.ival2.tv_sec = freq.tv_sec ;
 167         bcm_msg.msg_head.ival2.tv_usec = freq.tv_usec;
 168         bcm_msg.msg_head.nframes = 1;
 169         bitfield_encode_float(val,
 170                                                         can_signal_->get_bit_position(),
 171                                                         can_signal_->get_bit_size(),
 172                                                         can_signal_->get_factor(),
 173                                                         can_signal_->get_offset(),
 174                                                         cfd.data,
 175                                                         CAN_MAX_DLEN);
 176
 177         bcm_msg.frames = cfd;
 178
 179         if(socket_ << bcm_msg)
 180                 return 0;
 181         return -1;
 182 }
 183
 184 ///******************************************************************************
 185 ///
 186 ///             SystemD event loop Callbacks
 187 ///
 188 ///*******************************************************************************/
 189
 190 void on_no_clients(const std::string& message)
 191 {
 192         DiagnosticRequest* diag_req = application_t::instance().get_request_from_diagnostic_message(message);
 193         if(diag_req != nullptr)
 194         {
 195                 active_diagnostic_request_t* adr = application_t::instance().get_diagnostic_manager().find_recurring_request(diag_req);
 196                 if( adr != nullptr)
 197                         application_t::instance().get_diagnostic_manager().cleanup_request(adr, true);
 198         }
 199         delete diag_req;
 200         diag_req = nullptr;
 201 }
 202
 203 static void push_n_notify(const can_message_t& cm)
 204 {
 205         can_bus_t& cbm = application_t::instance().get_can_bus_manager();
 206         std::lock_guard<std::mutex> can_message_lock(cbm.get_can_message_mutex());
 207         { cbm.push_new_can_message(cm); }
 208         cbm.get_new_can_message_cv().notify_one();
 209 }
 210
 211 int read_message(sd_event_source *s, int fd, uint32_t revents, void *userdata)
 212 {
 213         can_message_t cm;
 214         low_can_subscription_t* can_subscription;
 215         diagnostic_manager_t& diag_m = application_t::instance().get_diagnostic_manager();
 216
 217         if(userdata != nullptr)
 218         {
 219                 can_subscription = (low_can_subscription_t*)userdata;
 220                 utils::socketcan_bcm_t& s = can_subscription->get_socket();
 221                 s >> cm;
 222         }
 223         else
 224         {
 225                 utils::socketcan_bcm_t& s = diag_m.get_socket();
 226                 s >> cm;
 227         }
 228
 229         push_n_notify(cm);
 230
 231         /* check if error or hangup */
 232         if ((revents & (EPOLLERR|EPOLLRDHUP|EPOLLHUP)) != 0)
 233         {
 234                 sd_event_source_unref(s);
 235                 if(userdata != nullptr)
 236                 {
 237                         can_subscription->get_socket().close();
 238                         can_subscription->create_rx_filter();
 239                         NOTICE(binder_interface, "%s: Recreated RX_SETUP BCM job for can_subscription: %s", __FUNCTION__, can_subscription->get_sig_name().c_str());
 240                 }
 241                 else
 242                 {
 243                         diag_m.get_socket().close();
 244                         diag_m.cleanup_active_requests(true);
 245                         ERROR(binder_interface, "%s: Error on diagnostic manager socket, cancelling active requests.", __FUNCTION__);
 246                 }
 247                 return -1;
 248         }
 249
 250         return 0;
 251 }
 252
 253 ///******************************************************************************
 254 ///
 255 ///             Subscription and unsubscription
 256 ///
 257 ///*******************************************************************************/
 258
 259 static int make_subscription_unsubscription(struct afb_req request, std::shared_ptr<low_can_subscription_t>& can_subscription, std::map<int, std::pair<std::shared_ptr<low_can_subscription_t>, struct afb_event> >& s, bool subscribe)
 260 {
 261         /* Make the subscription or unsubscription to the event */
 262         if (((subscribe ? afb_req_subscribe : afb_req_unsubscribe)(request, s[can_subscription->get_index()].second)) < 0)
 263         {
 264                 ERROR(binder_interface, "%s: Operation goes wrong for signal: %s", __FUNCTION__, can_subscription->get_sig_name().c_str());
 265                 return -1;
 266         }
 267         return 0;
 268 }
 269
 270 static int create_event_handle(std::shared_ptr<low_can_subscription_t>& can_subscription, std::map<int, std::pair<std::shared_ptr<low_can_subscription_t>, struct afb_event> >& s)
 271 {
 272         int sub_index = can_subscription->get_index();
 273         struct afb_event event = afb_daemon_make_event(binder_interface->daemon, can_subscription->get_sig_name().c_str());
 274         s[sub_index] = std::make_pair(can_subscription, event);
 275         if (!afb_event_is_valid(s[sub_index].second))
 276         {
 277                 ERROR(binder_interface, "%s: Can't create an event for %s, something goes wrong.", __FUNCTION__, can_subscription->get_sig_name().c_str());
 278                 return -1;
 279         }
 280         return 0;
 281 }
 282
 283 /// @brief Will determine if it is needed or not to create the event handle and checks it to be sure that
 284 /// we got a valid afb_event to get subscribe or unsubscribe. Then launch the subscription or unsubscription
 285 /// against the application framework using that event handle.
 286 static int subscribe_unsubscribe_signal(struct afb_req request, bool subscribe, std::shared_ptr<low_can_subscription_t>& can_subscription)
 287 {
 288         int ret;
 289         int sub_index = can_subscription->get_index();
 290         utils::signals_manager_t& sm = utils::signals_manager_t::instance();
 291
 292         std::lock_guard<std::mutex> subscribed_signals_lock(sm.get_subscribed_signals_mutex());
 293         std::map<int, std::pair<std::shared_ptr<low_can_subscription_t>, struct afb_event> >& s = sm.get_subscribed_signals();
 294         if (can_subscription && s.find(sub_index) != s.end())
 295         {
 296                 if (!afb_event_is_valid(s[sub_index].second) && !subscribe)
 297                 {
 298                         NOTICE(binder_interface, "%s: Event isn't valid, no need to unsubscribed.", __FUNCTION__);
 299                         ret = -1;
 300                 }
 301                 else
 302                 {
 303                         // Event it isn't valid anymore, recreate it
 304                         ret = create_event_handle(can_subscription, s);
 305                 }
 306         }
 307         else
 308         {
 309                 /* Event doesn't exist , so let's create it */
 310                 struct afb_event empty_event = {nullptr, nullptr};
 311                 s[sub_index] = std::make_pair(can_subscription, empty_event);
 312                 ret = create_event_handle(can_subscription, s);
 313         }
 314
 315         // Check whether or not the event handler has been correctly created and
 316         // make the subscription/unsubscription operation is so.
 317         if (ret < 0)
 318                 return ret;
 319         return make_subscription_unsubscription(request, can_subscription, s, subscribe);
 320 }
 321
 322 ///
 323 /// @brief subscribe to all signals in the vector signals
 324 ///
 325 /// @param[in] afb_req request : contain original request use to subscribe or unsubscribe
 326 /// @param[in] subscribe boolean value used to chose between a subscription operation or an unsubscription
 327 /// @param[in] signals -  struct containing vectors with can_signal_t and diagnostic_messages to subscribe
 328 ///
 329 /// @return Number of correctly subscribed signal
 330 ///
 331 static int subscribe_unsubscribe_signals(struct afb_req request, bool subscribe, const struct utils::signals_found& signals, struct event_filter_t& event_filter)
 332 {
 333         int rets = 0;
 334
 335         //TODO: Implement way to dynamically call the right function no matter
 336         // how much signals types we have.
 337         application_t& conf = application_t::instance();
 338
 339         for(const auto& sig : signals.diagnostic_messages)
 340         {
 341                 int ret = 0;
 342                 diagnostic_manager_t& diag_m = conf.get_diagnostic_manager();
 343                 DiagnosticRequest* diag_req = conf.get_request_from_diagnostic_message(sig->get_name());
 344
 345                 // If the requested diagnostic message isn't supported by the car then unsubcribe it
 346                 // no matter what we want, worse case will be a fail unsubscription but at least we don't
 347                 // poll a PID for nothing.
 348                 if(sig->get_supported() && subscribe)
 349                 {
 350                         float frequency = std::isnan(event_filter.frequency) ? sig->get_frequency() : event_filter.frequency;
 351
 352                         diag_m.add_recurring_request(diag_req, sig->get_name().c_str(), false, sig->get_decoder(), sig->get_callback(), frequency);
 353                         //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);
 354                 }
 355                 else
 356                 {
 357                         diag_m.cleanup_request(
 358                                 diag_m.find_recurring_request(diag_req), true);
 359                         WARNING(binder_interface, "%s: signal: %s isn't supported. Canceling operation.", __FUNCTION__, sig->get_name().c_str());
 360                         delete diag_req;
 361                         diag_req = nullptr;
 362                         return -1;
 363                 }
 364
 365                 std::shared_ptr<low_can_subscription_t> can_subscription(new low_can_subscription_t(event_filter));
 366                 ret = subscribe_unsubscribe_signal(request, subscribe, can_subscription);
 367                 if(ret < 0)
 368                         return ret;
 369                 rets++;
 370                 DEBUG(binder_interface, "%s: Signal: %s subscribed", __FUNCTION__, sig->get_name().c_str());
 371         }
 372
 373         for(const auto& sig: signals.can_signals)
 374         {
 375                 std::shared_ptr<low_can_subscription_t> can_subscription(new low_can_subscription_t(event_filter));
 376                 if(can_subscription->create_rx_filter(sig) < 0)
 377                         {return -1;}
 378                 else if(subscribe_unsubscribe_signal(request, subscribe, can_subscription) < 0)
 379                         {return -1;}
 380
 381                 struct sd_event_source* e_source;
 382                 sd_event_add_io(afb_daemon_get_event_loop(binder_interface->daemon), &e_source, can_subscription->get_socket().socket(), EPOLLIN, read_message, can_subscription.get());
 383                 rets++;
 384                 DEBUG(binder_interface, "%s: signal: %s subscribed", __FUNCTION__, sig->get_name().c_str());
 385         }
 386         return rets;
 387 }
 388
 389 static int one_subscribe_unsubscribe(struct afb_req request, bool subscribe, const std::string& tag, json_object* args)
 390 {
 391         int ret = 0;
 392         struct event_filter_t event_filter;
 393         struct json_object  *filter, *obj;
 394         struct utils::signals_found sf;
 395
 396         // computes the filter
 397         if (json_object_object_get_ex(args, "filter", &filter))
 398         {
 399                 if (json_object_object_get_ex(filter, "frequency", &obj)
 400                 && (json_object_is_type(obj, json_type_double) || json_object_is_type(obj, json_type_int)))
 401                 {
 402                         event_filter.frequency = (float)json_object_get_double(obj);
 403                         ret += 1;
 404                 }
 405                 if (json_object_object_get_ex(filter, "min", &obj)
 406                 && (json_object_is_type(obj, json_type_double) || json_object_is_type(obj, json_type_int)))
 407                 {
 408                         event_filter.min = (float)json_object_get_double(obj);
 409                         ret += 2;
 410                 }
 411                 if (json_object_object_get_ex(filter, "max", &obj)
 412                 && (json_object_is_type(obj, json_type_double) || json_object_is_type(obj, json_type_int)))
 413                 {
 414                         event_filter.max = (float)json_object_get_double(obj);
 415                         ret += 4;
 416                 }
 417         }
 418
 419         // subscribe or unsubscribe
 420         openxc_DynamicField search_key = build_DynamicField(tag);
 421         sf = utils::signals_manager_t::instance().find_signals(search_key);
 422         if (sf.can_signals.empty() && sf.diagnostic_messages.empty())
 423                 NOTICE(binder_interface, "%s: No signal(s) found for %s.", __FUNCTION__, tag.c_str());
 424         else
 425                 ret = subscribe_unsubscribe_signals(request, subscribe, sf, event_filter);
 426
 427         return ret;
 428 }
 429
 430 static void do_subscribe_unsubscribe(struct afb_req request, bool subscribe)
 431 {
 432         int i, n, rc, rc2;
 433         struct json_object *args, *event, *x;
 434
 435         args = afb_req_json(request);
 436         if (args == NULL || !json_object_object_get_ex(args, "event", &event))
 437         {
 438                 rc = one_subscribe_unsubscribe(request, subscribe, "*", args);
 439         }
 440         else if (json_object_get_type(event) != json_type_array)
 441         {
 442                 rc = one_subscribe_unsubscribe(request, subscribe, json_object_get_string(event), args);
 443         }
 444         else
 445         {
 446                 rc = 0;
 447                 n = json_object_array_length(event);
 448                 for (i = 0 ; i < n ; i++)
 449                 {
 450                         x = json_object_array_get_idx(event, i);
 451                         rc2 = one_subscribe_unsubscribe(request, subscribe, json_object_get_string(x), args);
 452                         if (rc >= 0)
 453                                 rc = rc2 >= 0 ? rc + rc2 : rc2;
 454                 }
 455         }
 456
 457         if (rc >= 0)
 458                 afb_req_success(request, NULL, NULL);
 459         else
 460                 afb_req_fail(request, "error", NULL);
 461 }
 462
 463 void subscribe(struct afb_req request)
 464 {
 465         do_subscribe_unsubscribe(request, true);
 466 }
 467
 468 void unsubscribe(struct afb_req request)
 469 {
 470         do_subscribe_unsubscribe(request, false);
 471 }