base: Reimplement the DPRINTF mechanism in a Logger class

Information
Submitter:	Andreas Hansson
Repository:	gem5
Branch:	default
Bugs:
Depends On:
Reviewers
Groups:	Default
People:

Description

Changeset 10457:29dc41797b87
---------------------------
base: Reimplement the DPRINTF mechanism in a Logger class

This patch adds a Logger class encapsulating dprintf.  This allows
variants of DPRINTF logging to be constructed and substituted in
place of the default behaviour.

The Logger provides a logMessage(when, name, format, ...) member
function like Trace::dprintf and a getOstream member function to
use a raw ostream for logging.

A class OstreamLogger is provided which generates the customary
debugging output with Trace::OstreamLogger::logMessage being the
old Trace::dprintf.

Testing Done

Issue Summary

Description	From	Last Updated	Status
This isn't necessary for stuff in base, right?	Nathan Binkert	Sept. 29, 2014, 6:19 a.m.	Open
This has the same static construction problem I described below.	Nathan Binkert	Sept. 29, 2014, 6:19 a.m.	Open
default_logger may not be constructed during a static constructor anymore, so if someone had log statements very early, things would ...	Nathan Binkert	Sept. 29, 2014, 6:19 a.m.	Open

src/base/trace.cc (Diff revision 1)

This isn't necessary for stuff in base, right?

Show all issues

Andrew Bardsley Sept. 29, 2014, 7:33 a.m. (Sept. 29, 2014, 7:33 a.m.)
```
Is there a copyright policy thing I don't know about base?
```

Nathan Binkert Sept. 29, 2014, 10:02 a.m. (Sept. 29, 2014, 10:02 a.m.)

Ask Andreas or Ali.  I thought that you guys were ok with leaving most of the stuff that is obviously not model related alone.

Andrew Bardsley Oct. 9, 2014, 5:52 a.m. (Oct. 9, 2014, 5:52 a.m.)
```
Done (new patch to follow soon)
```

src/base/trace.cc (Diff revision 1)

This has the same static construction problem I described below.

Show all issues

Andrew Bardsley Oct. 9, 2014, 5:52 a.m. (Oct. 9, 2014, 5:52 a.m.)
```
Done
```

src/base/trace.cc (Diff revision 1)

default_logger may not be constructed during a static constructor anymore, so if someone had log statements very early, things would break.  Consider something more like this:

Logger *&debugLogger() {
    static OstreamLogger the_default(std::cerr);
    static Logger *the_logger = &the_default;
    return the_logger;
}

Show all issues

Andrew Bardsley Sept. 29, 2014, 7:33 a.m. (Sept. 29, 2014, 7:33 a.m.)

Yes, static construction order would be a problem here.  I haven't looked through the codebase to see if there are any static object constructions which may present a problem.  I will

Nathan Binkert Sept. 29, 2014, 10:02 a.m. (Sept. 29, 2014, 10:02 a.m.)

I wouldn't bother looking through the codebase.  Just make it work :)  You don't want to unnecessarily restrict logging.

Andrew Bardsley Oct. 9, 2014, 5:52 a.m. (Oct. 9, 2014, 5:52 a.m.)
```
Done
```

Description:

~		Changeset 10453:682695bc3ee7
	~	Changeset 10457:29dc41797b87

		base: Reimplement the DPRINTF mechanism in a Logger class

		This patch adds a Logger class encapsulating dprintf. This allows
		variants of DPRINTF logging to be constructed and substituted in
		place of the default behaviour.

		The Logger provides a logMessage(when, name, format, ...) member
		function like Trace::dprintf and a getOstream member function to
		use a raw ostream for logging.

		A class OstreamLogger is provided which generates the customary
		debugging output with Trace::OstreamLogger::logMessage being the
		old Trace::dprintf.

Diff:

Revision 2 (+175 -102)

Show changes

	src/base/trace.hh
	src/base/trace.cc
	src/python/swig/trace.i

You have a pending review.

Review Board 2.0.15

This change has been marked as submitted.

Screenshots

Files

Issue Summary

Description:

Changeset 10453:682695bc3ee7

Changeset 10457:29dc41797b87

Diff:

Status: Closed (submitted)