-
Notifications
You must be signed in to change notification settings - Fork 398
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2222 from elBoberido/iox-1755-redirect-printing-i…
…n-the-platform-layer-to-the-logger iox-#1755 Redirect printing in the platform layer to the logger
- Loading branch information
Showing
18 changed files
with
574 additions
and
69 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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,55 @@ | ||
// Copyright (c) 2024 by Mathias Kraus <[email protected]>. All rights reserved. | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
// | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
#include "iox/logging.hpp" | ||
|
||
namespace iox::log::internal | ||
{ | ||
// NOLINTJUSTIFICATION Not used directly but as a function pointer to set the backend | ||
// NOLINTNEXTLINE(readability-function-size) | ||
void platform_log_backend( | ||
const char* file, int line, const char* function, IceoryxPlatformLogLevel log_level, const char* msg) | ||
{ | ||
auto level = LogLevel::TRACE; | ||
switch (log_level) | ||
{ | ||
case IceoryxPlatformLogLevel::IOX_PLATFORM_LOG_LEVEL_OFF: | ||
level = LogLevel::OFF; | ||
break; | ||
case IceoryxPlatformLogLevel::IOX_PLATFORM_LOG_LEVEL_FATAL: | ||
level = LogLevel::FATAL; | ||
break; | ||
case IceoryxPlatformLogLevel::IOX_PLATFORM_LOG_LEVEL_ERROR: | ||
level = LogLevel::ERROR; | ||
break; | ||
case IceoryxPlatformLogLevel::IOX_PLATFORM_LOG_LEVEL_WARN: | ||
level = LogLevel::WARN; | ||
break; | ||
case IceoryxPlatformLogLevel::IOX_PLATFORM_LOG_LEVEL_INFO: | ||
level = LogLevel::INFO; | ||
break; | ||
case IceoryxPlatformLogLevel::IOX_PLATFORM_LOG_LEVEL_DEBUG: | ||
level = LogLevel::DEBUG; | ||
break; | ||
case IceoryxPlatformLogLevel::IOX_PLATFORM_LOG_LEVEL_TRACE: | ||
level = LogLevel::TRACE; | ||
break; | ||
default: | ||
level = LogLevel::TRACE; | ||
} | ||
IOX_LOG_INTERNAL(file, line, function, level, msg); | ||
} | ||
} // namespace iox::log::internal |
This file contains 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
63 changes: 63 additions & 0 deletions
63
iceoryx_platform/generic/include/iceoryx_platform/logging.hpp
This file contains 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,63 @@ | ||
// Copyright (c) 2024 by Mathias Kraus <[email protected]>. All rights reserved. | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
// | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
#ifndef IOX_PLATFORM_LOGGING_HPP | ||
#define IOX_PLATFORM_LOGGING_HPP | ||
|
||
enum IceoryxPlatformLogLevel | ||
{ | ||
IOX_PLATFORM_LOG_LEVEL_OFF = 0, | ||
IOX_PLATFORM_LOG_LEVEL_FATAL, | ||
IOX_PLATFORM_LOG_LEVEL_ERROR, | ||
IOX_PLATFORM_LOG_LEVEL_WARN, | ||
IOX_PLATFORM_LOG_LEVEL_INFO, | ||
IOX_PLATFORM_LOG_LEVEL_DEBUG, | ||
IOX_PLATFORM_LOG_LEVEL_TRACE | ||
}; | ||
|
||
/// @brief Typedef to the platform log backend | ||
/// @param[in] file should be the '__FILE__' compiler intrinsic | ||
/// @param[in] line should be the '__LINE__' compiler intrinsic | ||
/// @param[in] function should be the '__FUNCTION__' compiler intrinsic | ||
/// @param[in] log_level is the log level to be used for the log message | ||
/// @param[in] msg is the message to be logged | ||
typedef void (*IceoryxPlatformLogBackend)( | ||
const char* file, int line, const char* function, IceoryxPlatformLogLevel log_level, const char* msg); | ||
|
||
/// @brief Sets the logging backend to the provided function | ||
/// @param[in] log_backend to be used | ||
/// @note The log_backend must have a static lifetime and must be thread-safe | ||
void iox_platform_set_log_backend(IceoryxPlatformLogBackend log_backend); | ||
|
||
/// @note Implementation detail! Do not use directly | ||
void iox_platform_detail_log( | ||
const char* file, int line, const char* function, IceoryxPlatformLogLevel log_level, const char* msg); | ||
|
||
/// @note Implementation detail! Do not use directly | ||
void iox_platform_detail_default_log_backend( | ||
const char* file, int line, const char* function, IceoryxPlatformLogLevel log_level, const char* msg); | ||
|
||
// NOLINTJUSTIFICATION The functionality of the macro (obtaining the source location) cannot be achieved with C++17 | ||
// NOLINTBEGIN(cppcoreguidelines-macro-usage) | ||
/// @brief Frontend for logging in the iceoryx platform | ||
/// @param[in] log_level is the log level to be used for the log message | ||
/// @param[in] msg is the message to be logged | ||
#define IOX_PLATFORM_LOG(log_level, msg) \ | ||
iox_platform_detail_log( \ | ||
__FILE__, __LINE__, static_cast<const char*>(__FUNCTION__), IceoryxPlatformLogLevel::log_level, msg) | ||
// NOLINTEND(cppcoreguidelines-macro-usage) | ||
|
||
#endif // IOX_PLATFORM_LOGGING_HPP |
Oops, something went wrong.