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.
25 #include <sys/ioctl.h>
26 #include <sys/socket.h>
27 #include <json-c/json.h>
28 #include <linux/can/raw.h>
30 #include "can-bus.hpp"
32 #include "can-signals.hpp"
33 #include "can-decoder.hpp"
34 #include "../configuration.hpp"
35 #include "../utils/signals.hpp"
36 #include "../utils/openxc-utils.hpp"
40 #include <afb/afb-binding.h>
43 /// @brief Class constructor
45 /// @param[in] conf_file - handle to the json configuration file.
46 can_bus_t::can_bus_t(int conf_file)
47 : conf_file_{conf_file}
51 std::map<std::string, std::shared_ptr<can_bus_dev_t>> can_bus_t::can_devices_;
53 /// @brief Will make the decoding operation on a classic CAN message. It will not
54 /// handle CAN commands nor diagnostic messages that have their own method to get
57 /// It will add to the vehicle_message queue the decoded message and tell the event push
58 /// thread to process it.
60 /// @param[in] can_message - a single CAN message from the CAN socket read, to be decode.
62 /// @return How many signals has been decoded.
63 int can_bus_t::process_can_signals(can_message_t& can_message)
65 int processed_signals = 0;
66 std::vector <can_signal_t*> signals;
67 openxc_DynamicField search_key, decoded_message;
68 openxc_VehicleMessage vehicle_message;
70 // First we have to found which can_signal_t it is
71 search_key = build_DynamicField((double)can_message.get_id());
72 configuration_t::instance().find_can_signals(search_key, signals);
74 // Decoding the message ! Don't kill the messenger !
75 for(auto& sig : signals)
77 std::lock_guard<std::mutex> subscribed_signals_lock(get_subscribed_signals_mutex());
78 std::map<std::string, struct afb_event>& s = get_subscribed_signals();
80 // DEBUG message to make easier debugger STL containers...
81 //DEBUG(binder_interface, "Operator[] key char: %s, event valid? %d", sig.generic_name, afb_event_is_valid(s[sig.generic_name]));
82 //DEBUG(binder_interface, "Operator[] key string: %s, event valid? %d", sig.generic_name, afb_event_is_valid(s[std::string(sig.generic_name)]));
83 //DEBUG(binder_interface, "Nb elt matched char: %d", (int)s.count(sig.generic_name));
84 //DEBUG(binder_interface, "Nb elt matched string: %d", (int)s.count(std::string(sig.generic_name));
85 if( s.find(sig->get_name()) != s.end() && afb_event_is_valid(s[sig->get_name()]))
87 decoded_message = decoder_t::translateSignal(*sig, can_message, configuration_t::instance().get_can_signals());
89 openxc_SimpleMessage s_message = build_SimpleMessage(sig->get_name(), decoded_message);
90 vehicle_message = build_VehicleMessage(s_message);
92 std::lock_guard<std::mutex> decoded_can_message_lock(decoded_can_message_mutex_);
93 push_new_vehicle_message(vehicle_message);
94 new_decoded_can_message_.notify_one();
99 DEBUG(binder_interface, "process_can_signals: %d/%d CAN signals processed.", processed_signals, (int)signals.size());
100 return processed_signals;
103 /// @brief Will make the decoding operation on a diagnostic CAN message.Then it find the subscribed signal
104 /// corresponding and will add the vehicle_message to the queue of event to pushed before notifying
105 /// the event push thread to process it.
107 /// @param[in] manager - the diagnostic manager object that handle diagnostic communication
108 /// @param[in] can_message - a single CAN message from the CAN socket read, to be decode.
110 /// @return How many signals has been decoded.
111 int can_bus_t::process_diagnostic_signals(diagnostic_manager_t& manager, const can_message_t& can_message)
113 int processed_signals = 0;
115 std::lock_guard<std::mutex> subscribed_signals_lock(get_subscribed_signals_mutex());
116 std::map<std::string, struct afb_event>& s = get_subscribed_signals();
118 openxc_VehicleMessage vehicle_message = manager.find_and_decode_adr(can_message);
119 if( (vehicle_message.has_simple_message && vehicle_message.simple_message.has_name) &&
120 (s.find(vehicle_message.simple_message.name) != s.end() && afb_event_is_valid(s[vehicle_message.simple_message.name])))
122 std::lock_guard<std::mutex> decoded_can_message_lock(decoded_can_message_mutex_);
123 push_new_vehicle_message(vehicle_message);
124 new_decoded_can_message_.notify_one();
128 return processed_signals;
131 /// @brief thread to decoding raw CAN messages.
133 /// Depending on the nature of message, if arbitration ID matches ID for a diagnostic response
134 /// then decoding a diagnostic message else use classic CAN signals decoding functions.
136 /// It will take from the can_message_q_ queue the next can message to process then it search
137 /// about signal subscribed if there is a valid afb_event for it. We only decode signal for which a
138 /// subscription has been made. Can message will be decoded using translateSignal that will pass it to the
139 /// corresponding decoding function if there is one assigned for that signal. If not, it will be the default
140 /// noopDecoder function that will operate on it.
142 /// TODO: make diagnostic messages parsing optionnal.
143 void can_bus_t::can_decode_message()
145 can_message_t can_message;
149 std::unique_lock<std::mutex> can_message_lock(can_message_mutex_);
150 new_can_message_cv_.wait(can_message_lock);
151 can_message = next_can_message();
153 if(configuration_t::instance().get_diagnostic_manager().is_diagnostic_response(can_message))
154 process_diagnostic_signals(configuration_t::instance().get_diagnostic_manager(), can_message);
156 process_can_signals(can_message);
160 /// @brief thread to push events to suscribers. It will read subscribed_signals map to look
161 /// which are events that has to be pushed.
162 void can_bus_t::can_event_push()
164 openxc_VehicleMessage v_message;
165 openxc_SimpleMessage s_message;
170 std::unique_lock<std::mutex> decoded_can_message_lock(decoded_can_message_mutex_);
171 new_decoded_can_message_.wait(decoded_can_message_lock);
172 v_message = next_vehicle_message();
174 s_message = get_simple_message(v_message);
176 std::lock_guard<std::mutex> subscribed_signals_lock(get_subscribed_signals_mutex());
177 std::map<std::string, struct afb_event>& s = get_subscribed_signals();
178 if(s.find(std::string(s_message.name)) != s.end() && afb_event_is_valid(s[std::string(s_message.name)]))
180 jo = json_object_new_object();
181 jsonify_simple(s_message, jo);
182 afb_event_push(s[std::string(s_message.name)], jo);
188 /// @brief Will initialize threads that will decode
189 /// and push subscribed events.
190 void can_bus_t::start_threads()
193 th_decoding_ = std::thread(&can_bus_t::can_decode_message, this);
194 if(!th_decoding_.joinable())
195 is_decoding_ = false;
198 th_pushing_ = std::thread(&can_bus_t::can_event_push, this);
199 if(!th_pushing_.joinable())
203 /// @brief Will stop all threads holded by can_bus_t object
204 /// which are decoding and pushing then will wait that's
205 /// they'll finish their job.
206 void can_bus_t::stop_threads()
208 is_decoding_ = false;
212 /// @brief Will initialize can_bus_dev_t objects after reading
213 /// the configuration file passed in the constructor. All CAN buses
214 /// Initialized here will be added to a vector holding them for
215 /// inventory and later access.
217 /// That will initialize CAN socket reading too using a new thread.
219 /// @return 0 if ok, other if not.
220 int can_bus_t::init_can_dev()
222 std::vector<std::string> devices_name;
226 devices_name = read_conf();
228 if (! devices_name.empty())
230 t = devices_name.size();
232 for(const auto& device : devices_name)
234 can_bus_t::can_devices_[device] = std::make_shared<can_bus_dev_t>(device, i);
235 if (can_bus_t::can_devices_[device]->open() == 0)
237 DEBUG(binder_interface, "Start reading thread");
238 NOTICE(binder_interface, "%s device opened and reading", device.c_str());
239 can_bus_t::can_devices_[device]->start_reading(*this);
243 ERROR(binder_interface, "Can't open device %s", device.c_str());
246 NOTICE(binder_interface, "Initialized %d/%d can bus device(s)", i, t);
249 ERROR(binder_interface, "init_can_dev: Error at CAN device initialization. No devices read from configuration file. Did you specify canbus JSON object ?");
253 /// @brief read the conf_file_ and will parse json objects
254 /// in it searching for canbus objects devices name.
256 /// @return Vector of can bus device name string.
257 std::vector<std::string> can_bus_t::read_conf()
259 std::vector<std::string> ret;
260 json_object *jo, *canbus;
264 FILE *fd = fdopen(conf_file_, "r");
267 std::string fd_conf_content;
268 std::fseek(fd, 0, SEEK_END);
269 fd_conf_content.resize(std::ftell(fd));
271 std::fread(&fd_conf_content[0], 1, fd_conf_content.size(), fd);
274 DEBUG(binder_interface, "Configuration file content : %s", fd_conf_content.c_str());
275 jo = json_tokener_parse(fd_conf_content.c_str());
277 if (jo == NULL || !json_object_object_get_ex(jo, "canbus", &canbus))
279 ERROR(binder_interface, "Can't find canbus node in the configuration file. Please review it.");
282 else if (json_object_get_type(canbus) != json_type_array)
284 taxi = json_object_get_string(canbus);
285 DEBUG(binder_interface, "Can bus found: %s", taxi);
286 ret.push_back(std::string(taxi));
290 n = json_object_array_length(canbus);
291 for (i = 0 ; i < n ; i++)
292 ret.push_back(json_object_get_string(json_object_array_get_idx(canbus, i)));
296 ERROR(binder_interface, "Problem at reading the conf file");
301 /// @brief return new_can_message_cv_ member
303 /// @return return new_can_message_cv_ member
304 std::condition_variable& can_bus_t::get_new_can_message_cv()
306 return new_can_message_cv_;
309 /// @brief return can_message_mutex_ member
311 /// @return return can_message_mutex_ member
312 std::mutex& can_bus_t::get_can_message_mutex()
314 return can_message_mutex_;
317 /// @brief Return first can_message_t on the queue
319 /// @return a can_message_t
320 can_message_t can_bus_t::next_can_message()
322 can_message_t can_msg;
324 if(!can_message_q_.empty())
326 can_msg = can_message_q_.front();
327 can_message_q_.pop();
328 DEBUG(binder_interface, "next_can_message: Here is the next can message : id %X, length %X, data %02X%02X%02X%02X%02X%02X%02X%02X", can_msg.get_id(), can_msg.get_length(),
329 can_msg.get_data()[0], can_msg.get_data()[1], can_msg.get_data()[2], can_msg.get_data()[3], can_msg.get_data()[4], can_msg.get_data()[5], can_msg.get_data()[6], can_msg.get_data()[7]);
336 /// @brief Push a can_message_t into the queue
338 /// @param[in] can_msg - the const reference can_message_t object to push into the queue
339 void can_bus_t::push_new_can_message(const can_message_t& can_msg)
341 can_message_q_.push(can_msg);
344 /// @brief Return first openxc_VehicleMessage on the queue
346 /// @return a openxc_VehicleMessage containing a decoded can message
347 openxc_VehicleMessage can_bus_t::next_vehicle_message()
349 openxc_VehicleMessage v_msg;
351 if(! vehicle_message_q_.empty())
353 v_msg = vehicle_message_q_.front();
354 vehicle_message_q_.pop();
355 DEBUG(binder_interface, "next_vehicle_message: next vehicle message poped");
362 /// @brief Push a openxc_VehicleMessage into the queue
364 /// @param[in] v_msg - const reference openxc_VehicleMessage object to push into the queue
365 void can_bus_t::push_new_vehicle_message(const openxc_VehicleMessage& v_msg)
367 vehicle_message_q_.push(v_msg);
370 /// @brief Return a map with the can_bus_dev_t initialized
372 /// @return map can_bus_dev_m_ map
373 const std::map<std::string, std::shared_ptr<can_bus_dev_t>>& can_bus_t::get_can_devices() const
375 return can_bus_t::can_devices_;
378 /// @brief Return the shared pointer on the can_bus_dev_t initialized
379 /// with device_name "bus"
381 /// @param[in] bus - CAN bus device name to retrieve.
383 /// @return A shared pointer on an object can_bus_dev_t
384 std::shared_ptr<can_bus_dev_t> can_bus_t::get_can_device(std::string bus)
386 return can_bus_t::can_devices_[bus];