dfhack/library/shm/shms-linux.cpp

/*
www.sourceforge.net/projects/dfhack
Copyright (c) 2009 Petr Mrázek (peterix)

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any
damages arising from the use of this software.

Permission is granted to anyone to use this software for any
purpose, including commercial applications, and to alter it and
redistribute it freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must
not claim that you wrote the original software. If you use this
software in a product, an acknowledgment in the product documentation
would be appreciated but is not required.

2. Altered source versions must be plainly marked as such, and
must not be misrepresented as being the original software.

3. This notice may not be removed or altered from any source
distribution.
*/

/**
 * This is the source for the DF <-> dfhack shm bridge
 */
#include <stdio.h>
#include <dlfcn.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <sys/shm.h>
#include <sys/types.h>
#include <sys/ipc.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <vector>
#include <string>
#include "shms.h"
#include "mod-core.h"
#include <sched.h>

#define DFhackCExport extern "C" __attribute__ ((visibility("default")))

// various crud
int counter = 0;
int errorstate = 0;
char *shm = 0;
int shmid = 0;
bool inited = 0;

int fd_svlock = -1;
int fd_cllock[SHM_MAX_CLIENTS];
int fd_clSlock[SHM_MAX_CLIENTS];
int held_clSlock[SHM_MAX_CLIENTS];
int numheld = SHM_MAX_CLIENTS;

/*******************************************************************************
*                           SHM part starts here                               *
*******************************************************************************/
// is the other side still there?
bool isValidSHM(int which)
{
    // if we get the client lock here, the client process failed and we need to reclaim our suspend lock
    if(lockf(fd_cllock[which],F_TLOCK,0) == 0)
    {
        // we get back our suspend lock from the cold, dead hands of the former client :P
        OS_lockSuspendLock(which);
        // free the client lock again
        lockf(fd_cllock[which],F_ULOCK,0);
        return false;
    }
    return true;
}

uint32_t OS_getPID()
{
    return getpid();
}

uint32_t OS_getAffinity()
{
    cpu_set_t mask;
    sched_getaffinity(0,sizeof(cpu_set_t),&mask);
    // FIXME: truncation
    uint32_t affinity = *(uint32_t *) &mask;
    return affinity;
}

void OS_lockSuspendLock(int which)
{
    if(numheld == SHM_MAX_CLIENTS)
        return;
    // lock not held by server and can be picked up. OK.
    if(held_clSlock[which] == 0 && lockf(fd_clSlock[which],F_LOCK,0) == 0)
    {
        held_clSlock[which] = 1;
        numheld++;
    }
    // lock couldn't be picked up!
    else if (held_clSlock[which] == 0)
    {
        fprintf(stderr,"lock %d failed to lock\n", which);
    }
}

void OS_releaseSuspendLock(int which)
{
    /*
    if(which >=0 && which < SHM_MAX_CLIENTS)
        return;
    */
    if(numheld != SHM_MAX_CLIENTS)
    {
        fprintf(stderr,"TOTAL FAILURE OF LOCKING SYSTEM\n");
        return;
    }
    // lock hel by server and can be released -> OK
    if(held_clSlock[which] == 1 && lockf(fd_clSlock[which],F_ULOCK,0) == 0)
    {
        numheld--;
        held_clSlock[which] = 0;
    }
    // locked and not can't be released? FAIL!
    else if (held_clSlock[which] == 1)
        fprintf(stderr,"lock %d failed to unlock\n", which);
}

void SHM_Init ( void )
{
    // check that we do this only once per process
    if(inited)
    {
        fprintf(stderr, "SDL_Init was called twice or more!\n");
        return;
    }
    inited = true;
    char name[256];
    char name2[256];
    // make folder structure for our lock files
    sprintf(name, "/tmp/DFHack/%d",OS_getPID());
    mode_t createmode = S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH;
    mkdir("/tmp/DFHack", createmode);
    mkdir(name, createmode);
    
    // create and lock the server lock file
    sprintf(name2, "%s/SVlock",name);
    fd_svlock = open(name2,O_WRONLY | O_CREAT, createmode);
    lockf( fd_svlock, F_LOCK, 0 );
    
    for(int i = 0; i < SHM_MAX_CLIENTS; i++)
    {
        // create the client lock file
        sprintf(name2, "%s/CLlock%d",name,i);
        fd_cllock[i] = open(name2,O_WRONLY | O_CREAT, createmode);
        // get and lock the suspend locks
        sprintf(name2, "%s/CLSlock%d",name,i);
        fd_clSlock[i] = open(name2,O_WRONLY | O_CREAT, createmode);
        lockf(fd_clSlock[i],F_LOCK,0);
        held_clSlock[i] = 1;
    }
    
    // name for the segment, an accident waiting to happen
    key_t key = SHM_KEY + OS_getPID();
    
    // find previous segment, check if it's used by some processes.
    // if it isn't, kill it with fire
    if ((shmid = shmget(key, SHM_SIZE, 0600)) != -1)
    {
        shmid_ds descriptor;
        shmctl(shmid, IPC_STAT, &descriptor);
        if(descriptor.shm_nattch == 0)
        {
            shmctl(shmid,IPC_RMID,NULL);
            fprintf(stderr,"dfhack: killed dangling resources from crashed DF.\n");
        }
    }
    // create the segment, make sure only ww are really creating it
    if ((shmid = shmget(key, SHM_SIZE, IPC_CREAT | IPC_EXCL | 0600)) < 0)
    {
        perror("shmget");
        errorstate = 1;
        return;
    }
    
    // attach the segment
    if ((shm = (char *) shmat(shmid, 0, 0)) == (char *) -1)
    {
        perror("shmat");
        errorstate = 1;
        return;
    }
    full_barrier
    // make sure we don't stall or do crazy stuff
    for(int i = 0; i < SHM_MAX_CLIENTS;i++)
    {
        ((uint32_t *)shm)[i] = CORE_RUNNING;
    }
    InitModules();
}

void SHM_Destroy ( void )
{
    if(inited && !errorstate)
    {
        KillModules();
        shmid_ds descriptor;
        shmctl(shmid, IPC_STAT, &descriptor);
        shmdt(shm);
        while(descriptor.shm_nattch != 0)
        {
            shmctl(shmid, IPC_STAT, &descriptor);
        }
        shmctl(shmid,IPC_RMID,NULL);
        
        char name[256];
        char name2[256];
        sprintf(name, "/tmp/DFHack/%d",OS_getPID());
        
        // unlock and close server lock, close client lock, destroy files
        lockf(fd_svlock,F_ULOCK,0);
        for(int i = 0; i < SHM_MAX_CLIENTS; i++)
        {
            close(fd_cllock[i]);
            fd_cllock[i] = 0;
            close(fd_clSlock[i]);
            fd_clSlock[i] = 0;
            held_clSlock[i] = 0;
            sprintf(name2, "%s/CLlock%d",name,i);
            unlink(name2);
            sprintf(name2, "%s/CLSlock%d",name,i);
            unlink(name2);
        }
        close(fd_svlock);
        fd_svlock = 0;
        sprintf(name2, "%s/SVlock",name);
        unlink(name2);
        // remove the PID folder
        rmdir(name);
        fprintf(stderr,"dfhack: destroyed shared segment.\n");
        inited = false;
    }
}

/*******************************************************************************
*                           SDL part starts here                               *
*******************************************************************************/
// this is supported from 0.31.04 forward
DFhackCExport int SDL_NumJoysticks(void)
{
    if(errorstate)
        return -1;
    if(!inited)
    {
        SHM_Init();
        return -2;
    }
    SHM_Act();
    return -3;
}


// ptr to the real functions
//static void (*_SDL_GL_SwapBuffers)(void) = 0;
static void (*_SDL_Quit)(void) = 0;
static int (*_SDL_Init)(uint32_t flags) = 0;
//static int (*_SDL_Flip)(void * some_ptr) = 0;
/*
// hook - called every tick in OpenGL mode of DF
DFhackCExport void SDL_GL_SwapBuffers(void)
{
    if(_SDL_GL_SwapBuffers)
    {
        if(!errorstate)
        {
            SHM_Act();
        }
        counter ++;
        _SDL_GL_SwapBuffers();
    }
}
*/
/*
// hook - called every tick in the 2D mode of DF
DFhackCExport int SDL_Flip(void * some_ptr)
{
    if(_SDL_Flip)
    {
        if(!errorstate)
        {
            SHM_Act();
        }
        counter ++;
        return _SDL_Flip(some_ptr);
    }
    return 0;
}
*/

// hook - called at program exit
DFhackCExport void SDL_Quit(void)
{
    if(!errorstate)
    {
        SHM_Destroy();
        errorstate = true;
    }
    if(_SDL_Quit)
    {
        _SDL_Quit();
    }
}

// hook - called at program start, initialize some stuffs we'll use later
DFhackCExport int SDL_Init(uint32_t flags)
{
    // find real functions
    //_SDL_GL_SwapBuffers = (void (*)( void )) dlsym(RTLD_NEXT, "SDL_GL_SwapBuffers");
    _SDL_Init = (int (*)( uint32_t )) dlsym(RTLD_NEXT, "SDL_Init");
    //_SDL_Flip = (int (*)( void * )) dlsym(RTLD_NEXT, "SDL_Flip");
    _SDL_Quit = (void (*)( void )) dlsym(RTLD_NEXT, "SDL_Quit");

    // check if we got them
    if(/*_SDL_GL_SwapBuffers &&*/ _SDL_Init && _SDL_Quit)
    {
        fprintf(stderr,"dfhack: hooking successful\n");
    }
    else
    {
        // bail, this would be a disaster otherwise
        fprintf(stderr,"dfhack: something went horribly wrong\n");
        errorstate = true;
        exit(1);
    }
    //SHM_Init();
    
    return _SDL_Init(flags);
}
//*/
/*******************************************************************************
*                           NCURSES part starts here                           *
*******************************************************************************/

static int (*_refresh)(void) = 0;
//extern NCURSES_EXPORT(int) refresh (void);
DFhackCExport int refresh (void)
{
    if(_refresh)
    {
        /*
        if(!errorstate)
        {
            SHM_Act();
        }
        counter ++;
        */
        return _refresh();
    }
    return 0;
}

static int (*_endwin)(void) = 0;
//extern NCURSES_EXPORT(int) endwin (void);
DFhackCExport int endwin (void)
{
    if(!errorstate)
    {
        SHM_Destroy();
        errorstate = true;
    }
    if(_endwin)
    {
        return _endwin();
    }
    return 0;
}

typedef void WINDOW;
//extern NCURSES_EXPORT(WINDOW *) initscr (void);
static WINDOW * (*_initscr)(void) = 0;
DFhackCExport WINDOW * initscr (void)
{
    // find real functions
    //_refresh = (int (*)( void )) dlsym(RTLD_NEXT, "refresh");
    _endwin = (int (*)( void )) dlsym(RTLD_NEXT, "endwin");
    _initscr = (WINDOW * (*)( void )) dlsym(RTLD_NEXT, "initscr");
    // check if we got them
    if(_refresh && _endwin && _initscr)
    {
        fprintf(stderr,"dfhack: hooking successful\n");
    }
    else
    {
        // bail, this would be a disaster otherwise
        fprintf(stderr,"dfhack: something went horribly wrong\n");
        exit(1);
    }
    //SHM_Init();
    return _initscr();
}