Mirrored_Repos/LookingGlass
1
0
Fork 0
mirror of https://github.com/gnif/LookingGlass.git synced 2026-11-13 15:27:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[common/client] ivshmem: add portable external frames

Browse Source
This commit is contained in:
Geoffrey McRae
2026-09-12 09:49:24 +10:00
parent 6d367d4ab2
commit 382f35e503
28 changed files with 946 additions and 227 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
client/transports/LGMP/CMakeLists.txt
View File

@@ -7,6 +7,14 @@ set(TRANSPORT_LGMP_SOURCES
lgmp.c
)
if(WIN32)
list(APPEND TRANSPORT_LGMP_SOURCES platform/windows.c)
elseif(UNIX)
list(APPEND TRANSPORT_LGMP_SOURCES platform/linux.c)
else()
message(FATAL_ERROR "Unsupported LGMP transport platform")
endif()
if(ENABLE_AUDIO)
list(APPEND TRANSPORT_LGMP_SOURCES audio.c)
endif()

128
client/transports/LGMP/lgmp.c
View File

@@ -22,6 +22,7 @@
#include "clipboard.h"
#include "input.h"
#include "platform.h"
#ifdef ENABLE_AUDIO
#include "audio.h"
#endif
@@ -39,11 +40,8 @@
#include <lgmp/client.h>
#include <dirent.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.h>
#define LGMP_TIMING_SPIN_COUNT 4096
#define LGMP_RECOVERY_PROBE_INTERVAL_US 10000U
@@ -64,7 +62,7 @@ struct DMAFrameInfo
const KVMFRFrame * frame;
size_t offset;
size_t dataSize;
int fd;
LG_ExternalFrame * externalFrame;
};
#define LGMP_FRAME_LEASE_COUNT (LGMP_Q_FRAME_LEN + 1)
@@ -420,65 +418,10 @@ static LG_VideoStatus lgmp_publishVideoStatus(LG_Transport * this,
return published;
}
static bool lgmp_deviceValidator(struct Option * opt, const char ** error)
{
const char * transport = option_get_string("app", "transport");
if (!transport || strcmp(transport, "lgmp") != 0)
return true;
if (strlen(opt->value.x_string) > 3 &&
memcmp(opt->value.x_string, "kvmfr", 5) != 0)
{
struct stat st;
if (stat(opt->value.x_string, &st) != 0)
{
*error = "Invalid path to the shared memory file";
return false;
}
}
return true;
}
static StringList lgmp_deviceValues(struct Option * option)
{
StringList values = stringlist_new(true);
DIR * dir = opendir("/sys/class/kvmfr");
if (!dir)
return values;
struct dirent * entry;
while ((entry = readdir(dir)))
{
if (entry->d_name[0] == '.')
continue;
char * name;
alloc_sprintf(&name, "/dev/%s", entry->d_name);
stringlist_push(values, name);
}
closedir(dir);
return values;
}
static void lgmp_setup(void)
{
struct stat st;
const char * defaultDevice = stat("/dev/kvmfr0", &st) == 0 ?
"/dev/kvmfr0" : "/dev/shm/looking-glass";
static struct Option options[] =
{
{
.module = "lgmp",
.name = "shmDevice",
.old_module = "app",
.old_name = "shmFile",
.shortopt = 'f',
.description = "Shared memory file or KVMFR device path",
.type = OPTION_TYPE_STRING,
.value.x_string = NULL,
.validator = lgmp_deviceValidator,
.getValues = lgmp_deviceValues,
},
{
.module = "lgmp",
.name = "allowDMA",
@@ -509,7 +452,7 @@ static void lgmp_setup(void)
{0}
};
options[0].value.x_string = (char *)defaultDevice;
lgmpPlatformOptionsInit();
option_register(options);
}
@@ -601,7 +544,7 @@ static bool lgmp_refreshRecoveryLockedCancellable(
if (!wait || now >= deadline)
break;
usleep(LGMP_RECOVERY_PROBE_INTERVAL_US);
nsleep((uint64_t)LGMP_RECOVERY_PROBE_INTERVAL_US * 1000U);
}
while (true);
@@ -697,9 +640,6 @@ static bool lgmp_create(LG_Transport ** result)
return false;
}
for (unsigned i = 0; i < LGMP_Q_FRAME_BUFFER_LEN; ++i)
this->dma[i].fd = -1;
LG_LOCK_INIT(this->frameLock);
LG_LOCK_INIT(this->pointerLock);
LG_RWLOCK_INIT(this->videoStatusLock);
@@ -711,8 +651,7 @@ static bool lgmp_create(LG_Transport ** result)
for (unsigned i = 0; i < LGMP_Q_FRAME_LEN; ++i)
this->frameLease[i + 1].subscription = &this->ownerFrameQueue[i];
if (!ivshmemOpenDev(&this->shm,
option_get_string("lgmp", "shmDevice")))
if (!lgmpPlatformOpenIVSHMEM(&this->shm))
{
LG_LOCK_FREE(this->frameLock);
LG_LOCK_FREE(this->pointerLock);
@@ -753,6 +692,7 @@ static bool lgmp_create(LG_Transport ** result)
DEBUG_ERROR("lgmpClientInit failed: %s", lgmpStatusString(status));
ivshmemClose(&this->shm);
ivshmemFree(&this->shm);
LG_LOCK_FREE(this->frameLock);
LG_LOCK_FREE(this->pointerLock);
LG_RWLOCK_FREE(this->videoStatusLock);
@@ -883,12 +823,11 @@ static void lgmp_closeDMA(struct LG_Transport * this)
{
for (unsigned i = 0; i < LGMP_Q_FRAME_BUFFER_LEN; ++i)
{
if (this->dma[i].fd >= 0)
close(this->dma[i].fd);
this->dma[i].fd = -1;
this->dma[i].frame = NULL;
this->dma[i].offset = 0;
this->dma[i].dataSize = 0;
lgExternalFrameRelease(this->dma[i].externalFrame);
this->dma[i].externalFrame = NULL;
this->dma[i].frame = NULL;
this->dma[i].offset = 0;
this->dma[i].dataSize = 0;
}
}
@@ -908,6 +847,7 @@ static void lgmp_destroyNow(LG_Transport * this)
lgmp_closeDMA(this);
free(this->pointerData);
ivshmemClose(&this->shm);
ivshmemFree(&this->shm);
LG_LOCK_FREE(this->frameLock);
LG_LOCK_FREE(this->pointerLock);
LG_RWLOCK_FREE(this->videoStatusLock);
@@ -1570,7 +1510,8 @@ static LG_TransportStatus lgmp_requestRecovery(LG_Transport * this,
static bool lgmp_supportsDMA(LG_Transport * this)
{
return this->client && this->allowDMA && ivshmemHasDMA(&this->shm);
return this->client && this->allowDMA &&
lgmpPlatformSupportsExternalFrame(&this->shm);
}
static bool lgmp_attachRenderer(LG_Transport * this,
@@ -1909,33 +1850,34 @@ static void lgmp_selectNewestFrameMessage(
*selected = candidate;
}
static int lgmp_getDMA(struct LG_Transport * this,
static LG_ExternalFrame * lgmp_getDMA(struct LG_Transport * this,
const KVMFRFrame * sharedFrame, size_t frameOffset, size_t dataSize)
{
const uintptr_t base = (uintptr_t)this->shm.mem;
const uintptr_t address = (uintptr_t)sharedFrame;
if (address < base)
return -1;
return NULL;
const size_t position = address - base;
if (position > this->lgmpSize ||
frameOffset > this->lgmpSize - position ||
sizeof(KVMFRFrameBuffer) > this->lgmpSize - position - frameOffset)
return -1;
return NULL;
const size_t offset = position + frameOffset + sizeof(KVMFRFrameBuffer);
if (dataSize > this->lgmpSize - offset)
return -1;
return NULL;
struct DMAFrameInfo * dma = NULL;
for (unsigned i = 0; i < LGMP_Q_FRAME_BUFFER_LEN; ++i)
if (this->dma[i].frame == sharedFrame)
{
dma = &this->dma[i];
if ((dma->offset != offset || dma->dataSize < dataSize) && dma->fd >= 0)
if ((dma->offset != offset || dma->dataSize < dataSize) &&
dma->externalFrame)
{
close(dma->fd);
dma->fd = -1;
lgExternalFrameRelease(dma->externalFrame);
dma->externalFrame = NULL;
}
break;
}
@@ -1950,14 +1892,15 @@ static int lgmp_getDMA(struct LG_Transport * this,
}
if (!dma)
return -1;
if (dma->fd >= 0)
return dma->fd;
return NULL;
if (dma->externalFrame)
return dma->externalFrame;
dma->offset = offset;
dma->dataSize = dataSize;
dma->fd = ivshmemGetDMABuf(&this->shm, offset, dataSize);
return dma->fd;
dma->offset = offset;
dma->dataSize = dataSize;
dma->externalFrame = lgmpPlatformCreateExternalFrame(
&this->shm, offset, dataSize);
return dma->externalFrame;
}
static void lgmp_releaseFrameLease(void * opaque, uint64_t handle);
@@ -2128,18 +2071,18 @@ static LG_TransportStatus lgmp_nextFrameLocked(LG_Transport * this,
result->framebuffer = (const KVMFRFrameBuffer *)
((const uint8_t *)selected->sharedFrame + frame->offset);
result->dmaFD = -1;
if (useDMA)
{
result->dmaFD = lgmp_getDMA(this, selected->sharedFrame,
LG_ExternalFrame * externalFrame = lgmp_getDMA(this, selected->sharedFrame,
frame->offset, selected->dataSize);
if (result->dmaFD < 0)
if (!externalFrame)
{
const LG_TransportStatus done = lgmp_doneFrameMessage(selected);
DEBUG_ERROR("Failed to obtain a DMA buffer for the frame");
DEBUG_ERROR("Failed to obtain an external frame handle");
return done == LG_TRANSPORT_DISCONNECTED ?
done : LG_TRANSPORT_ERROR;
}
result->externalFrame = lgExternalFrameRetain(externalFrame);
}
if (!fullDamage && frame->damageRectsCount <= KVMFR_MAX_DAMAGE_RECTS)
@@ -2308,6 +2251,9 @@ static void lgmp_releaseFrameLease(void * opaque, uint64_t handle)
static void lgmp_releaseFrame(LG_Transport * this, LG_TransportFrame * frame)
{
lgExternalFrameRelease(frame->externalFrame);
frame->externalFrame = NULL;
if (frame->releaseFn)
{
LG_LOCK(this->frameLock);

36
client/transports/LGMP/platform.h Normal file
View File

@@ -0,0 +1,36 @@
/**
* Looking Glass
* Copyright © 2017-2026 The Looking Glass Authors
* https://looking-glass.io
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc., 59
* Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef _H_LG_CLIENT_TRANSPORT_LGMP_PLATFORM_
#define _H_LG_CLIENT_TRANSPORT_LGMP_PLATFORM_
#include "common/ivshmem.h"
#include "interface/external_frame.h"
#include <stdbool.h>
#include <stddef.h>
void lgmpPlatformOptionsInit(void);
bool lgmpPlatformOpenIVSHMEM(struct IVSHMEM * shm);
bool lgmpPlatformSupportsExternalFrame(struct IVSHMEM * shm);
LG_ExternalFrame * lgmpPlatformCreateExternalFrame(struct IVSHMEM * shm,
size_t offset, size_t size);
#endif

189
client/transports/LGMP/platform/linux.c Normal file
View File

@@ -0,0 +1,189 @@
/**
* Looking Glass
* Copyright © 2017-2026 The Looking Glass Authors
* https://looking-glass.io
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc., 59
* Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#include "../platform.h"
#include "common/debug.h"
#include "common/ivshmem_dmabuf.h"
#include "common/option.h"
#include "common/stringutils.h"
#include <dirent.h>
#include <limits.h>
#include <stdatomic.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.h>
typedef struct LGMPExternalFrame
{
LG_ExternalFrame base;
atomic_uint refs;
int fd;
}
LGMPExternalFrame;
static void lgmpExternalFrameRetain(LG_ExternalFrame * frame)
{
LGMPExternalFrame * this = (LGMPExternalFrame *)frame;
const unsigned int refs = atomic_fetch_add_explicit(
&this->refs, 1, memory_order_relaxed);
DEBUG_ASSERT(refs > 0 && refs < UINT_MAX);
}
static void lgmpExternalFrameRelease(LG_ExternalFrame * frame)
{
LGMPExternalFrame * this = (LGMPExternalFrame *)frame;
const unsigned int refs = atomic_fetch_sub_explicit(
&this->refs, 1, memory_order_acq_rel);
DEBUG_ASSERT(refs > 0);
if (refs != 1)
return;
close(this->fd);
free(this);
}
static bool lgmpExternalFrameQuery(const LG_ExternalFrame * frame,
void * result, size_t resultSize)
{
if (!result || resultSize != sizeof(int))
return false;
const LGMPExternalFrame * this = (const LGMPExternalFrame *)frame;
*(int *)result = this->fd;
return true;
}
static const LG_ExternalFrameOps lgmpExternalFrameOps =
{
.type = LG_EXTERNAL_FRAME_DMABUF,
.retain = lgmpExternalFrameRetain,
.release = lgmpExternalFrameRelease,
.query = lgmpExternalFrameQuery,
};
static bool lgmpDeviceValidator(struct Option * opt, const char ** error)
{
const char * transport = option_get_string("app", "transport");
if (!transport || strcmp(transport, "lgmp") != 0)
return true;
if (strlen(opt->value.x_string) > 3 &&
strncmp(opt->value.x_string, "kvmfr", 5) != 0)
{
struct stat st;
if (stat(opt->value.x_string, &st) != 0)
{
*error = "Invalid path to the shared memory file";
return false;
}
}
return true;
}
static StringList lgmpDeviceValues(struct Option * option)
{
StringList values = stringlist_new(true);
DIR * dir = opendir("/sys/class/kvmfr");
if (!dir)
return values;
struct dirent * entry;
while ((entry = readdir(dir)))
{
if (entry->d_name[0] == '.')
continue;
char * name;
alloc_sprintf(&name, "/dev/%s", entry->d_name);
stringlist_push(values, name);
}
closedir(dir);
return values;
}
void lgmpPlatformOptionsInit(void)
{
struct stat st;
const char * defaultDevice = stat("/dev/kvmfr0", &st) == 0 ?
"/dev/kvmfr0" : "/dev/shm/looking-glass";
static struct Option options[] =
{
{
.module = "lgmp",
.name = "shmDevice",
.old_module = "app",
.old_name = "shmFile",
.shortopt = 'f',
.description = "Shared memory file or KVMFR device path",
.type = OPTION_TYPE_STRING,
.value.x_string = NULL,
.validator = lgmpDeviceValidator,
.getValues = lgmpDeviceValues,
},
{0}
};
options[0].value.x_string = (char *)defaultDevice;
option_register(options);
}
bool lgmpPlatformOpenIVSHMEM(struct IVSHMEM * shm)
{
if (!ivshmemInit(shm))
return false;
if (ivshmemOpenDev(shm, option_get_string("lgmp", "shmDevice"),
IVSHMEM_CACHE_MODE_CACHED))
return true;
ivshmemFree(shm);
return false;
}
bool lgmpPlatformSupportsExternalFrame(struct IVSHMEM * shm)
{
return ivshmemHasDMA(shm);
}
LG_ExternalFrame * lgmpPlatformCreateExternalFrame(struct IVSHMEM * shm,
size_t offset, size_t size)
{
const int fd = ivshmemGetDMABuf(shm, offset, size);
if (fd < 0)
return NULL;
LGMPExternalFrame * frame = malloc(sizeof(*frame));
if (!frame)
{
close(fd);
return NULL;
}
frame->base.ops = &lgmpExternalFrameOps;
frame->fd = fd;
atomic_init(&frame->refs, 1);
return &frame->base;
}

53
client/transports/LGMP/platform/windows.c Normal file
View File

@@ -0,0 +1,53 @@
/**
* Looking Glass
* Copyright © 2017-2026 The Looking Glass Authors
* https://looking-glass.io
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc., 59
* Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#include "../platform.h"
void lgmpPlatformOptionsInit(void)
{
ivshmemOptionsInit();
}
bool lgmpPlatformOpenIVSHMEM(struct IVSHMEM * shm)
{
if (!ivshmemInit(shm))
return false;
if (ivshmemOpen(shm, IVSHMEM_CACHE_MODE_CACHED))
return true;
ivshmemFree(shm);
return false;
}
bool lgmpPlatformSupportsExternalFrame(struct IVSHMEM * shm)
{
(void)shm;
return false;
}
LG_ExternalFrame * lgmpPlatformCreateExternalFrame(struct IVSHMEM * shm,
size_t offset, size_t size)
{
(void)shm;
(void)offset;
(void)size;
return NULL;
}

1
client/transports/Test/test.c
View File

@@ -640,7 +640,6 @@ static LG_TransportStatus test_nextFrame(LG_Transport * this, bool useDMA,
this->serial * (1000000000ULL / this->frameRate);
frame->format = &this->format;
frame->framebuffer = buffer->framebuffer;
frame->dmaFD = -1;
if (this->damageMode == TEST_DAMAGE_FULL ||
this->serial == 1 || formatChanged)