veejay/veejay-current/veejay-server/libvjmsg/vj-common.c

/* 
 * Linux VeeJay
 *
 * Copyright(C)2002-2010 Niels Elburg <nwelburg@gmail.com>
 *
 * 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
 */


/**
 * Printing the stack trace, explanation by Jaco Kroon:
 * http://tlug.up.ac.za/wiki/index.php/Obtaining_a_stack_trace_in_C_upon_SIGSEGV
 * Author: Jaco Kroon <jaco@kroon.co.za>
 * Copyright (C) 2005 - 2008 Jaco Kroon
 */

#include <config.h>
#include <stdio.h>
#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include <stdint.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>

#include <libvjmem/vjmem.h>
#include <libvjmsg/vj-msg.h>
#include <dlfcn.h>
#include <time.h>
#include <sys/wait.h>
#include <sys/signal.h>
#include <sys/ucontext.h>
#include <execinfo.h>
#include <unistd.h>
#include <libgen.h>

#include <mjpeg_logging.h>
/* Bug in gcc prevents from using CPP_DEMANGLE in pure "C" */
#if !defined(__cplusplus) && !defined(NO_CPP_DEMANGLE)
#define NO_CPP_DEMANGLE
#endif
#ifndef NO_CPP_DEMANGLE
#include <cxxabi.h>
#endif

#if defined(REG_RIP)
#define SIGSEGV_STACK_IA64
#elif defined(REG_EIP)
#define SIGSEGV_STACK_X86
#else
#define SIGSEGV_STACK_GENERIC
#endif

#define TXT_RED		"\033[0;31m"
#define TXT_RED_B 	"\033[1;31m"
#define TXT_GRE		"\033[0;32m"
#define TXT_GRE_B	"\033[1;32m"
#define TXT_YEL		"\033[0;33m"
#define TXT_YEL_B	"\033[1;33m"
#define TXT_BLU		"\033[0;34m"
#define TXT_BLU_B	"\033[1;34m"
#define TXT_WHI		"\033[0;37m"
#define TXT_WHI_B	"\033[1;37m"
#define TXT_END		"\033[0m"


static int _debug_level = 0;
static int _color_level = 1;
static int _no_msg = 0;

__thread struct timeval _start_time;
__thread int timerdy = 0;
__thread int _start_time_offset = 0;

#define MAX_LINES 100 
typedef struct
{
	char *msg[MAX_LINES];
	int	r_index;
	int	w_index;
} vj_msg_hist;
/*
static	vj_msg_hist	_message_history;
static	int		_message_his_status = 0;
*/

 	

/* Subtract the `struct timeval' values X and Y,
   storing the result in RESULT.
   Return 1 if the difference is negative, otherwise 0.  
   gnu/docs/glibc/libc_428.html
   */

static int
timeval_subtract (struct timeval *result, struct timeval *x, struct timeval *y)
{
  /* Perform the carry for the later subtraction by updating y. */
  if (x->tv_usec < y->tv_usec) {
    int nsec = (y->tv_usec - x->tv_usec) / 1000000 + 1;
    y->tv_usec -= 1000000 * nsec;
    y->tv_sec += nsec;
  }
  if (x->tv_usec - y->tv_usec > 1000000) {
    int nsec = (x->tv_usec - y->tv_usec) / 1000000;
    y->tv_usec += 1000000 * nsec;
    y->tv_sec -= nsec;
  }

  /* Compute the time remaining to wait.
     tv_usec is certainly positive. */
  result->tv_sec = x->tv_sec - y->tv_sec;
  result->tv_usec = x->tv_usec - y->tv_usec;

  /* Return 1 if result is negative. */
  return x->tv_sec < y->tv_sec;
}

static	void	veejay_addr2line_bt( int n, void *addr, void *sym )
{
	int res;
	Dl_info info;
	const void *address;
	FILE *out;
	char cmd[1024];
	char line[1024], *line_ptr, *line_pos;
	char func_name[1024];

	res = dladdr( addr, &info );
	if( (res == 0) || !info.dli_fname || !info.dli_fname[0] ) {
		veejay_msg(VEEJAY_MSG_INFO, "\t%d ?:ACCESS VIOLATION", n);
		return;
	}

	address = addr;
	if( info.dli_fbase >= (const void*)0x40000000)
#ifdef ARCH_X86_64
		addr = (void*)((const char*) address - (uint64_t) info.dli_fbase );
#else
		addr = (void*)((const char*) address - (unsigned int ) info.dli_fbase);
#endif
	snprintf( cmd,sizeof(cmd), "addr2line --functions --demangle -e $(which %s) %p", info.dli_fname, address);
	out = popen( cmd, "r");
	if(!out) {
		veejay_msg(VEEJAY_MSG_INFO, "\t%d %p (addr2line error)", n, sym );
		return;
	}

	func_name[0] = '\0';

	while( !feof(out)) {
		line_ptr = fgets(line,sizeof(line)-1,out);
		if(line_ptr && line_ptr[0]) {
			line_pos = strchr( line_ptr, '\n');
			if( line_pos )
				line_pos[0] = '\0';
			if( strchr( line_ptr, ':' )) {
				veejay_msg(VEEJAY_MSG_INFO, "\t%d %s %s (@%x)",
						n,
						line_ptr,
						func_name,
						addr);
				func_name[0] = '\0';
			} else {
				if( func_name[0] )
					veejay_msg(VEEJAY_MSG_INFO, "%d\t%s", n, func_name );
				snprintf(func_name, sizeof(func_name), "%s", line_ptr );
			}
		}
	}
	if( func_name[0] )
		veejay_msg(VEEJAY_MSG_INFO, "%03d %s",n,func_name );
	fclose(out);
}

void	veejay_print_backtrace()
{
	void *space[100];
	size_t i,s;
	char **strings;

	s = backtrace( space, 100 );
	strings = backtrace_symbols(space,s);

	for( i = 0; i < s ; i ++ ) 
		veejay_addr2line_bt( i + 1, space[i],strings[i] );


}

void	veejay_backtrace_handler(int n , void *dist, void *x)
{
	siginfo_t *ist = (siginfo_t*) dist;
	static char *strerr = "???";
	static struct ucontext *puc;
	int i,f=0;
	void *ip = NULL;
	void **bp = NULL;
	Dl_info info;
	
	puc = (struct ucontext*) x;
#define SICCASE(c) case c: strerr = #c
	switch(n) {
		case SIGSEGV:
			switch(ist->si_code) {
				SICCASE(SEGV_MAPERR);
				SICCASE(SEGV_ACCERR);
			}
			
		//@ print stack
#ifndef SIGSEGV_NOSTACK
#if defined(SIGSEGV_STACK_IA64) || defined(SIGSEGV_STACK_X86)
#if defined(SIGSEGV_STACK_IA64)
			ip = (void*) puc->uc_mcontext.gregs[REG_RIP];
			bp= (void**) puc->uc_mcontext.gregs[REG_RBP];
#elif defined(SIGSEGV_STACK_X86)
			ip = (void*) puc->uc_mcontext.gregs[REG_EIP];
			bp = (void**) puc->uc_mcontext.gregs[REG_EBP];
#endif
#endif
#endif

			veejay_msg(VEEJAY_MSG_ERROR,"Found Gremlins in your system."); //@ Suggested by Matthijs
			veejay_msg(VEEJAY_MSG_WARNING, "No fresh ale found in the fridge."); //@
			veejay_msg(VEEJAY_MSG_INFO, "Running with sub-atomic precision..."); //@

#if defined(SIGSEGV_STACK_IA64) || defined(SIGSEGV_STACK_X86)
#if defined(SIGSEGV_STACK_X86)
			veejay_msg(VEEJAY_MSG_INFO,"(%s) invalid access to %p at %08x",
					strerr,ist->si_addr, puc->uc_mcontext.gregs[REG_EIP]);
			veejay_addr2line_bt( 0, (void*) puc->uc_mcontext.gregs[REG_EIP] , (void*) puc->uc_mcontext.gregs[REG_EIP] );
#elif defined(SIGSEGV_STACK_IA64)
			veejay_msg(VEEJAY_MSG_INFO,"(%s) invalid access to %p at %08x",
					strerr,ist->si_addr, puc->uc_mcontext.gregs[REG_RIP]);
			veejay_addr2line_bt( 0, (void*) puc->uc_mcontext.gregs[REG_RIP], (void*) puc->uc_mcontext.gregs[REG_RIP] );
#endif
#endif
			for( i = 0; i < NGREG; i ++ ) {
				veejay_msg(VEEJAY_MSG_INFO, "\tregister [%2d]\t=%08x",i,puc->uc_mcontext.gregs[i]);
			}

			while( bp && ip ) {

				if( !dladdr( ip, &info ))
					break;
				char *symname = (char*) info.dli_sname;
#ifndef NO_CPP_DEMANGLE
				int status;
				char *tmp = __cxa_demangle( symname, NULL, 0,
						&status );
				if( status == 0 && tmp )
					symname = tmp;
#endif

				veejay_msg(VEEJAY_MSG_INFO,"\t\t%d\t: %p <%s+%lu> (%s)",
						++f,
						ip,
						symname,
						(unsigned long) ip - (unsigned long) info.dli_saddr,
						info.dli_fname );
#ifndef NO_CPP_DEMANGLE
				if(tmp)
					free(tmp);
#endif

				if(info.dli_sname && !strcmp(info.dli_sname, "main"))
					break;

				ip = bp[1];
				bp = (void**) bp[0];

			}

			break;
	}

#if defined(SIGSEGV_STACK_IA64) || defined(SIGSEGV_STACK_X86)
#if defined(SIGSEGV_STACK_IA64)
	veejay_print_backtrace(puc->uc_mcontext.gregs[REG_RIP]);	
#elif defined(SIGSEGV_STACK_X86)
	veejay_print_backtrace(puc->uc_mcontext.gregs[REG_EIP]);
#endif
#endif
	//@ Bye
	veejay_msg(VEEJAY_MSG_ERROR, "Bugs compromised the system.");

	report_bug();

	_exit(0);
}

void veejay_set_debug_level(int level)
{
	if(level)
	{
		_debug_level = 1;
	}
	else
	{
		_debug_level = 0;
	}

    	mjpeg_default_handler_verbosity( _debug_level ? 1:0);
}

void veejay_set_colors(int l)
{
	if(l) _color_level = 1;
	else _color_level = 0;
}

int	veejay_is_colored()
{
	return _color_level;
}

void veejay_silent()
{
	_no_msg = 1;
}

int veejay_is_silent()
{
	if(_no_msg) return 1;          
	return 0;
}

void veejay_msg(int type, const char format[], ...)
{
    char prefix[128];
    char buf[1024];
    va_list args;
    int line = 0;
    FILE *out = (_no_msg ? stderr: stdout );
    if( type != VEEJAY_MSG_ERROR && _no_msg )
		return;

    if( !_debug_level && type == VEEJAY_MSG_DEBUG )
	return ; // bye

    // parse arguments
    va_start(args, format);
    vsnprintf(buf, sizeof(buf) - 1, format, args);

#ifdef STRICT_CHECKING
	
	struct tm *nowtm = NULL;
	
	gettimeofday( &timenow, NULL );
	if( !timerdy  ) {
		memcpy( &_start_time, &timenow, sizeof(struct timeval));
		timerdy = 1;
		timeval_subtract( &timenow,&timenow,&_start_time);
		nowtm = localtime(&timenow);
		if(nowtm->tm_hour > 0 )
			_start_time_offset = nowtm->tm_hour; // wat
	}
	else {
		timeval_subtract( &timenow, &timenow, &_start_time );
		nowtm = localtime(&timenow);
	}

	nowtm->tm_hour -= _start_time_offset;

	strftime( tmbuf,sizeof(tmbuf), "%H:%M:%S",nowtm );
	snprintf( timebuf, sizeof(timebuf), "%s.%06d", tmbuf, timenow.tv_usec );

 /*
    if(!_message_his_status)
    {
	veejay_memset( &_message_history , 0 , sizeof(vj_msg_hist));
	_message_his_status = 1;
    }
*/
    if(_color_level)
    {
	  switch (type) {
	    case 2: //info
		sprintf(prefix, "%s %s I: ", TXT_GRE,timebuf);
		break;
	    case 1: //warning
		sprintf(prefix, "%s %s W: ", TXT_YEL,timebuf);
		break;
	    case 0: // error
		sprintf(prefix, "%s %s E: ", TXT_RED,timebuf);
		break;
	    case 3:
	        line = 1;
		break;
	    case 4: // debug
		sprintf(prefix, "%s %s D: ", TXT_BLU,timebuf);
		break;
	 }

 	 if(!line)
	     fprintf(out,"%s %s %s\n",prefix, buf, TXT_END);
	     else
	     fprintf(out,"%s%s%s", TXT_GRE, buf, TXT_END );
/* 
	if( _message_history.w_index < MAX_LINES )
	{
		if(type == 3)
			sprintf(sline, "%s", buf );
		else
			sprintf( sline, "%s\n", buf );	
		_message_history.msg[_message_history.w_index ++ ] = strndup(sline,200);
	}*/
     }
     else
     {
	   switch (type) {
	    case 2: //info
		sprintf(prefix, "%s I: ",timebuf);
		break;
	    case 1: //warning
		sprintf(prefix, "%s W: ",timebuf);
		break;
	    case 0: // error
		sprintf(prefix, "%s E: ",timebuf);
		break;
	    case 3:
	        line = 1;
		break;
	    case 4: // debug
		sprintf(prefix, "%s D: ",timebuf);
		break;
	   }

	   if(!line)
	     fprintf(out,"%s %s\n", prefix, buf);
	     else
	     fprintf(out,"%s", buf );

	/*  if( _message_history.w_index < MAX_LINES )
	  {
		if(type == 3 )
			sprintf(sline, "%s", buf );
		else
			sprintf(sline, "%s\n", buf );
		_message_history.msg[_message_history.w_index ++ ] = strdup(sline);
	  }*/
     }
#else
    if(_color_level)
    {
	  switch (type) {
	    case 2: //info
		sprintf(prefix, "%sI: ", TXT_GRE);
		break;
	    case 1: //warning
		sprintf(prefix, "%sW: ", TXT_YEL);
		break;
	    case 0: // error
		sprintf(prefix, "%sE: ", TXT_RED);
		break;
	    case 3:
	        line = 1;
		break;
	    case 4: // debug
		sprintf(prefix, "%sD: ", TXT_BLU);
		break;
	 }

 	 if(!line)
	     fprintf(out,"%s %s %s\n",prefix, buf, TXT_END);
	     else
	     fprintf(out,"%s%s%s", TXT_GRE, buf, TXT_END );
/* 
	if( _message_history.w_index < MAX_LINES )
	{
		if(type == 3)
			sprintf(sline, "%s", buf );
		else
			sprintf( sline, "%s\n", buf );	
		_message_history.msg[_message_history.w_index ++ ] = strndup(sline,200);
	}*/
     }
     else
     {
	   switch (type) {
	    case 2: //info
		sprintf(prefix, "I: ");
		break;
	    case 1: //warning
		sprintf(prefix, "W: ");
		break;
	    case 0: // error
		sprintf(prefix, "E: ");
		break;
	    case 3:
	        line = 1;
		break;
	    case 4: // debug
		sprintf(prefix, "D: ");
		break;
	   }

	   if(!line)
	     fprintf(out,"%s %s\n", prefix, buf);
	     else
	     fprintf(out,"%s", buf );

	/*  if( _message_history.w_index < MAX_LINES )
	  {
		if(type == 3 )
			sprintf(sline, "%s", buf );
		else
			sprintf(sline, "%s\n", buf );
		_message_history.msg[_message_history.w_index ++ ] = strdup(sline);
	  }*/
     }

#endif
     va_end(args);
}

char *veejay_pop_messages(int *num_lines, int *total_len)
{
	char *res = NULL;
/*	if( _message_his_status == 0 )
		return res;
	if( _message_history.w_index == 0 )
		return res;
	int i;
	int len = 0;
	for( i = 0; i < _message_history.w_index ; i ++ )
		len += strlen( _message_history.msg[i] );
	if(len <= 0)
		return res;

	res = (char*) vj_malloc(sizeof(char) * (len+1) );
	if(!res)
		return NULL;
	bzero(res, len );
	*num_lines = i;

	for( i = 0; i < _message_history.w_index ; i ++ )
	{
		if( strlen(_message_history.msg[i]) > 0 )
		strcat( res, _message_history.msg[i] );
	}
	*total_len = len;
	_message_history.r_index ++;
*/
	return res;

}

int	veejay_keep_messages(void)
{
/*	if( _message_history.r_index )
		return 0;
*/
	return 1;
}

void	veejay_reap_messages(void)
{
/*	for( i = 0; i < _message_history.w_index ; i ++ )
	{
		if( _message_history.msg[i] ) 
		{
			free(_message_history.msg[i] );
			_message_history.msg[i] = NULL;
		}
	}

	_message_his_status = 0;
	_message_history.w_index = 0;
*/
}

int	veejay_get_file_ext( char *file, char *dst, int dlen)
{
	int len = strlen(file)-1;
	int i = 0;
	char tmp[dlen];
	memset( tmp, 0, dlen );
	while(len)
	{
		if(file[len] == '.')
		{
			if(i==0) return 0;
			int j;
			int k = 0;
			for(j = i-1; j >= 0;j--)
			{
			  dst[k] = tmp[j];
			 k ++;
			}
			return 1;
		}
		tmp[i] = file[len];
		i++;
		if( i >= dlen)
			return 0;
		len --;
	}
	return 0;
}

void veejay_strrep(char *s, char delim, char tok)
{
  unsigned int i;
  unsigned int len = strlen(s);
  if(!s) return;
  for(i=0; i  < len; i++)
  {
    if( s[i] == delim ) s[i] = tok;
  }
}

void	veejay_chomp_str( char *msg, int *nlen )
{
	int len = strlen( msg ) - 1;
	if(len > 0 )
	{
		if( msg[len] == '\n' )
		{
			msg[len] = '\0';
			*nlen = len;
		}
	}
}

void    report_bug(void)
{
    veejay_msg(VEEJAY_MSG_WARNING, "Please report this error to http://groups.google.com/group/veejay-discussion?hl=en");
    veejay_msg(VEEJAY_MSG_WARNING, "Send at least veejay's output and include the command(s) you have used to start it.");
	veejay_msg(VEEJAY_MSG_WARNING, "Also, please consider sending in the recovery files if any have been created.");
	veejay_msg(VEEJAY_MSG_WARNING, "If you compiled it yourself, please include information about your system.");

#ifdef STRICT_CHECKING
	veejay_msg(VEEJAY_MSG_WARNING, "Dumping core file to: core.%d",getpid() );
	
	char cmd[128];
	memset(cmd,0,sizeof(cmd));
	sprintf(cmd, "generate-core-file");
	int fd = open( "veejay.cmd", O_RDWR|O_CREAT );
	if(!fd) {
		veejay_msg(VEEJAY_MSG_ERROR,"Unable to write gdb batch commands, no core dump written. ");
	} else {
		int res = write( fd , cmd, strlen(cmd));
		close(fd);
		sprintf(cmd, "gdb -p %d -batch -x veejay.cmd", getpid());
		veejay_msg(VEEJAY_MSG_WARNING,"Please wait! Running command '%s'", cmd);
		system(cmd);
		veejay_msg(VEEJAY_MSG_WARNING, "Done!");
		veejay_msg(VEEJAY_MSG_INFO, "Please bzip2 and upload the coredump somewhere and tell us where to find it!");
	}
#endif
		

}