/*
 * Copyright (C) 2012-2017 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 */

#pragma once

#include "JSRunLoopTimer.h"

namespace JSC {

class Heap;
class BlockDirectory;

class IncrementalSweeper final : public JSRunLoopTimer {
public:
    using Base = JSRunLoopTimer;
    JS_EXPORT_PRIVATE explicit IncrementalSweeper(Heap*);

    JS_EXPORT_PRIVATE void startSweeping(Heap&);

    void doWorkUntil(VM&, MonotonicTime deadline);
    void doWork(VM&) final;
    void stopSweeping();

private:
    enum class SweepTrigger : bool { Timer, OpportunisticTask };
    bool sweepNextBlock(VM&, SweepTrigger);
    void doSweep(VM&, MonotonicTime startTime, SweepTrigger);
    void scheduleTimer();
    
    BlockDirectory* m_currentDirectory;
    bool m_lastOpportunisticTaskDidFinishSweeping { false };
};

} // namespace JSC
