1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
// This code is based on Rust implementation at
// https://github.com/the8472/weyland-p5000
// Version 1.2
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <sys/ioctl.h>
#include <sys/socket.h>
#include <sys/stat.h>
#include <sys/wait.h>
#include <sys/un.h>
#include <spawn.h>
#include <poll.h>
#include <vector>
#include <cerrno>
#include <fcntl.h>
#include <unistd.h>
#include <memory>
#include <cassert>
#include <pthread.h>
#include <sched.h>
#include <fstream>
#include <ctime>
#include "wayland-proxy.h"
constexpr const char* stateFlags[] = {
"WP:E ",
"WP:D ",
"WP:RF ",
"WP:RT ",
"WP:CA ",
"WP:CR ",
"WP:AT ",
"WP:ACT ",
"WP:CPCA ",
"WP:CPCF ",
"WP:CPSF ",
};
CompositorCrashHandler WaylandProxy::sCompositorCrashHandler = nullptr;
std::atomic<unsigned> WaylandProxy::sProxyStateFlags = 0;
// The maximum number of fds libwayland can recvmsg at once
#define MAX_LIBWAY_FDS 28
#define MAX_DATA_SIZE 4096
#define POLL_TIMEOUT 30000
bool sPrintInfo = false;
void Print(const char* aFormat, ...) {
if (!sPrintInfo) {
return;
}
va_list args;
va_start(args, aFormat);
vfprintf(stderr, aFormat, args);
va_end(args);
}
void Warning(const char* aOperation) {
fprintf(stderr, "Warning: %s : %s\n", aOperation, strerror(errno));
}
void Error(const char* aOperation) {
fprintf(stderr, "Error: %s : %s\n", aOperation, strerror(errno));
}
void ErrorPlain(const char* aFormat, ...) {
va_list args;
va_start(args, aFormat);
vfprintf(stderr, aFormat, args);
va_end(args);
}
class WaylandMessage {
public:
bool Write(int aSocket);
bool Loaded() const { return !mFailed && (mFds.size() || mData.size()); }
bool Failed() const { return mFailed; }
explicit WaylandMessage(int aSocket) { Read(aSocket); }
~WaylandMessage();
private:
void Read(int aSocket);
private:
bool mFailed = false;
std::vector<int> mFds;
std::vector<unsigned char> mData;
};
class ProxiedConnection {
public:
bool Init(int aChildSocket, char* aWaylandDisplay);
bool IsConnected() { return mCompositorConnected; }
struct pollfd* AddToPollFd(struct pollfd* aPfds);
struct pollfd* LoadPollFd(struct pollfd* aPfds);
// Process this connection (send/receive data).
// Returns false if connection is broken and should be removed.
bool Process();
bool ProcessFailure();
void PrintConnectionInfo();
~ProxiedConnection();
private:
// Try to connect to compositor. Returns false in case of fatal error.
bool ConnectToCompositor();
bool TransferOrQueue(
int aSourceSocket, int aSourcePollFlags, int aDestSocket,
std::vector<std::unique_ptr<WaylandMessage>>* aMessageQueue,
int& aStatSent, int& aStatReceived);
bool FlushQueue(int aDestSocket, int aDestPollFlags,
std::vector<std::unique_ptr<WaylandMessage>>& aMessageQueue,
int& aStatSent);
// Where we should connect.
// Weak pointer to parent WaylandProxy class.
char* mWaylandDisplay = nullptr;
// We don't have connected compositor yet. Try to connect
bool mCompositorConnected = false;
// Don't cycle endlessly over compositor connection
int mFailedCompositorConnections = 0;
static constexpr int sMaxFailedCompositorConnections = 100;
// We're disconnected from app or compositor. We will close such connection.
bool mApplicationFailed = false;
bool mCompositorFailed = false;
int mCompositorSocket = -1;
int mCompositorFlags = 0;
int mApplicationSocket = -1;
int mApplicationFlags = 0;
// Stored proxied data
std::vector<std::unique_ptr<WaylandMessage>> mToCompositorQueue;
std::vector<std::unique_ptr<WaylandMessage>> mToApplicationQueue;
int mStatRecvFromCompositor = 0;
int mStatSentToCompositor = 0;
int mStatSentToCompositorLater = 0;
int mStatRecvFromClient = 0;
int mStatSentToClient = 0;
int mStatSentToClientLater = 0;
// Wait one sec before we disconnect client
// from compositor. It gives client time to
// process potential error messages from compositor.
constexpr static const double sFailureTimeout = CLOCKS_PER_SEC;
clock_t mFailureTime = 0;
};
WaylandMessage::~WaylandMessage() {
for (auto const fd : mFds) {
close(fd);
}
}
void WaylandMessage::Read(int aSocket) {
// We don't expect WaylandMessage re-read
assert(!Loaded() && !mFailed);
mData.resize(MAX_DATA_SIZE);
struct msghdr msg = {0};
struct iovec iov = {mData.data(), mData.size()};
msg.msg_iov = &iov;
msg.msg_iovlen = 1;
char cmsgdata[(CMSG_LEN(MAX_LIBWAY_FDS * sizeof(int32_t)))] = {0};
msg.msg_control = &cmsgdata;
msg.msg_controllen = sizeof(cmsgdata);
ssize_t ret = recvmsg(aSocket, &msg, MSG_CMSG_CLOEXEC | MSG_DONTWAIT);
if (msg.msg_flags & (MSG_CTRUNC | MSG_TRUNC)) {
Error("WaylandMessage::Read() data truncated, small buffer?");
mFailed = true;
return;
}
if (ret < 1) {
switch (errno) {
case EAGAIN:
case EINTR:
// Neither loaded nor failed, we'll try again later
Print("WaylandMessage::Read() failed %s\n", strerror(errno));
return;
default:
Error("WaylandMessage::Read() failed");
mFailed = true;
return;
}
}
// Set correct data size
mData.resize(ret);
// Read cmsg
struct cmsghdr* header = CMSG_FIRSTHDR(&msg);
while (header) {
struct cmsghdr* next = CMSG_NXTHDR(&msg, header);
if (header->cmsg_level != SOL_SOCKET || header->cmsg_type != SCM_RIGHTS) {
header = next;
continue;
}
int* data = (int*)CMSG_DATA(header);
int filenum = (int)((header->cmsg_len - CMSG_LEN(0)) / sizeof(int));
if (filenum > MAX_LIBWAY_FDS) {
ErrorPlain("WaylandMessage::Read(): too many files to read\n");
mFailed = true;
return;
}
for (int i = 0; i < filenum; i++) {
#ifdef DEBUG
int flags = fcntl(data[i], F_GETFL, 0);
if (flags == -1 && errno == EBADF) {
Error("WaylandMessage::Read() invalid fd");
}
#endif
mFds.push_back(data[i]);
}
header = next;
}
}
bool WaylandMessage::Write(int aSocket) {
if (!Loaded()) {
return false;
}
struct msghdr msg = {0};
struct iovec iov = {mData.data(), mData.size()};
msg.msg_iov = &iov;
msg.msg_iovlen = 1;
union {
char buf[CMSG_SPACE(sizeof(int) * MAX_LIBWAY_FDS)];
struct cmsghdr align;
} cmsgu;
memset(cmsgu.buf, 0, sizeof(cmsgu.buf));
int filenum = mFds.size();
if (filenum) {
if (filenum > MAX_LIBWAY_FDS) {
ErrorPlain("WaylandMessage::Write() too many files to send\n");
return false;
}
#ifdef DEBUG
for (int i = 0; i < filenum; i++) {
int flags = fcntl(mFds[i], F_GETFL, 0);
if (flags == -1 && errno == EBADF) {
Error("WaylandMessage::Write() invalid fd\n");
}
}
#endif
msg.msg_control = cmsgu.buf;
msg.msg_controllen = CMSG_SPACE(filenum * sizeof(int));
struct cmsghdr* cmsg = CMSG_FIRSTHDR(&msg);
cmsg->cmsg_level = SOL_SOCKET;
cmsg->cmsg_type = SCM_RIGHTS;
cmsg->cmsg_len = CMSG_LEN(filenum * sizeof(int));
memcpy(CMSG_DATA(cmsg), mFds.data(), filenum * sizeof(int));
}
ssize_t ret = sendmsg(aSocket, &msg, MSG_CMSG_CLOEXEC | MSG_DONTWAIT);
if (ret < 1) {
switch (errno) {
case EAGAIN:
case EINTR:
// Neither loaded nor failed, we'll try again later
Print("WaylandMessage::Write() failed %s\n", strerror(errno));
return false;
default:
Warning("WaylandMessage::Write() failed");
mFailed = true;
return false;
}
}
if (ret != (ssize_t)mData.size()) {
Print("WaylandMessage::Write() failed to write all data! (%d vs. %d)\n", ret,
mData.size());
}
return true;
}
ProxiedConnection::~ProxiedConnection() {
if (mCompositorSocket != -1) {
close(mCompositorSocket);
}
if (mApplicationSocket != -1) {
close(mApplicationSocket);
}
}
bool ProxiedConnection::Init(int aApplicationSocket, char* aWaylandDisplay) {
mWaylandDisplay = aWaylandDisplay;
mApplicationSocket = aApplicationSocket;
mCompositorSocket =
socket(AF_UNIX, SOCK_STREAM | SOCK_NONBLOCK | SOCK_CLOEXEC, 0);
if (mCompositorSocket == -1) {
Error("WaylandProxy: ProxiedConnection::Init() socket()");
}
bool ret = mApplicationSocket >= 0 && mCompositorSocket >= 0;
Print("WaylandProxy: ProxiedConnection::Init() %s\n", ret ? "OK" : "FAILED");
return ret;
}
struct pollfd* ProxiedConnection::AddToPollFd(struct pollfd* aPfds) {
// Listen application's requests
aPfds->fd = mApplicationSocket;
aPfds->events = POLLIN;
// We're connected and we have data for appplication from compositor.
// Add POLLOUT to request write to app socket.
if (mCompositorConnected && !mToApplicationQueue.empty()) {
aPfds->events |= POLLOUT;
}
aPfds++;
aPfds->fd = mCompositorSocket;
aPfds->events = 0;
// We're waiting for connection or we have data for compositor
if (!mCompositorConnected || !mToCompositorQueue.empty()) {
aPfds->events |= POLLOUT;
}
if (mCompositorConnected) {
aPfds->events |= POLLIN;
}
aPfds++;
return aPfds;
}
struct pollfd* ProxiedConnection::LoadPollFd(struct pollfd* aPfds) {
if (aPfds->fd != mApplicationSocket) {
return aPfds;
}
mApplicationFlags = aPfds->revents;
aPfds++;
mCompositorFlags = aPfds->revents;
aPfds++;
return aPfds;
}
bool ProxiedConnection::ConnectToCompositor() {
struct sockaddr_un addr = {};
addr.sun_family = AF_UNIX;
strcpy(addr.sun_path, mWaylandDisplay);
mCompositorConnected =
connect(mCompositorSocket, (const struct sockaddr*)&addr,
sizeof(struct sockaddr_un)) != -1;
if (!mCompositorConnected) {
switch (errno) {
case EAGAIN:
case EALREADY:
case ECONNREFUSED:
case EINPROGRESS:
case EINTR:
case EISCONN:
case ETIMEDOUT:
mFailedCompositorConnections++;
if (mFailedCompositorConnections > sMaxFailedCompositorConnections) {
Error("ConnectToCompositor() connect() failed repeatedly");
WaylandProxy::AddState(WAYLAND_PROXY_COMPOSITOR_SOCKET_FAILED);
return false;
}
// We can recover from these errors and try again
Warning("ConnectToCompositor() try again");
return true;
default:
Error("ConnectToCompositor() connect()");
WaylandProxy::AddState(WAYLAND_PROXY_COMPOSITOR_SOCKET_FAILED);
return false;
}
}
Print("ConnectToCompositor() Connected to compositor\n");
WaylandProxy::AddState(WAYLAND_PROXY_COMPOSITOR_ATTACHED);
return true;
}
// Read data from aSourceSocket and try to twite them to aDestSocket.
// If data write fails, append them to aMessageQueue.
// Return
bool ProxiedConnection::TransferOrQueue(
int aSourceSocket, int aSourcePollFlags, int aDestSocket,
std::vector<std::unique_ptr<WaylandMessage>>* aMessageQueue,
int& aStatSent, int& aStatReceived) {
// Don't read if we don't have any data ready
if (!(aSourcePollFlags & POLLIN)) {
return true;
}
while (true) {
int availableData = 0;
if (ioctl(aSourceSocket, FIONREAD, &availableData) < 0) {
// Broken connection, we're finished here
Warning("ProxiedConnection::TransferOrQueue() broken source socket\n");
return false;
}
if (availableData == 0) {
return true;
}
auto message = std::make_unique<WaylandMessage>(aSourceSocket);
if (message->Failed()) {
// Failed to read message due to error
return false;
}
if (!message->Loaded()) {
// Let's try again
return true;
}
aStatReceived++;
if (message->Write(aDestSocket)) {
aStatSent++;
continue;
}
if (message->Failed()) {
// Failed to write and we can't recover
return false;
}
aMessageQueue->push_back(std::move(message));
}
}
// Try to flush all data to aMessageQueue.
bool ProxiedConnection::FlushQueue(
int aDestSocket, int aDestPollFlags,
std::vector<std::unique_ptr<WaylandMessage>>& aMessageQueue,
int& aStatSent) {
// Can't write to destination yet
if (!(aDestPollFlags & POLLOUT) || aMessageQueue.empty()) {
return true;
}
std::vector<std::unique_ptr<WaylandMessage>>::iterator message;
for (message = aMessageQueue.begin(); message != aMessageQueue.end();) {
if (!(*message)->Write(aDestSocket)) {
// Failed to write the message, remove whole connection
// if it's broken.
if ((*message)->Failed()) {
return false;
}
break;
}
aStatSent++;
message++;
}
// Remove all written messages at once.
if (message != aMessageQueue.begin()) {
aMessageQueue.erase(aMessageQueue.begin(), message);
}
return true;
}
void ProxiedConnection::PrintConnectionInfo() {
constexpr char animation[] = {'-','\\','|','/'};
static unsigned int animationState = 0;
animationState = (animationState + 1) % sizeof(animation);
static bool isCharDevice = []() {
struct stat st;
if (fstat(STDERR_FILENO, &st)) {
return false;
}
return (S_ISCHR(st.st_mode));
}();
fprintf(stderr,"%s[%p][%c] compositor [%d] -> [%d] delay [%d] pending [%d] | application [%d] -> [%d] delayed [%d] pending [%d]%c",
isCharDevice ? "\r" : "",
this,
animation[animationState],
mStatRecvFromCompositor,
mStatSentToClient,
mStatSentToClientLater,
mStatRecvFromCompositor - mStatSentToClient - mStatSentToClientLater,
mStatRecvFromClient,
mStatSentToCompositor,
mStatSentToCompositorLater,
mStatRecvFromClient - mStatSentToCompositor - mStatSentToCompositorLater,
isCharDevice ? ' ' : '\n');
}
bool ProxiedConnection::Process() {
// If the connection already fails at ProxiedConnection::Process() somewhere,
// well finish processing all pending messages and flush queues to sockets.
// Then the connection becomes inactive (so we return early here) and we'll
// keep application socket opened for some time and then close
// the connection (disconnect application).
//
// It's because if we close application socket the app is instantly
// terminated by gtk event loop and there may be unprocessed messages
// pending in wayland client queues.
//
// That ensures we see actual wayland protocol error instead of
// 'application is terminated' error.
if (mApplicationFailed || mCompositorFailed) {
return false;
}
// If we hit any error (instead of compositor waiting to connect),
// we keep the code running and flush pending messages where it's possible.
// Check if appplication is still listening
if (mApplicationFlags & (POLLHUP | POLLERR)) {
Print("ProxiedConnection::Process(): Client socket is not listening\n");
WaylandProxy::AddState(WAYLAND_PROXY_APP_CONNECTION_FAILED);
mApplicationFailed = true;
}
// Check if compositor is still listening
if (mCompositorConnected) {
if (mCompositorFlags & (POLLHUP | POLLERR)) {
Print("ProxiedConnection::Process(): Compositor socket is not listening\n");
WaylandProxy::AddState(WAYLAND_PROXY_COMPOSITOR_CONNECTION_FAILED);
mCompositorFailed = true;
}
} else {
// Try to reconnect to compositor.
if (!ConnectToCompositor()) {
Error("ProxiedConnection::Process(): Failed to connect to compositor\n");
WaylandProxy::AddState(WAYLAND_PROXY_COMPOSITOR_CONNECTION_FAILED);
mCompositorFailed = true;
} else if (!mCompositorConnected) {
// We're not connected yet but ConnectToCompositor() didn't return
// fatal error. Try again later.
return true;
}
}
if (!TransferOrQueue(mCompositorSocket, mCompositorFlags, mApplicationSocket,
&mToApplicationQueue, mStatRecvFromCompositor,
mStatSentToClient)) {
Error("ProxiedConnection::Process(): Failed to read data from compositor!");
WaylandProxy::AddState(WAYLAND_PROXY_COMPOSITOR_CONNECTION_FAILED);
mCompositorFailed = true;
}
if (!TransferOrQueue(mApplicationSocket, mApplicationFlags, mCompositorSocket,
&mToCompositorQueue, mStatRecvFromClient,
mStatSentToCompositor)) {
Error("ProxiedConnection::Process(): Failed to read data from client!");
WaylandProxy::AddState(WAYLAND_PROXY_APP_CONNECTION_FAILED);
mApplicationFailed = true;
}
if (!FlushQueue(mCompositorSocket, mCompositorFlags, mToCompositorQueue,
mStatSentToCompositorLater)) {
Error("ProxiedConnection::Process(): Failed to flush queue to compositor!");
WaylandProxy::AddState(WAYLAND_PROXY_COMPOSITOR_CONNECTION_FAILED);
mCompositorFailed = true;
}
if (!FlushQueue(mApplicationSocket, mApplicationFlags, mToApplicationQueue,
mStatSentToClientLater)) {
Error("ProxiedConnection::Process(): Failed to flush queue to client!");
WaylandProxy::AddState(WAYLAND_PROXY_APP_CONNECTION_FAILED);
mApplicationFailed = true;
}
if (sPrintInfo) {
PrintConnectionInfo();
}
if (mCompositorFailed) {
mFailureTime = clock();
}
return !mApplicationFailed && !mCompositorFailed;
}
bool ProxiedConnection::ProcessFailure() {
if (!mCompositorFailed && !mApplicationFailed) {
return false;
}
if (mCompositorFailed) {
double time = (double)(clock() - mFailureTime);
if (time < sFailureTimeout) {
return false;
}
struct stat buffer;
if (stat(mWaylandDisplay, &buffer) < 0) {
Print("ProxiedConnection(): compositor crashed!\n");
WaylandProxy::CompositorCrashed();
} else {
Print("ProxiedConnection(): compositor fails to read/write events!\n");
}
} else if (mApplicationFailed) {
Print("ProxiedConnection(): application fails to read/write events!\n");
}
return true;
}
bool WaylandProxy::CheckWaylandDisplay(const char* aWaylandDisplay) {
struct sockaddr_un addr = {};
addr.sun_family = AF_UNIX;
strcpy(addr.sun_path, aWaylandDisplay);
int sc = socket(AF_UNIX, SOCK_STREAM | SOCK_NONBLOCK | SOCK_CLOEXEC, 0);
if (sc == -1) {
Error("CheckWaylandDisplay(): failed to create socket");
return false;
}
bool ret =
connect(sc, (const struct sockaddr*)&addr,
sizeof(struct sockaddr_un)) != -1;
if (!ret) {
switch (errno) {
case EAGAIN:
case EALREADY:
case ECONNREFUSED:
case EINPROGRESS:
case EINTR:
case EISCONN:
case ETIMEDOUT:
// We can recover from these errors and try again
Info("CheckWaylandDisplay(): Wayland display %s non-fatal error %s\n",
mWaylandDisplay, strerror(errno));
ret = true;
break;
default:
ErrorPlain(
"CheckWaylandDisplay(): Failed to connect to Wayland display '%s' error: %s\n",
mWaylandDisplay, strerror(errno));
break;
}
}
close(sc);
return ret;
}
bool WaylandProxy::SetupWaylandDisplays() {
char* waylandDisplay = getenv("WAYLAND_DISPLAY_COMPOSITOR");
if (!waylandDisplay) {
waylandDisplay = getenv("WAYLAND_DISPLAY");
if (!waylandDisplay || waylandDisplay[0] == '\0') {
ErrorPlain("WaylandProxy::SetupWaylandDisplays(), Missing Wayland display, WAYLAND_DISPLAY is empty.\n");
return false;
}
}
char* XDGRuntimeDir = getenv("XDG_RUNTIME_DIR");
if (!XDGRuntimeDir) {
ErrorPlain("WaylandProxy::SetupWaylandDisplays() Missing XDG_RUNTIME_DIR\n");
return false;
}
// WAYLAND_DISPLAY can be absolute path
if (waylandDisplay[0] == '/') {
if (strlen(mWaylandDisplay) >= sMaxDisplayNameLen) {
ErrorPlain("WaylandProxy::SetupWaylandDisplays() WAYLAND_DISPLAY is too large.\n");
return false;
}
strcpy(mWaylandDisplay, waylandDisplay);
} else {
int ret = snprintf(mWaylandDisplay, sMaxDisplayNameLen, "%s/%s",
XDGRuntimeDir, waylandDisplay);
if (ret < 0 || ret >= sMaxDisplayNameLen) {
ErrorPlain("WaylandProxy::SetupWaylandDisplays() WAYLAND_DISPLAY/XDG_RUNTIME_DIR is too large.\n");
return false;
}
}
if (!CheckWaylandDisplay(mWaylandDisplay)) {
return false;
}
int ret = snprintf(mWaylandProxy, sMaxDisplayNameLen,
"%s/wayland-proxy-%d", XDGRuntimeDir, getpid());
if (ret < 0 || ret >= sMaxDisplayNameLen) {
ErrorPlain("WaylandProxy::SetupWaylandDisplays() WAYLAND_DISPLAY/XDG_RUNTIME_DIR is too large.\n");
return false;
}
// Save original Wayland display variable for potential reuse
setenv("WAYLAND_DISPLAY_COMPOSITOR", waylandDisplay, /* overwrite = */ true);
Info("SetupWaylandDisplays() Wayland '%s' proxy '%s'\n",
mWaylandDisplay, mWaylandProxy);
return true;
}
bool WaylandProxy::StartProxyServer() {
mProxyServerSocket =
socket(AF_UNIX, SOCK_STREAM | SOCK_NONBLOCK | SOCK_CLOEXEC, 0);
if (mProxyServerSocket == -1) {
Error("StartProxyServer(): failed to create socket");
return false;
}
struct sockaddr_un serverName = {0};
serverName.sun_family = AF_UNIX;
strcpy(serverName.sun_path, mWaylandProxy);
if (bind(mProxyServerSocket, (struct sockaddr*)&serverName,
sizeof(serverName)) == -1) {
Error("StartProxyServer(): bind() error");
return false;
}
if (listen(mProxyServerSocket, 128) == -1) {
Error("StartProxyServer(): listen() error");
return false;
}
return true;
}
bool WaylandProxy::Init() {
Info("Init()\n");
if (!SetupWaylandDisplays()) {
return false;
}
if (!StartProxyServer()) {
return false;
}
Info("Init() finished\n");
return true;
}
void WaylandProxy::SetWaylandProxyDisplay() {
Info("SetWaylandProxyDisplay() WAYLAND_DISPLAY %s\n", mWaylandDisplay);
setenv("WAYLAND_DISPLAY", mWaylandProxy, /* overwrite = */ true);
}
void WaylandProxy::RestoreWaylandDisplay() {
unlink(mWaylandProxy);
char* waylandDisplay = getenv("WAYLAND_DISPLAY_COMPOSITOR");
if (waylandDisplay) {
Info("RestoreWaylandDisplay() WAYLAND_DISPLAY restored to %s\n",
waylandDisplay);
setenv("WAYLAND_DISPLAY", waylandDisplay, /* overwrite = */ true);
unsetenv("WAYLAND_DISPLAY_COMPOSITOR");
}
}
bool WaylandProxy::IsChildAppTerminated() {
if (!mApplicationPID) {
return false;
}
int status = 0;
int ret = waitpid(mApplicationPID, &status, WNOHANG | WUNTRACED | WCONTINUED);
if (ret == 0) {
return false;
}
if (ret == mApplicationPID) {
// Child application is terminated, so quit too.
WaylandProxy::AddState(WAYLAND_PROXY_APP_TERMINATED);
return true;
}
bool terminate = (errno == ECHILD);
Error("IsChildAppTerminated: waitpid() error");
return terminate;
}
bool WaylandProxy::PollConnections() {
int nfds_max = mConnections.size() * 2 + 1;
struct pollfd pollfds[nfds_max];
struct pollfd* addedPollfd = pollfds;
for (auto const& connection : mConnections) {
addedPollfd = connection->AddToPollFd(addedPollfd);
}
int nfds = (addedPollfd - pollfds);
// If all connections are attached to compositor, add another one
// for new potential connection from application.
bool addNewConnection = mConnections.empty() ||
mConnections.back()->IsConnected();
if (addNewConnection) {
addedPollfd->fd = mProxyServerSocket;
addedPollfd->events = POLLIN;
nfds++;
}
assert(addedPollfd < pollfds + nfds_max);
while (1) {
int ret = poll(pollfds, nfds, POLL_TIMEOUT);
if (ret == 0) {
// No change on fds
continue;
} else if (ret > 0) {
// We have FD to read
break;
} else if (ret == -1) {
switch (errno) {
case EINTR:
case EAGAIN:
if (IsChildAppTerminated()) {
Info("PollConnections(): ChildAppTerminated\n");
return false;
}
continue;
default:
Error("PollConnections(): poll() error");
return false;
}
}
}
struct pollfd* loadedPollfd = pollfds;
for (auto const& connection : mConnections) {
loadedPollfd = connection->LoadPollFd(loadedPollfd);
}
assert(loadedPollfd == addedPollfd);
assert(loadedPollfd < pollfds + nfds_max);
// Create a new connection if there's a new client waiting
if (addNewConnection && (loadedPollfd->revents & POLLIN)) {
Info("new child connection\n");
int applicationSocket = accept4(loadedPollfd->fd, nullptr, nullptr,
SOCK_NONBLOCK | SOCK_CLOEXEC);
if (applicationSocket == -1) {
switch (errno) {
case EAGAIN:
case EINTR:
// Try again later
break;
default:
Error("Faild to accept connection from application");
return false;
}
} else {
auto connection = std::make_unique<ProxiedConnection>();
if (connection->Init(applicationSocket, mWaylandDisplay)) {
WaylandProxy::AddState(WAYLAND_PROXY_CONNECTION_ADDED);
mConnections.push_back(std::move(connection));
}
}
}
return true;
}
bool WaylandProxy::ProcessConnections() {
std::vector<std::unique_ptr<ProxiedConnection>>::iterator connection;
for (connection = mConnections.begin(); connection != mConnections.end();) {
if (!(*connection)->Process()) {
WaylandProxy::AddState(WAYLAND_PROXY_CONNECTION_REMOVED);
if ((*connection)->ProcessFailure()) {
connection = mConnections.erase(connection);
if (mConnections.empty()) {
// We removed last connection - quit.
Info("removed last connection, quit\n");
return false;
}
}
} else {
connection++;
}
}
return true;
}
void WaylandProxy::Run() {
while (1) {
if (IsChildAppTerminated()) {
Info("quit - ChildAppTerminated\n");
break;
}
if (!PollConnections()) {
Info("quit - no connection\n");
break;
}
if (!ProcessConnections()) {
Info("quit - failed to process connections\n");
break;
}
}
WaylandProxy::AddState(WAYLAND_PROXY_TERMINATED);
}
WaylandProxy::~WaylandProxy() {
Info("terminated\n");
if (mThreadRunning) {
Info("thread is still running, terminating.\n");
mThreadRunning = false;
pthread_cancel(mThread);
pthread_join(mThread, nullptr);
}
if (mProxyServerSocket != -1) {
close(mProxyServerSocket);
}
RestoreWaylandDisplay();
}
void* WaylandProxy::RunProxyThread(WaylandProxy* aProxy) {
#if defined(__linux__) || defined(__FreeBSD__)
pthread_setname_np(pthread_self(), "WaylandProxy");
#endif
aProxy->Run();
Print("[%d] WaylandProxy [%p]: thread exited.\n", getpid(), aProxy);
return nullptr;
}
std::unique_ptr<WaylandProxy> WaylandProxy::Create() {
auto proxy = std::make_unique<WaylandProxy>();
Print("[%d] WaylandProxy [%p]: Created().\n", getpid(), proxy.get());
if (!proxy->Init()) {
Print("[%d] WaylandProxy [%p]: Init failed, exiting.\n", getpid(), proxy.get());
return nullptr;
}
return proxy;
}
bool WaylandProxy::RunChildApplication(char* argv[]) {
if (!argv[0]) {
ErrorPlain("WaylandProxy::RunChildApplication: missing application to run\n");
return false;
}
mApplicationPID = fork();
if (mApplicationPID == -1) {
Error("WaylandProxy::RunChildApplication: fork() error");
return false;
}
if (mApplicationPID == 0) {
SetWaylandProxyDisplay();
if (execv(argv[0], argv) == -1) {
ErrorPlain(
"WaylandProxy::RunChildApplication: failed to run %s error %s\n",
argv[0], strerror(errno));
exit(1);
}
}
Run();
return true;
}
bool WaylandProxy::RunThread() {
pthread_attr_t attr;
if (pthread_attr_init(&attr) != 0) {
ErrorPlain("WaylandProxy::RunThread(): pthread_attr_init() failed\n");
return false;
}
sched_param param;
if (pthread_attr_getschedparam(&attr, ¶m) == 0) {
param.sched_priority = sched_get_priority_min(SCHED_FIFO);
pthread_attr_setschedparam(&attr, ¶m);
}
SetWaylandProxyDisplay();
mThreadRunning = pthread_create(&mThread, nullptr, (void* (*)(void*))RunProxyThread, this) == 0;
if (!mThreadRunning) {
ErrorPlain("WaylandProxy::RunThread(): pthread_create() failed\n");
// If we failed to run proxy thread, set WAYLAND_DISPLAY back.
RestoreWaylandDisplay();
WaylandProxy::AddState(WAYLAND_PROXY_RUN_FAILED);
}
pthread_attr_destroy(&attr);
return mThreadRunning;
}
void WaylandProxy::SetVerbose(bool aVerbose) { sPrintInfo = aVerbose; }
void WaylandProxy::Info(const char* aFormat, ...) {
if (!sPrintInfo) {
return;
}
fprintf(stderr,"[%d] WaylandProxy [%p]: ", getpid(), this);
va_list args;
va_start(args, aFormat);
vfprintf(stderr, aFormat, args);
va_end(args);
}
void WaylandProxy::Warning(const char* aOperation) {
fprintf(stderr, "[%d] Wayland Proxy [%p] Warning: %s : %s\n",
getpid(), this, aOperation, strerror(errno));
}
void WaylandProxy::Error(const char* aOperation) {
fprintf(stderr, "[%d] Wayland Proxy [%p] Error: %s : %s\n",
getpid(), this, aOperation, strerror(errno));
}
void WaylandProxy::ErrorPlain(const char* aFormat, ...) {
fprintf(stderr, "[%d] Wayland Proxy [%p] Error: ", getpid(), this);
va_list args;
va_start(args, aFormat);
vfprintf(stderr, aFormat, args);
va_end(args);
}
void WaylandProxy::SetCompositorCrashHandler(CompositorCrashHandler aCrashHandler) {
sCompositorCrashHandler = aCrashHandler;
}
void WaylandProxy::CompositorCrashed() {
if (sCompositorCrashHandler) {
sCompositorCrashHandler();
}
}
void WaylandProxy::AddState(unsigned aState) {
sProxyStateFlags.fetch_or(aState, std::memory_order_relaxed);
}
const char* WaylandProxy::GetState() {
std::string stateString;
unsigned state = sProxyStateFlags.load(std::memory_order_relaxed);
for (unsigned i = 0, flag = 1; i < sizeof(stateFlags); i++, flag <<= 1) {
if (state & flag) {
stateString.append(stateFlags[i]);
}
}
return strdup(stateString.c_str());
}
|