gdb/gdbserver/notif.h

   1 /* Notification to GDB.
   2    Copyright (C) 1989-2019 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 #ifndef GDBSERVER_NOTIF_H
  20 #define GDBSERVER_NOTIF_H
  21
  22 #include "target.h"
  23 #include "common/queue.h"
  24
  25 /* Structure holding information related to a single event.  We
  26    keep a queue of these to push to GDB.  It can be extended if
  27    the event of given notification contains more information.  */
  28
  29 typedef struct notif_event
  30 {
  31   /* C requires that a struct or union has at least one member.  */
  32   char dummy;
  33 } *notif_event_p;
  34
  35 DECLARE_QUEUE_P (notif_event_p);
  36
  37 /* A type notification to GDB.  An object of 'struct notif_server'
  38    represents a type of notification.  */
  39
  40 typedef struct notif_server
  41 {
  42   /* The name of ack packet, for example, 'vStopped'.  */
  43   const char *ack_name;
  44
  45   /* The notification packet, for example, '%Stop'.  Note that '%' is
  46      not in 'notif_name'.  */
  47   const char *notif_name;
  48
  49   /* A queue of events to GDB.  A new notif_event can be enque'ed
  50      into QUEUE at any appropriate time, and the notif_reply is
  51      deque'ed only when the ack from GDB arrives.  */
  52   QUEUE (notif_event_p) *queue;
  53
  54   /* Write event EVENT to OWN_BUF.  */
  55   void (*write) (struct notif_event *event, char *own_buf);
  56 } *notif_server_p;
  57
  58 extern struct notif_server notif_stop;
  59
  60 int handle_notif_ack (char *own_buf, int packet_len);
  61 void notif_write_event (struct notif_server *notif, char *own_buf);
  62
  63 void notif_push (struct notif_server *np, struct notif_event *event);
  64 void notif_event_enque (struct notif_server *notif,
  65                         struct notif_event *event);
  66
  67 void initialize_notif (void);
  68
  69 #endif /* GDBSERVER_NOTIF_H */