Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

C++: tidy up #1304

Merged
merged 5 commits into from
Jan 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 15 additions & 9 deletions worker/.clang-tidy
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ Checks: "*,\
-altera*,\
-boost-use-to-string,\
-bugprone-easily-swappable-parameters,\
-bugprone-lambda-function-name,\
-bugprone-macro-parentheses,\
-cert-*,\
-clang-analyzer-optin.osx.*,\
-clang-analyzer-osx.*,\
Expand Down Expand Up @@ -37,34 +39,38 @@ Checks: "*,\
-hicpp-uppercase-literal-suffix,\
-hicpp-vararg,\
-llvm-include-order,\
-llvm-header-guard,\
-llvm-else-after-return,\
-llvmlibc-*,\
-misc-non-private-member-variables-in-classes,\
-modernize-avoid-c-arrays,\
-modernize-concat-nested-namespaces,\
-modernize-make-unique,\
-modernize-pass-by-value,\
-modernize-use-nodiscard, \
-modernize-use-trailing-return-type,\
-readability-else-after-return,\
-readability-function-cognitive-complexity,\
-readability-identifier-length,\
-readability-implicit-bool-cast,\
-readability-implicit-bool-conversion,\
-readability-magic-numbers,\
-readability-redundant-access-specifiers, \
-readability-uppercase-literal-suffix,\
"

HeaderFilterRegex: ''
AnalyzeTemporaryDtors: false
User: mediasoup

# Old clang-tidy does not support this option which indicates to take the
# format options from .clang-format when applying fixes.
#FormatStyle: file
FormatStyle: file

CheckOptions:
- key: cppcoreguidelines-pro-bounds-constant-array-index.GslHeader
value: ''
- key: cppcoreguidelines-pro-bounds-constant-array-index.IncludeStyle
value: '0'
- key: cppcoreguidelines-macro-usage.AllowedRegexp
value: ^MS_*
- key: misc-assert-side-effect.AssertMacros
value: assert
- key: misc-assert-side-effect.CheckFunctionCalls
Expand Down Expand Up @@ -98,7 +104,7 @@ CheckOptions:
- key: readability-identifier-naming.ClassCase
value: CamelCase
- key: readability-identifier-naming.ClassConstantCase
value: camelBack
value: CamelCase
- key: readability-identifier-naming.ClassConstantPrefix
value: ''
- key: readability-identifier-naming.ClassConstantSuffix
Expand Down Expand Up @@ -156,9 +162,9 @@ CheckOptions:
- key: readability-identifier-naming.ConstexprVariableSuffix
value: ''
- key: readability-identifier-naming.EnumCase
value: aNy_Case
value: aNy_CasE
- key: readability-identifier-naming.EnumConstantCase
value: aNy_Case
value: aNy_CasE
- key: readability-identifier-naming.EnumConstantPrefix
value: ''
- key: readability-identifier-naming.EnumConstantSuffix
Expand Down Expand Up @@ -194,7 +200,7 @@ CheckOptions:
- key: readability-identifier-naming.IgnoreFailedSplit
value: '0'
- key: readability-identifier-naming.InlineNamespaceCase
value: aNy_Case
value: aNy_CasE
- key: readability-identifier-naming.InlineNamespacePrefix
value: ''
- key: readability-identifier-naming.InlineNamespaceSuffix
Expand Down Expand Up @@ -224,7 +230,7 @@ CheckOptions:
- key: readability-identifier-naming.MethodSuffix
value: ''
- key: readability-identifier-naming.NamespaceCase
value: aNy_Case
value: aNy_CasE
- key: readability-identifier-naming.NamespacePrefix
value: ''
- key: readability-identifier-naming.NamespaceSuffix
Expand Down
10 changes: 5 additions & 5 deletions worker/include/Channel/ChannelSocket.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ namespace Channel

public:
ConsumerSocket(int fd, size_t bufferSize, Listener* listener);
~ConsumerSocket();
~ConsumerSocket() override;

/* Pure virtual methods inherited from ::UnixStreamSocketHandle. */
public:
Expand Down Expand Up @@ -75,7 +75,7 @@ namespace Channel
class Listener : public RequestHandler, public NotificationHandler
{
public:
virtual ~Listener() = default;
~Listener() override = default;

public:
virtual void OnChannelClosed(Channel::ChannelSocket* channel) = 0;
Expand All @@ -88,13 +88,13 @@ namespace Channel
ChannelReadCtx channelReadCtx,
ChannelWriteFn channelWriteFn,
ChannelWriteCtx channelWriteCtx);
virtual ~ChannelSocket();
~ChannelSocket() override;

public:
void Close();
void SetListener(Listener* listener);
void Send(const uint8_t* message, uint32_t messageLen);
void SendLog(const char* message, uint32_t messageLen);
void Send(const uint8_t* data, uint32_t dataLen);
void SendLog(const char* data, uint32_t dataLen);
bool CallbackRead();

private:
Expand Down
36 changes: 20 additions & 16 deletions worker/include/Logger.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,10 @@

// clang-format off

// NOLINTBEGIN
#define _MS_TAG_ENABLED(tag) Settings::configuration.logTags.tag
#define _MS_TAG_ENABLED_2(tag1, tag2) (Settings::configuration.logTags.tag1 || Settings::configuration.logTags.tag2)
// NOLINTEND

#if !defined(MS_LOG_DEV_LEVEL)
#define MS_LOG_DEV_LEVEL 0
Expand Down Expand Up @@ -145,14 +147,15 @@ class Logger
static void ClassInit(Channel::ChannelSocket* channel);

public:
static const uint64_t pid;
static const uint64_t Pid;
thread_local static Channel::ChannelSocket* channel;
static const size_t bufferSize {50000};
static const size_t BufferSize {50000};
thread_local static char buffer[];
};

/* Logging macros. */

// NOLINTBEGIN
#define _MS_LOG_SEPARATOR_CHAR_STD "\n"

#ifdef MS_LOG_FILE_LINE
Expand All @@ -165,14 +168,15 @@ class Logger
#define _MS_LOG_STR_DESC _MS_LOG_STR " | "
#define _MS_LOG_ARG MS_CLASS, __FUNCTION__
#endif
// NOLINTEND

#ifdef MS_LOG_TRACE
#define MS_TRACE() \
do \
{ \
if (Settings::configuration.logLevel == LogLevel::LOG_DEBUG) \
{ \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::bufferSize, "D(trace) " _MS_LOG_STR, _MS_LOG_ARG); \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::BufferSize, "D(trace) " _MS_LOG_STR, _MS_LOG_ARG); \
Logger::channel->SendLog(Logger::buffer, static_cast<uint32_t>(loggerWritten)); \
} \
} \
Expand Down Expand Up @@ -204,7 +208,7 @@ class Logger
{ \
if (Settings::configuration.logLevel == LogLevel::LOG_DEBUG && _MS_TAG_ENABLED(tag)) \
{ \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::bufferSize, "D" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::BufferSize, "D" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
Logger::channel->SendLog(Logger::buffer, static_cast<uint32_t>(loggerWritten)); \
} \
} \
Expand All @@ -226,7 +230,7 @@ class Logger
{ \
if (Settings::configuration.logLevel >= LogLevel::LOG_WARN && _MS_TAG_ENABLED(tag)) \
{ \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::bufferSize, "W" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::BufferSize, "W" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
Logger::channel->SendLog(Logger::buffer, static_cast<uint32_t>(loggerWritten)); \
} \
} \
Expand All @@ -248,7 +252,7 @@ class Logger
{ \
if (Settings::configuration.logLevel == LogLevel::LOG_DEBUG && _MS_TAG_ENABLED_2(tag1, tag2)) \
{ \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::bufferSize, "D" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::BufferSize, "D" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
Logger::channel->SendLog(Logger::buffer, static_cast<uint32_t>(loggerWritten)); \
} \
} \
Expand All @@ -270,7 +274,7 @@ class Logger
{ \
if (Settings::configuration.logLevel >= LogLevel::LOG_WARN && _MS_TAG_ENABLED_2(tag1, tag2)) \
{ \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::bufferSize, "W" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::BufferSize, "W" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
Logger::channel->SendLog(Logger::buffer, static_cast<uint32_t>(loggerWritten)); \
} \
} \
Expand All @@ -291,7 +295,7 @@ class Logger
#define MS_DEBUG_DEV(desc, ...) \
do \
{ \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::bufferSize, "D" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::BufferSize, "D" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
Logger::channel->SendLog(Logger::buffer, static_cast<uint32_t>(loggerWritten)); \
} \
while (false)
Expand All @@ -313,7 +317,7 @@ class Logger
#define MS_WARN_DEV(desc, ...) \
do \
{ \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::bufferSize, "W" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::BufferSize, "W" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
Logger::channel->SendLog(Logger::buffer, static_cast<uint32_t>(loggerWritten)); \
} \
while (false)
Expand All @@ -333,7 +337,7 @@ class Logger
#define MS_DUMP(desc, ...) \
do \
{ \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::bufferSize, "X" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::BufferSize, "X" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
Logger::channel->SendLog(Logger::buffer, static_cast<uint32_t>(loggerWritten)); \
} \
while (false)
Expand All @@ -349,7 +353,7 @@ class Logger
#define MS_DUMP_DATA(data, len) \
do \
{ \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::bufferSize, "X(data) " _MS_LOG_STR, _MS_LOG_ARG); \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::BufferSize, "X(data) " _MS_LOG_STR, _MS_LOG_ARG); \
Logger::channel->SendLog(Logger::buffer, static_cast<uint32_t>(loggerWritten)); \
size_t bufferDataLen{ 0 }; \
for (size_t i{0}; i < len; ++i) \
Expand All @@ -361,10 +365,10 @@ class Logger
Logger::channel->SendLog(Logger::buffer, static_cast<uint32_t>(bufferDataLen)); \
bufferDataLen = 0; \
} \
const int loggerWritten = std::snprintf(Logger::buffer + bufferDataLen, Logger::bufferSize, "X%06X ", static_cast<unsigned int>(i)); \
const int loggerWritten = std::snprintf(Logger::buffer + bufferDataLen, Logger::BufferSize, "X%06X ", static_cast<unsigned int>(i)); \
bufferDataLen += loggerWritten; \
} \
const int loggerWritten = std::snprintf(Logger::buffer + bufferDataLen, Logger::bufferSize, "%02X ", static_cast<unsigned char>(data[i])); \
const int loggerWritten = std::snprintf(Logger::buffer + bufferDataLen, Logger::BufferSize, "%02X ", static_cast<unsigned char>(data[i])); \
bufferDataLen += loggerWritten; \
} \
if (bufferDataLen != 0) \
Expand All @@ -389,10 +393,10 @@ class Logger
std::fprintf(stdout, "%s", Logger::buffer); \
bufferDataLen = 0; \
} \
const int loggerWritten = std::snprintf(Logger::buffer + bufferDataLen, Logger::bufferSize, "\n%06X ", static_cast<unsigned int>(i)); \
const int loggerWritten = std::snprintf(Logger::buffer + bufferDataLen, Logger::BufferSize, "\n%06X ", static_cast<unsigned int>(i)); \
bufferDataLen += loggerWritten; \
} \
const int loggerWritten = std::snprintf(Logger::buffer + bufferDataLen, Logger::bufferSize, "%02X ", static_cast<unsigned char>(data[i])); \
const int loggerWritten = std::snprintf(Logger::buffer + bufferDataLen, Logger::BufferSize, "%02X ", static_cast<unsigned char>(data[i])); \
bufferDataLen += loggerWritten; \
} \
if (bufferDataLen != 0) \
Expand All @@ -409,7 +413,7 @@ class Logger
{ \
if (Settings::configuration.logLevel >= LogLevel::LOG_ERROR || MS_LOG_DEV_LEVEL >= 1) \
{ \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::bufferSize, "E" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
const int loggerWritten = std::snprintf(Logger::buffer, Logger::BufferSize, "E" _MS_LOG_STR_DESC desc, _MS_LOG_ARG, ##__VA_ARGS__); \
Logger::channel->SendLog(Logger::buffer, static_cast<uint32_t>(loggerWritten)); \
} \
} \
Expand Down
10 changes: 5 additions & 5 deletions worker/include/MediaSoupErrors.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ class MediaSoupError : public std::runtime_error
}

public:
static const size_t bufferSize{ 2000 };
static const size_t BufferSize{ 2000 };
thread_local static char buffer[];
};

Expand All @@ -30,31 +30,31 @@ class MediaSoupTypeError : public MediaSoupError
do \
{ \
MS_ERROR("throwing MediaSoupError: " desc, ##__VA_ARGS__); \
std::snprintf(MediaSoupError::buffer, MediaSoupError::bufferSize, desc, ##__VA_ARGS__); \
std::snprintf(MediaSoupError::buffer, MediaSoupError::BufferSize, desc, ##__VA_ARGS__); \
throw MediaSoupError(MediaSoupError::buffer); \
} while (false)

#define MS_THROW_ERROR_STD(desc, ...) \
do \
{ \
MS_ERROR_STD("throwing MediaSoupError: " desc, ##__VA_ARGS__); \
std::snprintf(MediaSoupError::buffer, MediaSoupError::bufferSize, desc, ##__VA_ARGS__); \
std::snprintf(MediaSoupError::buffer, MediaSoupError::BufferSize, desc, ##__VA_ARGS__); \
throw MediaSoupError(MediaSoupError::buffer); \
} while (false)

#define MS_THROW_TYPE_ERROR(desc, ...) \
do \
{ \
MS_ERROR("throwing MediaSoupTypeError: " desc, ##__VA_ARGS__); \
std::snprintf(MediaSoupError::buffer, MediaSoupError::bufferSize, desc, ##__VA_ARGS__); \
std::snprintf(MediaSoupError::buffer, MediaSoupError::BufferSize, desc, ##__VA_ARGS__); \
throw MediaSoupTypeError(MediaSoupError::buffer); \
} while (false)

#define MS_THROW_TYPE_ERROR_STD(desc, ...) \
do \
{ \
MS_ERROR_STD("throwing MediaSoupTypeError: " desc, ##__VA_ARGS__); \
std::snprintf(MediaSoupError::buffer, MediaSoupError::bufferSize, desc, ##__VA_ARGS__); \
std::snprintf(MediaSoupError::buffer, MediaSoupError::BufferSize, desc, ##__VA_ARGS__); \
throw MediaSoupTypeError(MediaSoupError::buffer); \
} while (false)
// clang-format on
Expand Down
4 changes: 2 additions & 2 deletions worker/include/RTC/ActiveSpeakerObserver.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ namespace RTC
public:
Speaker();
void EvalActivityScores();
double GetActivityScore(uint8_t interval);
double GetActivityScore(uint8_t interval) const;
void LevelChanged(uint32_t level, uint64_t now);
void LevelTimedOut(uint64_t now);

Expand Down Expand Up @@ -95,7 +95,7 @@ namespace RTC
void OnTimer(TimerHandle* timer) override;

private:
double relativeSpeachActivities[RelativeSpeachActivitiesLen];
double relativeSpeachActivities[RelativeSpeachActivitiesLen]{};
std::string dominantId;
TimerHandle* periodicTimer{ nullptr };
uint16_t interval{ 300u };
Expand Down
4 changes: 2 additions & 2 deletions worker/include/RTC/Consumer.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,15 @@ namespace RTC
RTC::Consumer::Listener* listener,
const FBS::Transport::ConsumeRequest* data,
RTC::RtpParameters::Type type);
virtual ~Consumer();
~Consumer() override;

public:
flatbuffers::Offset<FBS::Consumer::BaseConsumerDump> FillBuffer(
flatbuffers::FlatBufferBuilder& builder) const;
virtual flatbuffers::Offset<FBS::Consumer::GetStatsResponse> FillBufferStats(
flatbuffers::FlatBufferBuilder& builder) = 0;
virtual flatbuffers::Offset<FBS::Consumer::ConsumerScore> FillBufferScore(
flatbuffers::FlatBufferBuilder& builder) const
flatbuffers::FlatBufferBuilder& /*builder*/) const
{
return 0;
};
Expand Down
4 changes: 2 additions & 2 deletions worker/include/RTC/DataConsumer.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ namespace RTC
RTC::DataConsumer::Listener* listener,
const FBS::Transport::ConsumeDataRequest* data,
size_t maxMessageSize);
virtual ~DataConsumer();
~DataConsumer() override;

public:
flatbuffers::Offset<FBS::DataConsumer::DumpResponse> FillBuffer(
Expand Down Expand Up @@ -104,7 +104,7 @@ namespace RTC
uint32_t ppid,
std::vector<uint16_t>& subchannels,
std::optional<uint16_t> requiredSubchannel,
onQueuedCallback* = nullptr);
onQueuedCallback* cb = nullptr);

/* Methods inherited from Channel::ChannelSocket::RequestHandler. */
public:
Expand Down
2 changes: 1 addition & 1 deletion worker/include/RTC/DataProducer.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ namespace RTC
size_t maxMessageSize,
RTC::DataProducer::Listener* listener,
const FBS::Transport::ProduceDataRequest* data);
virtual ~DataProducer();
~DataProducer() override;

public:
flatbuffers::Offset<FBS::DataProducer::DumpResponse> FillBuffer(
Expand Down
Loading
Loading