jack2/common/JackTools.cpp

/*
  Copyright (C) 2006-2008 Grame

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser 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 "JackConstants.h"
#include "JackDriverLoader.h"
#include "JackTools.h"
#include "JackError.h"
#include <stdlib.h>
#include <stdio.h>
#include <assert.h>

#ifdef WIN32
#include <process.h>
#endif


using namespace std;

namespace Jack {

    void JackTools::KillServer()
    {
#ifdef WIN32
        exit(1);
#else
        kill(GetPID(), SIGINT);
#endif
    }

    void JackTools::ThrowJackNetException()
    {
        throw JackNetException();
    }

     int JackTools::MkDir(const char* path)
     {
#ifdef WIN32
        return CreateDirectory(path, NULL) == 0;
#else
        return mkdir(path, 0777) != 0;
#endif
    }

#define DEFAULT_TMP_DIR "/tmp"
    char* jack_tmpdir = (char*)DEFAULT_TMP_DIR;

    int JackTools::GetPID()
    {
#ifdef WIN32
        return _getpid();
#else
        return getpid();
#endif
    }

    int JackTools::GetUID()
    {
#ifdef WIN32
        return  _getpid();
        //#error "No getuid function available"
#else
        return getuid();
#endif
    }

    const char* JackTools::DefaultServerName()
    {
        const char* server_name;
        if ((server_name = getenv("JACK_DEFAULT_SERVER")) == NULL)
            server_name = JACK_DEFAULT_SERVER_NAME;
        return server_name;
    }

    /* returns the name of the per-user subdirectory of jack_tmpdir */
#ifdef WIN32

    char* JackTools::UserDir()
    {
        return "";
    }

    char* JackTools::ServerDir(const char* server_name, char* server_dir)
    {
        return "";
    }

    void JackTools::CleanupFiles(const char* server_name) {}

    int JackTools::GetTmpdir()
    {
        return 0;
    }

#else
    char* JackTools::UserDir()
    {
        static char user_dir[JACK_PATH_MAX + 1] = "";

        /* format the path name on the first call */
        if (user_dir[0] == '\0') {
            if (getenv ("JACK_PROMISCUOUS_SERVER")) {
                snprintf(user_dir, sizeof(user_dir), "%s/jack", jack_tmpdir);
            } else {
                snprintf(user_dir, sizeof(user_dir), "%s/jack-%d", jack_tmpdir, GetUID());
            }
        }

        return user_dir;
    }

    /* returns the name of the per-server subdirectory of jack_user_dir() */
    char* JackTools::ServerDir(const char* server_name, char* server_dir)
    {
        /* format the path name into the suppled server_dir char array,
        * assuming that server_dir is at least as large as JACK_PATH_MAX + 1 */

        snprintf(server_dir, JACK_PATH_MAX + 1, "%s/%s", UserDir(), server_name);
        return server_dir;
    }

    void JackTools::CleanupFiles(const char* server_name)
    {
        DIR* dir;
        struct dirent *dirent;
        char dir_name[JACK_PATH_MAX + 1] = "";
        ServerDir(server_name, dir_name);

        /* On termination, we remove all files that jackd creates so
        * subsequent attempts to start jackd will not believe that an
        * instance is already running. If the server crashes or is
        * terminated with SIGKILL, this is not possible. So, cleanup
        * is also attempted when jackd starts.
        *
        * There are several tricky issues. First, the previous JACK
        * server may have run for a different user ID, so its files
        * may be inaccessible. This is handled by using a separate
        * JACK_TMP_DIR subdirectory for each user. Second, there may
        * be other servers running with different names. Each gets
        * its own subdirectory within the per-user directory. The
        * current process has already registered as `server_name', so
        * we know there is no other server actively using that name.
        */

        /* nothing to do if the server directory does not exist */
        if ((dir = opendir(dir_name)) == NULL) {
            return;
        }

        /* unlink all the files in this directory, they are mine */
        while ((dirent = readdir(dir)) != NULL) {

            char fullpath[JACK_PATH_MAX + 1];

            if ((strcmp(dirent->d_name, ".") == 0) || (strcmp (dirent->d_name, "..") == 0)) {
                continue;
            }

            snprintf(fullpath, sizeof(fullpath), "%s/%s", dir_name, dirent->d_name);

            if (unlink(fullpath)) {
                jack_error("cannot unlink `%s' (%s)", fullpath, strerror(errno));
            }
        }

        closedir(dir);

        /* now, delete the per-server subdirectory, itself */
        if (rmdir(dir_name)) {
            jack_error("cannot remove `%s' (%s)", dir_name, strerror(errno));
        }

        /* finally, delete the per-user subdirectory, if empty */
        if (rmdir(UserDir())) {
            if (errno != ENOTEMPTY) {
                jack_error("cannot remove `%s' (%s)", UserDir(), strerror(errno));
            }
        }
    }

    int JackTools::GetTmpdir()
    {
        FILE* in;
        size_t len;
        char buf[JACK_PATH_MAX + 2]; /* allow tmpdir to live anywhere, plus newline, plus null */

        if ((in = popen("jackd -l", "r")) == NULL) {
            return -1;
        }

        if (fgets(buf, sizeof(buf), in) == NULL) {
            pclose(in);
            return -1;
        }

        len = strlen(buf);

        if (buf[len - 1] != '\n') {
            /* didn't get a whole line */
            pclose(in);
            return -1;
        }

        jack_tmpdir = (char *)malloc(len);
        memcpy(jack_tmpdir, buf, len - 1);
        jack_tmpdir[len - 1] = '\0';

        pclose(in);
        return 0;
    }
#endif

    void JackTools::RewriteName(const char* name, char* new_name)
    {
        size_t i;
        for (i = 0; i < strlen(name); i++) {
            if ((name[i] == '/') || (name[i] == '\\'))
                new_name[i] = '_';
            else
                new_name[i] = name[i];
        }
        new_name[i] = '\0';
    }

#ifdef WIN32

void BuildClientPath(char* path_to_so, int path_len, const char* so_name)
{
    snprintf(path_to_so, path_len, ADDON_DIR "/%s.dll", so_name);
}

void PrintLoadError(const char* so_name)
{
    // Retrieve the system error message for the last-error code
    LPVOID lpMsgBuf;
    LPVOID lpDisplayBuf;
    DWORD dw = GetLastError();

    FormatMessage(
        FORMAT_MESSAGE_ALLOCATE_BUFFER |
        FORMAT_MESSAGE_FROM_SYSTEM |
        FORMAT_MESSAGE_IGNORE_INSERTS,
        NULL,
        dw,
        MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
        (LPTSTR) &lpMsgBuf,
        0, NULL );

    // Display the error message and exit the process
    lpDisplayBuf = (LPVOID)LocalAlloc(LMEM_ZEROINIT,
        (lstrlen((LPCTSTR)lpMsgBuf) + lstrlen((LPCTSTR)so_name) + 40) * sizeof(TCHAR));
    _snprintf((LPTSTR)lpDisplayBuf, LocalSize(lpDisplayBuf) / sizeof(TCHAR),
        TEXT("error loading %s err = %s"), so_name, lpMsgBuf);

    jack_error((LPCTSTR)lpDisplayBuf);

    LocalFree(lpMsgBuf);
    LocalFree(lpDisplayBuf);
}

#else

void PrintLoadError(const char* so_name)
{
    jack_log("error loading %s err = %s", so_name, dlerror());
}

void BuildClientPath(char* path_to_so, int path_len, const char* so_name)
{
    const char* internal_dir;
    if ((internal_dir = getenv("JACK_INTERNAL_DIR")) == 0) {
        if ((internal_dir = getenv("JACK_DRIVER_DIR")) == 0) {
            internal_dir = ADDON_DIR;
        }
    }

    snprintf(path_to_so, path_len, "%s/%s.so", internal_dir, so_name);
}

#endif

template <class T>
JackGnuPlotMonitor<T>::JackGnuPlotMonitor(uint32_t measure_cnt, uint32_t measure_points, std::string name)
{
    jack_log ( "JackGnuPlotMonitor::JackGnuPlotMonitor %u measure points - %u measures", measure_points, measure_cnt );

    fMeasureCnt = measure_cnt;
    fMeasurePoints = measure_points;
    fTablePos = 0;
    fName = name;
    fCurrentMeasure = new T[fMeasurePoints];
    fMeasureTable = new T*[fMeasureCnt];
    for ( uint32_t cnt = 0; cnt < fMeasureCnt; cnt++ )
    {
        fMeasureTable[cnt] = new T[fMeasurePoints];
        fill_n ( fMeasureTable[cnt], fMeasurePoints, 0 );
    }
}

template <class T>
JackGnuPlotMonitor<T>::~JackGnuPlotMonitor()
{
    jack_log ( "JackGnuPlotMonitor::~JackGnuPlotMonitor" );

    for ( uint32_t cnt = 0; cnt < fMeasureCnt; cnt++ )
        delete[] fMeasureTable[cnt];
    delete[] fMeasureTable;
    delete[] fCurrentMeasure;
}

template <class T>
T JackGnuPlotMonitor<T>::AddNew(T measure_point)
{
    fMeasureId = 0;
    return fCurrentMeasure[fMeasureId++] = measure_point;
}

template <class T>
uint32_t JackGnuPlotMonitor<T>::New()
{
    return fMeasureId = 0;
}

template <class T>
T JackGnuPlotMonitor<T>::Add(T measure_point)
{
    return fCurrentMeasure[fMeasureId++] = measure_point;
}

template <class T>
uint32_t JackGnuPlotMonitor<T>::AddLast(T measure_point)
{
    fCurrentMeasure[fMeasureId] = measure_point;
    fMeasureId = 0;
    return Write();
}

template <class T>
uint32_t JackGnuPlotMonitor<T>::Write()
{
    for ( uint32_t point = 0; point < fMeasurePoints; point++ )
        fMeasureTable[fTablePos][point] = fCurrentMeasure[point];
    if ( ++fTablePos == fMeasureCnt )
        fTablePos = 0;
    return fTablePos;
}

template <class T>
int JackGnuPlotMonitor<T>::Save(std::string name)
{
    std::string filename = ( name.empty() ) ? fName : name;
    filename += ".log";

    jack_log ( "JackGnuPlotMonitor::Save filename %s", filename.c_str() );

    std::ofstream file ( filename.c_str() );

    for ( uint32_t cnt = 0; cnt < fMeasureCnt; cnt++ )
    {
        for ( uint32_t point = 0; point < fMeasurePoints; point++ )
            file << fMeasureTable[cnt][point] << " \t";
        file << std::endl;
    }

    file.close();
    return 0;
}

template <class T>
int JackGnuPlotMonitor<T>::SetPlotFile(std::string* options_list, uint32_t options_number,
                std::string* field_names, uint32_t field_number,
                std::string name)
{
    std::string title = ( name.empty() ) ? fName : name;
    std::string plot_filename = title + ".plt";
    std::string data_filename = title + ".log";

    std::ofstream file ( plot_filename.c_str() );

    file << "set multiplot" << std::endl;
    file << "set grid" << std::endl;
    file << "set title \"" << title << "\"" << std::endl;

    for ( uint32_t i = 0; i < options_number; i++ )
        file << options_list[i] << std::endl;

    file << "plot ";
    for ( uint32_t row = 1; row <= field_number; row++ )
    {
        file << "\"" << data_filename << "\" using " << row << " title \"" << field_names[row-1] << "\" with lines";
        file << ( ( row < field_number ) ? ", " : "\n" );
    }

    jack_log ( "JackGnuPlotMonitor::SetPlotFile - Save GnuPlot file to '%s'", plot_filename.c_str() );

    file.close();
    return 0;
}

}  // end of namespace