configs/common/SysPaths.py

   1 # Copyright (c) 2006 The Regents of The University of Michigan
   2 # All rights reserved.
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions are
   6 # met: redistributions of source code must retain the above copyright
   7 # notice, this list of conditions and the following disclaimer;
   8 # redistributions in binary form must reproduce the above copyright
   9 # notice, this list of conditions and the following disclaimer in the
  10 # documentation and/or other materials provided with the distribution;
  11 # neither the name of the copyright holders nor the names of its
  12 # contributors may be used to endorse or promote products derived from
  13 # this software without specific prior written permission.
  14 #
  15 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  17 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  18 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  19 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  21 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26
  27 from __future__ import print_function
  28 from __future__ import absolute_import
  29
  30 from six import string_types
  31 import os, sys
  32
  33 config_path = os.path.dirname(os.path.abspath(__file__))
  34 config_root = os.path.dirname(config_path)
  35
  36 class PathSearchFunc(object):
  37     _sys_paths = None
  38     environment_variable = 'M5_PATH'
  39
  40     def __init__(self, subdirs, sys_paths=None):
  41         if isinstance(subdirs, string_types):
  42             subdirs = [subdirs]
  43         self._subdir = os.path.join(*subdirs)
  44         if sys_paths:
  45             self._sys_paths = sys_paths
  46
  47     def __call__(self, filename):
  48         if os.sep in filename:
  49             return filename
  50         else:
  51             if self._sys_paths is None:
  52                 try:
  53                     paths = os.environ[self.environment_variable].split(':')
  54                 except KeyError:
  55                     paths = [ '/dist/m5/system', '/n/poolfs/z/dist/m5/system' ]
  56
  57                 # expand '~' and '~user' in paths
  58                 paths = list(map(os.path.expanduser, paths))
  59
  60                 # filter out non-existent directories
  61                 paths = list(filter(os.path.isdir, paths))
  62
  63                 if not paths:
  64                     raise IOError(
  65                         "Can't find system files directory, "
  66                         "check your {} environment variable"
  67                         .format(self.environment_variable))
  68
  69                 self._sys_paths = list(paths)
  70
  71             filepath = os.path.join(self._subdir, filename)
  72             paths = (os.path.join(p, filepath) for p in self._sys_paths)
  73             try:
  74                 return next(p for p in paths if os.path.exists(p))
  75             except StopIteration:
  76                 raise IOError("Can't find file '{}' on {}."
  77                         .format(filename, self.environment_variable))
  78
  79 disk = PathSearchFunc('disks')
  80 binary = PathSearchFunc('binaries')
  81 script = PathSearchFunc('boot', sys_paths=[config_root])