src/diagnostic/diagnostic-manager.cpp

   1 /*
   2  * Copyright (C) 2015, 2016 "IoT.bzh"
   3  * Author "Romain Forlot" <romain.forlot@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *       http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <systemd/sd-event.h>
  19 #include <algorithm>
  20
  21 #include "diagnostic-manager.hpp"
  22
  23 #include "uds/uds.h"
  24 #include "../utils/openxc-utils.hpp"
  25 #include "../configuration.hpp"
  26
  27 #define MAX_RECURRING_DIAGNOSTIC_FREQUENCY_HZ 10
  28 #define MAX_SIMULTANEOUS_DIAG_REQUESTS 50
  29 #define TIMERFD_ACCURACY 0
  30 #define MICRO 1000000
  31
  32 diagnostic_manager_t::diagnostic_manager_t()
  33         : initialized_{false}
  34 {}
  35
  36 bool diagnostic_manager_t::initialize(std::shared_ptr<can_bus_dev_t> cbd)
  37 {
  38         // Mandatory to set the bus before intiliaze shims.
  39         bus_ = cbd;
  40
  41         init_diagnostic_shims();
  42         reset();
  43
  44         initialized_ = true;
  45         DEBUG(binder_interface, "initialize: Diagnostic Manager initialized");
  46         return initialized_;
  47 }
  48
  49 /**
  50  * @brief initialize shims used by UDS lib and set initialized_ to true.
  51  *  It is needed before used the diagnostic manager fully because shims are
  52  *  required by most member functions.
  53  */
  54 void diagnostic_manager_t::init_diagnostic_shims()
  55 {
  56         shims_ = diagnostic_init_shims(shims_logger, shims_send, NULL);
  57         DEBUG(binder_interface, "init_diagnostic_shims: Shims initialized");
  58 }
  59
  60 void diagnostic_manager_t::reset()
  61 {
  62         if(initialized_)
  63         {
  64                 DEBUG(binder_interface, "Clearing existing diagnostic requests");
  65                 cleanup_active_requests(true);
  66         }
  67 }
  68
  69
  70 void diagnostic_manager_t::find_and_erase(active_diagnostic_request_t* entry, std::vector<active_diagnostic_request_t*>& requests_list)
  71 {
  72         auto i = std::find(requests_list.begin(), requests_list.end(), entry);
  73         if ( i != requests_list.end())
  74                 requests_list.erase(i);
  75 }
  76
  77 /// Move the entry to the free list and decrement the lock count for any
  78 /// CAN filters it used.
  79 void diagnostic_manager_t::cancel_request(active_diagnostic_request_t* entry)
  80 {
  81
  82         /* TODO: implement acceptance filters.
  83         if(entry.arbitration_id_ == OBD2_FUNCTIONAL_BROADCAST_ID) {
  84                 for(uint32_t filter = OBD2_FUNCTIONAL_RESPONSE_START;
  85                                 filter < OBD2_FUNCTIONAL_RESPONSE_START +
  86                                         OBD2_FUNCTIONAL_RESPONSE_COUNT;
  87                                 filter++) {
  88                         removeAcceptanceFilter(entry.bus_, filter,
  89                                         CanMessageFormat::STANDARD, getCanBuses(),
  90                                         getCanBusCount());
  91                 }
  92         } else {
  93                 removeAcceptanceFilter(entry.bus_,
  94                                 entry.arbitration_id_ +
  95                                         DIAGNOSTIC_RESPONSE_ARBITRATION_ID_OFFSET,
  96                                 CanMessageFormat::STANDARD, getCanBuses(), getCanBusCount());
  97         }*/
  98 }
  99
 100 void diagnostic_manager_t::cleanup_request(active_diagnostic_request_t* entry, bool force)
 101 {
 102         if(force || (entry->get_in_flight() && entry->request_completed()))
 103         {
 104                 entry->set_in_flight(false);
 105
 106                 char request_string[128] = {0};
 107                 diagnostic_request_to_string(&entry->get_handle()->request,
 108                         request_string, sizeof(request_string));
 109                 if(entry->get_recurring())
 110                 {
 111                         find_and_erase(entry, recurring_requests_);
 112                         if(force)
 113                                 cancel_request(entry);
 114                 }
 115                 else
 116                 {
 117                         DEBUG(binder_interface, "cleanup_request: Cancelling completed, non-recurring request: %s", request_string);
 118                         find_and_erase(entry, non_recurring_requests_);
 119                         cancel_request(entry);
 120                 }
 121         }
 122 }
 123
 124 /// @brief Clean up the request list
 125 void diagnostic_manager_t::cleanup_active_requests(bool force)
 126 {
 127         for(auto& entry : non_recurring_requests_)
 128                 if (entry != nullptr)
 129                         cleanup_request(entry, force);
 130
 131         for(auto& entry : recurring_requests_)
 132                 if (entry != nullptr)
 133                         cleanup_request(entry, force);
 134 }
 135
 136 /// @brief Will return the active_diagnostic_request_t pointer of found request or nullptr if
 137 /// not found.
 138 active_diagnostic_request_t* diagnostic_manager_t::find_recurring_request(const DiagnosticRequest* request)
 139 {
 140         for (auto& entry : recurring_requests_)
 141         {
 142                 if(entry != nullptr)
 143                 {
 144                         if(diagnostic_request_equals(&entry->get_handle()->request, request))
 145                         {
 146                                 return entry;
 147                                 break;
 148                         }
 149                 }
 150         }
 151         return nullptr;
 152 }
 153
 154 std::shared_ptr<can_bus_dev_t> diagnostic_manager_t::get_can_bus_dev()
 155 {
 156         return bus_;
 157 }
 158
 159 bool diagnostic_manager_t::add_request(DiagnosticRequest* request, const std::string name,
 160         bool wait_for_multiple_responses, const DiagnosticResponseDecoder decoder,
 161         const DiagnosticResponseCallback callback)
 162 {
 163         cleanup_active_requests(false);
 164
 165         bool added = true;
 166
 167         if (non_recurring_requests_.size() <= MAX_SIMULTANEOUS_DIAG_REQUESTS)
 168         {
 169                 // TODO: implement Acceptance Filter
 170                 //      if(updateRequiredAcceptanceFilters(bus, request)) {
 171                         active_diagnostic_request_t* entry = new active_diagnostic_request_t(bus_, request, name,
 172                                         wait_for_multiple_responses, decoder, callback, 0);
 173                         entry->set_handle(shims_, request);
 174
 175                         char request_string[128] = {0};
 176                         diagnostic_request_to_string(&entry->get_handle()->request, request_string,
 177                                         sizeof(request_string));
 178
 179                         find_and_erase(entry, non_recurring_requests_);
 180                         DEBUG(binder_interface, "Added one-time diagnostic request on bus %s: %s",
 181                                         bus_->get_device_name(), request_string);
 182
 183                         non_recurring_requests_.push_back(entry);
 184         }
 185         else
 186         {
 187                 WARNING(binder_interface, "There isn't enough request entry. Vector exhausted %d/%d", (int)non_recurring_requests_.size());
 188                 non_recurring_requests_.resize(MAX_SIMULTANEOUS_DIAG_REQUESTS);
 189                 added = false;
 190         }
 191         return added;
 192 }
 193
 194 bool diagnostic_manager_t::validate_optional_request_attributes(float frequencyHz)
 195 {
 196         if(frequencyHz > MAX_RECURRING_DIAGNOSTIC_FREQUENCY_HZ) {
 197                 DEBUG(binder_interface, "Requested recurring diagnostic frequency %d is higher than maximum of %d",
 198                         frequencyHz, MAX_RECURRING_DIAGNOSTIC_FREQUENCY_HZ);
 199                 return false;
 200         }
 201         return true;
 202 }
 203
 204 bool diagnostic_manager_t::add_recurring_request(DiagnosticRequest* request, const char* name,
 205                 bool wait_for_multiple_responses, const DiagnosticResponseDecoder decoder,
 206                 const DiagnosticResponseCallback callback, float frequencyHz)
 207 {
 208         if(!validate_optional_request_attributes(frequencyHz))
 209                 return false;
 210
 211         cleanup_active_requests(false);
 212
 213         bool added = true;
 214         if(find_recurring_request(request) == nullptr)
 215         {
 216                 active_diagnostic_request_t* entry = get_free_entry();
 217
 218                 if(entry != nullptr)
 219                 {
 220                         sd_event_source *source;
 221                         // TODO: implement Acceptance Filter
 222                         //if(updateRequiredAcceptanceFilters(bus, request)) {
 223                                 entry = new active_diagnostic_request_t(bus_, request, name,
 224                                                 wait_for_multiple_responses, decoder, callback, frequencyHz);
 225                                 entry->set_handle(shims_, request);
 226
 227                                 char request_string[128] = {0};
 228                                 diagnostic_request_to_string(&entry->get_handle()->request, request_string,
 229                                                 sizeof(request_string));
 230
 231                                 find_and_erase(entry, recurring_requests_);
 232                                 DEBUG(binder_interface, "Added recurring diagnostic request (freq: %f) on bus %s: %s",
 233                                                 frequencyHz, bus_->get_device_name().c_str(), request_string);
 234
 235                                 uint64_t usec;
 236                                 usec = sd_event_now(afb_daemon_get_event_loop(binder_interface->daemon), CLOCK_MONOTONIC, &usec) + (uint64_t)(frequency_clock_t::frequency_to_period(frequencyHz)*MICRO);
 237                                 if(sd_event_add_time(afb_daemon_get_event_loop(binder_interface->daemon), &source,
 238                                                 CLOCK_MONOTONIC, usec, TIMERFD_ACCURACY, send_request, request) >= 0)
 239                                         recurring_requests_.push_back(entry);
 240                                 else
 241                                 {
 242                                         ERROR(binder_interface, "add_recurring_request: Request fails to be schedule through event loop");
 243                                         free_request_entries_.push_back(entry);
 244                                         added = false;
 245                                 }
 246                 }
 247                 else
 248                 {
 249                         WARNING(binder_interface, "There isn't enough request entry. Vector exhausted %d/%d", (int)request_list_entries_.size(), (int)request_list_entries_.max_size());
 250                         free_request_entries_.push_back(entry);
 251                         added = false;
 252                 }
 253         }
 254         else
 255         {
 256                 DEBUG(binder_interface, "Can't add request, one already exists with same key");
 257                 added = false;
 258         }
 259         return added;
 260 }
 261
 262 bool diagnostic_manager_t::is_diagnostic_response(const active_diagnostic_request_t& adr, const can_message_t& cm) const
 263 {
 264         if(cm.get_id() == adr.get_id() + DIAGNOSTIC_RESPONSE_ARBITRATION_ID_OFFSET)
 265                 return true;
 266         DEBUG(binder_interface, "Doesn't find an active diagnostic request that matches.");
 267         return false;
 268 }
 269
 270 active_diagnostic_request_t* diagnostic_manager_t::is_diagnostic_response(const can_message_t& can_message)
 271 {
 272         for (auto& entry : non_recurring_requests_)
 273         {
 274                 if(is_diagnostic_response(*entry, can_message))
 275                         return entry;
 276         }
 277
 278         for (auto& entry : recurring_requests_)
 279         {
 280                 if(is_diagnostic_response(*entry, can_message))
 281                         return entry;
 282         }
 283         return nullptr;
 284 }
 285
 286 openxc_VehicleMessage diagnostic_manager_t::relay_diagnostic_response(active_diagnostic_request_t* adr, const DiagnosticResponse& response) const
 287 {
 288         openxc_VehicleMessage message;
 289         float value = (float)diagnostic_payload_to_integer(&response);
 290         if(adr->get_decoder() != nullptr)
 291         {
 292                 value = adr->get_decoder()(&response, value);
 293         }
 294
 295         if((response.success && strnlen(adr->get_name().c_str(), adr->get_name().size())) > 0)
 296         {
 297                 // If name, include 'value' instead of payload, and leave of response
 298                 // details.
 299                 message = build_VehicleMessage(build_SimpleMessage(adr->get_name(), build_DynamicField(value)));
 300         }
 301         else
 302         {
 303                 // If no name, send full details of response but still include 'value'
 304                 // instead of 'payload' if they provided a decoder. The one case you
 305                 // can't get is the full detailed response with 'value'. We could add
 306                 // another parameter for that but it's onerous to carry that around.
 307                 message = build_VehicleMessage(adr, response, value);
 308         }
 309
 310         if(adr->get_callback() != nullptr)
 311         {
 312                 adr->get_callback()(adr, &response, value);
 313         }
 314
 315         return message;
 316 }
 317
 318 bool diagnostic_manager_t::conflicting(active_diagnostic_request_t* request, active_diagnostic_request_t* candidate) const
 319 {
 320         return (candidate->get_in_flight() && candidate != request &&
 321                         candidate->get_can_bus_dev() == request->get_can_bus_dev() &&
 322                         candidate->get_id() == request->get_id());
 323 }
 324
 325
 326 /// @brief Returns true if there are no other active requests to the same arbitration ID.
 327 bool diagnostic_manager_t::clear_to_send(active_diagnostic_request_t* request) const
 328 {
 329         for ( auto entry : non_recurring_requests_)
 330         {
 331                 if(conflicting(request, entry))
 332                         return false;
 333         }
 334
 335         for ( auto entry : recurring_requests_)
 336         {
 337                 if(conflicting(request, entry))
 338                         return false;
 339         }
 340         return true;
 341 }
 342
 343 int diagnostic_manager_t::send_request(sd_event_source *s, uint64_t usec, void *userdata)
 344 {
 345         diagnostic_manager_t& dm = configuration_t::instance().get_diagnostic_manager();
 346         DiagnosticRequest* request = (DiagnosticRequest*)userdata;
 347         active_diagnostic_request_t* adr = dm.find_recurring_request(request);
 348
 349 //      if(adr != nullptr && adr->get_can_bus_dev() == dm.get_can_bus_dev() && adr->should_send() &&
 350 //              dm.clear_to_send(adr))
 351         if(adr != nullptr && adr->get_can_bus_dev() == dm.bus_)
 352         {
 353                 adr->get_frequency_clock().tick();
 354                 start_diagnostic_request(&dm.shims_, adr->get_handle());
 355                 if(adr->get_handle()->completed && !adr->get_handle()->success)
 356                 {
 357                         DEBUG(binder_interface, "send_request: Fatal error sending diagnostic request");
 358                         return 0;
 359                 }
 360                 adr->get_timeout_clock().tick();
 361                 adr->set_in_flight(true);
 362
 363                 usec = usec + (uint64_t)(frequency_clock_t::frequency_to_period(adr->get_frequency_clock().get_frequency())*MICRO);
 364                 DEBUG(binder_interface, "send_request: usec: %d", usec);
 365                 if(sd_event_source_set_time(s, usec) >= 0)
 366                         if(sd_event_source_set_enabled(s, SD_EVENT_ON) >= 0)
 367                         {
 368                                 dm.recurring_requests_.push_back(adr);
 369                                 return 1;
 370                         }
 371         }
 372         dm.recurring_requests_.push_back(adr);
 373         ERROR(binder_interface, "send_request: Something goes wrong when submitting a new request to the CAN bus");
 374         return -1;
 375 }
 376
 377 DiagnosticShims& diagnostic_manager_t::get_shims()
 378 {
 379         return shims_;
 380 }
 381
 382 bool diagnostic_manager_t::shims_send(const uint32_t arbitration_id, const uint8_t* data, const uint8_t size)
 383 {
 384         std::shared_ptr<can_bus_dev_t> can_bus_dev = configuration_t::instance().get_diagnostic_manager().get_can_bus_dev();
 385         return can_bus_dev->shims_send(arbitration_id, data, size);
 386 }
 387
 388 void diagnostic_manager_t::shims_logger(const char* m, ...)
 389 {
 390         DEBUG(binder_interface, "%s", m);
 391 }
 392
 393 void diagnostic_manager_t::shims_timer()
 394 {}
 395