alc/helpers.cpp

   1 /**
   2  * OpenAL cross platform audio library
   3  * Copyright (C) 2011 by authors.
   4  * This library is free software; you can redistribute it and/or
   5  *  modify it under the terms of the GNU Library General Public
   6  *  License as published by the Free Software Foundation; either
   7  *  version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  *  Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  *  License along with this library; if not, write to the
  16  *  Free Software Foundation, Inc.,
  17  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  * Or go to http://www.gnu.org/copyleft/lgpl.html
  19  */
  20
  21 #include "config.h"
  22
  23 #include <algorithm>
  24 #include <cerrno>
  25 #include <cstdarg>
  26 #include <cstdlib>
  27 #include <cstdio>
  28 #include <cstring>
  29 #include <mutex>
  30 #include <string>
  31
  32 #include "alcmain.h"
  33 #include "almalloc.h"
  34 #include "alfstream.h"
  35 #include "alspan.h"
  36 #include "alstring.h"
  37 #include "compat.h"
  38 #include "logging.h"
  39 #include "strutils.h"
  40 #include "vector.h"
  41
  42
  43 #ifdef _WIN32
  44
  45 #include <shlobj.h>
  46
  47 const PathNamePair &GetProcBinary()
  48 {
  49     static PathNamePair ret;
  50     if(!ret.fname.empty() || !ret.path.empty())
  51         return ret;
  52
  53     auto fullpath = al::vector<WCHAR>(256);
  54     DWORD len;
  55     while((len=GetModuleFileNameW(nullptr, fullpath.data(), static_cast<DWORD>(fullpath.size()))) == fullpath.size())
  56         fullpath.resize(fullpath.size() << 1);
  57     if(len == 0)
  58     {
  59         ERR("Failed to get process name: error %lu\n", GetLastError());
  60         return ret;
  61     }
  62
  63     fullpath.resize(len);
  64     if(fullpath.back() != 0)
  65         fullpath.push_back(0);
  66
  67     auto sep = std::find(fullpath.rbegin()+1, fullpath.rend(), '\\');
  68     sep = std::find(fullpath.rbegin()+1, sep, '/');
  69     if(sep != fullpath.rend())
  70     {
  71         *sep = 0;
  72         ret.fname = wstr_to_utf8(&*sep + 1);
  73         ret.path = wstr_to_utf8(fullpath.data());
  74     }
  75     else
  76         ret.fname = wstr_to_utf8(fullpath.data());
  77
  78     TRACE("Got binary: %s, %s\n", ret.path.c_str(), ret.fname.c_str());
  79     return ret;
  80 }
  81
  82
  83 void al_print(FILE *logfile, const char *fmt, ...)
  84 {
  85     al::vector<char> dynmsg;
  86     char stcmsg[256];
  87     char *str{stcmsg};
  88
  89     va_list args, args2;
  90     va_start(args, fmt);
  91     va_copy(args2, args);
  92     int msglen{std::vsnprintf(str, sizeof(stcmsg), fmt, args)};
  93     if UNLIKELY(msglen >= 0 && static_cast<size_t>(msglen) >= sizeof(stcmsg))
  94     {
  95         dynmsg.resize(static_cast<size_t>(msglen) + 1u);
  96         str = dynmsg.data();
  97         msglen = std::vsnprintf(str, dynmsg.size(), fmt, args2);
  98     }
  99     va_end(args2);
 100     va_end(args);
 101
 102     std::wstring wstr{utf8_to_wstr(str)};
 103     fputws(wstr.c_str(), logfile);
 104     fflush(logfile);
 105 }
 106
 107
 108 namespace {
 109
 110 void DirectorySearch(const char *path, const char *ext, al::vector<std::string> *const results)
 111 {
 112     std::string pathstr{path};
 113     pathstr += "\\*";
 114     pathstr += ext;
 115     TRACE("Searching %s\n", pathstr.c_str());
 116
 117     std::wstring wpath{utf8_to_wstr(pathstr.c_str())};
 118     WIN32_FIND_DATAW fdata;
 119     HANDLE hdl{FindFirstFileW(wpath.c_str(), &fdata)};
 120     if(hdl == INVALID_HANDLE_VALUE) return;
 121
 122     const auto base = results->size();
 123
 124     do {
 125         results->emplace_back();
 126         std::string &str = results->back();
 127         str = path;
 128         str += '\\';
 129         str += wstr_to_utf8(fdata.cFileName);
 130     } while(FindNextFileW(hdl, &fdata));
 131     FindClose(hdl);
 132
 133     const al::span<std::string> newlist{results->data()+base, results->size()-base};
 134     std::sort(newlist.begin(), newlist.end());
 135     for(const auto &name : newlist)
 136         TRACE(" got %s\n", name.c_str());
 137 }
 138
 139 } // namespace
 140
 141 al::vector<std::string> SearchDataFiles(const char *ext, const char *subdir)
 142 {
 143     auto is_slash = [](int c) noexcept -> int { return (c == '\\' || c == '/'); };
 144
 145     static std::mutex search_lock;
 146     std::lock_guard<std::mutex> _{search_lock};
 147
 148     /* If the path is absolute, use it directly. */
 149     al::vector<std::string> results;
 150     if(isalpha(subdir[0]) && subdir[1] == ':' && is_slash(subdir[2]))
 151     {
 152         std::string path{subdir};
 153         std::replace(path.begin(), path.end(), '/', '\\');
 154         DirectorySearch(path.c_str(), ext, &results);
 155         return results;
 156     }
 157     if(subdir[0] == '\\' && subdir[1] == '\\' && subdir[2] == '?' && subdir[3] == '\\')
 158     {
 159         DirectorySearch(subdir, ext, &results);
 160         return results;
 161     }
 162
 163     std::string path;
 164
 165     /* Search the app-local directory. */
 166     if(auto localpath = al::getenv(L"ALSOFT_LOCAL_PATH"))
 167     {
 168         path = wstr_to_utf8(localpath->c_str());
 169         if(is_slash(path.back()))
 170             path.pop_back();
 171     }
 172     else if(WCHAR *cwdbuf{_wgetcwd(nullptr, 0)})
 173     {
 174         path = wstr_to_utf8(cwdbuf);
 175         if(is_slash(path.back()))
 176             path.pop_back();
 177         free(cwdbuf);
 178     }
 179     else
 180         path = ".";
 181     std::replace(path.begin(), path.end(), '/', '\\');
 182     DirectorySearch(path.c_str(), ext, &results);
 183
 184     /* Search the local and global data dirs. */
 185     static const int ids[2]{ CSIDL_APPDATA, CSIDL_COMMON_APPDATA };
 186     for(int id : ids)
 187     {
 188         WCHAR buffer[MAX_PATH];
 189         if(SHGetSpecialFolderPathW(nullptr, buffer, id, FALSE) == FALSE)
 190             continue;
 191
 192         path = wstr_to_utf8(buffer);
 193         if(!is_slash(path.back()))
 194             path += '\\';
 195         path += subdir;
 196         std::replace(path.begin(), path.end(), '/', '\\');
 197
 198         DirectorySearch(path.c_str(), ext, &results);
 199     }
 200
 201     return results;
 202 }
 203
 204 void SetRTPriority(void)
 205 {
 206     if(RTPrioLevel > 0)
 207     {
 208         if(!SetThreadPriority(GetCurrentThread(), THREAD_PRIORITY_TIME_CRITICAL))
 209             ERR("Failed to set priority level for thread\n");
 210     }
 211 }
 212
 213 #else
 214
 215 #include <sys/types.h>
 216 #include <unistd.h>
 217 #include <dirent.h>
 218 #ifdef __FreeBSD__
 219 #include <sys/sysctl.h>
 220 #endif
 221 #ifdef __HAIKU__
 222 #include <FindDirectory.h>
 223 #endif
 224 #ifdef HAVE_PROC_PIDPATH
 225 #include <libproc.h>
 226 #endif
 227 #if defined(HAVE_PTHREAD_SETSCHEDPARAM) && !defined(__OpenBSD__)
 228 #include <pthread.h>
 229 #include <sched.h>
 230 #endif
 231
 232 const PathNamePair &GetProcBinary()
 233 {
 234     static PathNamePair ret;
 235     if(!ret.fname.empty() || !ret.path.empty())
 236         return ret;
 237
 238     al::vector<char> pathname;
 239 #ifdef __FreeBSD__
 240     size_t pathlen;
 241     int mib[4] = { CTL_KERN, KERN_PROC, KERN_PROC_PATHNAME, -1 };
 242     if(sysctl(mib, 4, nullptr, &pathlen, nullptr, 0) == -1)
 243         WARN("Failed to sysctl kern.proc.pathname: %s\n", strerror(errno));
 244     else
 245     {
 246         pathname.resize(pathlen + 1);
 247         sysctl(mib, 4, pathname.data(), &pathlen, nullptr, 0);
 248         pathname.resize(pathlen);
 249     }
 250 #endif
 251 #ifdef HAVE_PROC_PIDPATH
 252     if(pathname.empty())
 253     {
 254         char procpath[PROC_PIDPATHINFO_MAXSIZE]{};
 255         const pid_t pid{getpid()};
 256         if(proc_pidpath(pid, procpath, sizeof(procpath)) < 1)
 257             ERR("proc_pidpath(%d, ...) failed: %s\n", pid, strerror(errno));
 258         else
 259             pathname.insert(pathname.end(), procpath, procpath+strlen(procpath));
 260     }
 261 #endif
 262 #ifdef __HAIKU__
 263     char procpath[PATH_MAX];
 264     if(find_path(B_APP_IMAGE_SYMBOL, B_FIND_PATH_IMAGE_PATH, NULL, procpath, sizeof(procpath)) == B_OK)
 265     {
 266         pathname.insert(pathname.end(), procpath, procpath+strlen(procpath));
 267     }
 268 #endif
 269     if(pathname.empty())
 270     {
 271         static const char SelfLinkNames[][32]{
 272             "/proc/self/exe",
 273             "/proc/self/file",
 274             "/proc/curproc/exe",
 275             "/proc/curproc/file"
 276         };
 277
 278         pathname.resize(256);
 279
 280         const char *selfname{};
 281         ssize_t len{};
 282         for(const char *name : SelfLinkNames)
 283         {
 284             selfname = name;
 285             len = readlink(selfname, pathname.data(), pathname.size());
 286             if(len >= 0 || errno != ENOENT) break;
 287         }
 288
 289         while(len > 0 && static_cast<size_t>(len) == pathname.size())
 290         {
 291             pathname.resize(pathname.size() << 1);
 292             len = readlink(selfname, pathname.data(), pathname.size());
 293         }
 294         if(len <= 0)
 295         {
 296             WARN("Failed to readlink %s: %s\n", selfname, strerror(errno));
 297             return ret;
 298         }
 299
 300         pathname.resize(static_cast<size_t>(len));
 301     }
 302     while(!pathname.empty() && pathname.back() == 0)
 303         pathname.pop_back();
 304
 305     auto sep = std::find(pathname.crbegin(), pathname.crend(), '/');
 306     if(sep != pathname.crend())
 307     {
 308         ret.path = std::string(pathname.cbegin(), sep.base()-1);
 309         ret.fname = std::string(sep.base(), pathname.cend());
 310     }
 311     else
 312         ret.fname = std::string(pathname.cbegin(), pathname.cend());
 313
 314     TRACE("Got binary: %s, %s\n", ret.path.c_str(), ret.fname.c_str());
 315     return ret;
 316 }
 317
 318
 319 void al_print(FILE *logfile, const char *fmt, ...)
 320 {
 321     std::va_list ap;
 322     va_start(ap, fmt);
 323     vfprintf(logfile, fmt, ap);
 324     va_end(ap);
 325
 326     fflush(logfile);
 327 }
 328
 329
 330 namespace {
 331
 332 void DirectorySearch(const char *path, const char *ext, al::vector<std::string> *const results)
 333 {
 334     TRACE("Searching %s for *%s\n", path, ext);
 335     DIR *dir{opendir(path)};
 336     if(!dir) return;
 337
 338     const auto base = results->size();
 339     const size_t extlen{strlen(ext)};
 340
 341     while(struct dirent *dirent{readdir(dir)})
 342     {
 343         if(strcmp(dirent->d_name, ".") == 0 || strcmp(dirent->d_name, "..") == 0)
 344             continue;
 345
 346         const size_t len{strlen(dirent->d_name)};
 347         if(len <= extlen) continue;
 348         if(al::strcasecmp(dirent->d_name+len-extlen, ext) != 0)
 349             continue;
 350
 351         results->emplace_back();
 352         std::string &str = results->back();
 353         str = path;
 354         if(str.back() != '/')
 355             str.push_back('/');
 356         str += dirent->d_name;
 357     }
 358     closedir(dir);
 359
 360     const al::span<std::string> newlist{results->data()+base, results->size()-base};
 361     std::sort(newlist.begin(), newlist.end());
 362     for(const auto &name : newlist)
 363         TRACE(" got %s\n", name.c_str());
 364 }
 365
 366 } // namespace
 367
 368 al::vector<std::string> SearchDataFiles(const char *ext, const char *subdir)
 369 {
 370     static std::mutex search_lock;
 371     std::lock_guard<std::mutex> _{search_lock};
 372
 373     al::vector<std::string> results;
 374     if(subdir[0] == '/')
 375     {
 376         DirectorySearch(subdir, ext, &results);
 377         return results;
 378     }
 379
 380     /* Search the app-local directory. */
 381     if(auto localpath = al::getenv("ALSOFT_LOCAL_PATH"))
 382         DirectorySearch(localpath->c_str(), ext, &results);
 383     else
 384     {
 385         al::vector<char> cwdbuf(256);
 386         while(!getcwd(cwdbuf.data(), cwdbuf.size()))
 387         {
 388             if(errno != ERANGE)
 389             {
 390                 cwdbuf.clear();
 391                 break;
 392             }
 393             cwdbuf.resize(cwdbuf.size() << 1);
 394         }
 395         if(cwdbuf.empty())
 396             DirectorySearch(".", ext, &results);
 397         else
 398         {
 399             DirectorySearch(cwdbuf.data(), ext, &results);
 400             cwdbuf.clear();
 401         }
 402     }
 403
 404     // Search local data dir
 405     if(auto datapath = al::getenv("XDG_DATA_HOME"))
 406     {
 407         std::string &path = *datapath;
 408         if(path.back() != '/')
 409             path += '/';
 410         path += subdir;
 411         DirectorySearch(path.c_str(), ext, &results);
 412     }
 413     else if(auto homepath = al::getenv("HOME"))
 414     {
 415         std::string &path = *homepath;
 416         if(path.back() == '/')
 417             path.pop_back();
 418         path += "/.local/share/";
 419         path += subdir;
 420         DirectorySearch(path.c_str(), ext, &results);
 421     }
 422
 423     // Search global data dirs
 424     std::string datadirs{al::getenv("XDG_DATA_DIRS").value_or("/usr/local/share/:/usr/share/")};
 425
 426     size_t curpos{0u};
 427     while(curpos < datadirs.size())
 428     {
 429         size_t nextpos{datadirs.find(':', curpos)};
 430
 431         std::string path{(nextpos != std::string::npos) ?
 432             datadirs.substr(curpos, nextpos++ - curpos) : datadirs.substr(curpos)};
 433         curpos = nextpos;
 434
 435         if(path.empty()) continue;
 436         if(path.back() != '/')
 437             path += '/';
 438         path += subdir;
 439
 440         DirectorySearch(path.c_str(), ext, &results);
 441     }
 442
 443     return results;
 444 }
 445
 446 void SetRTPriority()
 447 {
 448 #if defined(HAVE_PTHREAD_SETSCHEDPARAM) && !defined(__OpenBSD__)
 449     if(RTPrioLevel > 0)
 450     {
 451         struct sched_param param{};
 452         /* Use the minimum real-time priority possible for now (on Linux this
 453          * should be 1 for SCHED_RR).
 454          */
 455         param.sched_priority = sched_get_priority_min(SCHED_RR);
 456         int err;
 457 #ifdef SCHED_RESET_ON_FORK
 458         err = pthread_setschedparam(pthread_self(), SCHED_RR|SCHED_RESET_ON_FORK, &param);
 459         if(err == EINVAL)
 460 #endif
 461             err = pthread_setschedparam(pthread_self(), SCHED_RR, &param);
 462         if(err != 0)
 463             ERR("Failed to set real-time priority for thread: %s (%d)\n", std::strerror(err), err);
 464     }
 465 #else
 466     /* Real-time priority not available */
 467     if(RTPrioLevel > 0)
 468         ERR("Cannot set priority level for thread\n");
 469 #endif
 470 }
 471
 472 #endif