binutils-gdb/gdb/gdbserver/inferiors.h

/* Inferior process information for the remote server for GDB.
   Copyright (C) 1993-2017 Free Software Foundation, Inc.

   This file is part of GDB.

   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 3 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, see <http://www.gnu.org/licenses/>.  */

#ifndef INFERIORS_H
#define INFERIORS_H

#include "gdb_vecs.h"
#include <list>

/* Generic information for tracking a list of ``inferiors'' - threads,
   processes, etc.  */
struct inferior_list
{
  struct inferior_list_entry *head;
  struct inferior_list_entry *tail;
};
struct inferior_list_entry
{
  ptid_t id;
  struct inferior_list_entry *next;
};

struct thread_info;
struct regcache;
struct target_desc;
struct sym_cache;
struct breakpoint;
struct raw_breakpoint;
struct fast_tracepoint_jump;
struct process_info_private;

struct process_info
{
  /* This process' pid.  */
  int pid;

  /* Nonzero if this child process was attached rather than
     spawned.  */
  int attached;

  /* True if GDB asked us to detach from this process, but we remained
     attached anyway.  */
  int gdb_detached;

  /* The symbol cache.  */
  struct sym_cache *symbol_cache;

  /* The list of memory breakpoints.  */
  struct breakpoint *breakpoints;

  /* The list of raw memory breakpoints.  */
  struct raw_breakpoint *raw_breakpoints;

  /* The list of installed fast tracepoints.  */
  struct fast_tracepoint_jump *fast_tracepoint_jumps;

  /* The list of syscalls to report, or just a single element, ANY_SYSCALL,
     for unfiltered syscall reporting.  */
  VEC (int) *syscalls_to_catch;

  const struct target_desc *tdesc;

  /* Private target data.  */
  struct process_info_private *priv;
};

/* Get the pid of PROC.  */

static inline int
pid_of (const process_info *proc)
{
  return proc->pid;
}

/* Return a pointer to the process that corresponds to the current
   thread (current_thread).  It is an error to call this if there is
   no current thread selected.  */

struct process_info *current_process (void);
struct process_info *get_thread_process (const struct thread_info *);

extern std::list<process_info *> all_processes;

void add_inferior_to_list (struct inferior_list *list,
			   struct inferior_list_entry *new_inferior);
void for_each_inferior (struct inferior_list *list,
			void (*action) (struct inferior_list_entry *));

void for_each_inferior_with_data
  (struct inferior_list *list,
   void (*action) (struct inferior_list_entry *, void *),
   void *data);

void clear_inferior_list (struct inferior_list *list);

int one_inferior_p (struct inferior_list *list);

/* Helper for ALL_INFERIORS_TYPE.  Gets the next element starting at
   CUR, if CUR is not NULL.  */
#define A_I_NEXT(type, list, cur)					\
  ((cur) != NULL							\
   ? (type *) ((struct inferior_list_entry *) cur)->next		\
   : NULL)

/* Iterate over all inferiors of type TYPE in LIST, open loop
   style.  */
#define ALL_INFERIORS_TYPE(type, list, cur, tmp)				\
  for ((cur) = (type *) (list)->head, (tmp) = A_I_NEXT (type, list, cur); \
       (cur) != NULL;							\
       (cur) = (tmp), (tmp) = A_I_NEXT (type, list, cur))

/* Iterate over all inferiors in LIST, open loop style.  */
#define ALL_INFERIORS(list, cur, tmp)				\
  ALL_INFERIORS_TYPE (struct inferior_list_entry, list, cur, tmp)

/* Invoke FUNC for each process.  */

template <typename Func>
static void
for_each_process (Func func)
{
  std::list<process_info *>::iterator next, cur = all_processes.begin ();

  while (cur != all_processes.end ())
    {
      next = cur;
      next++;
      func (*cur);
      cur = next;
    }
}

/* Find the first process for which FUNC returns true.  Return NULL if no
   process satisfying FUNC is found.  */

template <typename Func>
static process_info *
find_process (Func func)
{
  std::list<process_info *>::iterator next, cur = all_processes.begin ();

  while (cur != all_processes.end ())
    {
      next = cur;
      next++;

      if (func (*cur))
        return *cur;

      cur = next;
    }

  return NULL;
}

extern struct thread_info *current_thread;
void remove_inferior (struct inferior_list *list,
		      struct inferior_list_entry *entry);

struct inferior_list_entry *get_first_inferior (struct inferior_list *list);

/* Return the first process in the processes list.  */
struct process_info *get_first_process (void);

struct process_info *add_process (int pid, int attached);
void remove_process (struct process_info *process);
struct process_info *find_process_pid (int pid);
int have_started_inferiors_p (void);
int have_attached_inferiors_p (void);

void clear_inferiors (void);
struct inferior_list_entry *find_inferior
     (struct inferior_list *,
      int (*func) (struct inferior_list_entry *,
		   void *),
      void *arg);
struct inferior_list_entry *find_inferior_id (struct inferior_list *list,
					      ptid_t id);
struct inferior_list_entry *
  find_inferior_in_random (struct inferior_list *,
			   int (*func) (struct inferior_list_entry *,
					void *),
			   void *arg);

void *thread_target_data (struct thread_info *);
struct regcache *thread_regcache_data (struct thread_info *);
void set_thread_regcache_data (struct thread_info *, struct regcache *);

#endif /* INFERIORS_H */