/*
 * This file is part of mtrace.
 * Copyright (C) 2015 Stefani Seibold <stefani@seibold.net>
 *  This file is based on the ltrace source
 *   Copyright (C) 2010,2011,2012 Petr Machata, Red Hat Inc.
 *   Copyright (C) 2010 Joe Damato
 *   Copyright (C) 1998,2001,2008,2009 Juan Cespedes
 *
 * 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., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

#ifndef _INC_TASK_H
#define _INC_TASK_H

#include "config.h"

#include <sys/time.h>

#include "forward.h"
#include "mtrace.h"
#include "dict.h"
#include "event.h"
#include "sysdep.h"
#include "arch.h"
#include "list.h"
#include "rbtree.h"
#include "report.h"

struct task {
	struct rb_node pid_node;	/* red/black tree node for fast pid -> struct task */

	pid_t pid;

	unsigned int stopped:1;
	unsigned int traced:1;
	unsigned int was_stopped:1;
	unsigned int is_64bit:1;
	
	/* Dictionary of breakpoints */
	struct dict *breakpoints;

	struct library_symbol *libsym;
	struct context context;		/* process context (registers, stack) */
	struct context saved_context;	/* context for fetch_param() */
	struct breakpoint *breakpoint;

	unsigned int threads;		/* set in leader: number of threads including the leader */
	unsigned int threads_stopped;	/* set in leader: number of stopped threads including the leader */

	/* linked list of libraries, the first entry is the executable itself */
	struct list_head libraries_list;

	void *backtrace;

	/* struct task chaining. */
	struct list_head leader_list;

	/* points to the leader thread of the POSIX.1 task */
	struct task *leader;

	/* Thread chaining to leader */
	struct list_head task_list;

	/* current pendig event */
	struct event event;

	/* pointer to a breakpoint which was interrupt by a signal during skip */
	struct breakpoint *skip_bp;

	/* only used in leader: bit mask for used hw breakpoints */
	unsigned long hw_bp_mask;

	/* array of addresses of hw breakpoints */
	struct breakpoint *hw_bp[HW_BREAKPOINTS];

	/* os specific task data */
#ifdef OS_HAVE_PROCESS_DATA
	struct os_task_data os;
#endif

	/* arch specific task data */
#ifdef TASK_HAVE_PROCESS_DATA
	struct arch_task_data arch;
#endif
};

/* PROC underwent an exec.  This is a bit like task_destroy
 * followed by task_init, except that some state is kept and the
 * process doesn't lose it's place in the list of processes.  */
int process_exec(struct task *task);

struct task *task_new(pid_t pid, int traced);

struct task *task_create(const char *command, char **argv);

void open_pid(pid_t pid);

struct task *pid2task(pid_t pid);

/* Clone the contents of PROC
 * Returns the new task pointer on succes or NULL on failure.  */
struct task *task_clone(struct task *task, pid_t pid);

/* get first process of leader list */
struct task *get_first_process(void);

/* Iterate through the leader tasks that mtrace currently traces. */
void each_process(void (*cb)(struct task *task));

/* Iterate through list of tasks of a given leader task asks */
void each_task(struct task *leader, void (*cb)(struct task *task, void *data), void *data);

/* Iterate through all allocated pids */
void each_pid(void (*cb)(struct task *task));

/* Remove task from the list of traced processes, drop any events in the event queue, destroy it and free memory. */
void remove_task(struct task *task);

/* Remove all threads of the process from the list of traced processes, drop any events in the event queue, destroy it and free memory. */
void remove_proc(struct task *leader);

/* return true if no more task is traced */
int task_list_empty(void);

#endif