Update copyright to LGPL on all files
[dyninst.git] / common / h / BG_AuxvReader.h
1 /*
2  * Copyright (c) 1996-2009 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31 #ifndef BG_AUXV_READER_H
32 #define BG_AUXV_READER_H
33
34 #include <string>
35 #include "auxvtypes.h"
36
37 #if defined(os_bg_ion) && defined(os_bgp)
38 #include "external/bluegene/bgp-debugger-interface.h"
39 #else
40 #error "BUILD ERROR: BG_AuxvReader.h compiled in non-bgp ion build."
41 #endif // defined(os_bg_ion) && defined(os_bgp)
42
43 // Type for elements in the auxiliary vector.
44 struct auxv_element {
45   uint32_t type;
46   uint32_t value;
47   const char *name() { return auxv_type_to_string(type); }
48 };
49
50 ///
51 /// Class for using CIO debugger interface to read auxv vectors.  This will read
52 /// all the vectors in order until there's nothing left.  Sample usage:
53 ///
54 /// BG_AuxvReader reader(mypid);
55 /// while (reader.hasNext()) {
56 ///   if (!reader.good()) {
57 ///     // handle error
58 ///   }
59 ///   auxv_element elt = reader.next();
60 ///   // do stuff with elt
61 /// }
62 ///
63 /// Note that the process on the compute node *must be stopped* for this to work
64 /// properly.  User of this class is responsible for stopping/restarting the process.
65 ///
66 class BG_AuxvReader {
67 private:
68   const size_t buffer_size;                    /// buffer size for chunks read from CN
69   const int pid;                               /// process to read from
70   size_t fetch_offset;                         /// offset within aux vectors to fetch
71   size_t read_offset;                          /// local offset in buffer to read from
72   DebuggerInterface::BG_Debugger_Msg ack_msg;  /// BG msg containing fetched auxv buffer.
73
74   const char *error;                                /// set if we encounter an error while reading.
75   auxv_element elt;                            /// Last element read
76   
77   void check_buffer();                         // checks whether buffer needs refilling.
78
79 public:
80   /// Construct a new reader for the specified process. PID is according to MPIR proctable.
81   BG_AuxvReader(int _pid);
82   ~BG_AuxvReader();
83
84   bool good();              /// Whether we encountered an error communicating wtih CIOD
85   const char *error_msg();  /// Message associated with the last error.
86   bool has_next();          /// Whether there are more auxv_elements to read.
87   auxv_element next();      /// Gets the next auxv element
88 };
89
90 #endif //BG_AUXV_READER_H