nanocoat/include/sjme/nvm.h

   1 /* -*- Mode: C; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the Mozilla Public License Version 2.0.
   7 // See license.mkd for licensing and copyright information.
   8 // -------------------------------------------------------------------------*/
   9
  10 /**
  11  * SquirrelJME NanoCoat Virtual Machine Header Definitions.
  12  *
  13  * @since 2023/07/25
  14  */
  15
  16 #ifndef SQUIRRELJME_NVM_H
  17 #define SQUIRRELJME_NVM_H
  18
  19 #include <stdlib.h>
  20 #include <stdint.h>
  21 #include <setjmp.h>
  22
  23 #include "sjme/config.h"
  24
  25 /* Anti-C++. */
  26 #ifdef __cplusplus
  27         #ifndef SJME_CXX_IS_EXTERNED
  28                 #define SJME_CXX_IS_EXTERNED
  29                 #define SJME_CXX_SQUIRRELJME_NVM_H
  30 extern "C" {
  31         #endif /* #ifdef SJME_CXX_IS_EXTERNED */
  32 #endif     /* #ifdef __cplusplus */
  33
  34 /*--------------------------------------------------------------------------*/
  35
  36 /**
  37  * Posts two tokens together.
  38  *
  39  * @param a The first token.
  40  * @param b The second token.
  41  * @since 2023/11/15
  42  */
  43 #define SJME_TOKEN_PASTE(a, b) a##b
  44
  45 /**
  46  * Pasting two tokens but with preprocessing.
  47  *
  48  * @param a The first token.
  49  * @param b The second token.
  50  * @since 2023/11/16
  51  */
  52 #define SJME_TOKEN_PASTE_PP(a, b) SJME_TOKEN_PASTE(a, b)
  53
  54 /**
  55  * Stringifies the given token.
  56  *
  57  * @param s The token to stringify.
  58  * @since 2023/11/24
  59  */
  60 #define SJME_TOKEN_STRING(s) #s
  61
  62 /**
  63  * Stringifies the given token.
  64  *
  65  * @param s The token to stringify.
  66  * @since 2023/11/24
  67  */
  68 #define SJME_TOKEN_STRING_PP(s) SJME_TOKEN_STRING(s)
  69
  70 /** SquirrelJME version string. */
  71 #define SQUIRRELJME_VERSION SJME_TOKEN_STRING_PP(SQUIRRELJME_VERSION_TRIM)
  72
  73 /**
  74  * Calculates the size of a struct member.
  75  *
  76  * @param type The type of the struct.
  77  * @param member The member to check.
  78  * @return The size of the given member.
  79  * @since 2023/11/16
  80  */
  81 #define SJME_SIZEOF_STRUCT_MEMBER(type, member) \
  82         (sizeof((*((type*)0)).member))
  83
  84 /**
  85  * Boolean type.
  86  *
  87  * @since 2023/07/25
  88  */
  89 typedef uint8_t sjme_jboolean;
  90
  91 /**
  92  * Byte type.
  93  *
  94  * @since 2023/07/25
  95  */
  96 typedef int8_t sjme_jbyte;
  97
  98 /**
  99  * Unsigned byte type.
 100  *
 101  * @since 2023/08/09
 102  */
 103 typedef uint8_t sjme_jubyte;
 104
 105 /**
 106  * Short type.
 107  *
 108  * @since 2023/07/25
 109  */
 110 typedef int16_t sjme_jshort;
 111
 112 /**
 113  * Character type.
 114  *
 115  * @since 2023/07/25
 116  */
 117 typedef uint16_t sjme_jchar;
 118
 119 /**
 120  * Integer type.
 121  *
 122  * @since 2023/07/25
 123  */
 124 typedef int32_t sjme_jint;
 125
 126 /**
 127  * Unsigned integer type.
 128  *
 129  * @since 2023/11/20
 130  */
 131 typedef uint32_t sjme_juint;
 132
 133 /**
 134  * Long value.
 135  *
 136  * @since 2023/07/25
 137  */
 138 typedef struct sjme_jlong
 139 {
 140         /** High value. */
 141         sjme_jint hi;
 142
 143         /** Low value. */
 144         sjme_juint lo;
 145 } sjme_jlong;
 146
 147 /**
 148  * Float value.
 149  *
 150  * @sinc 2023/07/25
 151  */
 152 typedef struct sjme_jfloat
 153 {
 154         sjme_jint value;
 155 } sjme_jfloat;
 156
 157 /**
 158  * Double value.
 159  *
 160  * @sinc 2023/07/25
 161  */
 162 typedef struct sjme_jdouble
 163 {
 164         /** High value. */
 165         sjme_juint hi;
 166
 167         /** Low value. */
 168         sjme_juint lo;
 169 } sjme_jdouble;
 170
 171 /**
 172  * Temporary index.
 173  *
 174  * @since 2023/07/25
 175  */
 176 typedef sjme_jint sjme_tempIndex;
 177
 178 /**
 179  * Basic data type identifier.
 180  *
 181  * @since 2023/07/25
 182  */
 183 typedef enum sjme_basicTypeId
 184 {
 185         /** Integer. */
 186         SJME_BASIC_TYPE_ID_INTEGER = 0,
 187
 188         /** Integer. */
 189         SJME_JAVA_TYPE_ID_INTEGER = SJME_BASIC_TYPE_ID_INTEGER,
 190
 191         /** Long. */
 192         SJME_BASIC_TYPE_ID_LONG = 1,
 193
 194         /** Long. */
 195         SJME_JAVA_TYPE_ID_LONG = SJME_BASIC_TYPE_ID_LONG,
 196
 197         /** Float. */
 198         SJME_BASIC_TYPE_ID_FLOAT = 2,
 199
 200         /** Float. */
 201         SJME_JAVA_TYPE_ID_FLOAT = SJME_BASIC_TYPE_ID_FLOAT,
 202
 203         /** Double. */
 204         SJME_BASIC_TYPE_ID_DOUBLE = 3,
 205
 206         /** Double. */
 207         SJME_JAVA_TYPE_ID_DOUBLE = SJME_BASIC_TYPE_ID_DOUBLE,
 208
 209         /** Object. */
 210         SJME_BASIC_TYPE_ID_OBJECT = 4,
 211
 212         /** Object. */
 213         SJME_JAVA_TYPE_ID_OBJECT = SJME_BASIC_TYPE_ID_OBJECT,
 214
 215         /** Boolean or byte. */
 216         SJME_BASIC_TYPE_ID_BOOLEAN_OR_BYTE = 5,
 217
 218         /** The number of Java type IDs. */
 219         SJME_NUM_JAVA_TYPE_IDS = SJME_BASIC_TYPE_ID_BOOLEAN_OR_BYTE,
 220
 221         /** Short. */
 222         SJME_BASIC_TYPE_ID_SHORT = 6,
 223
 224         /** Character. */
 225         SJME_BASIC_TYPE_ID_CHARACTER = 7,
 226
 227         /** Number of basic type IDs. */
 228         SJME_NUM_BASIC_TYPE_IDS = 8
 229 } sjme_basicTypeId;
 230
 231 /** The Java type ID. */
 232 typedef sjme_basicTypeId sjme_javaTypeId;
 233
 234 /**
 235  * Represents multiple type IDs.
 236  *
 237  * @since 2023/08/09
 238  */
 239 typedef struct sjme_basicTypeIds
 240 {
 241         /** The number of IDs. */
 242         sjme_jint count;
 243
 244         /** The IDs. */
 245         const sjme_javaTypeId ids[sjme_flexibleArrayCount];
 246 } sjme_basicTypeIds;
 247
 248 /**
 249  * Program counter address.
 250  *
 251  * @since 2023/07/25
 252  */
 253 typedef sjme_jint sjme_pcAddr;
 254
 255 /**
 256  * Static linkage type.
 257  *
 258  * @since 2023/07/25
 259  */
 260 typedef sjme_jint sjme_staticLinkageType;
 261
 262 /**
 263  * Base object information.
 264  *
 265  * @since 2023/07/25
 266  */
 267 typedef struct sjme_jobjectBase
 268 {
 269         /** The reference count of this object, zero it becomes GCed. */
 270         sjme_jint refCount;
 271 } sjme_jobjectBase;
 272
 273 /**
 274  * Object type.
 275  *
 276  * @since 2023/07/25
 277  */
 278 typedef sjme_jobjectBase* sjme_jobject;
 279
 280 /**
 281  * Class type.
 282  *
 283  * @since 2023/07/25
 284  */
 285 typedef sjme_jobject sjme_jclass;
 286
 287 /**
 288  * Throwable type.
 289  *
 290  * @since 2023/07/25
 291  */
 292 typedef sjme_jobject sjme_jthrowable;
 293
 294 typedef union sjme_anyData
 295 {
 296         /** Integer. */
 297         sjme_jint sjme_jint;
 298
 299         /** Object. */
 300         sjme_jobject sjme_jobject;
 301
 302         /** Temporary index. */
 303         sjme_tempIndex tempIndex;
 304 } sjme_anyData;
 305
 306 typedef struct sjme_any
 307 {
 308         /** Data type used. */
 309         sjme_basicTypeId type;
 310
 311         /** Data stored within. */
 312         sjme_anyData data;
 313 } sjme_any;
 314
 315 /**
 316  * Represents the virtual machine state.
 317  *
 318  * @since 2023/07/28
 319  */
 320 typedef struct sjme_nvm_state sjme_nvm_state;
 321
 322 /**
 323  * Frame of execution within a thread.
 324  *
 325  * @since 2023/07/25
 326  */
 327 typedef struct sjme_nvm_frame sjme_nvm_frame;
 328
 329 typedef struct sjme_nvm_thread
 330 {
 331         /** The VM state this thread is in. */
 332         sjme_nvm_state* inState;
 333
 334         /** The thread ID. */
 335         sjme_jint threadId;
 336
 337         /** The top of the stack. */
 338         sjme_nvm_frame* top;
 339
 340         /** The number of frames. */
 341         sjme_jint numFrames;
 342 } sjme_nvm_thread;
 343
 344 typedef struct sjme_static_constValue
 345 {
 346         /** Integer value. */
 347         sjme_jint sjme_jint;
 348
 349         /** Long value. */
 350         sjme_jlong sjme_jlong;
 351
 352         /** Float value. */
 353         sjme_jfloat sjme_jfloat;
 354
 355         /** Double value. */
 356         sjme_jdouble sjme_jdouble;
 357
 358         /** String value. */
 359         const char* sjme_jstring;
 360
 361         /** Class name. */
 362         const char* sjme_jclass;
 363 } sjme_static_constValue;
 364
 365 /**
 366  * Represents a field type.
 367  *
 368  * @since 2023/08/10
 369  */
 370 typedef struct sjme_static_fieldType
 371 {
 372         /** The hash code for the field type. */
 373         sjme_jint hashCode;
 374
 375         /** The field descriptor. */
 376         const char* descriptor;
 377
 378         /** The basic type. */
 379         sjme_basicTypeId basicType;
 380 } sjme_static_fieldType;
 381
 382 typedef struct sjme_static_classField
 383 {
 384         /** Field name. */
 385         const char* name;
 386
 387         /** The field type. */
 388         const sjme_static_fieldType* type;
 389
 390         /** Flags. */
 391         sjme_jint flags;
 392
 393         /** The constant value type. */
 394         sjme_basicTypeId valueType;
 395
 396         /** The value. */
 397         sjme_static_constValue value;
 398 } sjme_static_classField;
 399
 400 typedef struct sjme_static_classFields
 401 {
 402         /** The number of fields. */
 403         sjme_jint count;
 404
 405         /** Fields. */
 406         sjme_static_classField fields[sjme_flexibleArrayCount];
 407 } sjme_static_classFields;
 408
 409 /**
 410  * Type used for method code functions.
 411  *
 412  * @param currentState The current virtual machine state.
 413  * @param currentThread The current virtual machine thread.
 414  * @return Will return @c true if execution completed without throwing
 415  * a @c Throwable object.
 416  * @since 2023/07/25
 417  */
 418 typedef sjme_jboolean (*sjme_methodCodeFunction)(
 419         struct sjme_nvm_state* currentState,
 420         struct sjme_nvm_thread* currentThread);
 421
 422 /**
 423  * The variable mapping and setup for any given method.
 424  *
 425  * @since 2023/08/09
 426  */
 427 typedef struct sjme_static_classCodeLimits
 428 {
 429         /** The maximum number of @c sjme_basicTypeId local/stack variables. */
 430         const sjme_jubyte maxVariables[SJME_NUM_JAVA_TYPE_IDS];
 431 } sjme_static_classCodeLimits;
 432
 433 /**
 434  * Contains information about method code and how variables should be placed
 435  * on execution and stack handling.
 436  *
 437  * @since 2023/08/09
 438  */
 439 typedef struct sjme_static_classCode
 440 {
 441         /** The variable count and thrown index count used. */
 442         const sjme_static_classCodeLimits* limits;
 443
 444         /** The index where thrown objects are placed. */
 445         sjme_jshort thrownVarIndex;
 446
 447         /** The method code. */
 448         sjme_methodCodeFunction code;
 449 } sjme_static_classCode;
 450
 451 /**
 452  * Represents a standard Java method type, using field descriptors.
 453  *
 454  * @since 2023/08/10
 455  */
 456 typedef struct sjme_static_methodType
 457 {
 458         /** The hash code for the method type. */
 459         sjme_jint hashCode;
 460
 461         /** The descriptor for the method type. */
 462         const char* descriptor;
 463
 464         /** The return type. */
 465         const sjme_static_fieldType* returnType;
 466
 467         /** The number of arguments. */
 468         sjme_jint argCount;
 469
 470         /** The arguments to the method. */
 471         const sjme_static_fieldType* argTypes[0];
 472 } sjme_static_methodType;
 473
 474 typedef struct sjme_static_classMethod
 475 {
 476         /** Method name. */
 477         const char* name;
 478
 479         /** Flags. */
 480         sjme_jint flags;
 481
 482         /** Name typed. */
 483         const sjme_static_methodType* type;
 484
 485         /** Method code and any pertaining information. */
 486         const sjme_static_classCode* code;
 487 } sjme_static_classMethod;
 488
 489 typedef struct sjme_static_classMethods
 490 {
 491         /** The number of methods. */
 492         sjme_jint count;
 493
 494         /** Methods. */
 495         sjme_static_classMethod methods[sjme_flexibleArrayCount];
 496 } sjme_static_classMethods;
 497
 498 typedef struct sjme_static_classInterface
 499 {
 500         const char* interfaceName;
 501 } sjme_static_classInterface;
 502
 503 typedef struct sjme_static_classInterfaces
 504 {
 505         /** The number of interfaces. */
 506         sjme_jint count;
 507
 508         /** Interfaces. */
 509         sjme_static_classInterface interfaces[sjme_flexibleArrayCount];
 510 } sjme_static_classInterfaces;
 511
 512 typedef struct sjme_static_resource
 513 {
 514         /** The resource path. */
 515         const char* path;
 516
 517         /** The hash for the path. */
 518         sjme_jint pathHash;
 519
 520         /** The size of the resource. */
 521         sjme_jint size;
 522
 523         /** The resource data. */
 524         const sjme_jbyte data[sjme_flexibleArrayCount];
 525 } sjme_static_resource;
 526
 527 typedef struct sjme_static_linkage_data_classObject
 528 {
 529         /** The class name. */
 530         const char* className;
 531 } sjme_static_linkage_data_classObject;
 532
 533 typedef struct sjme_static_linkage_data_fieldAccess
 534 {
 535         /** Is this static? */
 536         sjme_jboolean isStatic;
 537
 538         /** Is this a store? */
 539         sjme_jboolean isStore;
 540
 541         /** The source method name. */
 542         const char* sourceMethodName;
 543
 544         /** The source method type. */
 545         const char* sourceMethodType;
 546
 547         /** The target class. */
 548         const char* targetClass;
 549
 550         /** The target field name. */
 551         const char* targetFieldName;
 552
 553         /** The target field type. */
 554         const char* targetFieldType;
 555 } sjme_static_linkage_data_fieldAccess;
 556
 557 typedef struct sjme_static_linkage_data_invokeSpecial
 558 {
 559         /** The source method name. */
 560         const char* sourceMethodName;
 561
 562         /** The source method type. */
 563         const char* sourceMethodType;
 564
 565         /** The target class. */
 566         const char* targetClass;
 567
 568         /** The target method name. */
 569         const char* targetMethodName;
 570
 571         /** The target method type. */
 572         const char* targetMethodType;
 573 } sjme_static_linkage_data_invokeSpecial;
 574
 575 typedef struct sjme_static_linkage_data_invokeNormal
 576 {
 577         /** Is this a static invocation? */
 578         sjme_jboolean isStatic;
 579
 580         /** The source method name. */
 581         const char* sourceMethodName;
 582
 583         /** The source method type. */
 584         const char* sourceMethodType;
 585
 586         /** The target class. */
 587         const char* targetClass;
 588
 589         /** The target method name. */
 590         const char* targetMethodName;
 591
 592         /** The target method type. */
 593         const char* targetMethodType;
 594 } sjme_static_linkage_data_invokeNormal;
 595
 596 typedef struct sjme_static_linkage_data_stringObject
 597 {
 598         /** The string value. */
 599         const char* string;
 600 } sjme_static_linkage_data_stringObject;
 601
 602 typedef union sjme_static_linkage_data
 603 {
 604         /** Reference to class object. */
 605         sjme_static_linkage_data_classObject classObject;
 606
 607         /** Field access. */
 608         sjme_static_linkage_data_fieldAccess fieldAccess;
 609
 610         /** Special invocation. */
 611         sjme_static_linkage_data_invokeSpecial invokeSpecial;
 612
 613         /** Normal invocation. */
 614         sjme_static_linkage_data_invokeNormal invokeNormal;
 615
 616         /** String object. */
 617         sjme_static_linkage_data_stringObject stringObject;
 618 } sjme_static_linkage_data;
 619
 620 /**
 621  * Static linkage.
 622  *
 623  * @since 2023/07/25
 624  */
 625 typedef struct sjme_static_linkage
 626 {
 627         /** The type of linkage this is. */
 628         sjme_staticLinkageType type;
 629
 630         /** Linkage data. */
 631         sjme_static_linkage_data data;
 632 } sjme_static_linkage;
 633
 634 typedef struct sjme_static_linkages
 635 {
 636         /** The number of linkages. */
 637         sjme_jint count;
 638
 639         /** The define linkages. */
 640         sjme_static_linkage linkages[sjme_flexibleArrayCount];
 641 } sjme_static_linkages;
 642
 643 typedef struct sjme_static_classInfo
 644 {
 645         /** This class name. */
 646         const char* thisName;
 647
 648         /** Hash of the current class name. */
 649         int thisNameHash;
 650
 651         /** The super name. */
 652         const char* superName;
 653
 654         /** Interfaces. */
 655         const sjme_static_classInterfaces* interfaceNames;
 656
 657         /** Flags. */
 658         sjme_jint flags;
 659
 660         /** Fields. */
 661         const sjme_static_classFields* fields;
 662
 663         /** Methods. */
 664         const sjme_static_classMethods* methods;
 665
 666         /** Linkages, effectively the constant pool. */
 667         const sjme_static_linkages* linkages;
 668 } sjme_static_classInfo;
 669
 670 typedef struct sjme_static_library_classes
 671 {
 672         /** The number of classes. */
 673         sjme_jint count;
 674
 675         /** Class set. */
 676         const struct sjme_static_classInfo* classes[sjme_flexibleArrayCount];
 677 } sjme_static_library_classes;
 678
 679 typedef struct sjme_static_library_resources
 680 {
 681         /** The number of resources. */
 682         sjme_jint count;
 683
 684         /** Resource set. */
 685         const struct sjme_static_resource* resources[sjme_flexibleArrayCount];
 686 } sjme_static_library_resources;
 687
 688 typedef struct sjme_static_library
 689 {
 690         /** Library name. */
 691         const char* name;
 692
 693         /** Hashcode for the name. */
 694         sjme_jint nameHash;
 695
 696         /** The hash of the original library, to detect changes. */
 697         const char* originalLibHash;
 698
 699         /** Resources. */
 700         const sjme_static_library_resources* resources;
 701
 702         /** Classes. */
 703         const sjme_static_library_classes* classes;
 704 } sjme_static_library;
 705
 706 typedef struct sjme_dynamic_linkage_data_classObject
 707 {
 708         int todo;
 709 } sjme_dynamic_linkage_data_classObject;
 710
 711 typedef struct sjme_dynamic_linkage_data_fieldAccess
 712 {
 713         int todo;
 714 } sjme_dynamic_linkage_data_fieldAccess;
 715
 716 typedef struct sjme_dynamic_linkage_data_invokeSpecial
 717 {
 718         int todo;
 719 } sjme_dynamic_linkage_data_invokeSpecial;
 720
 721 typedef struct sjme_dynamic_linkage_data_invokeNormal
 722 {
 723         int todo;
 724 } sjme_dynamic_linkage_data_invokeNormal;
 725
 726 typedef struct sjme_dynamic_linkage_data_stringObject
 727 {
 728         int todo;
 729 } sjme_dynamic_linkage_data_stringObject;
 730
 731 typedef union sjme_dynamic_linkage_data
 732 {
 733         /** Reference to class object. */
 734         sjme_dynamic_linkage_data_classObject classObject;
 735
 736         /** Field access. */
 737         sjme_dynamic_linkage_data_fieldAccess fieldAccess;
 738
 739         /** Special invocation. */
 740         sjme_dynamic_linkage_data_invokeSpecial invokeSpecial;
 741
 742         /** Normal invocation. */
 743         sjme_dynamic_linkage_data_invokeNormal invokeNormal;
 744
 745         /** String object. */
 746         sjme_dynamic_linkage_data_stringObject stringObject;
 747 } sjme_dynamic_linkage_data;
 748
 749 /**
 750  * Dynamic linkage.
 751  *
 752  * @since 2023/07/25
 753  */
 754 typedef struct sjme_dynamic_linkage
 755 {
 756         /** The type of linkage this is. */
 757         sjme_staticLinkageType type;
 758
 759         /** Linkage data. */
 760         sjme_dynamic_linkage_data data;
 761 } sjme_dynamic_linkage;
 762
 763 /**
 764  * Represents the frame of a stack tread.
 765  *
 766  * @since 2023/11/15
 767  */
 768 typedef struct sjme_nvm_frameTread
 769 {
 770         /** The number of items in this tread. */
 771         sjme_jint count;
 772
 773         /** The base index for the stack index. */
 774         sjme_jint stackBaseIndex;
 775
 776         /** The maximum size this tread can be. */
 777         sjme_jint max;
 778
 779         /** Values within the tread. */
 780         union
 781         {
 782                 /** Integer values. */
 783                 sjme_jint sjme_jints[sjme_flexibleArrayCountUnion];
 784
 785                 /** Long values. */
 786                 sjme_jlong sjme_jlongs[sjme_flexibleArrayCountUnion];
 787
 788                 /** Float values. */
 789                 sjme_jfloat sjme_jfloats[sjme_flexibleArrayCountUnion];
 790
 791                 /** Double values. */
 792                 sjme_jdouble sjme_jdoubles[sjme_flexibleArrayCountUnion];
 793
 794                 /** Object references. */
 795                 sjme_jobject sjme_jobjects[sjme_flexibleArrayCountUnion];
 796         } values;
 797 } sjme_nvm_frameTread;
 798
 799 /**
 800  * Calculates the size of a frame tread for a given type.
 801  *
 802  * @param type The type to get the size for.
 803  * @param count The number if items to store.
 804  * @return The size in bytes for the tread.
 805  * @since 2023/11/15
 806  */
 807 #define SJME_SIZEOF_FRAME_TREAD(type, count) \
 808         (sizeof(sjme_nvm_frameTread) + \
 809         /* Need to handle cases where values could be aligned up... */ \
 810         (offsetof(sjme_nvm_frameTread, values.SJME_TOKEN_PASTE(type,s)[0]) - \
 811                 offsetof(sjme_nvm_frameTread, values)) + \
 812         (sizeof(type) * (size_t)(count)))
 813
 814 /**
 815  * Calculates the size of a frame tread for a given type via variable.
 816  *
 817  * @param typeId The type to get the size for.
 818  * @param count The number if items to store.
 819  * @return The size in bytes for the tread.
 820  * @since 2023/11/15
 821  */
 822 static inline size_t SJME_SIZEOF_FRAME_TREAD_VAR(sjme_javaTypeId typeId,
 823         sjme_jint count)
 824 {
 825         switch (typeId)
 826         {
 827                 case SJME_JAVA_TYPE_ID_INTEGER:
 828                         return SJME_SIZEOF_FRAME_TREAD(sjme_jint, count);
 829
 830                 case SJME_JAVA_TYPE_ID_LONG:
 831                         return SJME_SIZEOF_FRAME_TREAD(sjme_jlong, count);
 832
 833                 case SJME_JAVA_TYPE_ID_FLOAT:
 834                         return SJME_SIZEOF_FRAME_TREAD(sjme_jfloat, count);
 835
 836                 case SJME_JAVA_TYPE_ID_DOUBLE:
 837                         return SJME_SIZEOF_FRAME_TREAD(sjme_jdouble, count);
 838
 839                 case SJME_JAVA_TYPE_ID_OBJECT:
 840                         return SJME_SIZEOF_FRAME_TREAD(sjme_jobject, count);
 841         }
 842
 843         /* Invalid. */
 844         return 0;
 845 }
 846
 847 /**
 848  * Represents information on a frame's stack storage.
 849  *
 850  * @since 2023/11/16
 851  */
 852 typedef struct sjme_nvm_frameStack
 853 {
 854         /** The number of items in the stack. */
 855         sjme_jint count;
 856
 857         /** The current limit of this structure. */
 858         sjme_jint limit;
 859
 860         /** The stack order. */
 861         sjme_javaTypeId order[sjme_flexibleArrayCount];
 862 } sjme_nvm_frameStack;
 863
 864 /**
 865  * Calculates the size of a frame stack.
 866  *
 867  * @param count The number if items to store.
 868  * @return The size in bytes for the tread.
 869  * @since 2023/11/16
 870  */
 871 #define SJME_SIZEOF_FRAME_STACK(count) \
 872         (sizeof(sjme_nvm_frameStack) + \
 873         (sizeof(sjme_javaTypeId) * (size_t)(count)))
 874
 875 typedef struct sjme_nvm_frameLocalMap
 876 {
 877         /** The maximum number of locals. */
 878         sjme_jint max;
 879
 880         /** Mapping of a specific variable to a given type index. */
 881         union
 882         {
 883                 sjme_jbyte to[SJME_NUM_JAVA_TYPE_IDS];
 884         } maps[sjme_flexibleArrayCount];
 885 } sjme_nvm_frameLocalMap;
 886
 887 /**
 888  * Calculates the size of the frame local variable map.
 889  *
 890  * @param count The number of items in the mapping.
 891  * @return The size in bytes of the local mapping.
 892  * @since 2023/11/26
 893  */
 894 #define SJME_SIZEOF_FRAME_LOCAL_MAP(count) \
 895         (sizeof(sjme_nvm_frameLocalMap) + \
 896         (SJME_SIZEOF_STRUCT_MEMBER(sjme_nvm_frameLocalMap, maps[0]) * (count)))
 897
 898 struct sjme_nvm_frame
 899 {
 900         /** The thread this frame is in. */
 901         sjme_nvm_thread* inThread;
 902
 903         /** The parent frame. */
 904         sjme_nvm_frame* parent;
 905
 906         /** The frame index in the thread. */
 907         sjme_jint frameIndex;
 908
 909         /** The current program counter. */
 910         sjme_pcAddr pc;
 911
 912         /** Object which is waiting to be thrown for exception handling. */
 913         sjme_jobject waitingThrown;
 914
 915         /** Frame linkage. */
 916         sjme_dynamic_linkage* linkage;
 917
 918         /** Temporary stack. */
 919         sjme_any* tempStack;
 920
 921         /** Reference to this. */
 922         sjme_jobject thisRef;
 923
 924         /** Class reference. */
 925         sjme_jclass classObjectRef;
 926
 927         /** The current stack information. */
 928         sjme_nvm_frameStack* stack;
 929
 930         /** Treads for the stack and locals. */
 931         sjme_nvm_frameTread* treads[SJME_NUM_BASIC_TYPE_IDS];
 932
 933         /** Mapping of local variables to the tread indexes per type. */
 934         const sjme_nvm_frameLocalMap* localMap;
 935
 936         /** Current exception handler go back. */
 937         jmp_buf exceptionPoint;
 938 };
 939
 940 typedef struct sjme_static_libraries
 941 {
 942         /** The number of libraries. */
 943         sjme_jint count;
 944
 945         /** The libraries. */
 946         const sjme_static_library* libraries[sjme_flexibleArrayCount];
 947 } sjme_static_libraries;
 948
 949 /**
 950  * ROM file.
 951  *
 952  * @since 2023/07/25
 953  */
 954 typedef struct sjme_static_rom
 955 {
 956         /** The ROM source set. */
 957         const char* sourceSet;
 958
 959         /** The ROM clutter level. */
 960         const char* clutterLevel;
 961
 962         /** The ROM libraries, is always last. */
 963         const sjme_static_libraries* libraries;
 964 } sjme_static_rom;
 965
 966 /**
 967  * Contains the payload information.
 968  *
 969  * @since 2023/07/27
 970  */
 971 typedef struct sjme_static_payload sjme_static_payload;
 972
 973 /**
 974  * Boot configuration for NanoCoat.
 975  *
 976  * @since 2023/07/27
 977  */
 978 typedef struct sjme_nvm_bootConfig
 979 {
 980         /** The payload to use for booting the virtual machine. */
 981         const sjme_static_payload* payload;
 982 } sjme_nvm_bootConfig;
 983
 984 /**
 985  * Hook for garbage collection detection and/or cancel capability.
 986  *
 987  * @param frame The frame this is garbage collecting in.
 988  * @param gcWhat what is being garbage collected?
 989  * @return Returns @c SJME_JNI_TRUE if garbage collection should continue.
 990  * @since 2023/11/17
 991  */
 992 typedef sjme_jboolean (*sjme_nvm_StateHookGc)(sjme_nvm_frame* frame,
 993         sjme_jobject gcWhat);
 994
 995 /**
 996  * Hooks for alternative function.
 997  *
 998  * @since 2023/11/17
 999  */
1000 typedef struct sjme_nvm_stateHooks
1001 {
1002         /** Garbage collection. */
1003         sjme_nvm_StateHookGc gc;
1004 } sjme_nvm_stateHooks;
1005
1006 /**
1007  * Represents the virtual machine state.
1008  *
1009  * @since 2023/07/28
1010  */
1011 struct sjme_nvm_state
1012 {
1013         /** The copy of the boot config. */
1014         sjme_nvm_bootConfig bootConfig;
1015
1016         /** Combined library set. */
1017         sjme_static_libraries* libraries;
1018
1019         /** Special value, is optional and front-end specific. */
1020         void* special;
1021
1022         /** Hooks for the state. */
1023         const sjme_nvm_stateHooks* hooks;
1024 };
1025
1026 /**
1027  * True value.
1028  *
1029  * @since 2023/07/25
1030  */
1031 #define SJME_JNI_TRUE ((sjme_jboolean)1)
1032
1033 /**
1034  * False value.
1035  *
1036  * @since 2023/07/25
1037  */
1038 #define SJME_JNI_FALSE ((sjme_jboolean)0)
1039
1040 /**
1041  * Method initialization start.
1042  *
1043  * @since 2023/07/25
1044  */
1045 #define SJME_NANOCOAT_START_CALL ((sjme_pcAddr)-1)
1046
1047 /**
1048  * Method closing end.
1049  *
1050  * @since 2023/07/25
1051  */
1052 #define SJME_NANOCOAT_END_CALL ((sjme_pcAddr)-2)
1053
1054 /**
1055  * Error codes.
1056  *
1057  * @since 2023/11/14
1058  */
1059 typedef enum sjme_errorCode
1060 {
1061         /** No error. */
1062         SJME_ERROR_CODE_NONE = 0,
1063
1064         /** Null arguments. */
1065         SJME_ERROR_CODE_NULL_ARGUMENTS = -1,
1066
1067         /** Local variable out of bounds. */
1068         SJME_ERROR_CODE_LOCAL_INDEX_INVALID = -2,
1069
1070         /** Stack variable out of bounds. */
1071         SJME_ERROR_CODE_STACK_INDEX_INVALID = -3,
1072
1073         /** Stack underflow. */
1074         SJME_ERROR_CODE_STACK_UNDERFLOW = -4,
1075
1076         /** Stack overflow. */
1077         SJME_ERROR_CODE_STACK_OVERFLOW = -5,
1078
1079         /** Top is not an integer type. */
1080         SJME_ERROR_CODE_TOP_NOT_INTEGER = -6,
1081
1082         /** Top is not a long type. */
1083         SJME_ERROR_CODE_TOP_NOT_LONG = -7,
1084
1085         /** Top is not a float type. */
1086         SJME_ERROR_CODE_TOP_NOT_FLOAT = -8,
1087
1088         /** Top is not a double type. */
1089         SJME_ERROR_CODE_TOP_NOT_DOUBLE = -9,
1090
1091         /** Top is not a object type. */
1092         SJME_ERROR_CODE_TOP_NOT_OBJECT = -10,
1093
1094         /** Frame is missing stack treads. */
1095         SJME_ERROR_FRAME_MISSING_STACK_TREADS = -11,
1096
1097         /** Invalid read of stack. */
1098         SJME_ERROR_CODE_STACK_INVALID_READ = -12,
1099
1100         /** Invalid write of stack. */
1101         SJME_ERROR_CODE_STACK_INVALID_WRITE = -13,
1102
1103         /** Invalid read of stack. */
1104         SJME_ERROR_CODE_LOCAL_INVALID_READ = -14,
1105
1106         /** Invalid write of stack. */
1107         SJME_ERROR_CODE_LOCAL_INVALID_WRITE = -15,
1108
1109         /** Invalid reference pop. */
1110         SJME_ERROR_INVALID_REFERENCE_POP = -16,
1111
1112         /** Invalid reference push. */
1113         SJME_ERROR_INVALID_REFERENCE_PUSH = -17,
1114
1115         /** Failed to garbage collect object. */
1116         SJME_ERROR_COULD_NOT_GC_OBJECT = -18,
1117
1118         /** Object reference count is not zero. */
1119         SJME_ERROR_OBJECT_REFCOUNT_NOT_ZERO = -19,
1120
1121         /** Garbage collection of object cancelled. */
1122         SJME_ERROR_OBJECT_GC_CANCELLED = -20,
1123
1124         /** The number of error codes. */
1125         SJME_NUM_ERROR_CODES = -21
1126 } sjme_errorCode;
1127
1128 sjme_jboolean sjme_nvm_arrayLength(
1129         sjme_attrInNotNull sjme_nvm_frame* frame,
1130         sjme_attrInNullable sjme_jobject arrayInstance,
1131         sjme_attrOutNotNull sjme_jint* outLen)
1132         sjme_attrCheckReturn;
1133
1134 sjme_tempIndex sjme_nvm_arrayLoadIntoTemp(
1135         sjme_attrInNotNull sjme_nvm_frame* frame,
1136         sjme_attrInValue sjme_basicTypeId primitiveType,
1137         sjme_attrInNullable sjme_jobject arrayInstance,
1138         sjme_attrInValue sjme_attrInPositive sjme_jint index)
1139         sjme_attrOutNegativeOnePositive sjme_attrCheckReturn;
1140
1141 sjme_jboolean sjme_nvm_arrayStore(
1142         sjme_attrInNotNull sjme_nvm_frame* frame,
1143         sjme_attrInValue sjme_basicTypeId primitiveType,
1144         sjme_attrInNullable sjme_jobject arrayInstance,
1145         sjme_attrInValue sjme_attrInPositive sjme_jint index,
1146         sjme_attrInNotNull sjme_any* value)
1147         sjme_attrCheckReturn;
1148
1149 sjme_jboolean sjme_nvm_checkCast(
1150         sjme_attrInNotNull sjme_nvm_frame* frame,
1151         sjme_attrInNullable sjme_jobject instance,
1152         sjme_attrInNotNull sjme_dynamic_linkage_data_classObject* type)
1153         sjme_attrCheckReturn;
1154
1155 sjme_jboolean sjme_nvm_countReferenceDown(
1156         sjme_attrInNotNull sjme_nvm_frame* frame,
1157         sjme_attrInNullable sjme_jobject instance)
1158         sjme_attrCheckReturn;
1159
1160 sjme_tempIndex sjme_nvm_fieldGetToTemp(
1161         sjme_attrInNotNull sjme_nvm_frame* frame,
1162         sjme_attrInNullable sjme_jobject instance,
1163         sjme_attrInNotNull sjme_dynamic_linkage_data_fieldAccess* field)
1164         sjme_attrOutNegativeOnePositive sjme_attrCheckReturn;
1165
1166 sjme_jboolean sjme_nvm_fieldPut(
1167         sjme_attrInNotNull sjme_nvm_frame* frame,
1168         sjme_attrInNullable sjme_jobject instance,
1169         sjme_attrInNotNull sjme_dynamic_linkage_data_fieldAccess* field,
1170         sjme_attrInNotNull sjme_any* value)
1171         sjme_attrCheckReturn;
1172
1173 /**
1174  * Garbage collects an object.
1175  *
1176  * @param frame The frame this is collecting in.
1177  * @param instance The instance to be garbage collected.
1178  * @return Returns @c SJME_JNI_TRUE on success.
1179  * @since 2023/11/17
1180  */
1181 sjme_jboolean sjme_nvm_gcObject(
1182         sjme_attrInNotNull sjme_nvm_frame* frame,
1183         sjme_attrInNullable sjme_jobject instance)
1184         sjme_attrCheckReturn;
1185
1186 sjme_jboolean sjme_nvm_invoke(
1187         sjme_attrInNotNull sjme_nvm_frame* frame,
1188         sjme_attrInNotNull sjme_dynamic_linkage_data_invokeNormal* method)
1189         sjme_attrCheckReturn;
1190
1191 sjme_jboolean sjme_nvm_localPopDouble(
1192         sjme_attrInNotNull sjme_nvm_frame* frame,
1193         sjme_attrInValue sjme_attrInPositive sjme_jint localIndex)
1194         sjme_attrCheckReturn;
1195
1196 sjme_jboolean sjme_nvm_localPopFloat(
1197         sjme_attrInNotNull sjme_nvm_frame* frame,
1198         sjme_attrInValue sjme_attrInPositive sjme_jint localIndex)
1199         sjme_attrCheckReturn;
1200
1201 sjme_jboolean sjme_nvm_localPopInteger(
1202         sjme_attrInNotNull sjme_nvm_frame* frame,
1203         sjme_attrInValue sjme_attrInPositive sjme_jint localIndex)
1204         sjme_attrCheckReturn;
1205
1206 sjme_jboolean sjme_nvm_localPopLong(
1207         sjme_attrInNotNull sjme_nvm_frame* frame,
1208         sjme_attrInValue sjme_attrInPositive sjme_jint localIndex)
1209         sjme_attrCheckReturn;
1210
1211 sjme_jboolean sjme_nvm_localPopReference(
1212         sjme_attrInNotNull sjme_nvm_frame* frame,
1213         sjme_attrInValue sjme_attrInPositive sjme_jint localIndex)
1214         sjme_attrCheckReturn;
1215
1216 sjme_jboolean sjme_nvm_localPushDouble(
1217         sjme_attrInNotNull sjme_nvm_frame* frame,
1218         sjme_attrInValue sjme_attrInPositive sjme_jint index)
1219         sjme_attrCheckReturn;
1220
1221 sjme_jboolean sjme_nvm_localPushFloat(
1222         sjme_attrInNotNull sjme_nvm_frame* frame,
1223         sjme_attrInValue sjme_attrInPositive sjme_jint index)
1224         sjme_attrCheckReturn;
1225
1226 sjme_jboolean sjme_nvm_localPushInteger(
1227         sjme_attrInNotNull sjme_nvm_frame* frame,
1228         sjme_attrInValue sjme_attrInPositive sjme_jint index)
1229         sjme_attrCheckReturn;
1230
1231 sjme_jboolean sjme_nvm_localPushLong(
1232         sjme_attrInNotNull sjme_nvm_frame* frame,
1233         sjme_attrInValue sjme_attrInPositive sjme_jint index)
1234         sjme_attrCheckReturn;
1235
1236 sjme_jboolean sjme_nvm_localPushReference(
1237         sjme_attrInNotNull sjme_nvm_frame* frame,
1238         sjme_attrInValue sjme_attrInPositive sjme_jint index)
1239         sjme_attrCheckReturn;
1240
1241 sjme_jboolean sjme_nvm_localReadInteger(
1242         sjme_attrInNotNull sjme_nvm_frame* frame,
1243         sjme_attrInValue sjme_attrInPositive sjme_jint index,
1244         sjme_attrOutNotNull sjme_jint* outValue)
1245         sjme_attrCheckReturn;
1246
1247 sjme_jboolean sjme_nvm_localWriteInteger(
1248         sjme_attrInNotNull sjme_nvm_frame* frame,
1249         sjme_attrInValue sjme_attrInPositive sjme_jint index,
1250         sjme_attrInValue sjme_jint value)
1251         sjme_attrCheckReturn;
1252
1253 sjme_tempIndex sjme_nvm_lookupClassObjectIntoTemp(
1254         sjme_attrInNotNull sjme_nvm_frame* frame,
1255         sjme_attrInNotNull sjme_dynamic_linkage_data_classObject* classLinkage)
1256         sjme_attrOutNegativeOnePositive sjme_attrCheckReturn;
1257
1258 sjme_tempIndex sjme_nvm_lookupStringIntoTemp(
1259         sjme_attrInNotNull sjme_nvm_frame* frame,
1260         sjme_attrInNotNull sjme_dynamic_linkage_data_stringObject* stringLinkage)
1261         sjme_attrOutNegativeOnePositive sjme_attrCheckReturn;
1262
1263 sjme_jboolean sjme_nvm_monitor(
1264         sjme_attrInNotNull sjme_nvm_frame* frame,
1265         sjme_attrInNullable sjme_jobject instance,
1266         sjme_attrInValue sjme_jboolean isEnter)
1267         sjme_attrCheckReturn;
1268
1269 sjme_tempIndex sjme_nvm_newArrayIntoTemp(
1270         sjme_attrInNotNull sjme_nvm_frame* frame,
1271         sjme_attrInNotNull sjme_dynamic_linkage_data_classObject* componentType,
1272         sjme_attrInValue sjme_attrInPositive sjme_jint length)
1273         sjme_attrOutNegativeOnePositive sjme_attrCheckReturn;
1274
1275 sjme_tempIndex sjme_nvm_newInstanceIntoTemp(
1276         sjme_attrInNotNull sjme_nvm_frame* frame,
1277         sjme_attrInNotNull sjme_dynamic_linkage_data_classObject* linkage)
1278         sjme_attrOutNegativeOnePositive sjme_attrCheckReturn;
1279
1280 sjme_jboolean sjme_nvm_returnFromMethod(
1281         sjme_attrInNotNull sjme_nvm_frame* frame,
1282         sjme_attrInNotNull sjme_any* value)
1283         sjme_attrCheckReturn;
1284
1285 sjme_jboolean sjme_nvm_stackPopAny(
1286         sjme_attrInNotNull sjme_nvm_frame* frame,
1287         sjme_attrOutNotNull sjme_any* output)
1288         sjme_attrCheckReturn;
1289
1290 sjme_tempIndex sjme_nvm_stackPopAnyToTemp(
1291         sjme_attrInNotNull sjme_nvm_frame* frame)
1292         sjme_attrOutNegativeOnePositive sjme_attrCheckReturn;
1293
1294 sjme_jint sjme_nvm_stackPopInteger(
1295         sjme_attrInNotNull sjme_nvm_frame* frame)
1296         sjme_attrOutNegativeOnePositive;
1297
1298 sjme_jobject sjme_nvm_stackPopReference(
1299         sjme_attrInNotNull sjme_nvm_frame* frame)
1300         sjme_attrOutNullable;
1301
1302 sjme_jboolean sjme_nvm_stackPopReferenceThenThrow(
1303         sjme_attrInNotNull sjme_nvm_frame* frame)
1304         sjme_attrCheckReturn;
1305
1306 sjme_tempIndex sjme_nvm_stackPopReferenceToTemp(
1307         sjme_attrInNotNull sjme_nvm_frame* frame)
1308         sjme_attrOutNegativeOnePositive sjme_attrCheckReturn;
1309
1310 sjme_jboolean sjme_nvm_stackPushAny(
1311         sjme_attrInNotNull sjme_nvm_frame* frame,
1312         sjme_attrInNotNull sjme_any* input)
1313         sjme_attrCheckReturn;
1314
1315 sjme_jboolean sjme_nvm_stackPushAnyFromTemp(
1316         sjme_attrInNotNull sjme_nvm_frame* frame,
1317         sjme_attrInPositive sjme_tempIndex input)
1318         sjme_attrCheckReturn;
1319
1320 sjme_jboolean sjme_nvm_stackPushDoubleParts(
1321         sjme_attrInNotNull sjme_nvm_frame* frame,
1322         sjme_attrInValue sjme_jint hi,
1323         sjme_attrInValue sjme_jint lo)
1324         sjme_attrCheckReturn;
1325
1326 sjme_jboolean sjme_nvm_stackPushFloatRaw(
1327         sjme_attrInNotNull sjme_nvm_frame* frame,
1328         sjme_attrInValue sjme_jint rawValue)
1329         sjme_attrCheckReturn;
1330
1331 sjme_jboolean sjme_nvm_stackPushInteger(
1332         sjme_attrInNotNull sjme_nvm_frame* frame,
1333         sjme_attrInValue sjme_jint value)
1334         sjme_attrCheckReturn;
1335
1336 sjme_jboolean sjme_nvm_stackPushIntegerIsInstanceOf(
1337         sjme_attrInNotNull sjme_nvm_frame* frame,
1338         sjme_attrInNullable sjme_jobject instance,
1339         sjme_attrInNotNull sjme_dynamic_linkage_data_classObject* type)
1340         sjme_attrCheckReturn;
1341
1342 sjme_jboolean sjme_nvm_stackPushLongParts(
1343         sjme_attrInNotNull sjme_nvm_frame* frame,
1344         sjme_attrInValue sjme_jint hi,
1345         sjme_attrInValue sjme_jint lo)
1346         sjme_attrCheckReturn;
1347
1348 sjme_jboolean sjme_nvm_stackPushReference(
1349         sjme_attrInNotNull sjme_nvm_frame* frame,
1350         sjme_attrInNullable sjme_jobject instance)
1351         sjme_attrCheckReturn;
1352
1353 sjme_jboolean sjme_nvm_stackPushReferenceFromTemp(
1354         sjme_attrInNotNull sjme_nvm_frame* frame,
1355         sjme_attrInPositive sjme_tempIndex tempIndex)
1356         sjme_attrCheckReturn;
1357
1358 sjme_jboolean sjme_nvm_tempDiscard(
1359         sjme_attrInNotNull sjme_nvm_frame* frame)
1360         sjme_attrCheckReturn;
1361
1362 sjme_jboolean sjme_nvm_throwExecute(
1363         sjme_attrInNotNull sjme_nvm_frame* frame)
1364         sjme_attrCheckReturn;
1365
1366 /**
1367  * Returns the top-most frame in the thread.
1368  *
1369  * @param inThread The thread to get the top frame from.
1370  * @param outFrame The top most frame.
1371  * @return Returns @c SJME_JNI_TRUE on success where the thread is valid and it
1372  * has at least one frame.
1373  * @since 2023/11/11
1374  */
1375 sjme_jboolean sjme_nvm_topFrame(
1376         sjme_attrInNotNull sjme_nvm_thread* inThread,
1377         sjme_attrOutNotNull sjme_nvm_frame* outFrame)
1378         sjme_attrCheckReturn;
1379
1380 /**
1381  * Ticks the virtual machine.
1382  *
1383  * @param state The state to tick, @c -1 means to tick forever.
1384  * @param maxTics The number of ticks to execute before returning.
1385  * @return Returns @c SJME_JNI_TRUE if the machine is still running.
1386  * @since 2023/07/27
1387  */
1388 sjme_jboolean sjme_nvm_tick(sjme_attrInNotNull sjme_nvm_state* state,
1389         sjme_attrInValue sjme_attrInPositive sjme_jint maxTics)
1390         sjme_attrCheckReturn;
1391
1392 /*--------------------------------------------------------------------------*/
1393
1394 /* Anti-C++. */
1395 #ifdef __cplusplus
1396         #ifdef SJME_CXX_SQUIRRELJME_NVM_H
1397 }
1398                 #undef SJME_CXX_SQUIRRELJME_NVM_H
1399                 #undef SJME_CXX_IS_EXTERNED
1400         #endif /* #ifdef SJME_CXX_SQUIRRELJME_NVM_H */
1401 #endif     /* #ifdef __cplusplus */
1402
1403 #endif /* SQUIRRELJME_NVM_H */