2 * Copyright (C) 2015, 2016 "IoT.bzh"
3 * Author "Romain Forlot" <romain.forlot@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include <systemd/sd-event.h>
22 #include "diagnostic-manager.hpp"
24 #include "../utils/openxc-utils.hpp"
25 #include "../utils/signals.hpp"
26 #include "../binding/application.hpp"
28 #define MAX_RECURRING_DIAGNOSTIC_FREQUENCY_HZ 10
29 #define MAX_SIMULTANEOUS_DIAG_REQUESTS 50
30 // There are only 8 slots of in flight diagnostic requests
31 #define MAX_SIMULTANEOUS_IN_FLIGHT_REQUESTS 8
32 #define TIMERFD_ACCURACY 0
35 diagnostic_manager_t::diagnostic_manager_t()
40 diagnostic_manager_t::~diagnostic_manager_t()
42 for(auto r: recurring_requests_)
46 for(auto r: non_recurring_requests_)
52 /// @brief Diagnostic manager is not initialized at launch but after
53 /// the initialization of CAN bus devices. For the moment, it is only possible
54 /// to have 1 diagnostic bus which are the first bus declared in the JSON
55 /// description file. Configuration instance will return it.
57 /// this will initialize DiagnosticShims and cancel all active requests
59 bool diagnostic_manager_t::initialize()
61 // Mandatory to set the bus before intialize shims.
62 bus_ = application_t::instance().get_diagnostic_bus();
64 init_diagnostic_shims();
68 AFB_DEBUG("Diagnostic Manager initialized");
72 /// @brief initialize shims used by UDS lib and set initialized_ to true.
73 /// It is needed before used the diagnostic manager fully because shims are
74 /// required by most member functions.
75 void diagnostic_manager_t::init_diagnostic_shims()
77 shims_ = diagnostic_init_shims(shims_logger, shims_send, NULL);
78 AFB_DEBUG("Shims initialized");
81 /// @brief Force cleanup all active requests.
82 void diagnostic_manager_t::reset()
84 AFB_DEBUG("Clearing existing diagnostic requests");
85 cleanup_active_requests(true);
88 /// @brief send function use by diagnostic library. It will open a BCM CAN socket TX_SETUP type.
89 /// That socket will send cyclic messages configured from a diagnostic request.
91 /// @param[in] arbitration_id - CAN arbitration ID to use when send message. OBD2 broadcast ID
92 /// is 0x7DF by example.
93 /// @param[in] data - The data payload for the message. NULL is valid if size is also 0.
94 /// @param[in] size - The size of the data payload, in bytes.
96 /// @return true if the CAN message was sent successfully.
97 bool diagnostic_manager_t::shims_send(const uint32_t arbitration_id, const uint8_t* data, const uint8_t size)
99 diagnostic_manager_t& dm = application_t::instance().get_diagnostic_manager();
100 active_diagnostic_request_t* current_adr = dm.get_last_recurring_requests();
101 utils::socketcan_bcm_t& tx_socket = current_adr->get_socket();
103 // Make sure that socket has been opened.
105 tx_socket.open(dm.get_bus_device_name());
107 struct utils::bcm_msg bcm_msg;
110 struct timeval freq = current_adr->get_frequency_clock().get_timeval_from_period();
112 bcm_msg.msg_head.opcode = TX_SETUP;
113 bcm_msg.msg_head.can_id = arbitration_id;
114 bcm_msg.msg_head.flags = SETTIMER|STARTTIMER|TX_CP_CAN_ID;
115 bcm_msg.msg_head.count = 0;
116 bcm_msg.msg_head.ival2.tv_sec = freq.tv_sec;
117 bcm_msg.msg_head.ival2.tv_usec = freq.tv_usec;
118 bcm_msg.msg_head.nframes = 1;
121 ::memset(cf.data, 0, sizeof(cf.data));
122 ::memcpy(cf.data, data, size);
124 bcm_msg.frames[0] = cf;
126 tx_socket << bcm_msg;
132 /// @brief The type signature for an optional logging function, if the user
133 /// wishes to provide one. It should print, store or otherwise display the
136 /// message - A format string to log using the given parameters.
137 /// ... (vargs) - the parameters for the format string.
139 void diagnostic_manager_t::shims_logger(const char* format, ...)
142 va_start(args, format);
145 vsnprintf(buffer, 256, format, args);
147 AFB_DEBUG("%s", buffer);
151 const std::string diagnostic_manager_t::get_bus_name() const
156 const std::string diagnostic_manager_t::get_bus_device_name() const
158 return application_t::instance().get_can_bus_manager()
159 .get_can_device_name(bus_);
162 active_diagnostic_request_t* diagnostic_manager_t::get_last_recurring_requests() const
164 return recurring_requests_.back();
167 /// @brief Return diagnostic manager shims member.
168 DiagnosticShims& diagnostic_manager_t::get_shims()
173 /// @brief Search for a specific active diagnostic request in the provided requests list
174 /// and erase it from the vector. This is useful at unsubscription to clean up the list otherwize
175 /// all received CAN messages will be passed to DiagnosticRequestHandle of all active diagnostic request
176 /// contained in the vector but no event if connected to, so we will decode uneeded request.
178 /// @param[in] entry - a pointer of an active_diagnostic_request instance to clean up
179 /// @param[in] requests_list - a vector where to make the search and cleaning.
180 void diagnostic_manager_t::find_and_erase(active_diagnostic_request_t* entry, std::vector<active_diagnostic_request_t*>& requests_list)
182 auto i = std::find(requests_list.begin(), requests_list.end(), entry);
183 if ( i != requests_list.end())
184 requests_list.erase(i);
187 /// @brief Free memory allocated on active_diagnostic_request_t object and close the socket.
188 void diagnostic_manager_t::cancel_request(active_diagnostic_request_t* entry)
190 entry->get_socket().close();
191 if(entry->get_handle())
192 delete(entry->get_handle());
197 /// @brief Cleanup a specific request if it isn't running and get complete. As it is almost
198 /// impossible to get that state for a recurring request without waiting for that, you can
199 /// force the cleaning operation.
201 /// @param[in] entry - the request to clean
202 /// @param[in] force - Force the cleaning or not ?
203 void diagnostic_manager_t::cleanup_request(active_diagnostic_request_t* entry, bool force)
205 if(entry != nullptr && (force || entry->response_received()))
207 char request_string[128] = {0};
208 diagnostic_request_to_string(&entry->get_handle()->request,
209 request_string, sizeof(request_string));
210 if(force && entry->get_recurring())
212 cancel_request(entry);
213 find_and_erase(entry, recurring_requests_);
214 AFB_DEBUG("Cancelling completed, recurring request: %s", request_string);
216 else if (!entry->get_recurring())
218 AFB_DEBUG("Cancelling completed, non-recurring request: %s", request_string);
219 cancel_request(entry);
220 find_and_erase(entry, non_recurring_requests_);
225 /// @brief Clean up all requests lists, recurring and not recurring.
227 /// @param[in] force - Force the cleaning or not ? If true, that will do
228 /// the same effect as a call to reset().
229 void diagnostic_manager_t::cleanup_active_requests(bool force)
231 for(auto& entry : non_recurring_requests_)
233 if (entry != nullptr)
234 cleanup_request(entry, force);
237 for(auto& entry : recurring_requests_)
239 if (entry != nullptr)
240 cleanup_request(entry, force);
244 /// @brief Will return the active_diagnostic_request_t pointer for theDiagnosticRequest or nullptr if
247 /// @param[in] request - Search key, method will go through recurring list to see if it find that request
248 /// holded by the DiagnosticHandle member.
249 active_diagnostic_request_t* diagnostic_manager_t::find_recurring_request(DiagnosticRequest& request)
251 for (auto& entry : recurring_requests_)
255 if(diagnostic_request_equals(&entry->get_handle()->request, &request))
262 /// @brief Add and send a new one-time diagnostic request. DON'T USED AT THIS TIME
264 /// A one-time (aka non-recurring) request can existing in parallel with a
265 /// recurring request for the same PID or mode, that's not a problem.
267 /// For an example, see the docs for addRecurringRequest. This function is very
268 /// similar but leaves out the frequencyHz parameter.
270 /// @param[in] request - The parameters for the request.
271 /// @param[in] name - Human readable name this response, to be used when
272 /// publishing received responses.
273 /// @param[in] wait_for_multiple_responses - If false, When any response is received
274 /// for this request it will be removed from the active list. If true, the
275 /// request will remain active until the timeout clock expires, to allow it
276 /// to receive multiple response. Functional broadcast requests will always
277 /// waint for the timeout, regardless of this parameter.
278 /// @param[in] decoder - An optional DiagnosticResponseDecoder to parse the payload of
279 /// responses to this request. If the decoder is NULL, the output will
280 /// include the raw payload instead of a parsed value.
281 /// @param[in] callback - An optional DiagnosticResponseCallback to be notified whenever a
282 /// response is received for this request.
284 /// @return true if the request was added successfully. Returns false if there
285 /// wasn't a free active request entry.
286 active_diagnostic_request_t* diagnostic_manager_t::add_request(DiagnosticRequest* request, const std::string& name,
287 bool wait_for_multiple_responses, const DiagnosticResponseDecoder decoder,
288 const DiagnosticResponseCallback callback)
290 cleanup_active_requests(false);
292 active_diagnostic_request_t* entry = nullptr;
294 if (non_recurring_requests_.size() <= MAX_SIMULTANEOUS_DIAG_REQUESTS)
296 active_diagnostic_request_t* entry = new active_diagnostic_request_t(bus_, request->arbitration_id, name,
297 wait_for_multiple_responses, decoder, callback, 0, false);
298 entry->set_handle(shims_, request);
300 char request_string[128] = {0};
301 diagnostic_request_to_string(&entry->get_handle()->request, request_string,
302 sizeof(request_string));
304 // Erase any existing request not already cleaned.
305 cleanup_request(entry, true);
306 AFB_DEBUG("Added one-time diagnostic request on bus %s: %s",
307 bus_.c_str(), request_string);
309 non_recurring_requests_.push_back(entry);
313 AFB_WARNING("There isn't enough request entry. Vector exhausted %d/%d", (int)non_recurring_requests_.size(), MAX_SIMULTANEOUS_DIAG_REQUESTS);
314 non_recurring_requests_.resize(MAX_SIMULTANEOUS_DIAG_REQUESTS);
319 /// @brief Validate frequency asked don't get higher than the maximum of a classical
320 /// CAN bus OBD2 request.
322 /// @param[in] frequencyHz - frequency asked for sending diagnostic requests.
324 /// @return True if frequency is below the Maximum false if not.
325 bool diagnostic_manager_t::validate_optional_request_attributes(float frequencyHz)
327 if(frequencyHz > MAX_RECURRING_DIAGNOSTIC_FREQUENCY_HZ) {
328 AFB_DEBUG("Requested recurring diagnostic frequency %lf is higher than maximum of %d",
329 frequencyHz, MAX_RECURRING_DIAGNOSTIC_FREQUENCY_HZ);
335 /// @brief Add and send a new recurring diagnostic request.
337 /// At most one recurring request can be active for the same arbitration ID, mode
338 /// and (if set) PID on the same bus at one time. If you try and call
339 /// add_recurring_request with the same key, it will return an error.
341 /// @param[in] request - The parameters for the request.
342 /// @param[in] name - An optional human readable name this response, to be used when
343 /// publishing received responses. If the name is NULL, the published output
344 /// will use the raw OBD-II response format.
345 /// @param[in] wait_for_multiple_responses - If false, When any response is received
346 /// for this request it will be removed from the active list. If true, the
347 /// request will remain active until the timeout clock expires, to allow it
348 /// to receive multiple response. Functional broadcast requests will always
349 /// waint for the timeout, regardless of this parameter.
350 /// @param[in] decoder - An optional DiagnosticResponseDecoder to parse the payload of
351 /// responses to this request. If the decoder is NULL, the output will
352 /// include the raw payload instead of a parsed value.
353 /// @param[in] callback - An optional DiagnosticResponseCallback to be notified whenever a
354 /// response is received for this request.
355 /// @param[in] frequencyHz - The frequency (in Hz) to send the request. A frequency above
356 /// MAX_RECURRING_DIAGNOSTIC_FREQUENCY_HZ is not allowed, and will make this
357 /// function return false.
359 /// @return true if the request was added successfully. Returns false if there
360 /// was too much already running requests, or if the frequency was too high.
361 active_diagnostic_request_t* diagnostic_manager_t::add_recurring_request(DiagnosticRequest* request, const char* name,
362 bool wait_for_multiple_responses, const DiagnosticResponseDecoder decoder,
363 const DiagnosticResponseCallback callback, float frequencyHz, bool permanent)
365 active_diagnostic_request_t* entry = nullptr;
367 if(!validate_optional_request_attributes(frequencyHz))
370 cleanup_active_requests(false);
372 if(find_recurring_request(*request) == nullptr)
374 if(recurring_requests_.size() <= MAX_SIMULTANEOUS_DIAG_REQUESTS)
376 entry = new active_diagnostic_request_t(bus_, request->arbitration_id, name,
377 wait_for_multiple_responses, decoder, callback, frequencyHz, permanent);
378 recurring_requests_.push_back(entry);
380 entry->set_handle(shims_, request);
381 start_diagnostic_request(&shims_, entry->get_handle());
385 AFB_WARNING("There isn't enough request entry. Vector exhausted %d/%d", (int)recurring_requests_.size(), MAX_SIMULTANEOUS_DIAG_REQUESTS);
386 recurring_requests_.resize(MAX_SIMULTANEOUS_DIAG_REQUESTS);
390 { AFB_DEBUG("Can't add request, one already exists with same key");}
394 /// @brief Will decode the diagnostic response and build the final openxc_VehicleMessage to return.
396 /// @param[in] adr - A pointer to an active diagnostic request holding a valid diagnostic handle
397 /// @param[in] response - The response to decode from which the Vehicle message will be built and returned
399 /// @return A filled openxc_VehicleMessage or a zeroed struct if there is an error.
400 openxc_VehicleMessage diagnostic_manager_t::relay_diagnostic_response(active_diagnostic_request_t* adr, const DiagnosticResponse& response, const uint64_t timestamp)
402 openxc_VehicleMessage message = build_VehicleMessage();
403 float value = (float)diagnostic_payload_to_integer(&response);
405 struct utils::signals_found found_signals;
406 found_signals = utils::signals_manager_t::instance().find_signals(build_DynamicField((double) adr->get_pid()));
408 if(adr->get_decoder() != nullptr)
410 value = adr->get_decoder()(&response, value);
413 if((response.success && adr->get_name().size()) > 0)
415 // If name, include 'value' instead of payload, and leave of response
417 message = build_VehicleMessage(build_SimpleMessage(adr->get_name(), build_DynamicField(value)));
418 message.has_diagnostic_response = true;
419 message.diagnostic_response = build_VehicleMessage(adr, response, value).diagnostic_response;
423 // If no name, only send full details of response but still include 'value'
424 // instead of 'payload' if they provided a decoder. The one case you
425 // can't get is the full detailed response with 'value'. We could add
426 // another parameter for that but it's onerous to carry that around.
427 message = build_VehicleMessage(adr, response, value);
430 // If not success but completed then the pid isn't supported
431 if(!response.success)
433 found_signals.diagnostic_messages.front()->set_supported(false);
434 cleanup_request(adr, true);
435 AFB_NOTICE("PID not supported or ill formed. Please unsubscribe from it. Error code : %d", response.negative_response_code);
436 message = build_VehicleMessage(build_SimpleMessage(adr->get_name(), build_DynamicField("This PID isn't supported by your vehicle.")));
439 if(adr->get_callback() != nullptr)
441 adr->get_callback()(adr, &response, value);
444 // Reset the completed flag handle to make sure that it will be reprocessed the next time.
445 adr->get_handle()->success = false;
447 // Save value and timestamp of diagnostic message
448 if(!found_signals.diagnostic_messages.empty())
450 // Then, for each diag_message found
451 for(const auto& diag_mess: found_signals.diagnostic_messages)
453 // Save value and timestamp for this message
454 diag_mess->set_received(true);
455 diag_mess->set_last_value(value);
456 diag_mess->set_timestamp(timestamp);
463 /// @brief Will take the CAN message and pass it to the receive functions that will process
464 /// diagnostic handle for each active diagnostic request then depending on the result we will
465 /// return pass the diagnostic response to decode it.
467 /// @param[in] entry - A pointer to an active diagnostic request holding a valid diagnostic handle
468 /// @param[in] cm - A raw CAN message.
470 /// @return A pointer to a filled openxc_VehicleMessage or a nullptr if nothing has been found.
471 openxc_VehicleMessage diagnostic_manager_t::relay_diagnostic_handle(active_diagnostic_request_t* entry, const can_message_t& cm)
473 DiagnosticResponse response = diagnostic_receive_can_frame(&shims_, entry->get_handle(), cm.get_id(), cm.get_data(), cm.get_length());
474 if(response.completed && entry->get_handle()->completed)
476 if(entry->get_handle()->success)
477 return relay_diagnostic_response(entry, response, cm.get_timestamp());
479 else if(!response.completed && response.multi_frame)
481 // Reset the timeout clock while completing the multi-frame receive
482 entry->get_timeout_clock().tick(
483 entry->get_timeout_clock().get_time_function()());
486 return build_VehicleMessage();
489 /// @brief Find the active diagnostic request with the correct DiagnosticRequestHandle
490 /// member that will understand the CAN message using diagnostic_receive_can_frame function
491 /// from UDS-C library. Then decode it with an ad-hoc method.
493 /// @param[in] cm - Raw CAN message received
495 /// @return VehicleMessage with decoded value.
496 openxc_VehicleMessage diagnostic_manager_t::find_and_decode_adr(const can_message_t& cm)
498 openxc_VehicleMessage vehicle_message = build_VehicleMessage();
500 for ( auto entry : non_recurring_requests_)
502 vehicle_message = relay_diagnostic_handle(entry, cm);
503 if (is_valid(vehicle_message))
504 return vehicle_message;
507 for ( auto entry : recurring_requests_)
509 vehicle_message = relay_diagnostic_handle(entry, cm);
510 if (is_valid(vehicle_message))
511 return vehicle_message;
514 return vehicle_message;
517 /// @brief Tell if the CAN message received is a diagnostic response.
518 /// Request broadcast ID use 0x7DF and assigned ID goes from 0x7E0 to Ox7E7. That allows up to 8 ECU to respond
519 /// at the same time. The response is the assigned ID + 0x8, so response ID can goes from 0x7E8 to 0x7EF.
521 /// @param[in] cm - CAN message received from the socket.
523 /// @return True if the active diagnostic request match the response.
524 bool diagnostic_manager_t::is_diagnostic_response(const can_message_t& cm)
526 if (cm.get_id() >= 0x7e8 && cm.get_id() <= 0x7ef)