wait-wrappers.c

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2016-2025 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave 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 3 of the License, or
// (at your option) any later version.
//
// Octave 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 Octave; see the file COPYING.  If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////
 
// These functions may be provided by gnulib.  We don't include gnulib
// headers directly in Octave's C++ source files to avoid problems that
// may be caused by the way that gnulib overrides standard library
// functions.
 
#if defined (HAVE_CONFIG_H)
#  include "config.h"
#endif
 
#include <sys/types.h>
#include <sys/wait.h>
 
#if defined (__WIN32__) && ! defined (__CYGWIN__)
#  include <windows.h>
#endif
 
#include "wait-wrappers.h"
 
#if ! defined (WCONTINUE)
#  define WCONTINUE 0
#endif
 
#if ! defined (WNOHANG)
#  define WNOHANG 0
#endif
 
#if ! defined (WUNTRACED)
#  define WUNTRACED 0
#endif
 
#if ! defined (WIFCONTINUED)
#  define WIFCONTINUED(x) false
#endif
 
pid_t
octave_waitpid_wrapper (pid_t pid, int *statusp, int options)
{
#if defined (__WIN32__) && ! defined (__CYGWIN__)
  // gnulib's waitpid replacement currently uses _cwait, which
  // apparently only works with console applications.
  // Implement our own wrapper using win32 API functions.
 
  octave_unused_parameter (options);
 
  pid_t retval = -1;
  DWORD status = 0;
 
  HANDLE hProcess = OpenProcess (PROCESS_QUERY_INFORMATION | SYNCHRONIZE,
                                 false, pid);
 
  if (! hProcess)
    return retval;
 
  if (WaitForSingleObject (hProcess, INFINITE) != WAIT_OBJECT_0)
    {
      CloseHandle (hProcess);
      return retval;
    }
 
  if (! GetExitCodeProcess (hProcess, &status))
    {
      CloseHandle (hProcess);
      return retval;
    }
 
  CloseHandle (hProcess);
 
  if (statusp)
    *statusp = status;
 
  retval = pid;
 
  return retval;
 
#else
  return waitpid (pid, statusp, options);
#endif
}
 
int
octave_wcontinue_wrapper (void)
{
  return WCONTINUE;
}
 
int
octave_wnohang_wrapper (void)
{
  return WNOHANG;
}
 
int
octave_wuntraced_wrapper (void)
{
  return WUNTRACED;
}
 
#if defined (HAVE_PRAGMA_GCC_DIAGNOSTIC)
// Disable the unused parameter warning for the following wrapper functions.
// The <sys/wait.h> header provided by gnulib may define some of the W*
// macros to expand to a constant and ignore the parameter.
#  pragma GCC diagnostic push
#  pragma GCC diagnostic ignored "-Wunused-parameter"
#endif
 
int
octave_wcoredump_wrapper (int status)
{
  return WCOREDUMP (status);
}
 
int
octave_wexitstatus_wrapper (int status)
{
  return WEXITSTATUS (status);
}
 
bool
octave_wifcontinued_wrapper (int status)
{
  return WIFCONTINUED (status);
}
 
bool
octave_wifexited_wrapper (int status)
{
  return WIFEXITED (status);
}
 
bool
octave_wifsignaled_wrapper (int status)
{
  return WIFSIGNALED (status);
}
 
bool
octave_wifstopped_wrapper (int status)
{
  return WIFSTOPPED (status);
}
 
int
octave_wstopsig_wrapper (int status)
{
  return WSTOPSIG (status);
}
 
int
octave_wtermsig_wrapper (int status)
{
  return WTERMSIG (status);
}
 
#if defined (HAVE_PRAGMA_GCC_DIAGNOSTIC)
// Restore prevailing warning state for remainder of the file.
#  pragma GCC diagnostic pop
#endif