vmkit/mmtk/java/src/org/j3/options/OptionSet.java

//===------------------------- OptionSet.java -----------------------------===//
//
//                            The VMKit project
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

package org.j3.options;


import org.mmtk.utility.Constants;
import org.vmmagic.pragma.Uninterruptible;
import org.vmmagic.unboxed.Extent;
import org.vmmagic.unboxed.Word;
import org.vmutil.options.AddressOption;
import org.vmutil.options.BooleanOption;
import org.vmutil.options.EnumOption;
import org.vmutil.options.FloatOption;
import org.vmutil.options.IntOption;
import org.vmutil.options.MicrosecondsOption;
import org.vmutil.options.Option;
import org.vmutil.options.PagesOption;
import org.vmutil.options.StringOption;

import org.jikesrvm.SizeConstants;
import org.j3.runtime.VM;

/**
 * Class to handle command-line arguments and options for GC.
 */
public final class OptionSet extends org.vmutil.options.OptionSet {

  private String prefix;

  public static final OptionSet gc = new OptionSet("-X:gc");

  private OptionSet(String prefix) {
    this.prefix = prefix;
  }

  /**
   * Format and log an option value.
   *
   * @param o The option.
   * @param forXml Is this part of xml output?
   */
  protected void logValue(Option o, boolean forXml) {
    switch (o.getType()) {
    case Option.BOOLEAN_OPTION:
      VM.sysWrite(((BooleanOption) o).getValue() ? "true" : "false");
      break;
    case Option.INT_OPTION:
      VM.sysWrite(((IntOption) o).getValue());
      break;
    case Option.ADDRESS_OPTION:
      VM.sysWrite(((AddressOption) o).getValue());
      break;
    case Option.FLOAT_OPTION:
      VM.sysWrite(((FloatOption) o).getValue());
      break;
    case Option.MICROSECONDS_OPTION:
      VM.sysWrite(((MicrosecondsOption) o).getMicroseconds());
      VM.sysWrite(" usec");
      break;
    case Option.PAGES_OPTION:
      VM.sysWrite(((PagesOption) o).getBytes());
      VM.sysWrite(" bytes");
      break;
    case Option.STRING_OPTION:
      VM.sysWrite(((StringOption) o).getValue());
      break;
    case Option.ENUM_OPTION:
      VM.sysWrite(((EnumOption) o).getValueString());
      break;
    }
  }

  /**
   * Log a string.
   */
  protected void logString(String s) {
    VM.sysWrite(s);
  }

  /**
   * Print a new line.
   */
  protected void logNewLine() {
    VM.sysWriteln();
  }

  /**
   * Determine the VM specific key for a given option name. Option names are
   * space delimited with capitalised words (e.g. "GC Verbosity Level").
   *
   * @param name The option name.
   * @return The VM specific key.
   */
  protected String computeKey(String name) {
    int space = name.indexOf(' ');
    if (space < 0) return name.toLowerCase();

    String word = name.substring(0, space);
    String key = word.toLowerCase();

    do {
      int old = space+1;
      space = name.indexOf(' ', old);
      if (space < 0) {
        key += name.substring(old);
        return key;
      }
      key += name.substring(old, space);
    } while (true);
  }

  /**
   * A non-fatal error occurred during the setting of an option. This method
   * calls into the VM and shall not cause the system to stop.
   *
   * @param o The responsible option.
   * @param message The message associated with the warning.
   */
  protected void warn(Option o, String message) {
    VM.sysWrite("WARNING: Option '");
    VM.sysWrite(o.getKey());
    VM.sysWrite("' : ");
    VM.sysWriteln(message);
  }

  /**
   * A fatal error occurred during the setting of an option. This method
   * calls into the VM and is required to cause the system to stop.
   *
   * @param o The responsible option.
   * @param message The error message associated with the failure.
   */
  protected void fail(Option o, String message) {
    VM.sysWrite("Error: Option '");
    VM.sysWrite(o.getKey());
    VM.sysWrite("' : ");
    VM.sysWriteln(message);
    VM.sysFail("");
  }

  /**
   * Convert bytes into pages, rounding up if necessary.
   *
   * @param bytes The number of bytes.
   * @return The corresponding number of pages.
   */
  @Uninterruptible
  protected int bytesToPages(Extent bytes) {
    return bytes.plus(Constants.BYTES_IN_PAGE-1).toWord().rshl(Constants.LOG_BYTES_IN_PAGE).toInt();
  }

  /**
   * Convert from pages into bytes.
   * @param pages the number of pages.
   * @return The corresponding number of bytes.
   */
  @Uninterruptible
  protected Extent pagesToBytes(int pages) {
    return Word.fromIntZeroExtend(pages).lsh(Constants.LOG_BYTES_IN_PAGE).toExtent();
  }

  public static void parseOptions(String[] args) {
    for (int i = 0; i < args.length; i++) {
      gc.parseOption(args[i]);
    }
  }

  private boolean parseOption(String arg) {
    // First handle the "option commands"
    if (arg.equals("help")) {
       printHelp();
       return true;
    }
    if (arg.equals("printOptions")) {
       printOptions();
       return true;
    }
    if (arg.length() == 0) {
      printHelp();
      return true;
    }

    // Required format of arg is 'name=value'
    // Split into 'name' and 'value' strings
    int split = arg.indexOf('=');
    if (split == -1) {
      VM.sysWrite("Illegal option specification: ");
      VM.sysWrite(arg);
      VM.sysWriteln(". Must be specified as a name-value pair in the form of option=value");
      return false;
    }

    String name = arg.substring(0, split);
    String value = arg.substring(split + 1);

    Option o = getOption(name);

    if (o == null) return false;

    switch (o.getType()) {
      case Option.BOOLEAN_OPTION:
        if (value.equals("true")) {
          ((BooleanOption) o).setValue(true);
          return true;
        } else if (value.equals("false")) {
          ((BooleanOption) o).setValue(false);
          return true;
        }
        return false;

      case Option.INT_OPTION: {
        int ival = parseInt(value, (IntOption) o);
        ((IntOption) o).setValue(ival);
        return true;
      }
      case Option.ADDRESS_OPTION: {
        int ival = parseInt(value, null);
        if (ival != 0) {
          ((AddressOption) o).setValue(ival);
        } else {
          VM.sysWrite("Invalid value for ");
          VM.sysWriteln(o.getName());
        }
        return true;
      }
      case Option.FLOAT_OPTION: {
        float fval = parseFloat(value, (FloatOption) o);
        ((FloatOption) o).setValue(fval);
        return true;
      }
      case Option.STRING_OPTION:
        ((StringOption) o).setValue(value);
        return true;

      case Option.ENUM_OPTION:
        ((EnumOption) o).setValue(value);
        return true;

      case Option.PAGES_OPTION:
        long pval = parseMemorySize(o.getName(), name, "b", 1, arg, value);
        if (pval < 0) return false;
        ((PagesOption) o).setBytes(Extent.fromIntSignExtend((int)pval));
        return true;

      case Option.MICROSECONDS_OPTION:
        int mval = parseInt(value, null);
        ((MicrosecondsOption) o).setMicroseconds(mval);
        return true;
    }

    // None of the above tests matched, so this wasn't an option
    return false;
  }

  private static int parseNumber(String arg, int base, int start, int end) {
    int value = 0;
    for (int i = start; i < end; i++) {
      value = value * base;
      char c = arg.charAt(i);
      switch (c) {
        case '0': break;
        case '1': value += 1; break;
        case '2': value += 2; break;
        case '3': value += 3; break;
        case '4': value += 4; break;
        case '5': value += 5; break;
        case '6': value += 6; break;
        case '7': value += 7; break;
        case '8': value += 8; break;
        case '9': value += 9; break;
        case 'a': value += 0xa; break;
        case 'b': value += 0xb; break;
        case 'c': value += 0xc; break;
        case 'd': value += 0xd; break;
        case 'e': value += 0xe; break;
        case 'f': value += 0xf; break;
        default:
          return -1;
      }
    }
    return value;
  }

  private static int parseInt(String arg, IntOption option) {
    int base = 10;
    int i = 0;
    boolean isNegative = false;
    if (arg.charAt(0) == '-') {
      i++;
      isNegative = true;
    } else if (arg.length() > 1 && arg.charAt(0) == '0' && arg.charAt(1) == 'x') {
      i += 2;
      base = 16;
    }
    int value = parseNumber(arg, base, i, arg.length());
    if (value == -1) {
      if (option != null) {
        VM.sysWrite("Invalid value for ");
        VM.sysWriteln(option.getName());
        return option.getValue();
      } else {
        return 0;
      }
    }
    return isNegative ? -value : value;
  }

  private static float parseFloat(String arg, FloatOption option) {
    boolean isNegative = false;
    int start = 0;
    if (arg.charAt(0) == '-') {
      start++;
      isNegative = true;
    }
    int dot = arg.indexOf('.');
    if (dot == -1) {
      int value = parseNumber(arg, 10, start, arg.length());
      if (value == -1) {
        VM.sysWrite("Invalid value for ");
        VM.sysWriteln(option.getName());
        return option.getValue();
      }
      return (float) (isNegative ? -value : value);
    } else {
      int value = parseNumber(arg, 10, start, dot);
      if (value == -1) {
        VM.sysWrite("Invalid value for ");
        VM.sysWriteln(option.getName());
        return option.getValue();
      }
      int intDecimal = parseNumber(arg, 10, dot + 1, arg.length());
      if (intDecimal == -1) {
        VM.sysWrite("Invalid value for ");
        VM.sysWriteln(option.getName());
        return option.getValue();
      }
      double divide = 1;
      for (int i = 1; i < arg.length() - dot; i++) {
        divide *= 10;
      }
      double decimal = ((double) intDecimal) / divide;
      return (float)(decimal + value);
    }
  }

  private static long parseMemorySize(String sizeName,
                                      String sizeFlag,
                                      String defaultFactor,
                                      int roundTo,
                                      String fullArg,
                                      String subArg) {
    return 0L;
  }


  private void printHelp() {
    VM.sysWriteln("Commands");
    VM.sysWrite(prefix);
    VM.sysWriteln("[:help]\t\t\tPrint brief description of arguments");
    VM.sysWrite(prefix);
    VM.sysWriteln(":printOptions\t\tPrint the current values of options");
    VM.sysWriteln();

    //Begin generated help messages
    VM.sysWrite("Boolean Options (");
    VM.sysWrite(prefix);
    VM.sysWrite(":<option>=true or ");
    VM.sysWrite(prefix);
    VM.sysWriteln(":<option>=false)");
    VM.sysWriteln("Option                                 Description");

    Option o = getFirst();
    while (o != null) {
      if (o.getType() == Option.BOOLEAN_OPTION) {
        String key = o.getKey();
        VM.sysWrite(key);
        for (int c = key.length(); c < 39;c++) {
          VM.sysWrite(" ");
        }
        VM.sysWriteln(o.getDescription());
      }
      o = o.getNext();
    }

    VM.sysWrite("\nValue Options (");
    VM.sysWrite(prefix);
    VM.sysWriteln(":<option>=<value>)");
    VM.sysWriteln("Option                         Type    Description");

    o = getFirst();
    while (o != null) {
      if (o.getType() != Option.BOOLEAN_OPTION &&
          o.getType() != Option.ENUM_OPTION) {
        String key = o.getKey();
        VM.sysWrite(key);
        for (int c = key.length(); c < 31;c++) {
          VM.sysWrite(" ");
        }
        switch (o.getType()) {
          case Option.INT_OPTION:          VM.sysWrite("int     "); break;
          case Option.ADDRESS_OPTION:      VM.sysWrite("address "); break;
          case Option.FLOAT_OPTION:        VM.sysWrite("float   "); break;
          case Option.MICROSECONDS_OPTION: VM.sysWrite("usec    "); break;
          case Option.PAGES_OPTION:        VM.sysWrite("bytes   "); break;
          case Option.STRING_OPTION:       VM.sysWrite("string  "); break;
        }
        VM.sysWriteln(o.getDescription());
      }
      o = o.getNext();
    }

    VM.sysWriteln("\nSelection Options (set option to one of an enumeration of possible values)");

    o = getFirst();
    while (o != null) {
      if (o.getType() == Option.ENUM_OPTION) {
        String key = o.getKey();
        VM.sysWrite(key);
        for (int c = key.length(); c < 31; c++) {
          VM.sysWrite(" ");
        }
        VM.sysWriteln(o.getDescription());
        VM.sysWrite("    { ");
        boolean first = true;
        for (String val : ((EnumOption)o).getValues()) {
          VM.sysWrite(first ? "" : ", ");
          VM.sysWrite(val);
          first = false;
        }
        VM.sysWriteln(" }");
      }
      o = o.getNext();
    }
  }

  private void printOptions() {
    VM.sysWriteln("Current value of GC options");

    Option o = getFirst();
    while (o != null) {
      if (o.getType() == Option.BOOLEAN_OPTION) {
        String key = o.getKey();
        VM.sysWrite("\t");
        VM.sysWrite(key);
        for (int c = key.length(); c < 31; c++) {
          VM.sysWrite(" ");
        }
        VM.sysWrite(" = ");
        logValue(o, false);
        VM.sysWriteln();
      }
      o = o.getNext();
    }

    o = getFirst();
    while (o != null) {
      if (o.getType() != Option.BOOLEAN_OPTION &&
          o.getType() != Option.ENUM_OPTION) {
        String key = o.getKey();
        VM.sysWrite("\t");
        VM.sysWrite(key);
        for (int c = key.length(); c < 31; c++) {
          VM.sysWrite(" ");
        }
        VM.sysWrite(" = ");
        logValue(o, false);
        VM.sysWriteln();
      }
      o = o.getNext();
    }

    o = getFirst();
    while (o != null) {
      if (o.getType() == Option.ENUM_OPTION) {
        String key = o.getKey();
        VM.sysWrite("\t");
        VM.sysWrite(key);
        for (int c = key.length(); c < 31; c++) {
          VM.sysWrite(" ");
        }
        VM.sysWrite(" = ");
        logValue(o, false);
        VM.sysWriteln();
      }
      o = o.getNext();
    }
  }
}