VuoRuntime.cc

Go to the documentation of this file.

 
#include <getopt.h>
#include <mach-o/dyld.h> // for _NSGetExecutablePath()
#include <libgen.h> // for dirname()
#include <dirent.h>
#include <dlfcn.h>
#include <sys/mman.h>
 
#include "VuoApp.h"
#include "VuoEventLoop.h"
#include "VuoException.hh"
#include "VuoRuntime.h"
#include "VuoRuntimeCommunicator.hh"
#include "VuoRuntimePersistentState.hh"
#include "VuoRuntimeState.hh"
 
extern "C"
{
 
static VuoRuntimeState *runtimeState = NULL;  
void *vuoRuntimeState = NULL;  
 
void vuoInit(int argc, char **argv)
{
    bool doAppInit = false;
    char *controlURL = NULL;
    char *telemetryURL = NULL;
    bool isPaused = false;
    pid_t runnerPid = 0;
    int runnerPipe = -1;
    bool continueIfRunnerDies = false;
    bool doPrintHelp = false;
    bool doPrintLicenses = false;
 
    // parse commandline arguments
    {
        int getoptArgC = 0;
        char **getoptArgV = (char **)malloc(sizeof(char *) * argc);
        for(int i = 0; i < argc; ++i)
        {
            // Don't pass the OS X Process Serial Number argument to getopt, since it can't handle long arguments with a single hyphen.
            if (strncmp(argv[i], "-psn_", 5) == 0)
            {
                // Since we have a process serial number, we can assume this is an exported app being invoked by LaunchServices.
                // Therefore we need to initialize the app (so it shows up in the dock).
                doAppInit = true;
                continue;
            }
 
            getoptArgV[getoptArgC++] = argv[i];
        }
 
        static struct option options[] = {
            {"help", no_argument, NULL, 0},
            {"vuo-control", required_argument, NULL, 0},
            {"vuo-telemetry", required_argument, NULL, 0},
            {"vuo-pause", no_argument, NULL, 0},
            {"vuo-loader", required_argument, NULL, 0},
            {"vuo-runner-pipe", required_argument, NULL, 0},
            {"vuo-continue-if-runner-dies", no_argument, NULL, 0},
            {"vuo-licenses", no_argument, NULL, 0},
            {"vuo-runner-pid", required_argument, NULL, 0},
            {NULL, no_argument, NULL, 0}
        };
        int optionIndex=-1;
        int ret;
        while ((ret = getopt_long(getoptArgC, getoptArgV, "", options, &optionIndex)) != -1)
        {
            if (ret == '?')
                continue;
 
            switch(optionIndex)
            {
                case 0:  // --help
                    doPrintHelp = true;
                    break;
                case 1:  // --vuo-control
                    if (controlURL)
                        free(controlURL);
                    controlURL = strdup(optarg);
                    break;
                case 2:  // --vuo-telemetry
                    if (telemetryURL)
                        free(telemetryURL);
                    telemetryURL = strdup(optarg);
                    break;
                case 3:  // --vuo-pause
                    isPaused = true;
                    break;
                case 4:  // --vuo-loader (ignored, but added here to avoid "unrecognized option" warning)
                    break;
                case 5:  // --vuo-runner-pipe
                    runnerPipe = atoi(optarg);
                    break;
                case 6:  // --vuo-continue-if-runner-dies
                    continueIfRunnerDies = true;
                    break;
                case 7:  // --vuo-licenses
                    doPrintLicenses = true;
                    break;
                case 8:  // --vuo-runner-pid
                    runnerPid = atoi(optarg);
                    break;
            }
        }
        free(getoptArgV);
    }
 
    // macOS 10.14 no longer provides the `-psn_` argument, so use an alternate method to detect LaunchServices.
    // launchd is pid 1.
    if (!doAppInit && !controlURL && getppid() == 1)
        doAppInit = true;
 
    // Get the exported executable path.
    char rawExecutablePath[PATH_MAX+1];
    uint32_t size = sizeof(rawExecutablePath);
    _NSGetExecutablePath(rawExecutablePath, &size);
 
    if (doPrintHelp)
    {
        printf("Usage: %s [options]\n"
               "Options:\n"
               "  --help                                   Display this information.\n"
               "  --vuo-licenses                           Display license information.\n",
               argv[0]);
 
        exit(0);
    }
    else if (doPrintLicenses)
    {
        printf("This composition may include software licensed under the following terms:\n\n");
 
        // Derive the path of the app bundle's "Licenses" directory from its executable path.
        char licensesPath[PATH_MAX+1];
        licensesPath[0] = 0;
        if (strlen(VuoApp_getVuoFrameworkPath()))
        {
            strncpy(licensesPath, VuoApp_getVuoFrameworkPath(), PATH_MAX);
            strncat(licensesPath, "/Vuo.framework/Versions/" VUO_FRAMEWORK_VERSION_STRING "/Documentation/Licenses", PATH_MAX);
        }
        else if (strlen(VuoApp_getVuoRunnerFrameworkPath()))
        {
            strncpy(licensesPath, VuoApp_getVuoRunnerFrameworkPath(), PATH_MAX);
            strncat(licensesPath, "/VuoRunner.framework/Versions/" VUO_FRAMEWORK_VERSION_STRING "/Documentation/Licenses", PATH_MAX);
        }
 
        bool foundLicenses = false;
        if (licensesPath[0] && access(licensesPath, 0) == 0)
        {
            DIR *dirp = opendir(licensesPath);
            struct dirent *dp;
            while ((dp = readdir(dirp)) != NULL)
            {
                if (dp->d_name[0] == '.')
                    continue;
 
                printf("=== %s =====================================================\n\n",dp->d_name);
 
                size_t pathSize = strlen(licensesPath) + dp->d_namlen + 2;
                char licensePath[pathSize];
                strlcpy(licensePath, licensesPath, pathSize);
                strlcat(licensePath, "/", pathSize);
                strlcat(licensePath, dp->d_name, pathSize);
 
                int fd = open(licensePath, O_RDONLY);
                char data[1024];
                int bytesRead;
                while((bytesRead = read(fd, data, 1024)) > 0)
                    write(1, data, bytesRead);
                close(fd);
 
                printf("\n\n\n");
                foundLicenses = true;
            }
            closedir(dirp);
        }
 
        if (!foundLicenses)
            printf("(No license information found.)\n");
 
        free(controlURL);
        free(telemetryURL);
        exit(0);
    }
 
    void *executableHandle = dlopen(rawExecutablePath, 0);
    if (! executableHandle)
    {
        VUserLog("The composition couldn't be started because a handle to the executable couldn't be obtained : %s", dlerror());
        free(controlURL);
        free(telemetryURL);
        return;
    }
 
    vuoInitInProcess(NULL, controlURL, telemetryURL, isPaused, runnerPid, runnerPipe, continueIfRunnerDies, "",
                     executableHandle, NULL, doAppInit);
 
    dlclose(executableHandle);
 
    free(controlURL);
    free(telemetryURL);
}
 
void vuoInitInProcess(void *ZMQContext, const char *controlURL, const char *telemetryURL, bool isPaused, pid_t runnerPid,
                      int runnerPipe, bool continueIfRunnerDies, const char *workingDirectory,
                      void *compositionBinaryHandle, void *previousRuntimeState, bool doAppInit)
{
    runtimeState = (VuoRuntimeState *)previousRuntimeState;
    if (! runtimeState)
    {
        runtimeState = new VuoRuntimeState();
        VuoEventLoop_installSignalHandlers();
        VuoEventLoop_disableAppNap();
    }
 
    vuoRuntimeState = (void *)runtimeState;
 
    VuoCompositionState *compositionState = new VuoCompositionState;
    compositionState->runtimeState = runtimeState;
    compositionState->compositionIdentifier = "";
    vuoAddCompositionStateToThreadLocalStorage(compositionState);
 
    try
    {
        runtimeState->init(ZMQContext, controlURL, telemetryURL, isPaused, runnerPid, runnerPipe, continueIfRunnerDies,
                           workingDirectory, compositionBinaryHandle);
    }
    catch (VuoException &e)
    {
        VUserLog("%s", e.what());
        return;
    }
 
    if (doAppInit)
    {
        typedef void (*vuoAppInitType)(bool requiresDockIcon);
        vuoAppInitType vuoAppInit = (vuoAppInitType) dlsym(RTLD_SELF, "VuoApp_init");
        if (vuoAppInit)
            vuoAppInit(true);
    }
 
    runtimeState->startComposition();
 
    // If the composition had a pending call to vuoStopComposition() when it was stopped, call it again.
    if (runtimeState->persistentState->isStopRequested())
        runtimeState->stopCompositionAsOrderedByComposition();
 
    vuoRemoveCompositionStateFromThreadLocalStorage();
}
 
void * vuoFini(void)
{
    runtimeState->fini();
    return (void *)runtimeState;
}
 
void vuoFiniRuntimeState(void *runtimeState)
{
    delete (VuoRuntimeState *)runtimeState;
}
 
typedef void (*VuoCompositionFiniCallback)(void);
 
char * vuoGetWorkingDirectory(VuoCompositionState *compositionState)
{
    VuoRuntimeState *r = (compositionState ? (VuoRuntimeState *)compositionState->runtimeState : runtimeState);
    if (r)
        return r->persistentState->getWorkingDirectory();
    else
        return strdup(VuoRuntimePersistentState::getCurrentWorkingDirectory().c_str());
}
 
pid_t vuoGetRunnerPid(VuoCompositionState *compositionState)
{
    VuoRuntimeState *r = (compositionState ? (VuoRuntimeState *)compositionState->runtimeState : runtimeState);
    if (r)
        return r->getRunnerPid();
    else
        return -1;
}
 
void vuoStopComposition(VuoCompositionState *compositionState)
{
    VuoRuntimeState *r = (compositionState ? (VuoRuntimeState *)compositionState->runtimeState : runtimeState);
    if (r)
        r->stopCompositionAsOrderedByComposition();
}
 
void vuoAddCompositionFiniCallback(VuoCompositionState *compositionState, VuoCompositionFiniCallback fini)
{
    VuoRuntimeState *r = (compositionState ? (VuoRuntimeState *)compositionState->runtimeState : runtimeState);
    if (r)
        r->persistentState->addFiniCallback(fini);
}
 
void vuoDisableTermination(VuoCompositionState *compositionState)
{
    VuoRuntimeState *r = (compositionState ? (VuoRuntimeState *)compositionState->runtimeState : runtimeState);
    if (r)
        r->disableTermination();
}
 
void vuoEnableTermination(VuoCompositionState *compositionState)
{
    VuoRuntimeState *r = (compositionState ? (VuoRuntimeState *)compositionState->runtimeState : runtimeState);
    if (r)
        r->enableTermination();
}
 
bool vuoIsCurrentCompositionStopped(void)
{
    return runtimeState->isStopped();
}
 
}  // extern "C"