cscommon.h

   1 // Common functions and macros used by the compile-server and its client.
   2 #ifndef CSCOMMON_H
   3 #define CSCOMMON_H 1
   4
   5 #if HAVE_NSS
   6 extern "C"
   7 {
   8 #include <ssl.h>
   9 }
  10 #endif
  11
  12 // Versioning system for the protocol used for communication between the compile-server and client.
  13 // The original version is 1.0. After that, we use the systemtap release number.
  14 //
  15 // By Policy:
  16 //   - All servers are backward compatible with clients. Servers adapt to the protocol version
  17 //     of the client.
  18 //   - All clients are backward compatible with servers. Clients adapt to the protocol version
  19 //     of the server. Warnings are issued for servers lacking features.
  20 //
  21 // Features:
  22 //   Version 1.0
  23 //     Original version
  24 //   Versions 1.6 and higher
  25 //     Client:
  26 //       - Passes localization variables to the server in the file client_tmpdir + "/locale"
  27 //       - Looks for the uprobes module in server_response + "/uprobes"
  28 //       - No longer needs to remove stap's "Keeping temporary directory ..." message from
  29 //         the server's stderr response.
  30 //       - Looks for 'version' tag in server's avahi record and does not automatically connect to
  31 //         an incompatible server. Also prefers newer servers over older ones.
  32 //     Server:
  33 //       - Applies localization variables passed from the client to stap during translation.
  34 //       - Looks for the uprobes module in server_response + "/uprobes"
  35 //       - Uses --tmpdir to specify temp directory to be used by stap, instead of -k, in order to
  36 //         avoid parsing error messages in search of stap's randomly-generated temp dir.
  37 //       - Advertises its protocol version using a 'version' tag in avahi.
  38 //
  39 #define CURRENT_CS_PROTOCOL_VERSION VERSION
  40
  41 struct cs_protocol_version
  42 {
  43   cs_protocol_version (const char *v = "1.0") : v(0) { *this = v; }
  44   ~cs_protocol_version ();
  45   const cs_protocol_version &operator= (const char *v);
  46   bool operator< (const cs_protocol_version &that) const;
  47
  48   const char *v;
  49 };
  50
  51 #if HAVE_NSS
  52 extern int read_from_file (const std::string &fname, cs_protocol_version &data);
  53 extern std::string get_cert_serial_number (const CERTCertificate *cert);
  54 #endif
  55
  56 #endif // CSCOMMON_H