gdb/gdbserver/notif.h

   1 /* Notification to GDB.
   2    Copyright (C) 1989-2014 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #include "ptid.h"
  20 #include "target.h"
  21 #include "queue.h"
  22
  23 /* Structure holding information related to a single event.  We
  24    keep a queue of these to push to GDB.  It can be extended if
  25    the event of given notification contains more information.  */
  26
  27 typedef struct notif_event
  28 {
  29   /* C requires that a struct or union has at least one member.  */
  30   char dummy;
  31 } *notif_event_p;
  32
  33 DECLARE_QUEUE_P (notif_event_p);
  34
  35 /* A type notification to GDB.  An object of 'struct notif_server'
  36    represents a type of notification.  */
  37
  38 typedef struct notif_server
  39 {
  40   /* The name of ack packet, for example, 'vStopped'.  */
  41   const char *ack_name;
  42
  43   /* The notification packet, for example, '%Stop'.  Note that '%' is
  44      not in 'notif_name'.  */
  45   const char *notif_name;
  46
  47   /* A queue of events to GDB.  A new notif_event can be enque'ed
  48      into QUEUE at any appropriate time, and the notif_reply is
  49      deque'ed only when the ack from GDB arrives.  */
  50   QUEUE (notif_event_p) *queue;
  51
  52   /* Write event EVENT to OWN_BUF.  */
  53   void (*write) (struct notif_event *event, char *own_buf);
  54 } *notif_server_p;
  55
  56 extern struct notif_server notif_stop;
  57
  58 int handle_notif_ack (char *own_buf, int packet_len);
  59 void notif_write_event (struct notif_server *notif, char *own_buf);
  60
  61 void notif_push (struct notif_server *np, struct notif_event *event);
  62 void notif_event_enque (struct notif_server *notif,
  63                         struct notif_event *event);
  64
  65 void initialize_notif (void);