Module: Origen

Extended by:
Utility::TimeAndDate
Defined in:
lib/origen/boot/api.rb,
lib/origen.rb,
lib/origen/log.rb,
lib/origen/bugs.rb,
lib/origen/mode.rb,
lib/origen/pins.rb,
lib/origen/chips.rb,
lib/origen/fuses.rb,
lib/origen/model.rb,
lib/origen/ports.rb,
lib/origen/specs.rb,
lib/origen/tests.rb,
lib/origen/users.rb,
lib/origen/value.rb,
lib/origen/client.rb,
lib/origen/clocks.rb,
lib/origen/errata.rb,
lib/origen/limits.rb,
lib/origen/loader.rb,
lib/origen/memory.rb,
lib/origen/models.rb,
lib/origen/netlist.rb,
lib/origen/utility.rb,
lib/origen/boot/app.rb,
lib/origen/bugs/bug.rb,
lib/origen/database.rb,
lib/origen/features.rb,
lib/origen/location.rb,
lib/origen/org_file.rb,
lib/origen/pins/pin.rb,
lib/origen/callbacks.rb,
lib/origen/chip_mode.rb,
lib/origen/encodings.rb,
lib/origen/generator.rb,
lib/origen/registers.rb,
lib/origen/top_level.rb,
lib/origen/undefined.rb,
lib/origen/chips/chip.rb,
lib/origen/chips/note.rb,
lib/origen/components.rb,
lib/origen/controller.rb,
lib/origen/models/mux.rb,
lib/origen/parameters.rb,
lib/origen/ports/port.rb,
lib/origen/specs/note.rb,
lib/origen/specs/spec.rb,
lib/origen/sub_blocks.rb,
lib/origen/tests/test.rb,
lib/origen/users/ldap.rb,
lib/origen/users/user.rb,
lib/origen/application.rb,
lib/origen/commands/rc.rb,
lib/origen/pins/timing.rb,
lib/origen/site_config.rb,
lib/origen/chip_package.rb,
lib/origen/clocks/clock.rb,
lib/origen/commands/web.rb,
lib/origen/file_handler.rb,
lib/origen/limits/limit.rb,
lib/origen/location/map.rb,
lib/origen/netlist/list.rb,
lib/origen/utility/diff.rb,
lib/origen/commands/mode.rb,
lib/origen/commands/site.rb,
lib/origen/componentable.rb,
lib/origen/generator/job.rb,
lib/origen/location/base.rb,
lib/origen/pins/pin_bank.rb,
lib/origen/ports/section.rb,
lib/origen/power_domains.rb,
lib/origen/registers/bit.rb,
lib/origen/registers/reg.rb,
lib/origen/specs/exhibit.rb,
lib/origen/generator/flow.rb,
lib/origen/global_methods.rb,
lib/origen/logger_methods.rb,
lib/origen/model/exporter.rb,
lib/origen/parameters/set.rb,
lib/origen/pins/other_pin.rb,
lib/origen/pins/pin_clock.rb,
lib/origen/pins/power_pin.rb,
lib/origen/remote_manager.rb,
lib/origen/specs/checkers.rb,
lib/origen/specs/override.rb,
lib/origen/utility/mailer.rb,
lib/origen/version_string.rb,
lib/origen/application/lsf.rb,
lib/origen/chips/doc_entry.rb,
lib/origen/code_generators.rb,
lib/origen/commands/target.rb,
lib/origen/generator/stage.rb,
lib/origen/parameters/live.rb,
lib/origen/pins/ground_pin.rb,
lib/origen/pins/pin_common.rb,
lib/origen/commands/helpers.rb,
lib/origen/core_ext/integer.rb,
lib/origen/features/feature.rb,
lib/origen/fuses/fuse_field.rb,
lib/origen/limits/limit_set.rb,
lib/origen/pins/timing/wave.rb,
lib/origen/pins/virtual_pin.rb,
lib/origen/registers/domain.rb,
lib/origen/revision_control.rb,
lib/origen/utility/csv_data.rb,
lib/origen/errata/hw_erratum.rb,
lib/origen/generator/pattern.rb,
lib/origen/model_initializer.rb,
lib/origen/operating_systems.rb,
lib/origen/specs/mode_select.rb,
lib/origen/utility/collector.rb,
lib/origen/utility/file_diff.rb,
lib/origen/value/bin_str_val.rb,
lib/origen/value/hex_str_val.rb,
lib/origen/application/runner.rb,
lib/origen/application/target.rb,
lib/origen/chips/design_entry.rb,
lib/origen/generator/compiler.rb,
lib/origen/generator/renderer.rb,
lib/origen/parameters/missing.rb,
lib/origen/regression_manager.rb,
lib/origen/site_config/config.rb,
lib/origen/specs/doc_resource.rb,
lib/origen/specs/power_supply.rb,
lib/origen/utility/block_args.rb,
lib/origen/application/plugins.rb,
lib/origen/application/release.rb,
lib/origen/code_generators/dut.rb,
lib/origen/generator/resources.rb,
lib/origen/netlist/connectable.rb,
lib/origen/pins/function_proxy.rb,
lib/origen/pins/pin_collection.rb,
lib/origen/pins/timing/timeset.rb,
lib/origen/registers/container.rb,
lib/origen/specs/creation_info.rb,
lib/origen/specs/documentation.rb,
lib/origen/specs/spec_features.rb,
lib/origen/application/deployer.rb,
lib/origen/code_generators/base.rb,
lib/origen/commands/environment.rb,
lib/origen/commands/interactive.rb,
lib/origen/generator/comparator.rb,
lib/origen/models/scan_register.rb,
lib/origen/org_file/interceptor.rb,
lib/origen/ports/bit_collection.rb,
lib/origen/revision_control/git.rb,
lib/origen/code_generators/block.rb,
lib/origen/code_generators/klass.rb,
lib/origen/code_generators/model.rb,
lib/origen/ports/port_collection.rb,
lib/origen/revision_control/base.rb,
lib/origen/specs/version_history.rb,
lib/origen/utility/input_capture.rb,
lib/origen/utility/time_and_date.rb,
lib/origen/application/statistics.rb,
lib/origen/code_generators/module.rb,
lib/origen/code_generators/semver.rb,
lib/origen/org_file/interceptable.rb,
lib/origen/application/environment.rb,
lib/origen/application/lsf_manager.rb,
lib/origen/code_generators/actions.rb,
lib/origen/code_generators/feature.rb,
lib/origen/code_generators/timever.rb,
lib/origen/clocks/clocks_collection.rb,
lib/origen/database/key_value_store.rb,
lib/origen/generator/pattern_finder.rb,
lib/origen/generator/pattern_thread.rb,
lib/origen/registers/bit_collection.rb,
lib/origen/registers/msb0_delegator.rb,
lib/origen/registers/reg_collection.rb,
lib/origen/application/configuration.rb,
lib/origen/database/key_value_stores.rb,
lib/origen/revision_control/perforce.rb,
lib/origen/generator/pattern_iterator.rb,
lib/origen/generator/pattern_sequence.rb,
lib/origen/power_domains/power_domain.rb,
lib/origen/application/plugins_manager.rb,
lib/origen/application/version_tracker.rb,
lib/origen/generator/pattern_sequencer.rb,
lib/origen/revision_control/subversion.rb,
lib/origen/code_generators/block_common.rb,
lib/origen/errata/sw_erratum_workaround.rb,
lib/origen/revision_control/design_sync.rb,
lib/origen/application/workspace_manager.rb,
lib/origen/application/command_dispatcher.rb,
lib/origen/power_domains/power_domains_collection.rb

Overview

Shim to handle Ruby < 2.4.0, where [] is implemented in Fixnum/Bignum instead of Integer

Defined Under Namespace

Modules: Boot, Bugs, Callbacks, Chips, Clocks, CodeGenerators, CommandHelpers, Component, Componentable, ConsoleMethods, Controller, Database, Errata, Features, Fuses, GlobalMethods, IntegerExtension, Limits, Loader, Location, LoggerMethods, Memory, Model, ModelInitializer, Models, Netlist, Parameters, PersistentCallbacks, Pins, Ports, PowerDomains, Registers, RevisionControl, Specs, SubBlocks, Tests, TopLevel, Users, Utility Classes: Application, BinStrValError, ChipMode, ChipPackage, Client, DesignSyncError, FileHandler, Generator, GitError, HexStrValError, Log, Mode, OperatingSystems, OrgFile, OrigenError, PerforceError, RegressionManager, RemoteManager, RevisionControlUninitializedError, SiteConfig, SubBlock, SyntaxError, UndefinedClass, Value, VersionString

Constant Summary collapse

APP_CONFIG = 
File.join('config', 'application.rb')
IPBlock =

Legacy API

Model
CoreCallbacks = 
PersistentCallbacks
ENCODINGS = 
{
  utf8: {
    inverted_exclamation_mark:                  "\u00A1",
    cent_sign:                                  "\u00A2",
    pound_sign:                                 "\u00A3",
    currency_sign:                              "\u00A4",
    yen_sign:                                   "\u00A5",
    broken_bar:                                 "\u00A6",
    section_sign:                               "\u00A7",
    diaeresis:                                  "\u00A8",
    copyright_sign:                             "\u00A9",
    feminine_ordinal_indicator:                 "\u00AA",
    left_pointing_double_angle_quotation_mark:  "\u00AB",
    not_sign:                                   "\u00AC",
    soft_hyphen:                                "\u00AD",
    registered_sign:                            "\u00AE ",
    macron:                                     "\u00AF",
    degree_sign:                                "\u00B0",
    plus_minus_sign:                            "\u00B1",
    superscript_two:                            "\u00B2",
    superscript_three:                          "\u00B3",
    acute_accent:                               "\u00B4",
    micro_sign:                                 "\u00B5",
    pilcrow_sign:                               "\u00B6",
    middle_dot:                                 "\u00B7",
    cedilla:                                    "\u00B8",
    superscript_one:                            "\u00B9",
    masculine_ordinal_indicator:                "\u00BA",
    right_pointing_double_angle_quotation_mark: "\u00BB",
    vulgar_fraction_one_quarter:                "\u00BC",
    vulgar_fraction_one_half:                   "\u00BD",
    vulgar_fraction_three_quarters:             "\u00BE",
    inverted_question_mark:                     "\u00BF",
    latin_capital_letter_a_with_grave:          "\u00C0",
    latin_capital_letter_a_with_acute:          "\u00C1",
    latin_capital_letter_a_with_circumflex:     "\u00C2",
    latin_capital_letter_a_with_tilde:          "\u00C3",
    latin_capital_letter_a_with_diaeresis:      "\u00C4",
    latin_capital_letter_a_with_ring_above:     "\u00C5",
    latin_capital_letter_ae:                    "\u00C6",
    latin_capital_letter_c_with_cedilla:        "\u00C7",
    latin_capital_letter_e_with_grave:          "\u00C8",
    latin_capital_letter_e_with_acute:          "\u00C9",
    latin_capital_letter_e_with_circumflex:     "\u00CA",
    latin_capital_letter_e_with_diaeresis:      "\u00CB",
    latin_capital_letter_i_with_grave:          "\u00CC",
    latin_capital_letter_i_with_acute:          "\u00CD",
    latin_capital_letter_i_with_circumflex:     "\u00CE",
    latin_capital_letter_i_with_diaeresis:      "\u00CF",
    latin_capital_letter_eth:                   "\u00D0",
    latin_capital_letter_n_with_tilde:          "\u00D1",
    latin_capital_letter_o_with_grave:          "\u00D2",
    latin_capital_letter_o_with_acute:          "\u00D3",
    latin_capital_letter_o_with_circumflex:     "\u00D4",
    latin_capital_letter_o_with_tilde:          "\u00D5",
    latin_capital_letter_o_with_diaeresis:      "\u00D6",
    multiplication_sign:                        "\u00D7",
    latin_capital_letter_o_with_stroke:         "\u00D8",
    latin_capital_letter_u_with_grave:          "\u00D9",
    latin_capital_letter_u_with_acute:          "\u00DA",
    latin_capital_letter_u_with_circumflex:     "\u00DB",
    latin_capital_letter_u_with_diaeresis:      "\u00DC",
    latin_capital_letter_y_with_acute:          "\u00DD",
    latin_capital_letter_thorn:                 "\u00DE",
    latin_small_letter_sharp_s:                 "\u00DF",
    latin_small_letter_a_with_grave:            "\u00E0",
    latin_small_letter_a_with_acute:            "\u00E1",
    latin_small_letter_a_with_circumflex:       "\u00E2",
    latin_small_letter_a_with_tilde:            "\u00E3",
    latin_small_letter_a_with_diaeresis:        "\u00E4",
    latin_small_letter_a_with_ring_above:       "\u00E5",
    latin_small_letter_ae:                      "\u00E6",
    latin_small_letter_c_with_cedilla:          "\u00E7",
    latin_small_letter_e_with_grave:            "\u00E8",
    latin_small_letter_e_with_acute:            "\u00E9",
    latin_small_letter_e_with_circumflex:       "\u00EA",
    latin_small_letter_e_with_diaeresis:        "\u00EB",
    latin_small_letter_i_with_grave:            "\u00EC",
    latin_small_letter_i_with_acute:            "\u00ED",
    latin_small_letter_i_with_circumflex:       "\u00EE",
    latin_small_letter_i_with_diaeresis:        "\u00EF",
    latin_small_letter_eth:                     "\u00F0",
    latin_small_letter_n_with_tilde:            "\u00F1",
    latin_small_letter_o_with_grave:            "\u00F2",
    latin_small_letter_o_with_acute:            "\u00F3",
    latin_small_letter_o_with_circumflex:       "\u00F4",
    latin_small_letter_o_with_tilde:            "\u00F5",
    latin_small_letter_o_with_diaeresis:        "\u00F6",
    division_sign:                              "\u00F7",
    latin_small_letter_o_with_stroke:           "\u00F8",
    latin_small_letter_u_with_grave:            "\u00F9",
    latin_small_letter_u_with_acute:            "\u00FA",
    latin_small_letter_u_with_circumflex:       "\u00FB",
    latin_small_letter_u_with_diaeresis:        "\u00FC",
    latin_small_letter_y_with_acute:            "\u00FD",
    latin_small_letter_thorn:                   "\u00FE",
    latin_small_letter_y_with_diaeresis:        "\u00FF",
    ohm_sign:                                   "\u03A9"
  }
}

Instance Attribute Summary collapse

Class Method Summary collapse

Methods included from Utility::TimeAndDate

time_now

Instance Attribute Details

#switch_user ⇒ Object (readonly)

Returns the value of attribute switch_user.



78
79
80
 
# File 'lib/origen.rb', line 78

def switch_user
  @switch_user
end

Class Method Details

._applications_lookup ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



218
219
220
 
# File 'lib/origen.rb', line 218

def _applications_lookup
  @_applications_lookup ||= { name: {}, root: {} }
end

._build_web_dir ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/origen/commands/web.rb', line 102

def self._build_web_dir
  _deployer.create_web_server_dir

  dir = Pathname.new(_deployer.web_server_dir).relative_path_from(Pathname.pwd)

  puts "Web server directory created at: #{dir}"
  puts ''
  puts "Compile any files you want to test into the #{dir}/content directory, e.g.:"
  puts "  origen c app/templates/file.md.erb -o #{dir}/content"
  puts ''
  puts 'To turn them into web pages:'
  puts "  cd #{dir}"
  if Origen.running_on_windows?
    puts '  nanoc'
  else
    puts '  env LANG=en_US.UTF-8 nanoc'
  end
  puts ''
  puts 'To start a web server for remote viewing:'
  puts "  cd #{dir}/output"
  puts '  origen web serve'
end

._deployer ⇒ Object 



125
126
127
128
129
 
# File 'lib/origen/commands/web.rb', line 125

def self._deployer
  @_deployer ||= Origen.app.deployer
  @_deployer.test = true
  @_deployer
end

._require_web_directory ⇒ Object 



65
66
67
68
69
70
71
72
73
 
# File 'lib/origen/commands/web.rb', line 65

def self._require_web_directory
  unless Origen.config.web_directory
    puts 'To run that command you must specify the location of your webserver, for example:'
    puts ''
    puts '# config/application.rb'
    puts 'config.web_directory = "/proj/.web_origen/html/origen"'
    exit 1
  end
end

._start_server ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/origen/commands/web.rb', line 75

def self._start_server
  # Get the current host
  require 'socket'
  # gethostbyname is deprecated in favor of Addrinfo#getaddrinfo
  # rubocop:disable Lint/DeprecatedClassMethods
  host = Socket.gethostbyname(Socket.gethostname).first.downcase
  # rubocop:enable Lint/DeprecatedClassMethods

  # Get a free port
  port = 8000 # preferred port
  begin
    server = TCPServer.new('127.0.0.1', port)
  rescue Errno::EADDRINUSE
    # port = rand(65000 - 1024) + 1024
    port += 1
    retry
  end
  server.close
  # Start the server
  puts ''
  puts "Point your browser to this address:  http://#{host}:#{port}"
  puts ''
  puts 'To shut down the server use CTRL-C'
  puts ''
  system "ruby -run -e httpd . -p #{port}"
end

.add_interface(interface_class) ⇒ Object 



579
580
581
 
# File 'lib/origen.rb', line 579

def add_interface(interface_class)
  interfaces << interface_class
end

.after_app_loaded(&block) ⇒ Object

Sometimes it is necessary to refer to the app instance before it is fully loaded, which can lead to runtime errors.

Such code can be wrapped in this method to ensure that it will run safely by differing it until the app is fully loaded.

If the application is already loaded by the time this is called, then it will execute straight away.

Origen.after_app_loaded do |app|
  app.do_something
end



538
539
540
541
542
543
544
545
 
# File 'lib/origen.rb', line 538

def after_app_loaded(&block)
  if application_loaded?
    yield app
  else
    @after_app_loaded_blocks ||= []
    @after_app_loaded_blocks << block
  end
end

.app(plugin = nil, _options = {}) ⇒ Object Also known as: application

Returns the current (top-level) application instance



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/origen.rb', line 151

def app(plugin = nil, _options = {})
  plugin, options = nil, plugin if plugin.is_a?(Hash)
  if plugin
    load_application
    app = _applications_lookup[:name][plugin.to_sym]
    if app
      app
    else
      puts "Couldn't find application instance called #{plugin}, known names are:"
      puts "  #{_applications_lookup[:name].keys.join(', ')}"
      puts
      fail 'Origen.root lookup error!'
    end
  else
    load_application
  end
end

.app! ⇒ Object Also known as: application!

Equivalent to application except that if called from code in a plugin this will return that plugin's application instance



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/origen.rb', line 172

def app!
  file = caller[0]
  path = @current_source_dir || Pathname.new(file).dirname
  path = path.parent until File.exist?(File.join(path, APP_CONFIG)) || path.root?
  if path.root?
    fail "Something went wrong resoving Origen.app! from: #{caller[0]}"
  end

  find_app_by_root(path)
end

.application_loaded? ⇒ Boolean Also known as: app_loaded?

Returns:

  • (Boolean) 


141
142
143
 
# File 'lib/origen.rb', line 141

def application_loaded?
  @application_loaded
end

.clean_help_line(str) ⇒ Object

Uniformly justifies the given help command line for display in a command line help output



95
96
97
98
99
100
101
102
103
104
 
# File 'lib/origen.rb', line 95

def clean_help_line(str)
  if str =~ /^\s\s\s\s\s\s\s*(.*)/
    (' ' * 20) + Regexp.last_match(1)
  # http://rubular.com/r/MKmU4xZgO2
  elsif str =~ /^\s*([^\s]+)\s+(.*)/
    ' ' + Regexp.last_match(1).ljust(19) + Regexp.last_match(2)
  else
    str
  end
end

.client ⇒ Object 



404
405
406
 
# File 'lib/origen.rb', line 404

def client
  @client ||= Client.new
end

.command_dispatcher ⇒ Object 



265
266
267
 
# File 'lib/origen.rb', line 265

def command_dispatcher
  @command_dispatcher ||= Application::CommandDispatcher.new
end

.compile(file, options = {}) ⇒ Object

Compile the given file and return the result as a string



562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/origen.rb', line 562

def compile(file, options = {})
  # This has to operate on a new instance so that helper methods can use the inline
  # compiler within an isolated context
  c = Origen::Generator::Compiler.new
  # It needs to be placed on the stack so that the global render method references
  # the correct compiler instance
  $_compiler_stack ||= []
  $_compiler_stack << c
  r = c.compile_inline(file, options)
  $_compiler_stack.pop
  r
end

.configuration ⇒ Object Also known as: config 



269
270
271
 
# File 'lib/origen.rb', line 269

def configuration
  app.config
end

.controllers ⇒ Object 



458
459
460
 
# File 'lib/origen.rb', line 458

def controllers
  @controllers ||= []
end

.current_command ⇒ Object

Returns the name of the currently executing Origen command (a String), e.g. 'generate', 'program', 'compile', etc.



744
745
746
 
# File 'lib/origen.rb', line 744

def current_command
  @current_command
end

.current_user(options = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Use User.current to retrieve the current user, this is an internal API that will be cleaned up (removed) in future



634
635
636
637
638
639
640
641
642
643
 
# File 'lib/origen.rb', line 634

def current_user(options = {})
  @current_user = nil if options[:refresh]
  if app_loaded? || in_app_workspace?
    return @switch_user unless @switch_user.nil?

    @current_user ||= application.current_user
  else
    @current_user ||= User.new(User.current_user_id)
  end
end

.debug? ⇒ Boolean Also known as: debugger?

Returns true if Origen is running with the -d or –debug switches enabled

Returns:

  • (Boolean) 


677
678
679
 
# File 'lib/origen.rb', line 677

def debug?
  @debug || false
end

.debugger_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


686
687
688
 
# File 'lib/origen.rb', line 686

def debugger_enabled?
  debug?
end

.deprecate(*msgs) ⇒ Object Also known as: deprecated 



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/origen.rb', line 715

def deprecate(*msgs)
  _deprecate(*msgs)
  if Origen.app
    # If an app deprecation return the caller who called the deprecated method
    if caller[0] =~ /#{Origen.root}/
      c = caller[1]
    # If an Origen deprecation then return the first caller from the current app
    else
      c = caller.find { |line| line =~ /#{Origen.root}/ }
    end
  else
    c = caller[1]
  end
  c =~ /(.*):(\d+):.*/
  begin
    _deprecate "Called by #{Regexp.last_match[1]}:#{Regexp.last_match[2]}", options
  rescue
    # For this to fail it means the deprecated method was called by IRB or similar
    # and in that case there is no point advising who called anyway
  end
end

.development? ⇒ Boolean

Returns:

  • (Boolean) 


690
691
692
693
 
# File 'lib/origen.rb', line 690

def development?
  # This should be integrated with Origen.config.mode in the future
  @development
end

.disable_profiling ⇒ Object 



110
111
112
 
# File 'lib/origen.rb', line 110

def disable_profiling
  @profiling = false
end

.enable_debugger ⇒ Object 



682
683
684
 
# File 'lib/origen.rb', line 682

def enable_debugger
  @debug = true
end

.enable_profiling ⇒ Object 



106
107
108
 
# File 'lib/origen.rb', line 106

def enable_profiling
  @profiling = true
end

.environment ⇒ Object 



289
290
291
 
# File 'lib/origen.rb', line 289

def environment
  application.environment
end

.file_handler ⇒ Object 



416
417
418
 
# File 'lib/origen.rb', line 416

def file_handler
  @file_handler ||= FileHandler.new
end

.find_app_by_root(path_to_origen_root, options = {}) ⇒ Object Also known as: application_instance, app_instance

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return the application instance from the given path to an Origen application workspace, i.e. Origen.app conventionally returns the current application instance, this method returns the same thing that would be returned from the given remote workspace.



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/origen.rb', line 234

def find_app_by_root(path_to_origen_root, options = {})
  app = _applications_lookup[:root][Pathname.new(path_to_origen_root).realpath.to_s]
  if !app || options[:reload]
    # If the application is already defined then un-define it, this is to allow it to
    # be reloaded.
    # This option feels like it doesn't belong here, but is part of the legacy import
    # require system. When that has been removed in future so can this reload system, under
    # bundler app versions will be resolved before loading them so there will be no need
    # for this
    if app
      begin
        Object.send(:remove_const, app.class.to_s)
      rescue
        # Nothing to do here
      end
    end
    require File.join(path_to_origen_root, APP_CONFIG)
    app = _applications_lookup[:root][Pathname.new(path_to_origen_root).realpath.to_s]
  end
  return app if app

  puts "Couldn't find application instance with root #{path_to_origen_root}, known roots are:"
  _applications_lookup[:root].keys.each do |key|
    puts "  #{key}"
  end
  puts
  fail 'Application lookup error!'
end

.flow ⇒ Object 



446
447
448
 
# File 'lib/origen.rb', line 446

def flow
  generator.flow
end

.generator ⇒ Object 



400
401
402
 
# File 'lib/origen.rb', line 400

def generator
  @generator ||= Generator.new
end

.has_plugin?(plugin) ⇒ Boolean

Returns:

  • (Boolean) 


184
185
186
 
# File 'lib/origen.rb', line 184

def has_plugin?(plugin)
  _applications_lookup[:name][plugin.to_sym].nil? ? false : true
end

.home ⇒ Object

Returns the home directory of Origen (i.e., the primary place that Origen operates out of)



755
756
757
 
# File 'lib/origen.rb', line 755

def home
  File.expand_path(Origen.site_config.home_dir)
end

.hostname ⇒ Object

Platform independent means of retrieving the hostname



10
11
12
13
14
15
 
# File 'lib/origen/boot/api.rb', line 10

def self.hostname
  # gethostbyname is deprecated in favor of Addrinfo#getaddrinfo
  # rubocop:disable Lint/DeprecatedClassMethods
  Socket.gethostbyname(Socket.gethostname).first.downcase
  # rubocop:enable Lint/DeprecatedClassMethods
end

.import_manager ⇒ Object Also known as: imports_manager 



424
425
426
427
 
# File 'lib/origen.rb', line 424

def import_manager
  Origen.deprecated 'Origen.import_manager is deprecated, use Origen.app.plugins instead'
  app.plugins
end

.in_app_workspace? ⇒ Boolean

Returns true if Origen is running in an application workspace

Returns:

  • (Boolean) 


294
295
296
297
298
299
300
301
302
 
# File 'lib/origen.rb', line 294

def in_app_workspace?
  return @in_app_workspace if defined? @in_app_workspace

  @in_app_workspace ||= begin
    path = Pathname.new(Dir.pwd)
    path = path.parent until path.root? || File.exist?(File.join(path, APP_CONFIG))
    !path.root?
  end
end

.interface(options = {}) ⇒ Object

Returns the (application defined) test program interface for the given tester if one has been defined, otherwise returns nil



622
623
624
 
# File 'lib/origen.rb', line 622

def interface(options = {})
  @interface || reset_interface(options)
end

.interface_loaded? ⇒ Boolean

Returns:

  • (Boolean) 


616
617
618
 
# File 'lib/origen.rb', line 616

def interface_loaded?
  !!@interface
end

.interface_present? ⇒ Boolean

Returns true if an interface is defined for the current tester

Returns:

  • (Boolean) 


627
628
629
 
# File 'lib/origen.rb', line 627

def interface_present?
  !!interface(silence_no_interface_error: true)
end

.interfaces ⇒ Object 



575
576
577
 
# File 'lib/origen.rb', line 575

def interfaces
  @interfaces ||= []
end

.launch_time ⇒ Object 



552
553
554
 
# File 'lib/origen.rb', line 552

def launch_time
  @launch_time ||= time_now
end

.ldap ⇒ Object

Returns an instance of Origen::Users::LDAP which provides methods to query and authorize users against a company's LDAP-based employee directory



224
225
226
 
# File 'lib/origen.rb', line 224

def ldap
  @ldap ||= Origen::Users::LDAP.new
end

.listeners_for(*args) ⇒ Object

This is the application-facing API for implementing custom callbacks, the top-level application, all plugin application instances, and any application objects that include the Origen::Callbacks module will be returned

Origen system callbacks should use Origen.app.listeners_for instead, that version will return only the current plugin instance instead of them all (yes we need to make the API more obvious).



387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/origen.rb', line 387

def listeners_for(*args)
  callback = args.shift
  max = args.first.is_a?(Numeric) ? args.shift : nil
  listeners = [Origen.app] + Origen.app.plugins +
              Origen.app.instantiated_callback_listeners
  listeners = listeners.select { |l| l.respond_to?(callback) }
  if max && listeners.size > max
    fail "You can only define a #{callback} callback #{max > 1 ? (max.to_s + 'times') : 'once'}, however you have declared it #{listeners.size} times for instances of: #{listeners.map(&:class)}"
  end

  listeners
end

.load_application(options = {}) ⇒ Object

Loads the top-level application and all of its plugins, but not the target

In most cases this should never need to be called directly and will be called automatically the first time the application is referenced via Origen.app



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/origen.rb', line 476

def load_application(options = {})
  # If running globally (outside of an app workspace), instantiate a bare bones app to help
  # many of Origen's features that expect an app to be present.
  @application ||= if running_globally?
                     @plugins_loaded = true
                     # Now load the app
                     @loading_top_level = true
                     require 'origen/global_app'
                     @application = _applications_lookup[:root][root.to_s]
                     @loading_top_level = false
                     @application_loaded = true
                     @application
                   else
                     # Make sure the top-level root is always in the load path, it seems that some existing
                     # plugins do some strange things to require stuff from the top-level app and rely on this
                     path = File.join(root, 'lib')
                     $LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
                     if File.exist?(File.join(root, 'Gemfile')) && !@with_boot_environment
                       # Don't understand the rules here, belt and braces approach for now to make
                       # sure that all Origen plugins are auto-required (otherwise Origen won't know
                       # about them to plug them into the application)
                       Bundler.require
                       Bundler.require(:development)
                       Bundler.require(:runtime)
                       Bundler.require(:default)
                     end
                     @plugins_loaded = true
                     # Now load the app
                     @loading_top_level = true
                     require File.join(root, APP_CONFIG)
                     @application = _applications_lookup[:root][root.to_s]
                     @loading_top_level = false
                     if @with_boot_environment
                       @application.plugins.disable_current
                     else
                       Origen.remote_manager.require!
                     end
                     boot = File.join(root, 'config', 'boot.rb')
                     require boot if File.exist?(boot)
                     env = File.join(root, 'config', 'environment.rb')
                     require env if File.exist?(env)
                     dev = File.join(root, 'config', 'development.rb')
                     require dev if File.exist?(dev)
                     validate_origen_dev_configuration!
                     ([@application] + Origen.app.plugins).each(&:on_loaded)
                     @application_loaded = true
                     Array(@after_app_loaded_blocks).each { |b| b.call(@application) }
                     @application
                   end
end

.load_target(t = nil, options = {}) ⇒ Object 



282
283
284
285
286
287
 
# File 'lib/origen.rb', line 282

def load_target(t = nil, options = {})
  t, options = nil, t if t.is_a?(Hash)
  target.temporary = t if t
  application.load_target!(options)
  application.runner.prepare_and_validate_workspace
end

.loading_top_level? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


548
549
550
 
# File 'lib/origen.rb', line 548

def loading_top_level?
  @loading_top_level
end

.log ⇒ Object 



738
739
740
 
# File 'lib/origen.rb', line 738

def log
  @log ||= Log.new
end

.lsf ⇒ Object

Picks between either the global lsf_manager or the application's LSF manager



764
765
766
767
768
769
770
 
# File 'lib/origen.rb', line 764

def lsf
  if running_globally?
    lsf_manager
  else
    application.lsf_manager
  end
end

.lsf! ⇒ Object

Returns the Origen LSF instance, not the lsf_manager. Use Origen.lsf for that



773
774
775
 
# File 'lib/origen.rb', line 773

def lsf!
  @lsf ||= Origen::Application::LSF.new
end

.lsf_manager ⇒ Object 



759
760
761
 
# File 'lib/origen.rb', line 759

def lsf_manager
  @lsf_manager ||= Origen::Application::LSFManager.new
end

.mailer ⇒ Object 



274
275
276
 
# File 'lib/origen.rb', line 274

def mailer
  application.mailer
end

.mode ⇒ Object

Returns an object tracking the Origen execution mode/configuration, an instance of Origen::Mode



701
702
703
 
# File 'lib/origen.rb', line 701

def mode
  @mode ||= Origen::Mode.new
end

.mode=(val) ⇒ Object 



705
706
707
 
# File 'lib/origen.rb', line 705

def mode=(val)
  mode.set(val)
end

.os ⇒ Object 



29
30
31
 
# File 'lib/origen/operating_systems.rb', line 29

def self.os
  @operating_systems ||= OperatingSystems.new
end

.pattern ⇒ Object 



442
443
444
 
# File 'lib/origen.rb', line 442

def pattern
  generator.pattern
end

.pin_bank ⇒ Object 



412
413
414
 
# File 'lib/origen.rb', line 412

def pin_bank
  @pin_bank ||= Pins::PinBank.new
end

.plugins ⇒ Object 



136
137
138
139
 
# File 'lib/origen.rb', line 136

def plugins
  Origen.deprecate 'Origen.plugins is deprecated, use Origen.app.plugins instead'
  Origen.app.plugins
end

.plugins_loaded? ⇒ Boolean

Returns:

  • (Boolean) 


146
147
148
 
# File 'lib/origen.rb', line 146

def plugins_loaded?
  @plugins_loaded
end

.plugins_manager ⇒ Object Also known as: plugin_manager, current_plugin 



430
431
432
433
 
# File 'lib/origen.rb', line 430

def plugins_manager
  Origen.deprecated 'Origen.plugins_manager and Origen.current_plugin are deprecated, use Origen.app.plugins instead'
  app.plugins
end

.profile(message) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/origen.rb', line 114

def profile(message)
  if @profiling
    caller[0] =~ /.*\/(\w+\.rb):(\d+).*/
    if block_given?
      start = Time.now
      yield
      duration_in_ms = ((Time.now - start) * 1000).round
      puts "#{duration_in_ms}ms".ljust(10) + "#{Regexp.last_match[1]}:#{Regexp.last_match[2]} '#{message}'"
    else
      puts "#{Time.now} - #{Regexp.last_match[1]}:#{Regexp.last_match[2]} #{message}"
    end
  else
    yield if block_given?
  end
end

.register_acronym(name) ⇒ Object

Let's Origen know about any domain specific acronyms used with an application, this will cause them to be translated between underscored and camel-cased versions correctly



779
780
781
782
783
784
 
# File 'lib/origen.rb', line 779

def register_acronym(name)
  require 'active_support/core_ext/string/inflections'
  ActiveSupport::Inflector.inflections(:en) do |inflect|
    inflect.acronym(name)
  end
end

.register_application(app) ⇒ Object 



130
131
132
133
134
 
# File 'lib/origen.rb', line 130

def register_application(app)
  _applications_lookup[:name][app.name] = app
  _applications_lookup[:root][app.root.to_s] = app
  @plugins = nil
end

.regression_manager ⇒ Object 



420
421
422
 
# File 'lib/origen.rb', line 420

def regression_manager
  @regression_manager ||= RegressionManager.new
end

.remote_manager ⇒ Object Also known as: remotes_manager 



437
438
439
 
# File 'lib/origen.rb', line 437

def remote_manager
  @remote_manager ||= RemoteManager.new
end

.reset_interface(options = {}) ⇒ Object

Resets the tester interface (instantiates a new one). Any supplied options are passed to the interface initialization.



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/origen.rb', line 585

def reset_interface(options = {})
  # The doc interface should in future be phased out, but for now assume that an explicitly
  # declared interface is for the non-doc case
  if options[:interface] && !Origen.tester.doc?
    @interface = eval(options[:interface]).new(options)
  else
    int = interfaces.find { |i| i.supports?(Origen.tester) }
    if int
      @interface = int.new(options)
    else
      if defined? OrigenTesters::NoInterface
        @interface = OrigenTesters::NoInterface.new
      else
        unless options.delete(:silence_no_interface_error)
          fail "No interface has been defined for tester: #{Origen.tester.class}"
        end
      end
    end
  end
  @interface._load_generator if @interface.respond_to?(:_load_generator)
  if @interface.respond_to?(:at_flow_start)
    @interface.at_flow_start
  else
    @interface.reset_globals if @interface.respond_to?(:reset_globals)
  end
  if @interface.respond_to?(:on_interface_reset)
    @interface.on_interface_reset
  end
  @interface
end

.resources ⇒ Object 



450
451
452
 
# File 'lib/origen.rb', line 450

def resources
  generator.resources
end

.root(plugin = nil) ⇒ Object Also known as: app_root 



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/origen.rb', line 311

def root(plugin = nil)
  if plugin
    app(plugin).root
  else
    if @root_fudge_active
      app.root
    else
      @root ||= begin
        path = Pathname.new(Dir.pwd)
        path = path.parent until path.root? || File.exist?(File.join(path, APP_CONFIG))
        if path.root?
          @running_globally = true
          path = Pathname.new($_origen_invocation_pwd || Dir.pwd)
        else
          @in_app_workspace = true
        end
        path
      end
    end
  end
end

.root! ⇒ Object

Like Origen.root but this will return the plugin root if called by plugin code



335
336
337
338
339
340
341
342
343
344
 
# File 'lib/origen.rb', line 335

def root!
  file = caller[0]
  path = Pathname.new(file).dirname
  path = path.parent until path.root? || File.exist?(File.join(path, APP_CONFIG))
  if path.root?
    fail "Something went wrong resolving Origen.root! from: #{caller[0]}"
  end

  path.realpath
end

.running_globally? ⇒ Boolean Also known as: invoked_globally?

Shortcut method to find if Origen was invoked from within an application or from the global Origen install. This is just the opposite of in_app_workspace?

Returns:

  • (Boolean) 


306
307
308
 
# File 'lib/origen.rb', line 306

def running_globally?
  @running_globally ||= !in_app_workspace?
end

.running_interactively? ⇒ Boolean Also known as: interactive?

Returns true if Origen is running interactively. That is, the command was 'origen i'

Returns:

  • (Boolean) 


671
672
673
 
# File 'lib/origen.rb', line 671

def running_interactively?
  !!@running_interactively
end

.running_locally? ⇒ Boolean

Returns:

  • (Boolean) 


658
659
660
 
# File 'lib/origen.rb', line 658

def running_locally?
  !running_remotely?
end

.running_on_linux? ⇒ Boolean

Returns:

  • (Boolean) 


649
650
651
 
# File 'lib/origen.rb', line 649

def running_on_linux?
  !running_on_windows?
end

.running_on_windows? ⇒ Boolean

Returns:

  • (Boolean) 


645
646
647
 
# File 'lib/origen.rb', line 645

def running_on_windows?
  Origen.os.windows?
end

.running_remotely=(val) ⇒ Object 



662
663
664
 
# File 'lib/origen.rb', line 662

def running_remotely=(val)
  @running_remotely = val
end

.running_remotely? ⇒ Boolean Also known as: running_remotely

Returns:

  • (Boolean) 


653
654
655
 
# File 'lib/origen.rb', line 653

def running_remotely?
  @running_remotely
end

.running_simulation? ⇒ Boolean

Returns:

  • (Boolean) 


666
667
668
 
# File 'lib/origen.rb', line 666

def running_simulation?
  !!(defined?(OrigenSim) && Origen.tester && Origen.tester.sim?)
end

.session(reload = false) ⇒ Object

Provides a global Origen session stored at ~/.origen/session (Origen.home)



749
750
751
752
 
# File 'lib/origen.rb', line 749

def session(reload = false)
  @session = nil if reload
  @session ||= Database::KeyValueStores.new(self, persist: false)
end

.set_development_mode ⇒ Object 



695
696
697
 
# File 'lib/origen.rb', line 695

def set_development_mode
  @development = true
end

.site_config ⇒ Object 



438
439
440
 
# File 'lib/origen/site_config.rb', line 438

def self.site_config
  @site_config ||= SiteConfig.new
end

.split_caller_line(line) ⇒ Object

OS agnostic split of a caller line into file and line number



787
788
789
790
791
 
# File 'lib/origen.rb', line 787

def split_caller_line(line)
  arr = line.split(':')
  arr[0] = arr[0] + ':' + arr.delete_at(1) if Origen.os.windows?
  arr
end

.target ⇒ Object 



278
279
280
 
# File 'lib/origen.rb', line 278

def target
  application.target
end

.tester ⇒ Object 



408
409
410
 
# File 'lib/origen.rb', line 408

def tester
  application && application.tester
end

.time ⇒ Object 



454
455
456
 
# File 'lib/origen.rb', line 454

def time
  @time ||= Origen::Tester::Time.new
end

.top ⇒ Object

Returns the full path to the Origen core top-level directory



557
558
559
 
# File 'lib/origen.rb', line 557

def top
  @origen_top ||= Pathname.new(File.dirname(__FILE__)).parent
end

.top_level ⇒ Object

Returns the current top-level (DUT) object if one has been defined (by instantiating an object that includes Origen::TopLevel).



711
712
713
 
# File 'lib/origen.rb', line 711

def top_level
  application.top_level
end

.validate_origen_dev_configuration! ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Validates that when the current app is OrigenCore then the origen executable is coming from the same workspace



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/origen.rb', line 199

def validate_origen_dev_configuration!
  if Origen.app.name == :origen_core
    if Origen.root != Origen.top
      puts 'It looks like you are trying to develop Origen core, but you are running an Origen'
      puts 'executable from another workspace!'
      if Origen.running_on_windows?
        puts 'To resolve this error you must add the following directory to your Windows PATH:'
        puts "  #{Origen.root}\\bin"
      else
        puts 'To resolve this error run:'
        puts "  cd #{Origen.root}"
        puts '  source source_setup'
      end
      exit 1
    end
  end
end

.version(options = {}) ⇒ Object 



462
463
464
465
466
467
468
469
470
 
# File 'lib/origen.rb', line 462

def version(options = {})
  @version = nil if options[:refresh]
  return @version if @version && !options[:refresh]

  if options[:refresh] || !defined?(Origen::VERSION)
    load File.join(Pathname.new(File.dirname(__FILE__)).parent, 'config', 'version.rb')
  end
  @version = Origen::VersionString.new(Origen::VERSION)
end

.with_boot_environment ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Turns off bundler and all plugins if the app is loaded within this block



373
374
375
376
377
 
# File 'lib/origen.rb', line 373

def with_boot_environment
  @with_boot_environment = true
  yield
  @with_boot_environment = false
end

.with_origen_root(path) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Ugly hack to force Origen.root references to the plugin's top-level when loading the environment.rb of the plugin

References to Origen.root in a plugin environment.rb is deprecated and this will be removed in future once all plugins load through bundler



353
354
355
356
357
358
359
360
 
# File 'lib/origen.rb', line 353

def with_origen_root(path)
  orig = app.root
  @root_fudge_active = true
  app.root = Pathname.new(path)
  yield
  app.root = orig
  @root_fudge_active = false
end

.with_source_file(file) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



189
190
191
192
193
 
# File 'lib/origen.rb', line 189

def with_source_file(file)
  @current_source_dir = Pathname.new(file).dirname
  yield
  @current_source_dir = nil
end

.with_user(user_obj, &block) ⇒ Object

This is similar to the command line of 'sudo <user_name>'. The main use case is when someone is running with a Service Account and needs to change to an actually user instead of the service account



365
366
367
368
369
 
# File 'lib/origen.rb', line 365

def with_user(user_obj, &block)
  @switch_user = user_obj
  block.call
  @switch_user = nil
end