fix #514, call_data_callbacks after shared the data #548
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| /******************************************************************************* | ||
| * Copyright (C) 2025 Commissariat a l'energie atomique et aux energies alternatives (CEA) | ||
| * All rights reserved. | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions are met: | ||
| * * Redistributions of source code must retain the above copyright | ||
| * notice, this list of conditions and the following disclaimer. | ||
| * * Redistributions in binary form must reproduce the above copyright | ||
| * notice, this list of conditions and the following disclaimer in the | ||
| * documentation and/or other materials provided with the distribution. | ||
| * * Neither the name of CEA nor the names of its contributors may be used to | ||
| * endorse or promote products derived from this software without specific | ||
| * prior written permission. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| ******************************************************************************/ | ||
|
|
||
| #ifndef PDI_DELAYED_DATA_CALLBACK_H_ | ||
| #define PDI_DELAYED_DATA_CALLBACK_H_ | ||
|
|
||
|
|
||
| #include <iostream> | ||
| #include <list> | ||
| #include <string> | ||
|
|
||
| #include <pdi/pdi_fwd.h> | ||
| #include "pdi/context.h" | ||
| #include "pdi/datatype.h" | ||
| #include "pdi/error.h" | ||
| #include "pdi/plugin.h" | ||
| #include "pdi/ref_any.h" | ||
| #include "pdi/scalar_datatype.h" | ||
| #include <pdi/context.h> | ||
| #include <pdi/data_descriptor.h> | ||
| #include <pdi/datatype_template.h> | ||
| #include <pdi/ref_any.h> | ||
|
|
||
| #include <data_descriptor_impl.h> | ||
|
|
||
| #include "global_context.h" | ||
|
|
||
| namespace PDI { | ||
|
|
||
| class PDI_EXPORT Delayed_data_callbacks | ||
| { | ||
| /// friend class Global_context; | ||
| std::list<std::string> m_datanames; | ||
|
Member
There was a problem hiding this comment. You are iterating over all the elements of this data structure. It probably is better if this is a std::forward_list.
Contributor
Author
There was a problem hiding this comment. For the logger message, I need the size of the list. In
Member
There was a problem hiding this comment. If the size is only used for logger, we can do it differently e.g. nb_elemt = std::distance(m_datanames.begin(), m_datanames.end()) |
||
|
|
||
| /// The context this descriptor is part of | ||
| Global_context& m_context; | ||
|
|
||
| /// A descriptor in case of | ||
| Data_descriptor_impl** m_descriptor; | ||
|
|
||
| public: | ||
| /// constructor used in: | ||
| /// - desc.share(void* data, bool read, bool write) | ||
| /// - desc.share(Ref data_ref, bool read, bool write) | ||
| /// to define a "Delayed_data_callbacks" object | ||
| Delayed_data_callbacks(Data_descriptor_impl** desc) | ||
| : m_descriptor(desc) | ||
| , m_datanames(0) | ||
Yushan-Wang marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| , m_context((*desc)->m_context) | ||
Yushan-Wang marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| {} | ||
|
|
||
| /// constructor used in: | ||
| /// - the case of PDI_multi_expose | ||
| /// - when a user want to define is own "Delayed_data_callbacks" object | ||
| /// Remark: This constructor doesn't work if PDI_init is not called. | ||
| Delayed_data_callbacks(Global_context& ctx) | ||
| : m_context{ctx} | ||
| , m_datanames(0) | ||
Yushan-Wang marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| , m_descriptor(nullptr) | ||
Yushan-Wang marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| {} | ||
|
|
||
| // In the destructor, we need to throw an error message in case of the callback on the data doesn't work (trigger function) | ||
| // (example: error in the config.yml for a plugin, error due to external library incompatibility) | ||
| ~Delayed_data_callbacks() noexcept(false) | ||
Yushan-Wang marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| try { | ||
| this->trigger(); | ||
| } catch (Error& e) { | ||
| if (std::uncaught_exceptions()) { | ||
|
Member
There was a problem hiding this comment. I'm not sure that this is useful. I would not use |
||
| // An exception is throwing. Print simple message to avoid std::terminate. | ||
| m_context.logger().error("Error in the destructor of Delayed_data_callbacks, {}", e.what()); | ||
| } else { | ||
| // No exception is throwing. Throw an error. | ||
| throw Error(e.status(), "Error in the destructor of Delayed_data_callbacks, {}", e.what()); | ||
Yushan-Wang marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| } catch (const std::exception& e) { | ||
| if (std::uncaught_exceptions()) { | ||
|
|
||
| // An exception is throwing. Print simple message to avoid std::terminate. | ||
| m_context.logger().error("Error in the destructor of Delayed_data_callbacks, {}", e.what()); | ||
| } else { | ||
| // No exception is throwing. Throw an error. | ||
| m_context.logger().error("Error in the destructor of Delayed_data_callbacks."); | ||
| throw; | ||
|
Member
There was a problem hiding this comment. you should not throw in a noexcept method. |
||
| } | ||
| } catch (...) { | ||
| if (std::uncaught_exceptions()) { | ||
|
|
||
| // An exception is throwing. Print simple message to avoid std::terminate. | ||
| m_context.logger().error("Error in the destructor of Delayed_data_callbacks."); | ||
| } else { | ||
| // No exception is throwing. Throw an error. | ||
| m_context.logger().error("Error in the destructor of Delayed_data_callbacks."); | ||
| throw; | ||
|
|
||
| } | ||
| } | ||
| m_descriptor = nullptr; | ||
| } | ||
|
|
||
| // add element to the list | ||
| void add_dataname(const std::string& name) { m_datanames.emplace_back(name); } | ||
|
|
||
| // trigger_delayed_data_callbacks() | ||
| void trigger() | ||
| try { | ||
| int i = 0; | ||
| size_t number_of_elements = m_datanames.size(); | ||
| for (; !m_datanames.empty(); m_datanames.pop_front()) { | ||
| auto&& element_name = m_datanames.front(); | ||
| m_context.logger().trace("Trigger data callback `{}' ({}/{})", element_name.c_str(), ++i, number_of_elements); | ||
|
|
||
| if (!m_descriptor) { | ||
| m_context[element_name.c_str()].trigger_delayed_data_callbacks(); | ||
| } else { | ||
| (*m_descriptor)->trigger_delayed_data_callbacks(); | ||
| } | ||
| } | ||
| } catch (Error& e) { | ||
| this->cancel(); // clear the m_datanames | ||
| throw Error(e.status(), "Error in trigger data callback: `{}'", e.what()); | ||
| } catch (...) { | ||
| this->cancel(); // clear the m_datanames | ||
| throw; | ||
| } | ||
|
|
||
| // clear the element in the list | ||
| void cancel() { m_datanames.clear(); } | ||
| }; // class Delayed_data_callbacks | ||
|
|
||
| } // namespace PDI | ||
| #endif // PDI_DELAYED_DATA_CALLBACK_H_ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this commented ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will be remove in the next commit