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.

Sign up for GitHub

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

Added Bunnysplit MQ for Linux #360

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Added Bunnysplit MQ for Linux #360

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2e31d6f
Added Bunnysplit MQ for Linux
chinese-soup Oct 18, 2022
0c7e710
Extract milisecond variable
chinese-soup Oct 29, 2022
3a16684
Extract milisecond variable in Windows
chinese-soup Nov 2, 2022
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
100 changes: 97 additions & 3 deletions BunnymodXT/Linux/interprocess.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
namespace Interprocess
{
mqd_t mq = static_cast<mqd_t>(-1);
mqd_t mq_bunnysplit = static_cast<mqd_t>(-1);

void Initialize()
{
Expand Down Expand Up @@ -62,13 +63,24 @@ namespace Interprocess

void WriteTime(const Time& time)
{
if (!CVars::bxt_interprocess_enable.GetBool())
return;

std::vector<char> buf(10);
buf[0] = static_cast<char>(buf.size());
buf[1] = static_cast<char>(MessageType::TIME);
AddTimeToBuffer(buf.data() + 2, time);

if (CVars::_bxt_bunnysplit_time_update_frequency.GetFloat() > 0.0f) {
static auto last_time = std::chrono::steady_clock::now() - std::chrono::milliseconds(static_cast<long long>(1000 / CVars::_bxt_bunnysplit_time_update_frequency.GetFloat()) + 1);
auto now = std::chrono::steady_clock::now();
if (now >= last_time + std::chrono::milliseconds(static_cast<long long>(1000 / CVars::_bxt_bunnysplit_time_update_frequency.GetFloat()))) {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you extract variable on the std::chrono::milliseconds(static_cast<long long>(1000 / CVars::_bxt_bunnysplit_time_update_frequency.GetFloat()))?

Copy link
Contributor Author

@chinese-soup chinese-soup Oct 29, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens if there's no client to read from the message queue? The tasview one will block once it exhausts the buffer, but what happens with the bunnysplit one? Does it start erroring and recreating the message queue every few seconds? If so, doesn't that cause lag? Most of the time there's no bunnysplit on linux so that's why I'm wondering, that situation shouldn't regress.

Uhh, isn't this already answered in the OP? And no, it doesn't restart the message queue every few seconds.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you extract variable on the std::chrono::milliseconds(static_cast<long long>(1000 / CVars::_bxt_bunnysplit_time_update_frequency.GetFloat()))?

Done. Couldn't extract the whole std::chrono::milisecond call without doubling code, because then I wouldn't be able to add + 1 to it in static auto last_time = //...

Should I backport it to the Windows version too?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uhh, isn't this already answered in the OP? And no, it doesn't restart the message queue every few seconds.

Well I still don't understand what happens when there's no reader then? Do the messages get dropped or what happens?

Couldn't extract the whole std::chrono::milisecond call without doubling code, because then I wouldn't be able to add + 1 to it in static auto last_time = //...

Now that you extracted it I can actually see there's a + 1 there that I missed before, heh.

Should I backport it to the Windows version too?

Sure.

Copy link
Contributor Author

@chinese-soup chinese-soup Nov 2, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that you extracted it I can actually see there's a + 1 there that I missed before, heh.

Same tbh, so optimized for humans now 👍

Well I still don't understand what happens when there's no reader then? Do the messages get dropped or what happens?

Ah right, my bad, no idea how I didn't notice it before, lol, so yeah, you are correct in the fact that currently it keeps on retrying to do mq_send and closes and opens the message queue, every time that WriteBunnySplit is called (which most of the time is when _bxt_bunnysplit_time_update_frequency is hit in WriteTime)

How would do you want me to solve this? Should it just fail (close the queue) and not reopen it automatically and only reopen it when _bxt_interprocess_reset is manually entered in the game console?

Sure.

Alright, will do.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How would do you want me to solve this? Should it just fail (close the queue) and not reopen it automatically and only reopen it when _bxt_interprocess_reset is manually entered in the game console?

Yeah idk this stuff is complicated, let's go with the "only reopen it when _bxt_interprocess_reset" solution for now

WriteBunnySplit(buf);
last_time = now;
}
} else {
WriteBunnySplit(buf);
}

if (!CVars::bxt_interprocess_enable.GetBool())
return;

Write(buf);
}
Expand Down Expand Up @@ -110,21 +122,103 @@ namespace Interprocess

void WriteGameEnd(const Time& time)
{
std::vector<char> buf(11);
buf[0] = static_cast<char>(buf.size());
buf[1] = static_cast<char>(MessageType::EVENT);
buf[2] = static_cast<char>(EventType::GAMEEND);
AddTimeToBuffer(buf.data() + 3, time);

WriteBunnySplit(buf);
}

void WriteMapChange(const Time& time, const std::string& map)
{
int32_t size = static_cast<int32_t>(map.size());

std::vector<char> buf(15 + size);
buf[0] = static_cast<char>(buf.size());
buf[1] = static_cast<char>(MessageType::EVENT);
buf[2] = static_cast<char>(EventType::MAPCHANGE);
auto time_size = AddTimeToBuffer(buf.data() + 3, time);

std::memcpy(buf.data() + 3 + time_size, &size, sizeof(size));
std::memcpy(buf.data() + 3 + time_size + 4, map.data(), size);

WriteBunnySplit(buf);
}

void WriteTimerReset(const Time& time)
{
std::vector<char> buf(11);
buf[0] = static_cast<char>(buf.size());
buf[1] = static_cast<char>(MessageType::EVENT);
buf[2] = static_cast<char>(EventType::TIMER_RESET);
AddTimeToBuffer(buf.data() + 3, time);

WriteBunnySplit(buf);
}

void WriteTimerStart(const Time& time)
{
std::vector<char> buf(11);
buf[0] = static_cast<char>(buf.size());
buf[1] = static_cast<char>(MessageType::EVENT);
buf[2] = static_cast<char>(EventType::TIMER_START);
AddTimeToBuffer(buf.data() + 3, time);

WriteBunnySplit(buf);
}

void WriteBSALeapOfFaith(const Time& time)
{
std::vector<char> buf(11);
buf[0] = static_cast<char>(buf.size());
buf[1] = static_cast<char>(MessageType::EVENT);
buf[2] = static_cast<char>(EventType::BS_ALEAPOFFAITH);
AddTimeToBuffer(buf.data() + 3, time);

WriteBunnySplit(buf);
}

void InitBunnySplitPipe()
{
mq_bunnysplit = mq_open(
"/" BUNNYSPLIT_MQ_NAME,
O_WRONLY | O_CREAT | O_NONBLOCK,
S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH,
nullptr);

if (mq_bunnysplit == static_cast<mqd_t>(-1)) {
EngineDevWarning("Error opening the BunnySplit message queue: %s\n", strerror(errno));
EngineWarning("BunnySplit integration is not available.\n");
return;
}

EngineDevMsg("Opened the BunnySplit message queue.\n");
}

void ShutdownBunnySplitPipe()
{
if (mq_bunnysplit != static_cast<mqd_t>(-1)) {
mq_close(mq_bunnysplit);
mq_unlink("/" BUNNYSPLIT_MQ_NAME);
EngineDevMsg("Closed the BunnySplit message queue.\n");
}

mq_bunnysplit = static_cast<mqd_t>(-1);
}

void WriteBunnySplit(const std::vector<char>& data)
{
if (mq_bunnysplit == static_cast<mqd_t>(-1))
return;

if (mq_send(mq_bunnysplit, data.data(), data.size(), 0) == -1) {
// This shouldn't really happen.
// Perhaps the message queue was force-deleted or something.
EngineDevWarning("[mq_bunnysplit] mq_send failed with %d (%s).\n", errno, strerror(errno));
ShutdownBunnySplitPipe();
InitBunnySplitPipe();
}
}
}
2 changes: 2 additions & 0 deletions BunnymodXT/Linux/main_linux.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ static __attribute__((constructor(1337))) void Construct()
_EngineDevWarning = PrintDevWarning;

Interprocess::Initialize();
Interprocess::InitBunnySplitPipe();

Hooks::AddToHookedModules(&HwDLL::GetInstance());
Hooks::AddToHookedModules(&ClientDLL::GetInstance());
Expand All @@ -111,4 +112,5 @@ static __attribute__((destructor(1337))) void Destruct()
fclose(logfile);

Interprocess::Shutdown();
Interprocess::ShutdownBunnySplitPipe();
}
6 changes: 6 additions & 0 deletions BunnymodXT/interprocess.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,10 @@ namespace Interprocess
void WriteTimerReset(const Time& time);
void WriteTimerStart(const Time& time);
void WriteBSALeapOfFaith(const Time& time);

#ifndef _WIN32
void InitBunnySplitPipe();
void ShutdownBunnySplitPipe();
void WriteBunnySplit(const std::vector<char>& data);
#endif
}
1 change: 1 addition & 0 deletions BunnymodXT/shared.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ enum class EventType : unsigned char {

#define MQ_NAME "BunnymodXT-TASView"
#define BUNNYSPLIT_PIPE_NAME "BunnymodXT-BunnySplit"
#define BUNNYSPLIT_MQ_NAME "BunnymodXT-BunnySplit"