/* sane - Scanner Access Now Easy.
   Copyright (C) 1998-2001 Yuri Dario
   Copyright (C) 2003 Gerhard Jaeger (pthread/process support)
   This file is part of the SANE package.

   This program 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 2 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
   General Public License for more details.

   You should have received a copy of the GNU 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.

   As a special exception, the authors of SANE give permission for
   additional uses of the libraries contained in this release of SANE.

   The exception is that, if you link a SANE library with other files
   to produce an executable, this does not by itself cause the
   resulting executable to be covered by the GNU General Public
   License.  Your use of that executable is in no way restricted on
   account of linking the SANE library code into it.

   This exception does not, however, invalidate any other reasons why
   the executable file might be covered by the GNU General Public
   License.

   If you submit changes to SANE to the maintainers to be included in
   a subsequent release, you agree by submitting the changes that
   those changes may be distributed with this exception intact.

   If you write modifications of your own for SANE, it is your choice
   whether to permit this exception to apply to your modifications.
   If you do not wish that, delete this exception notice.

   OS/2
   Helper functions for the OS/2 port (using threads instead of forked
   processes). Don't use them in the backends, they are used automatically by
   macros.

   Other OS:
   use this lib, if you intend to let run your reader function within its own
   task (thread or process). Depending on the OS and/or the configure settings
   pthread or fork is used to achieve this goal.
*/

#include "../include/sane/config.h"

#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#ifdef HAVE_UNISTD_H
# include <unistd.h>
#endif

#define BACKEND_NAME sanei_thread      /**< name of this module for debugging */

#include "../include/sane/sane.h"
#include "../include/sane/sanei_debug.h"
#include "../include/sane/sanei_thread.h"

#ifndef _VAR_NOT_USED
# define _VAR_NOT_USED(x)	((x)=(x))
#endif
      
/** for init issues - here only for the debug output
 */
void
sanei_thread_init( void )
{
	DBG_INIT();
}

#ifdef HAVE_OS2_H

#define INCL_DOSPROCESS
#include <os2.h>

/*
 * starts a new thread or process
 * parameters:
 * star  address of reader function
 * args  pointer to scanner data structure
 *
*/
int
sanei_thread_begin( int (*func)(void *args), void* args )
{
   return _beginthread( func, NULL, 1024*1024, args );
}

int
sanei_thread_kill( int pid )
{
   return DosKillThread(pid);
}

int
sanei_thread_waitpid( int pid, int *status )
{
  if (status)
    *status = 0;
  return pid; /* DosWaitThread( (TID*) &pid, DCWW_WAIT);*/
}

int
sanei_thread_sendsig( int pid, int sig )
{
	return 0;
}

int
sanei_thread_get_status( int pid )
{
	return 0;
}

#else /* HAVE_OS2_H */

#ifdef USE_PTHREAD
# include <signal.h>
# include <pthread.h>
#else
# include <sys/wait.h>
#endif

#ifdef USE_PTHREAD

/* seems to be undefined in MacOS X */
#ifndef PTHREAD_CANCELED
# define PTHREAD_CANCELED ((void *) -1)
#endif

typedef struct {

    int  (*func)( void* );
    void *func_data;

} ThreadDataDef, *pThreadDataDef;

static void*
local_thread( void *arg )
{
	static int     status;
	int            old;
	pThreadDataDef td = (pThreadDataDef)arg;

	DBG( 2, "thread started, calling func() now...\n" );
	pthread_setcancelstate( PTHREAD_CANCEL_ENABLE, &old );
	pthread_setcanceltype( PTHREAD_CANCEL_ASYNCHRONOUS, &old );
	
	status = td->func( td->func_data );

	DBG( 2, "func() done - status = %d\n", status );

	/* return the status, so pthread_join is able to get it*/
	pthread_exit((void*)&status );
}

#else /* the process stuff */

static int
eval_wp_result( int pid, int wpres, int pf )
{
	int retval = SANE_STATUS_IO_ERROR;

	if( wpres == pid ) {

		if( WIFEXITED(pf)) {
			retval = WEXITSTATUS(pf);
		} else {

			if( !WIFSIGNALED(pf)) {
				retval = SANE_STATUS_GOOD;
			} else {
				DBG( 1, "Child terminated by signal %d\n", WTERMSIG(pf));
				if( WTERMSIG(pf) == SIGTERM )
					retval = SANE_STATUS_GOOD;
			}
		}
	}
	return retval;
}
#endif

int
sanei_thread_begin( int (func)(void *args), void* args )
{
	int       pid;
#ifdef USE_PTHREAD
	pthread_t     thread;
	ThreadDataDef td;

    td.func      = func;
    td.func_data = args;
	
	pid = pthread_create( &thread, NULL, local_thread, &td );

	if ( pid != 0 ) {
		DBG( 1, "pthread_create() failed with %d\n", pid );
		return -1;
	}

	DBG( 2, "pthread_create() created thread %d\n", (int)thread );
	return (int)thread;
#else
	pid = fork();
	if( pid < 0 ) {
		DBG( 1, "fork() failed\n" );
		return -1;
	}

	if( pid == 0 ) {

    	/* run in child context... */
	    int status = func( args );
		
		/* don't use exit() since that would run the atexit() handlers */
		_exit( status );
	}

	/* parents return */
	return pid;
#endif
}

int
sanei_thread_kill( int pid )
{
	DBG(2, "sanei_thread_kill() will kill %d\n", (int)pid);
#ifdef USE_PTHREAD
	return pthread_cancel((pthread_t)pid);
#else
	return kill( pid, SIGTERM );
#endif
}

int
sanei_thread_sendsig( int pid, int sig )
{
#ifdef USE_PTHREAD
	DBG(2, "sanei_thread_sendsig() %d to thread(id=%d)\n", sig, pid);
	return pthread_kill((pthread_t)pid, sig );
#else
	DBG(2, "sanei_thread_sendsig() %d to process (id=%d)\n", sig, pid);
	return kill( pid, sig );
#endif
}

int
sanei_thread_waitpid( int pid, int *status )
{
#ifdef USE_PTHREAD
	int *ls;
#else
	int ls;
#endif
	int  result, stat;

	stat = 0;

	DBG(2, "sanei_thread_waitpid() - %d\n", (int)pid);
#ifdef USE_PTHREAD
	result = pthread_join((pthread_t)pid, (void*)&ls );

	if( 0 == result ) {
		DBG(2, "* detaching thread\n" );
		pthread_detach((pthread_t)pid );

		if( PTHREAD_CANCELED == ls ) {
			DBG(2, "* thread has been canceled!\n" );
			stat = SANE_STATUS_GOOD;
		} else {
			stat = *ls;
		}
		DBG(2, "* result = %d (%p)\n", stat, (void*)status );
	}
	if (status)
		*status = stat;
		
	/* should return pid */
	return pid;
#else
	result = waitpid( pid, &ls, 0 );
	if((result < 0) && (errno == ECHILD)) {
		stat   = SANE_STATUS_GOOD;
		result = pid;
	} else {
		stat = eval_wp_result( pid, result, ls );
		DBG(2, "* result = %d (%p)\n", stat, (void*)status );
	}
	if( status )
		*status = stat;

	return result;
#endif
}

SANE_Status
sanei_thread_get_status( int pid )
{
#ifdef USE_PTHREAD
	_VAR_NOT_USED( pid );

	return SANE_STATUS_GOOD;
#else
	int ls, stat, result;

	stat = SANE_STATUS_IO_ERROR;
	if( pid > 0 ) {

		result = waitpid( pid, &ls, WNOHANG );
		
		stat = eval_wp_result( pid, result, ls );
	}
	return stat;
#endif
}

SANE_Bool
sanei_thread_is_forked( void )
{
#ifdef USE_PTHREAD
	return SANE_FALSE;
#else
	return SANE_TRUE;
#endif
}

#endif /* HAVE_OS2_H */