chisel
7.9.0+2-5294dafe-SNAPSHOT
API
Generated with
chisel/logger

logger

package logger

Members list

Packages

package logger.phases

Type members

Classlikes

object LoggerOptionsView extends OptionsView[LoggerOptions]

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
Self type

Deprecated classlikes

case class ClassLogLevelAnnotation(className: String, level: Value) extends NoTargetAnnotation, LoggerOption, Unserializable

Describes a mapping of a class to a specific log level

Describes a mapping of a class to a specific log level

  • set with -cll/--class-log-level

Value parameters

level

the verbosity level

name

the class name to log

Attributes

Companion
object
Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
LoggerAnnotations.scala
Supertypes
trait Serializable
trait LoggerOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ClassLogLevelAnnotation extends HasShellOptions

Attributes

Companion
class
Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
LoggerAnnotations.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
trait LazyLogging

extend this trait to enable logging in a class you are implementing

extend this trait to enable logging in a class you are implementing

Attributes

Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
Logger.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object JsonProtocol
trait TransformLike[A]
trait DependencyManager[A, B]
class PhaseManager
trait Phase
object Checks
class AddDefaults
class Checks
class GetIncludes
class Stage
class ChiselStage
class AddDefaults
class Checks
class CIRCT
class Checks
class Checks
class Convert
class Elaborate
class Emitter
trait Translator[A, B]
object PrimOps
object Utils
object decoder
Show all
case object LogClassNamesAnnotation extends NoTargetAnnotation, LoggerOption, HasShellOptions, Unserializable

Enables class names in log output

Enables class names in log output

  • enabled with -lcn/--log-class-names

Attributes

Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
LoggerAnnotations.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait LoggerOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case class LogFileAnnotation(file: Option[String]) extends NoTargetAnnotation, LoggerOption, Unserializable

Enables logging to a file (as opposed to STDOUT)

Enables logging to a file (as opposed to STDOUT)

Attributes

Companion
object
Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
LoggerAnnotations.scala
Supertypes
trait Serializable
trait LoggerOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LogFileAnnotation extends HasShellOptions

Attributes

Companion
class
Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
LoggerAnnotations.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
object LogLevel extends Enumeration

The supported log levels, what do they mean? Whatever you want them to.

The supported log levels, what do they mean? Whatever you want them to.

Attributes

Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
Logger.scala
Supertypes
class Enumeration
trait Serializable
class Object
trait Matchable
class Any
Self type
LogLevel.type
case class LogLevelAnnotation(globalLogLevel: Value = ...) extends NoTargetAnnotation, LoggerOption, Unserializable

Describes the verbosity of information to log

Describes the verbosity of information to log

  • set with -ll/--log-level
  • if unset, a LogLevelAnnotation with the default log level will be emitted

Value parameters

level

the level of logging

Attributes

Companion
object
Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
LoggerAnnotations.scala
Supertypes
trait Serializable
trait LoggerOption
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LogLevelAnnotation extends HasShellOptions

Attributes

Companion
class
Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
LoggerAnnotations.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
object Logger

Singleton in control of what is supposed to get logged, how it's to be logged and where it is to be logged We uses a dynamic variable in case multiple threads are used as can be in scalatests

Singleton in control of what is supposed to get logged, how it's to be logged and where it is to be logged We uses a dynamic variable in case multiple threads are used as can be in scalatests

Attributes

Companion
class
Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
Logger.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Logger.type
class Logger(containerClass: String)

Classes implementing LazyLogging will have logger of this type

Classes implementing LazyLogging will have logger of this type

Value parameters

containerClass

passed in from the LazyLogging trait in order to provide class level logging granularity

Attributes

Companion
object
Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
Logger.scala
Supertypes
class Object
trait Matchable
class Any
class LoggerException(val str: String, cause: Throwable = ...) extends RuntimeException

An exception originating from the Logger

An exception originating from the Logger

Value parameters

cause

a reason for the exception

str

an exception message

Attributes

Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
Logger.scala
Supertypes
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
sealed trait LoggerOption

An annotation associated with a Logger command line option

An annotation associated with a Logger command line option

Attributes

Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
LoggerAnnotations.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
Self type
class LoggerOptions

Internal options used to control the logging in programs that are part of the Chisel stack

Internal options used to control the logging in programs that are part of the Chisel stack

Value parameters

classLogLevels

the individual verbosity of logging for specific classes

globalLogLevel

the verbosity of logging (default: logger.LogLevel.None)

logClassNames

indicates logging verbosity on a class-by-class basis

logToFile

if true, log to a file

Attributes

Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
LoggerOptions.scala
Supertypes
class Object
trait Matchable
class Any
Generated with