#722 Adding Host Name in Reporting #733

jatinx · 2018-11-29T16:42:02Z

PR with CLA signed

LebedevRI · 2018-11-29T16:44:32Z

src/reporter.cc

@@ -79,7 +82,7 @@ void BenchmarkReporter::PrintBasicContext(std::ostream *out,
 // No initializer because it's already initialized to NULL.
 const char *BenchmarkReporter::Context::executable_name;

-BenchmarkReporter::Context::Context() : cpu_info(CPUInfo::Get()) {}
+BenchmarkReporter::Context::Context() : cpu_info(CPUInfo::Get()), sys_info(SystemInformation::Get()) {}


LebedevRI · 2018-11-29T16:45:25Z

src/reporter.cc

@@ -38,6 +38,9 @@ void BenchmarkReporter::PrintBasicContext(std::ostream *out,

  Out << LocalDateTimeString() << "\n";

+  const SystemInformation &sys_info = context.sys_info;
+  Out << "System Name "<< sys_info.name << "\n";


Is this printed only for the json dumper, or for all of them?
Put differently, i don't think it should be in the console output, it is getting rather crowded already.

Removed from console and added only to JSON

LebedevRI · 2018-11-29T16:48:05Z

src/sysinfo.cc

+#endif
+  return str;
+#else
+  const unsigned COUNT = 64;


Just use HOST_NAME_MAX

HOST_NAME_MAX was not present on OSx, added local initialization.
The Job on Travis failed in config, can you please have a look at it?

LebedevRI · 2018-11-29T16:49:12Z

src/sysinfo.cc

+std::string GetSystemName() {
+#if defined(BENCHMARK_OS_WINDOWS)
+  std::string str;
+  const unsigned COUNT =  32767;


Again, why invent a magic number.
MAX_COMPUTERNAME_LENGTH+1 ?
And that being said, isn't that a rather too big to have as an array on stack?
Maybe use resized std::string?

LebedevRI · 2018-11-29T16:51:24Z

test/reporter_output_test.cc

@@ -16,6 +16,7 @@ static int AddContextCases() {
  AddCases(TC_ConsoleErr,
           {
               {"%int[-/]%int[-/]%int %int:%int:%int$", MR_Default},
+               {"System Name", MR_Next},


What is "system name"?
How is this different from "host name"?
If it is exactly the "host name", just use that term?

coveralls · 2018-11-29T17:02:00Z

Coverage increased (+0.06%) to 89.352% when pulling a651c6f on jatinx:HostName into eee8b05 on google:master.

AppVeyorBot · 2018-11-29T17:37:18Z

❌ Build benchmark 1584 failed (commit f70f5b39af by @jatinx)

AppVeyorBot · 2018-11-29T17:52:56Z

❌ Build benchmark 1585 failed (commit 7f7bb81561 by @jatinx)

AppVeyorBot · 2018-11-29T19:08:00Z

✅ Build benchmark 1586 completed (commit 7e957a81be by @jatinx)

AppVeyorBot · 2018-11-29T20:28:43Z

✅ Build benchmark 1587 completed (commit ffd0fa611f by @jatinx)

AppVeyorBot · 2018-11-30T03:07:19Z

✅ Build benchmark 1589 completed (commit 7fda14a749 by @jatinx)

jatinx · 2018-11-30T03:43:22Z

@LebedevRI did the asked changes, can you please have a look at it?

jatinx · 2018-12-07T05:10:40Z

@LebedevRI its been a week, is something wrong with my design, would like some comments if thats the case.

LebedevRI

Sorry, lost track.

LebedevRI · 2018-12-07T19:07:23Z

src/sysinfo.cc

+  str = hostname;
+#else
+  std::wstring wStr = hostname;
+  str = std::string(wStr.begin(), wStr.end());


Does this work? Is this already done elsewhere in the library?
wchar is bigger than char, what makes sure that this isn't lossy?

Using Standard wstring_convert to fix this

LebedevRI · 2018-12-07T19:08:19Z

src/sysinfo.cc

+#ifdef BENCHMARK_OS_MACOSX //Mac Doesnt have a copy for Host Name in it
+#define HOST_NAME_MAX 64
+#endif
+  const unsigned COUNT = HOST_NAME_MAX;


Can't you just use HOST_NAME_MAX directly, why do you need COUNT variable?

Removing unnecessary COUNT variable references, using macro directly

LebedevRI · 2018-12-07T19:12:20Z

src/sysinfo.cc

+  int retVal = gethostname(hostname, COUNT);
+  if (retVal != 0) return std::string("Unable to Get Host Name");
+  return std::string(hostname);
+#endif


And others?

benchmark/src/internal_macros.h

Lines 39 to 73 in 439d6b1

#if defined(__CYGWIN__)

#define BENCHMARK_OS_CYGWIN 1

#elif defined(_WIN32)

#define BENCHMARK_OS_WINDOWS 1

#if defined(__MINGW32__)

#define BENCHMARK_OS_MINGW 1

#endif

#elif defined(__APPLE__)

#define BENCHMARK_OS_APPLE 1

#include "TargetConditionals.h"

#if defined(TARGET_OS_MAC)

#define BENCHMARK_OS_MACOSX 1

#if defined(TARGET_OS_IPHONE)

#define BENCHMARK_OS_IOS 1

#endif

#endif

#elif defined(__FreeBSD__)

#define BENCHMARK_OS_FREEBSD 1

#elif defined(__NetBSD__)

#define BENCHMARK_OS_NETBSD 1

#elif defined(__OpenBSD__)

#define BENCHMARK_OS_OPENBSD 1

#elif defined(__linux__)

#define BENCHMARK_OS_LINUX 1

#elif defined(__native_client__)

#define BENCHMARK_OS_NACL 1

#elif defined(__EMSCRIPTEN__)

#define BENCHMARK_OS_EMSCRIPTEN 1

#elif defined(__rtems__)

#define BENCHMARK_OS_RTEMS 1

#elif defined(__Fuchsia__)

#define BENCHMARK_OS_FUCHSIA 1

#elif defined (__SVR4) && defined (__sun)

#define BENCHMARK_OS_SOLARIS 1

#endif

The only segregation needed here is POSIX vs non POSIX Compliance.
POSIX has gethostname

LebedevRI · 2018-12-07T19:14:38Z

src/sysinfo.cc

+  if (!GetComputerName(hostname, &DWCOUNT))
+    return std::string("Unable to Get Host Name");
+#ifndef UNICODE
+  str = hostname;


Are you 100.0% sure this is safe?
https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-getcomputernamew

On input, specifies the size of the buffer, in TCHARs. On output, the number of TCHARs copied to the destination buffer, not including the terminating null character.

I'd recommend to use 'returned' DWCOUNT.

Initialising TCHAR to null and only copying DWCOUNT into string.

LebedevRI · 2018-12-07T19:16:39Z

src/sysinfo.cc

+  str = hostname;
+#else
+  std::wstring wStr = hostname;
+  str = std::string(wStr.begin(), wStr.end());


Also, same comment about DWCOUNT.

LebedevRI · 2018-12-09T14:57:13Z

src/sysinfo.cc

+  str = std::string(wStr.begin(), wStr.end());
+#endif
+  return str;
+#else


Suggested change

#else

#else // defined(BENCHMARK_OS_WINDOWS)

// Catch-all POSIX block.

LebedevRI · 2018-12-09T14:57:24Z

src/sysinfo.cc

+  int retVal = gethostname(hostname, COUNT);
+  if (retVal != 0) return std::string("Unable to Get Host Name");
+  return std::string(hostname);
+#endif


Suggested change

#endif

#endif // Catch-all POSIX block.

googlebot · 2018-12-10T09:11:35Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of all the commit author(s), set the cla label to yes (if enabled on your project), and then merge this pull request when appropriate.

googlebot · 2018-12-10T09:19:13Z

CLAs look good, thanks!

AppVeyorBot · 2018-12-10T10:41:22Z

✅ Build benchmark 1598 completed (commit 5c4b5786b0 by @)

LebedevRI · 2018-12-10T10:46:16Z

src/json_reporter.cc

@@ -77,6 +77,8 @@ bool JSONReporter::ReportContext(const Context& context) {
  std::string walltime_value = LocalDateTimeString();
  out << indent << FormatKV("date", walltime_value) << ",\n";

+  out << indent << FormatKV("host_name", context.sys_info.name) << ",\n";


We are sure that this won't contain \\? (see executable_name)

Do we want to print "Unable to Get Host Name"?2

I wonder if this should be after the executable_name.

No. We should check and only output if it's available.

Yes, I checked the output of the function, it just outputs the hostname for windows without the \\

Addressed

I am not sure about this one, it can be done, but since the output being in json only, is it desirable?

Aren't we still always printing it?

Looks about right other than this.

are you talking about the 2nd point?
I have placed an empty string incase it fails to fetch the host name

LebedevRI

In general seems to look ok, but i'd prefer to leave this for @dominichamon.

AppVeyorBot · 2018-12-10T12:14:19Z

✅ Build benchmark 1600 completed (commit 58dde37f5d by @jatinx)

dmah42 · 2018-12-10T15:13:23Z

include/benchmark/benchmark.h

@@ -1293,6 +1293,14 @@ struct CPUInfo {
  BENCHMARK_DISALLOW_COPY_AND_ASSIGN(CPUInfo);
 };

+struct SystemInformation {


nit: for consistency with CPUInfo, maybe SystemInfo.

Can be done, let me know if you want me proceed with this

Yes please.

dmah42 · 2018-12-10T15:14:17Z

src/sysinfo.cc

+  TCHAR  hostname[COUNT] = {'\0'};
+  DWORD DWCOUNT = COUNT;
+  if (!GetComputerName(hostname, &DWCOUNT))
+    return std::string("Unable to Get Host Name");


return empty string and don't print in that case?

we can use something like this
https://github.com/google/benchmark/blob/master/src/benchmark.cc#L430-L431

merging requested changes

…tch fails

jatinx · 2018-12-10T17:34:32Z

Sometimes, on travis-ci, the last build on MacOS fails in configure.
It gets resolved if I restart the build with a minor comment merge.
This has happened twice now.

@dominichamon @LebedevRI

AppVeyorBot · 2018-12-10T18:19:22Z

✅ Build benchmark 1603 completed (commit f61aac7286 by @jatinx)

AppVeyorBot · 2018-12-10T19:40:18Z

✅ Build benchmark 1604 completed (commit e16277d78a by @jatinx)

dmah42 · 2018-12-11T11:23:15Z

Thanks! I'll keep an eye on the travis build.

Adding Host Name and test

3f44492

googlebot added the cla: yes label Nov 29, 2018

LebedevRI reviewed Nov 29, 2018

View reviewed changes

Addressing Review Comments

f38f8ef

Adding Test for JSON Reporter

2c6d90c

Adding HOST_NAME_MAX for MacOS systems

0ffce1d

Adding Explaination for MacOS HOST_NAME_MAX Addition

8128e07

LebedevRI reviewed Dec 7, 2018

View reviewed changes

LebedevRI reviewed Dec 9, 2018

View reviewed changes

jatinx pushed a commit to jatinx/benchmark that referenced this pull request Dec 10, 2018

Addressing Peer Reivew Comments PR:google#733

26b2d4d

googlebot added cla: no and removed cla: yes labels Dec 10, 2018

Addressing Peer Review Comments

7147aee

jatinx force-pushed the HostName branch from 26b2d4d to 7147aee Compare December 10, 2018 09:19

googlebot added cla: yes and removed cla: no labels Dec 10, 2018

Adding codecvt in windows header guard

b628cf4

LebedevRI reviewed Dec 10, 2018

View reviewed changes

dmah42 approved these changes Dec 10, 2018

View reviewed changes

jatinx added 2 commits December 10, 2018 21:29

Changing name SystemInfo and adding empty message incase host name fe…

6223a48

…tch fails

Adding Comment on Struct SystemInfo

a651c6f

dmah42 merged commit 47a5f77 into google:master Dec 11, 2018

	#if defined(__CYGWIN__)
	#define BENCHMARK_OS_CYGWIN 1
	#elif defined(_WIN32)
	#define BENCHMARK_OS_WINDOWS 1
	#if defined(__MINGW32__)
	#define BENCHMARK_OS_MINGW 1
	#endif
	#elif defined(__APPLE__)
	#define BENCHMARK_OS_APPLE 1
	#include "TargetConditionals.h"
	#if defined(TARGET_OS_MAC)
	#define BENCHMARK_OS_MACOSX 1
	#if defined(TARGET_OS_IPHONE)
	#define BENCHMARK_OS_IOS 1
	#endif
	#endif
	#elif defined(__FreeBSD__)
	#define BENCHMARK_OS_FREEBSD 1
	#elif defined(__NetBSD__)
	#define BENCHMARK_OS_NETBSD 1
	#elif defined(__OpenBSD__)
	#define BENCHMARK_OS_OPENBSD 1
	#elif defined(__linux__)
	#define BENCHMARK_OS_LINUX 1
	#elif defined(__native_client__)
	#define BENCHMARK_OS_NACL 1
	#elif defined(__EMSCRIPTEN__)
	#define BENCHMARK_OS_EMSCRIPTEN 1
	#elif defined(__rtems__)
	#define BENCHMARK_OS_RTEMS 1
	#elif defined(__Fuchsia__)
	#define BENCHMARK_OS_FUCHSIA 1
	#elif defined (__SVR4) && defined (__sun)
	#define BENCHMARK_OS_SOLARIS 1
	#endif

	#else
	#else // defined(BENCHMARK_OS_WINDOWS)
	// Catch-all POSIX block.

#722 Adding Host Name in Reporting #733

#722 Adding Host Name in Reporting #733

Conversation

jatinx commented Nov 29, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Nov 29, 2018 • edited

AppVeyorBot commented Nov 29, 2018

AppVeyorBot commented Nov 29, 2018

AppVeyorBot commented Nov 29, 2018

AppVeyorBot commented Nov 29, 2018

AppVeyorBot commented Nov 30, 2018

jatinx commented Nov 30, 2018

jatinx commented Dec 7, 2018

LebedevRI left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

googlebot commented Dec 10, 2018

googlebot commented Dec 10, 2018

AppVeyorBot commented Dec 10, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jatinx Dec 11, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LebedevRI left a comment

Choose a reason for hiding this comment

AppVeyorBot commented Dec 10, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jatinx commented Dec 10, 2018

AppVeyorBot commented Dec 10, 2018

AppVeyorBot commented Dec 10, 2018

dmah42 commented Dec 11, 2018

coveralls commented Nov 29, 2018 •

edited

jatinx Dec 11, 2018 •

edited