stack_vm.cc 16.5 KB
Newer Older
1 2 3 4 5 6
/*!
 *  Copyright (c) 2017 by Contributors
 * Implementation stack VM.
 * \file stack_vm.cc
 */
#include <dmlc/thread_local.h>
7
#include <tvm/ir.h>
8 9 10
#include "./stack_vm.h"

namespace tvm {
11
namespace codegen {
12 13 14 15 16 17 18 19 20 21 22 23 24

typedef dmlc::ThreadLocalStore<StackVM::State> StackVMStateStore;

StackVM::State* StackVM::ThreadLocalState() {
  return StackVMStateStore::Get();
}

#define STACK_VM_BINOP(OP, FIELD)                                 \
  {                                                               \
    stack[sp - 1].FIELD = stack[sp - 1].FIELD OP stack[sp].FIELD; \
    sp -= 1; pc += 1;                                             \
  }

25 26
#define STACK_VM_CMPOP(OP, FIELD)                                   \
  {                                                                 \
27
    stack[sp - 1].v_int64 = stack[sp - 1].FIELD OP stack[sp].FIELD; \
28
    sp -= 1; pc += 1;                                               \
29 30 31 32
  }

#define STACK_VM_LOAD(FIELD, DST_TYPE, SRC_TYPE)                        \
  {                                                                     \
33 34 35 36
    int index = code[pc + 1].v_int;                                     \
    stack[sp]FIELD = static_cast<DST_TYPE>(                             \
        static_cast<SRC_TYPE*>(stack[sp].v_handle)[index]);             \
    pc += 2;                                                            \
37 38 39 40
  }

#define STACK_VM_STORE(FIELD, DST_TYPE)                                 \
  {                                                                     \
41 42 43 44
    int index = code[pc + 1].v_int;                                     \
    static_cast<DST_TYPE*>(stack[sp - 1].v_handle)[index] =             \
        static_cast<DST_TYPE>(stack[sp]FIELD);                          \
    sp -= 2; pc += 2;                                                   \
45 46
  }

47 48
#define STACK_VM_PRINT_CODE0(CODE)                            \
  case CODE:  {                                                     \
49 50 51 52 53 54
    os << "[" << pc << "]\t" << #CODE << std::endl; return pc + 1;  \
  }

#define STACK_VM_PRINT_CODE1(CODE)                                      \
  case CODE:  {                                                         \
    os << "[" << pc << "]\t" << #CODE << " " << code[pc + 1].v_int << "\n" \
55
       <<  "[" << pc + 1 << "]" << std::endl;                           \
56 57 58
        return pc + 2;                                                  \
  }

59 60 61 62 63 64 65 66 67 68
#define STACK_VM_PRINT_CODE2(CODE)                                      \
  case CODE:  {                                                         \
    os << "[" << pc << "]\t" << #CODE                                   \
        << " " << code[pc + 1].v_int                                    \
        << " " << code[pc + 2].v_int << "\n"                            \
       <<  "[" << pc + 1 << "]" << std::endl                            \
       <<  "[" << pc + 2 << "]" << std::endl;                           \
        return pc + 3;                                                  \
  }

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
#define STACK_VM_PRINT_HEAP_ACCESS(CODE)                                \
  case CODE:  {                                                         \
    os << "[" << pc << "]\t" << #CODE << " " << code[pc + 1].v_int      \
       << " " << heap_id_name[code[pc + 1].v_int] << "\n"               \
       <<  "[" << pc + 1 << "]" << std::endl;                           \
        return pc + 2;                                                  \
  }

#define STACK_VM_PRINT_JUMP(CODE)                                     \
  case CODE:  {                                                        \
    os << "[" << pc << "]\t" << #CODE << " rel=" << code[pc + 1].v_int \
       << " to " << pc + code[pc + 1].v_int << '\n'                    \
       << "[" << pc + 1 << "]" << std::endl;                         \
    return pc + 2;                                                     \
  }


int64_t StackVM::PrintCode(std::ostream& os, int64_t pc) const {
  switch (code[pc].op_code) {
    // int
    STACK_VM_PRINT_CODE0(ADD_I64);
    STACK_VM_PRINT_CODE0(SUB_I64);
    STACK_VM_PRINT_CODE0(MUL_I64);
    STACK_VM_PRINT_CODE0(MOD_I64);
    STACK_VM_PRINT_CODE0(DIV_I64);
    STACK_VM_PRINT_CODE0(EQ_I64);
    STACK_VM_PRINT_CODE0(LT_I64);
    STACK_VM_PRINT_CODE0(LE_I64);
    // floats
    STACK_VM_PRINT_CODE0(ADD_F64);
    STACK_VM_PRINT_CODE0(SUB_F64);
    STACK_VM_PRINT_CODE0(MUL_F64);
    STACK_VM_PRINT_CODE0(DIV_F64);
    STACK_VM_PRINT_CODE0(EQ_F64);
    STACK_VM_PRINT_CODE0(LT_F64);
    STACK_VM_PRINT_CODE0(LE_F64);
    // addressing load
    STACK_VM_PRINT_CODE1(ARRAY_LOAD_UINT32);
107 108 109 110 111 112 113 114 115 116 117
    STACK_VM_PRINT_CODE1(ARRAY_LOAD_INT32);
    STACK_VM_PRINT_CODE1(ARRAY_LOAD_INT64);
    STACK_VM_PRINT_CODE1(ARRAY_LOAD_FP64);
    STACK_VM_PRINT_CODE1(ARRAY_LOAD_HANDLE);
    STACK_VM_PRINT_CODE1(ARRAY_LOAD_TVMVALUE);
    STACK_VM_PRINT_CODE1(ARRAY_STORE_UINT32);
    STACK_VM_PRINT_CODE1(ARRAY_STORE_INT32);
    STACK_VM_PRINT_CODE1(ARRAY_STORE_INT64);
    STACK_VM_PRINT_CODE1(ARRAY_STORE_FP64);
    STACK_VM_PRINT_CODE1(ARRAY_STORE_HANDLE);
    STACK_VM_PRINT_CODE1(ARRAY_STORE_TVMVALUE);
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
    STACK_VM_PRINT_CODE0(NOT);
    STACK_VM_PRINT_CODE0(ADDR_ADD);
    // stack ops
    STACK_VM_PRINT_CODE1(PUSH_I64);
    STACK_VM_PRINT_CODE1(PUSH_VALUE);
    STACK_VM_PRINT_CODE0(POP);
    STACK_VM_PRINT_CODE0(SELECT);
    STACK_VM_PRINT_HEAP_ACCESS(STORE_HEAP);
    STACK_VM_PRINT_HEAP_ACCESS(LOAD_HEAP);
    STACK_VM_PRINT_CODE1(ASSERT);
    STACK_VM_PRINT_JUMP(RJUMP_IF_TRUE);
    STACK_VM_PRINT_JUMP(RJUMP_IF_FALSE);
    STACK_VM_PRINT_JUMP(RJUMP);
    STACK_VM_PRINT_CODE1(ASSERT_SP);
    // Intrinsics
133 134 135 136
    STACK_VM_PRINT_CODE2(TVM_STRUCT_GET);
    STACK_VM_PRINT_CODE2(TVM_STRUCT_SET);
    // Allocate data by 8 bytes.
    STACK_VM_PRINT_CODE1(TVM_STACK_ALLOCA_BY_8BYTE);
137
    // packed function.
138 139 140 141
    case CALL_PACKED_LOWERED: {
      int call_fid = code[pc + 1].v_int;
      int begin = code[pc + 2].v_int;
      int end = code[pc + 3].v_int;
142
      os << "[" << pc << "]\tCALL_PACKED_FUNC "
143 144 145
         << " fid=" << call_fid
         << " begin=" << begin
         << " end=" << end;
146
      os << '\n';
147 148
      for (int i = 0; i < 3; ++i) {
        os << "[" << pc + 1 + i << "]" << std::endl;
149
      }
150
      return pc + 4;
151
    }
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
  }
  LOG(FATAL) << "unknown op code " << code[pc].op_code;
  return 0;
}

std::ostream& operator<<(std::ostream& os, const StackVM& vm) {  // NOLINT(*)
  int64_t pc = 0;
  const int64_t code_size = static_cast<int64_t>(vm.code.size());
  os << "Program dump: code-size=" << code_size << '\n'
     << "----------begin-----------------\n";
  while (pc < code_size) {
    pc = vm.PrintCode(os, pc);
  }
  os << "----------end--------------------\n";
  return os;
}

169 170 171 172 173 174 175
void StackVM::operator()(const runtime::TVMArgs& args) const {
  StackVM::State* s = StackVM::ThreadLocalState();
  s->sp = 0;
  s->pc = 0;
  if (s->heap.size() < this->heap_size) {
    s->heap.resize(this->heap_size);
  }
176

177 178 179 180 181 182
  s->heap[0].v_handle = (void*)args.values;  // NOLINT(*)
  s->heap[1].v_handle = (void*)args.type_codes;  // NOLINT(*)
  s->heap[2].v_int64 = args.num_args;
  this->Run(s);
}

183 184 185
void StackVM::Run(State* s) const {
  int64_t sp = s->sp;
  int64_t pc = s->pc;
186
  int64_t alloca_sp = s->sp;
187 188
  std::vector<TVMValue>& stack = s->stack;
  std::vector<TVMValue>& heap = s->heap;
189 190
  s->extern_func.clear();
  s->extern_func.resize(extern_func_name.size());
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
  if (stack.size() < stack_size) {
    stack.resize(stack_size);
  }
  int64_t stack_cap = static_cast<int64_t>(stack_size - 4);
  if (heap.size() < heap_size) {
    heap.resize(heap_size);
  }
  const int64_t code_size = static_cast<int64_t>(code.size());
  while (pc < code_size) {
    switch (code[pc].op_code) {
      case ADD_I64: STACK_VM_BINOP(+, v_int64); break;
      case SUB_I64: STACK_VM_BINOP(-, v_int64); break;
      case MUL_I64: STACK_VM_BINOP(*, v_int64); break;
      case DIV_I64: STACK_VM_BINOP(/, v_int64); break;
      case MOD_I64: STACK_VM_BINOP(%, v_int64); break;
      case EQ_I64: STACK_VM_CMPOP(==, v_int64); break;
      case LT_I64: STACK_VM_CMPOP(<, v_int64); break;
      case LE_I64: STACK_VM_CMPOP(<=, v_int64); break;
      case ADD_F64: STACK_VM_BINOP(+, v_float64); break;
      case SUB_F64: STACK_VM_BINOP(-, v_float64); break;
      case MUL_F64: STACK_VM_BINOP(*, v_float64); break;
      case DIV_F64: STACK_VM_BINOP(/, v_float64); break;
      case EQ_F64: STACK_VM_CMPOP(==, v_float64); break;
      case LT_F64: STACK_VM_CMPOP(<, v_float64); break;
      case LE_F64: STACK_VM_CMPOP(<=, v_float64); break;
      // addressing
217 218 219 220 221 222 223 224 225 226 227 228 229 230
      case ARRAY_LOAD_UINT32: STACK_VM_LOAD(.v_int64, int64_t, uint32_t); break;
      case ARRAY_LOAD_INT32: STACK_VM_LOAD(.v_int64, int64_t, int32_t); break;
      case ARRAY_LOAD_INT64: STACK_VM_LOAD(.v_int64, int64_t, int64_t); break;
      case ARRAY_LOAD_FP64: STACK_VM_LOAD(.v_float64, double, double); break;
      case ARRAY_LOAD_HANDLE: STACK_VM_LOAD(.v_handle, void*, void*); break;
      case ARRAY_LOAD_TVMVALUE: STACK_VM_LOAD(, TVMValue, TVMValue); break;
      // store
      case ARRAY_STORE_UINT32: STACK_VM_STORE(.v_int64, uint32_t); break;
      case ARRAY_STORE_INT32: STACK_VM_STORE(.v_int64, int32_t); break;
      case ARRAY_STORE_INT64: STACK_VM_STORE(.v_int64, int64_t); break;
      case ARRAY_STORE_FP64: STACK_VM_STORE(.v_float64, double); break;
      case ARRAY_STORE_HANDLE: STACK_VM_STORE(.v_handle, void*); break;
      case ARRAY_STORE_TVMVALUE: STACK_VM_STORE(, TVMValue); break;
      // add
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
      case ADDR_ADD: {
        stack[sp - 1].v_handle = (char*)(stack[sp - 1].v_handle) + stack[sp].v_int64;  // NOLINT(*)
        sp = sp - 1;
        pc = pc + 1;
        break;
      }
      case NOT: {
        stack[sp].v_int64 = !stack[sp].v_int64;
        pc += 1;
        break;
      }
      case PUSH_I64: {
        stack[sp + 1].v_int64 = code[pc + 1].v_int;
        sp += 1;
        pc += 2;
        break;
      }
      case PUSH_VALUE: {
        int relpos = code[pc + 1].v_int;
        CHECK_LE(relpos, 0);
        stack[sp + 1] = stack[sp + relpos];
        sp += 1;
        pc += 2;
        break;
      }
      case POP: {
        sp -= 1;
        pc += 1;
        break;
      }
      case SELECT: {
        stack[sp - 2] = (stack[sp].v_int64 ? stack[sp - 2] : stack[sp - 1]);
        sp -= 2;
        pc += 1;
        break;
      }
      case LOAD_HEAP: {
        stack[sp + 1] = heap[code[pc + 1].v_int];
        sp += 1;
        pc += 2;
        break;
      }
      case STORE_HEAP: {
        heap[code[pc + 1].v_int] = stack[sp];
        sp -= 1;
        pc += 2;
        break;
      }
      case ASSERT: {
        CHECK(stack[sp].v_int64) << str_data[code[pc + 1].v_int];
        sp -= 1;
        pc += 2;
        break;
      }
      case RJUMP_IF_TRUE: {
        if (stack[sp].v_int64) {
          pc += code[pc + 1].v_int;
        } else {
          pc += 2;
        }
        break;
      }
      case RJUMP_IF_FALSE: {
        if (!stack[sp].v_int64) {
          pc += code[pc + 1].v_int;
        } else {
          pc += 2;
        }
        break;
      }
      case RJUMP: {
        pc += code[pc + 1].v_int;
        break;
      }
      case ASSERT_SP: {
        int64_t expected = code[pc + 1].v_int;
        CHECK_EQ(sp, expected)
            << "sp assertion failed, expected="
            << expected << " now=" << sp << ", pc=" << pc;
        pc += 2;
        break;
      }
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
      case CALL_PACKED_LOWERED: {
        // call packed function.
        TVMValue* value_stack = static_cast<TVMValue*>(stack[sp - 1].v_handle);
        int* type_stack = static_cast<int*>(stack[sp].v_handle);
        int call_fid = code[pc + 1].v_int;
        int begin = code[pc + 2].v_int;
        int end = code[pc + 3].v_int;
        int num_args = end - begin;
        static_assert(sizeof(Code) == sizeof(int) &&
                      alignof(Code) == alignof(int), "asusmption");
        runtime::TVMRetValue rv;
        GetExtern(s, call_fid).CallPacked(
            runtime::TVMArgs(value_stack + begin, type_stack + begin, num_args), &rv);
        sp = sp - 1;
        stack[sp] = rv.value();
        pc += 4;
        break;
330
      }
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
      // intrinsics
      case TVM_STRUCT_GET: {
        using namespace ir;
        int index = code[pc + 1].v_int;
        int kind = code[pc + 2].v_int;
        TVMArray* arr = static_cast<TVMArray*>(stack[sp].v_handle);
        switch (kind) {
          case intrinsic::kArrData: {
            stack[sp].v_handle = arr[index].data; break;
          }
          case intrinsic::kArrShape: {
            stack[sp].v_handle = arr[index].shape; break;
          }
          case intrinsic::kArrStrides: {
            stack[sp].v_handle = arr[index].strides; break;
          }
          case intrinsic::kArrNDim: {
            stack[sp].v_int64 = arr[index].ndim; break;
          }
          case intrinsic::kArrTypeCode: {
            stack[sp].v_int64 = static_cast<int64_t>(
                arr[index].dtype.code); break;
          }
          case intrinsic::kArrTypeBits: {
            stack[sp].v_int64 = static_cast<int64_t>(
                arr[index].dtype.bits); break;
          }
          case intrinsic::kArrTypeLanes: {
            stack[sp].v_int64 = static_cast<int64_t>(
                arr[index].dtype.lanes); break;
          }
          case intrinsic::kArrByteOffset: {
            stack[sp].v_int64 = static_cast<int64_t>(
                arr[index].byte_offset); break;
            break;
          }
          case intrinsic::kArrDeviceId: {
            stack[sp].v_int64 = arr[index].ctx.device_id; break;
          }
          case intrinsic::kArrDeviceType: {
            stack[sp].v_int64 = static_cast<int64_t>(
                arr[index].ctx.device_type); break;
          }
          case intrinsic::kArrAddr: {
            stack[sp].v_handle = arr + index; break;
          }
          case intrinsic::kTVMValueContent: {
            stack[sp] = static_cast<TVMValue*>(stack[sp].v_handle)[index]; break;
          }
          default: LOG(FATAL) << "unhandled get " << kind;
        }
        pc = pc + 3;
        break;
384
      }
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
      case TVM_STRUCT_SET: {
        using namespace ir;
        int index = code[pc + 1].v_int;
        int kind = code[pc + 2].v_int;
        TVMArray* arr = static_cast<TVMArray*>(stack[sp - 1].v_handle);
        switch (kind) {
          case intrinsic::kArrData: {
            arr[index].data = stack[sp].v_handle; break;
          }
          case intrinsic::kArrShape: {
            arr[index].shape = static_cast<int64_t*>(stack[sp].v_handle);
            break;
          }
          case intrinsic::kArrStrides: {
            arr[index].strides = static_cast<int64_t*>(stack[sp].v_handle);
            break;
          }
          case intrinsic::kArrNDim: {
            arr[index].ndim = static_cast<int>(stack[sp].v_int64);
            break;
          }
          case intrinsic::kArrTypeCode: {
            arr[index].dtype.code = static_cast<uint8_t>(stack[sp].v_int64);
            break;
          }
          case intrinsic::kArrTypeBits: {
            arr[index].dtype.bits = static_cast<uint8_t>(stack[sp].v_int64);
            break;
          }
          case intrinsic::kArrTypeLanes: {
            arr[index].dtype.lanes = static_cast<uint16_t>(stack[sp].v_int64);
            break;
          }
          case intrinsic::kArrByteOffset: {
            arr[index].byte_offset = static_cast<uint64_t>(stack[sp].v_int64);
            break;
          }
          case intrinsic::kArrDeviceId: {
            arr[index].ctx.device_id = static_cast<int>(stack[sp].v_int64);
            break;
          }
          case intrinsic::kArrDeviceType: {
            arr[index].ctx.device_type = static_cast<DLDeviceType>(stack[sp].v_int64);
            break;
          }
          case intrinsic::kTVMValueContent: {
            static_cast<TVMValue*>(stack[sp - 1].v_handle)[index] = stack[sp]; break;
          }
          default: LOG(FATAL) << "unhandled tvm_struct_set " << kind;
        }
        sp -= 2;
        pc += 3;
        break;
438
      }
439 440 441 442 443 444 445 446 447 448
      // alloca
      case TVM_STACK_ALLOCA_BY_8BYTE: {
        static_assert(sizeof(TVMValue) == 8, "invariance");
        int num = code[pc + 1].v_int;
        void* addr = &stack[sp] + 1;
        sp = sp + num + 1;
        alloca_sp = sp - 1;
        stack[sp].v_handle = addr;
        pc = pc + 2;
        break;
449 450
      }
    }
451
    CHECK_GE(sp, alloca_sp) << "touch allocated space";
452 453 454 455
    CHECK_LT(sp, stack_cap) << "Stack overflow";
  }
}

456 457 458 459 460 461 462 463 464 465 466 467 468 469
const PackedFunc& StackVM::GetExtern(State* s, int fid) const {
  PackedFunc& f = s->extern_func[fid];
  if (f == nullptr) {
    CHECK(mod_ctx != nullptr)
        << "No local context is set in stackvm";
    const PackedFunc* pf = mod_ctx->GetFuncFromEnv(extern_func_name[fid]);
    CHECK(pf != nullptr);
    f = *pf;
    CHECK(f != nullptr);
  }
  return f;
}

}  // namespace codegen
470
}  // namespace tvm