log.h File Reference

Go to the source code of this file.

Macros
#define	panic   gw_panic

Enumerations
enum	output_level {   GW_DEBUG, GW_INFO, GW_WARNING, GW_ERROR,   GW_PANIC, GW_BACKTRACE }
enum	excl_state { GW_NON_EXCL, GW_EXCL }

Functions
void	log_init (void)
void	log_shutdown (void)
void	gw_panic (int, const char *,...) PRINTFLIKE(2
void void	gw_backtrace (void **, size_t, int)
void	error (int, const char *,...) PRINTFLIKE(2
void void	warning (int, const char *,...) PRINTFLIKE(2
void void void	info (int, const char *,...) PRINTFLIKE(2
void void void void	debug (const char *, int, const char *,...) PRINTFLIKE(3
void void void void void	log_set_debug_places (const char *places)
void	log_set_output_level (enum output_level level)
void	log_set_log_level (enum output_level level)
void	log_set_syslog_facility (char *facility)
void	log_set_syslog (const char *ident, int syslog_level)
int	log_open (char *filename, int level, enum excl_state excl)
void	log_reopen (void)
void	log_close_all (void)
void	log_thread_to (int idx)

Macro Definition Documentation

panic

#define panic   gw_panic

Definition at line 87 of file log.h.

Referenced by accept_thread(), at2_detect_modem_type(), at2_read_modems(), bb_smscconn_receive(), become_daemon(), cfg_get_group_checksum(), cfg_get_real(), cfg_read(), check(), check_args(), check_comparisons(), client(), client_destroy(), client_session(), conn_claim(), connect_to_bearerbox(), convert(), convert_wmlscript_to_wmlscriptc(), create_onetrans(), create_oneuser(), dlr_db_fields_create(), dlr_init(), dlr_init_spool(), emi2_handle_smscreq(), emi2_idleprocessing(), entity_read(), generic_init(), get_and_set_debugs(), getthreadinfo(), gw_check_calloc(), gw_check_claim_area(), gw_check_free(), gw_check_malloc(), gw_check_realloc(), gw_native_calloc(), gw_native_malloc(), gw_native_realloc(), gw_rwlock_create(), gw_rwlock_destroy(), gw_rwlock_init_static(), gw_rwlock_rdlock(), gw_rwlock_unlock(), gw_rwlock_wrlock(), gwthread_init(), handle_action(), handle_reply(), handle_transaction(), handler(), http_use_proxy(), httpadmin_start(), httpd_emu_create(), init_batch(), init_bearerbox(), init_reroute(), init_smppbox(), init_smsbox(), init_smsc_routes(), init_sqlbox(), init_wapbox(), ip_allowed_by_ppg(), lock(), main(), main_for_extract(), main_for_list_add_and_delete(), main_for_producer_and_consumer(), main_thread(), msg_pack(), mutex_destroy(), mutex_lock_real(), mutex_trylock_real(), mutex_unlock_real(), new_thread(), octstr_imm(), parachute_init_signals(), parachute_start(), post_content_create(), proxy_thread(), push_content_create(), radius_acct_init(), radius_type_convert(), read_ppg_config(), read_test_ppg_config(), receive_request(), record_allocation(), restore_user_signals(), run_requests(), run_smppbox(), run_sqlbox(), semaphore_create(), semaphore_destroy(), semaphore_getvalue(), send_post(), server(), setup_official_name(), signal_handler(), smpp_emu(), smpp_emu_handle_pdu(), smppboxc_run(), smsbox_start(), smsbox_thread(), smsboxc_run(), smsc2_start(), smsc_emu_create(), smsc_smasi_create(), smsc_smpp_create(), smscconn_create(), sqlboxc_run(), start_http_thread(), start_wap(), start_wapbox(), store_file_init(), store_file_load(), udp_addwdp_from_client(), udp_addwdp_from_server(), unlock(), unlock_in_real(), unlock_out_real(), unpack_accept_language_general_form(), unpack_cache_directive(), unpack_field_name(), unpack_parameter(), wait_for_client(), wap_event_create_real(), wap_event_destroy(), wap_event_duplicate(), wap_event_name(), wapbox_start(), wapboxc_run(), write_pid_file(), wsp_pdu_create(), wsp_pdu_destroy(), wsp_pdu_pack(), wsp_unpack_accept_charset_general_form(), wsp_unpack_accept_general_form(), wsp_unpack_well_known_field(), and wtp_pdu_pack().

Enumeration Type Documentation

excl_state

enum excl_state

Enumerator
GW_NON_EXCL
GW_EXCL

Definition at line 73 of file log.h.

                {
    GW_NON_EXCL, GW_EXCL
};

output_level

enum output_level

Enumerator
GW_DEBUG
GW_INFO
GW_WARNING
GW_ERROR
GW_PANIC
GW_BACKTRACE

Definition at line 68 of file log.h.

                  {
    GW_DEBUG, GW_INFO, GW_WARNING, GW_ERROR, GW_PANIC, GW_BACKTRACE
};

Function Documentation

debug()

void void void void debug	(	const char *	,
		int	,
		const char *	,
			...
	)

error()

void error	(	int	,
		const char *	,
			...
	)

gw_backtrace()

void void gw_backtrace	(	void **	,
		size_t	,
		int
	)

Definition at line 599 of file log.c.

References gw_native_free(), and size.

Referenced by fatal_handler(), and gw_panic().

{
#if HAVE_BACKTRACE
    void *frames[50];
    size_t i;
    char **strings;

    if (stack_frames == NULL) {
        stack_frames = frames;
        size = backtrace(stack_frames, sizeof(frames) / sizeof(void*));
    }

    strings = backtrace_symbols(stack_frames, size);

    if (strings) {
        for (i = 0; i < size; i++)
            gw_panic_output(0, "%s", strings[i]);
    }
    else { /* hmm, no memory available */
        for (i = 0; i < size; i++)
            gw_panic_output(0, "%p", stack_frames[i]);
    }

    /*
     * Note: we must call gw_native_free directly because if gw_free points to gw_check_free we could
     *       panic's and we have endless loop with SEGFAULT at the end.
     */
    gw_native_free(strings);
#endif
}

gw_panic()

void gw_panic	(	int	,
		const char *	,
			...
	)

info()

void void void info	(	int	,
		const char *	,
			...
	)

log_close_all()

void log_close_all

(

void

)

Definition at line 341 of file log.c.

References closelog(), dosyslog, file, filename, gw_rwlock_unlock(), gw_rwlock_wrlock(), logfiles, num_logfiles, and rwlock.

Referenced by get_and_set_debugs(), log_shutdown(), and main().

{
    /*
     * Writer lock.
     */
    gw_rwlock_wrlock(&rwlock);

    while (num_logfiles > 0) {
        --num_logfiles;
        if (logfiles[num_logfiles].file != stderr && logfiles[num_logfiles].file != NULL) {
            int i;
            /* look for the same filename and set file to NULL */
            for (i = num_logfiles - 1; i >= 0; i--) {
                if (strcmp(logfiles[num_logfiles].filename, logfiles[i].filename) == 0)
                    logfiles[i].file = NULL;
            }
            fclose(logfiles[num_logfiles].file);
            logfiles[num_logfiles].file = NULL;
        }
    }

    /*
     * Unlock writer.
     */
    gw_rwlock_unlock(&rwlock);

    /* close syslog if used */
    if (dosyslog) {
        closelog();
        dosyslog = 0;
    }
}

log_init()

void log_init

(

void

)

Definition at line 230 of file log.c.

References add_stderr(), gw_rwlock_init_static(), rwlock, thread_to, and THREADTABLE_SIZE.

Referenced by gwlib_init().

{
    unsigned long i;

    /* Initialize rwlock */
    gw_rwlock_init_static(&rwlock);

    /* default all possible thread to logging index 0, stderr */
    for (i = 0; i < THREADTABLE_SIZE; i++) {
        thread_to[i] = 0;
    }

    add_stderr();
}

log_open()

int log_open	(	char *	filename,
		int	level,
		enum excl_state	excl
	)

Definition at line 375 of file log.c.

References error(), filename, gw_rwlock_unlock(), gw_rwlock_wrlock(), info(), logfiles, MAX_LOGFILES, num_logfiles, and rwlock.

Referenced by get_and_set_debugs(), init_bearerbox(), init_smppbox(), init_smsbox(), init_sqlbox(), init_wapbox(), main(), and smscconn_create().

{
    FILE *f = NULL;
    int i;
    
    gw_rwlock_wrlock(&rwlock);

    if (num_logfiles == MAX_LOGFILES) {
        gw_rwlock_unlock(&rwlock);
        error(0, "Too many log files already open, not adding `%s'",
              filename);
        return -1;
    }

    if (strlen(filename) > FILENAME_MAX) {
        gw_rwlock_unlock(&rwlock);
        error(0, "Log filename too long: `%s'.", filename);
        return -1;
    }

    /*
     * Check if the file is already opened for logging.
     * If there is an open file, then assign the file descriptor
     * that is already existing for this log file.
     */
    for (i = 0; i < num_logfiles && f == NULL; ++i) {
        if (strcmp(logfiles[i].filename, filename) == 0)
            f = logfiles[i].file;
    }

    /* if not previously opened, then open it now */
    if (f == NULL) {
        f = fopen(filename, "a");
        if (f == NULL) {
            gw_rwlock_unlock(&rwlock);
            error(errno, "Couldn't open logfile `%s'.", filename);
            return -1;
        }
    }
    
    logfiles[num_logfiles].file = f;
    logfiles[num_logfiles].minimum_output_level = level;
    logfiles[num_logfiles].exclusive = excl;
    strcpy(logfiles[num_logfiles].filename, filename);
    ++num_logfiles;
    i = num_logfiles - 1;
    gw_rwlock_unlock(&rwlock);

    info(0, "Added logfile `%s' with level `%d'.", filename, level);

    return i;
}

log_reopen()

void log_reopen

(

void

)

Definition at line 297 of file log.c.

References error(), file, filename, found, gw_rwlock_unlock(), gw_rwlock_wrlock(), logfiles, num_logfiles, and rwlock.

Referenced by main(), and signal_handler().

{
    int i, j, found;

    /*
     * Writer lock.
     */
    gw_rwlock_wrlock(&rwlock);

    for (i = 0; i < num_logfiles; ++i) {
        if (logfiles[i].file != stderr) {
            found = 0;

            /*
             * Reverse seek for allready reopened logfile.
             * If we find a previous file descriptor for the same file
             * name, then don't reopen that duplicate, but assign the
             * file pointer to it.
             */
            for (j = i-1; j >= 0 && found == 0; j--) {
                if (strcmp(logfiles[i].filename, logfiles[j].filename) == 0) {
                    logfiles[i].file = logfiles[j].file;
                    found = 1;
                }
            }
            if (found)
                continue;
            if (logfiles[i].file != NULL)
                fclose(logfiles[i].file);
            logfiles[i].file = fopen(logfiles[i].filename, "a");
            if (logfiles[i].file == NULL) {
                error(errno, "Couldn't re-open logfile `%s'.",
                      logfiles[i].filename);
            }
        }
    }

    /*
     * Unlock writer.
     */
    gw_rwlock_unlock(&rwlock);
}

log_set_debug_places()

void void void void void log_set_debug_places

(

const char *

places

)

Definition at line 746 of file log.c.

References loggable_places, MAX_LOGGABLE_PLACES, and num_places.

Referenced by get_and_set_debugs().

{
    char *p;
    
    p = strtok(gw_strdup(places), " ,");
    num_places = 0;
    while (p != NULL && num_places < MAX_LOGGABLE_PLACES) {
        loggable_places[num_places++] = p;
        p = strtok(NULL, " ,");
    }
}

log_set_log_level()

void log_set_log_level

(

enum output_level

level

)

Definition at line 265 of file log.c.

References file, filename, info(), logfiles, and num_logfiles.

Referenced by config_reload(), and httpd_loglevel().

{
    int i;

    /* change everything but stderr */
    for (i = 0; i < num_logfiles; ++i) {
        if (logfiles[i].file != stderr) {
            logfiles[i].minimum_output_level = level;
            info(0, "Changed logfile `%s' to level `%d'.", logfiles[i].filename, level);
        }
    }
}

log_set_output_level()

void log_set_output_level

(

enum output_level

level

)

Definition at line 253 of file log.c.

References file, logfiles, and num_logfiles.

Referenced by get_and_set_debugs(), and main().

{
    int i;

    for (i = 0; i < num_logfiles; ++i) {
        if (logfiles[i].file == stderr) {
            logfiles[i].minimum_output_level = level;
            break;
        }
    }
}

log_set_syslog()

void log_set_syslog	(	const char *	ident,
		int	syslog_level
	)

Definition at line 284 of file log.c.

References debug(), dosyslog, LOG_PID, openlog(), syslogfacility, and sysloglevel.

Referenced by get_and_set_debugs(), init_bearerbox(), init_smsbox(), init_wapbox(), and remove_pid_file().

{
    if (ident == NULL)
        dosyslog = 0;
    else {
        dosyslog = 1;
        sysloglevel = syslog_level;
        openlog(ident, LOG_PID, syslogfacility);
        debug("gwlib.log", 0, "Syslog logging enabled.");
    }
}

log_set_syslog_facility()

void log_set_syslog_facility

(

char *

facility

)

Definition at line 278 of file log.c.

References decode(), and syslogfacility.

Referenced by init_bearerbox(), init_smsbox(), and init_wapbox().

{
    if (facility != NULL)
        syslogfacility = decode(facility);
}

log_shutdown()

void log_shutdown

(

void

)

Definition at line 245 of file log.c.

References gw_rwlock_destroy(), log_close_all(), and rwlock.

Referenced by gwlib_shutdown().

{
    log_close_all();
    /* destroy rwlock */
    gw_rwlock_destroy(&rwlock);
}

log_thread_to()

void log_thread_to

(

int

idx

)

Definition at line 759 of file log.c.

References filename, info(), logfiles, minimum_output_level, num_logfiles, thread_slot, thread_to, and warning().

Referenced by at2_device_thread(), cgw_listener(), cgw_sender(), emi2_listener(), emi2_sender(), fake_listener(), httpsmsc_receiver(), httpsmsc_send_cb(), httpsmsc_sender(), io_thread(), smasi_thread(), wrapper_receiver(), and wrapper_sender().

{
    long thread_id = thread_slot();

    if (idx > 0) {
        info(0, "Logging thread `%ld' to logfile `%s' with level `%d'.", 
             thread_id, logfiles[idx].filename, logfiles[idx].minimum_output_level);
        thread_to[thread_id] = idx;
    } else if (idx != 0 && num_logfiles > 0) {
        warning(0, "Logging thread `%ld' to logfile `%s' with level `%d'.",
                thread_id, logfiles[0].filename, logfiles[0].minimum_output_level);
    }
}

warning()

void void warning	(	int	,
		const char *	,
			...
	)