// Copyright 2022 Risc0, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include "risc0/core/util.h"
#include "risc0/zkp/core/constants.h"
#include "risc0/zkvm/platform/memory.h"

namespace risc0 {

namespace CodeCycleType {
enum {
  NORMAL,
  FINAL,
  INIT,
  MEM_WRITE,
  RESET,
  FINI,
  NUM_TYPES,
};
} // namespace CodeCycleType

namespace DataCycleType {
enum {
  DECODE,
  COMPUTE_0,
  COMPUTE_1,
  COMPUTE_2,
  COMPUTE_3,
  MULTIPLY,
  DIVIDE,
  FINAL,
  SHA_SYNC,
  SHA_CONTROL,
  SHA_DATA,
  HALT,
  NUM_CYCLE_TYPES,
};
} // namespace DataCycleType

namespace ShaCycleType {
enum {
  CONTROL,
  LOAD,
  MIX,
  NUM_TYPES,
};
} // namespace ShaCycleType

CONSTSCALAR size_t kCodeSize = 16;
CONSTSCALAR size_t kDataSize = 162;
CONSTSCALAR size_t kAccumSize = 10;

CONSTSCALAR size_t kOutputRegs = 9;
CONSTSCALAR size_t kMinCycles = 512;
CONSTSCALAR size_t kZkCycles = kQueries;

CONSTSCALAR size_t kRegistersGlobalOffset = 0;
CONSTSCALAR size_t kRegistersGlobalSize = kOutputRegs * 2;
CONSTSCALAR size_t kAccumMixGlobalOffset = kRegistersGlobalSize;
CONSTSCALAR size_t kAccumMixGlobalSize = 20;
CONSTSCALAR size_t kGlobalSize = kAccumMixGlobalOffset + kAccumMixGlobalSize;

CONSTSCALAR size_t kComboCount = 5;

/// The maximum number of entries that a MethodId table can have. This is based on the maximum
/// number of cycles that the zkVM is allowed to execute.
CONSTSCALAR size_t kMaxCodeDigestCount = log2Ceil(kMaxCycles / kMinCycles) + 1;

/// The default number of digest entries in a MethodId. This is set to something less than the
/// `kMaxCodeDigestCount` so that computation of MethodId doesn't take too long.
CONSTSCALAR size_t kDefaultCodeDigestCount = 12;

} // namespace risc0