/*
 *  This file is part of the Jikes RVM project (http://jikesrvm.org).
 *
 *  This file is licensed to You under the Eclipse Public License (EPL);
 *  You may not use this file except in compliance with the License. You
 *  may obtain a copy of the License at
 *
 *      http://www.opensource.org/licenses/eclipse-1.0.php
 *
 *  See the COPYRIGHT.txt file distributed with this work for information
 *  regarding copyright ownership.
 */
package org.mmtk.plan.poisoned;

import org.mmtk.plan.marksweep.MS;

import org.vmmagic.pragma.*;
import org.vmmagic.unboxed.Address;
import org.vmmagic.unboxed.ObjectReference;
import org.vmmagic.unboxed.Word;

/**
 * This class implements a poisoned collector, that is essentially a test
 * case for read and write barriers in the VM.
 */
@Uninterruptible
public class Poisoned extends MS {

  @Override
  public Word bootTimeWriteBarrier(Word reference) {
    return reference.or(Word.one());
  }

  /**
   * Poisons a reference value.
   *
   * @param reference the reference to poison
   * @return the poisoned value
   */
  @Inline
  public static Word poison(ObjectReference reference) {
    return reference.toAddress().toWord().or(Word.one());
  }

  /**
   * DePoisons a reference value.
   *
   * @param value the reference to dePoison
   * @return the dePoisoned value
   */
  @Inline
  public static ObjectReference depoison(Word value) {
    return value.and(Word.one().not()).toAddress().toObjectReference();
  }

  /****************************************************************************
   * Internal read/write barriers.
   */

  /**
   * {@inheritDoc}
   */
  @Override
  @Inline
  public void storeObjectReference(Address slot, ObjectReference value) {
    slot.store(poison(value));
  }

  @Override
  @Inline
  public ObjectReference loadObjectReference(Address slot) {
    return depoison(slot.loadWord());
  }
}