nanocoat/include/sjme/nvm/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 <setjmp.h>
  20
  21 #include "sjme/closeable.h"
  22 #include "sjme/config.h"
  23 #include "sjme/stdTypes.h"
  24 #include "sjme/tokenUtils.h"
  25 #include "sjme/alloc.h"
  26 #include "sjme/list.h"
  27 #include "sjme/atomic.h"
  28
  29 /* Anti-C++. */
  30 #ifdef __cplusplus
  31         #ifndef SJME_CXX_IS_EXTERNED
  32                 #define SJME_CXX_IS_EXTERNED
  33                 #define SJME_CXX_SQUIRRELJME_NVM_H
  34 extern "C" {
  35         #endif /* #ifdef SJME_CXX_IS_EXTERNED */
  36 #endif     /* #ifdef __cplusplus */
  37
  38 /*--------------------------------------------------------------------------*/
  39
  40 /**
  41  * Program counter address.
  42  *
  43  * @since 2023/07/25
  44  */
  45 typedef sjme_jint sjme_pcAddr;
  46
  47 /**
  48  * Static linkage type.
  49  *
  50  * @since 2023/07/25
  51  */
  52 typedef sjme_jint sjme_staticLinkageType;
  53
  54 struct sjme_jobjectBase
  55 {
  56         /** The reference count of this object, zero it becomes GCed. */
  57         sjme_jint refCount;
  58 };
  59
  60 /**
  61  * Throwable type.
  62  *
  63  * @since 2023/07/25
  64  */
  65 typedef sjme_jobject sjme_jthrowable;
  66
  67 typedef union sjme_anyData
  68 {
  69         /** Integer. */
  70         sjme_jint jint;
  71
  72         /** Object. */
  73         sjme_jobject jobject;
  74
  75         /** Temporary index. */
  76         sjme_tempIndex tempIndex;
  77 } sjme_anyData;
  78
  79 typedef struct sjme_any
  80 {
  81         /** Data type used. */
  82         sjme_basicTypeId type;
  83
  84         /** Data stored within. */
  85         sjme_anyData data;
  86 } sjme_any;
  87
  88 /**
  89  * The type of structure a type is.
  90  *
  91  * @since 2024/08/09
  92  */
  93 typedef enum sjme_nvm_structType
  94 {
  95         /** Unknown. */
  96         SJME_NVM_STRUCT_UNKNOWN,
  97
  98         /** Class information. */
  99         SJME_NVM_STRUCT_CLASS_INFO,
 100
 101         /** Method code. */
 102         SJME_NVM_STRUCT_CODE,
 103
 104         /** Field information. */
 105         SJME_NVM_STRUCT_FIELD_INFO,
 106
 107         /** Identifier. */
 108         SJME_NVM_STRUCT_IDENTIFIER,
 109
 110         /** Method information. */
 111         SJME_NVM_STRUCT_METHOD_INFO,
 112
 113         /** Rom Library. */
 114         SJME_NVM_STRUCT_ROM_LIBRARY,
 115
 116         /** Rom Suite. */
 117         SJME_NVM_STRUCT_ROM_SUITE,
 118
 119         /** Constant pool. */
 120         SJME_NVM_STRUCT_POOL,
 121
 122         /** NanoCoat state. */
 123         SJME_NVM_STRUCT_STATE,
 124
 125         /** A string pool. */
 126         SJME_NVM_STRUCT_STRING_POOL,
 127
 128         /** A string in the string pool. */
 129         SJME_NVM_STRUCT_STRING_POOL_STRING,
 130
 131         /** The number of structure types. */
 132         SJME_NVM_NUM_STRUCT
 133 } sjme_nvm_structType;
 134
 135 /**
 136  * Common data structure between all NanoCoat types.
 137  *
 138  * @since 2024/08/09
 139  */
 140 typedef struct sjme_nvm_commonBase sjme_nvm_commonBase;
 141
 142 /**
 143  * Common data structure pointer.
 144  *
 145  * @since 2024/08/10
 146  */
 147 typedef sjme_nvm_commonBase* sjme_nvm_common;
 148
 149 /** Cast to common type. */
 150 #define SJME_AS_NVM_COMMON(x) ((sjme_nvm_common)(x))
 151
 152 /** Cast to common pointer type. */
 153 #define SJME_AS_NVM_COMMONP(x) ((sjme_nvm_common*)(x))
 154
 155 /**
 156  * Represents the virtual machine state.
 157  *
 158  * @since 2023/08/08
 159  */
 160 typedef struct sjme_nvm_stateBase sjme_nvm_stateBase;
 161
 162 /**
 163  * Represents the virtual machine state.
 164  *
 165  * @since 2023/07/28
 166  */
 167 typedef sjme_nvm_stateBase* sjme_nvm;
 168
 169 /**
 170  * Frame of execution within a thread.
 171  *
 172  * @since 2023/08/08
 173  */
 174 typedef struct sjme_nvm_frameBase sjme_nvm_frameBase;
 175
 176 /**
 177  * Frame of execution within a thread.
 178  *
 179  * @since 2023/07/25
 180  */
 181 typedef sjme_nvm_frameBase* sjme_nvm_frame;
 182
 183 /**
 184  * Base structure for virtual machine threads.
 185  *
 186  * @since 2024/08/08
 187  */
 188 typedef struct sjme_nvm_threadBase sjme_nvm_threadBase;
 189
 190 /**
 191  * Exception stack trace mechanism storage.
 192  *
 193  * @since 2023/12/08
 194  */
 195 typedef struct sjme_exceptTrace sjme_exceptTrace;
 196
 197 /**
 198  * A thread within SquirrelJME.
 199  *
 200  * @since 2024/08/08
 201  */
 202 typedef sjme_nvm_threadBase* sjme_nvm_thread;
 203
 204 struct sjme_nvm_threadBase
 205 {
 206         /** The VM state this thread is in. */
 207         sjme_nvm inState;
 208
 209         /** The wrapper in the front end. */
 210         sjme_frontEnd frontEnd;
 211
 212         /** The thread ID. */
 213         sjme_jint threadId;
 214
 215         /** The top of the stack. */
 216         sjme_nvm_frame top;
 217
 218         /** The number of frames. */
 219         sjme_jint numFrames;
 220
 221         /** Current exception handler go back. */
 222         sjme_exceptTrace* except;
 223 };
 224
 225 typedef struct sjme_static_constValue
 226 {
 227         /** Integer value. */
 228         sjme_jint jint;
 229
 230         /** Long value. */
 231         sjme_jlong jlong;
 232
 233         /** Float value. */
 234         sjme_jfloat jfloat;
 235
 236         /** Double value. */
 237         sjme_jdouble jdouble;
 238
 239         /** String value. */
 240         sjme_lpcstr jstring;
 241
 242         /** Class name. */
 243         sjme_lpcstr jclass;
 244 } sjme_static_constValue;
 245
 246 /**
 247  * Represents a field type.
 248  *
 249  * @since 2023/08/10
 250  */
 251 typedef struct sjme_static_fieldType
 252 {
 253         /** The hash code for the field type. */
 254         sjme_jint hashCode;
 255
 256         /** The field descriptor. */
 257         sjme_lpcstr descriptor;
 258
 259         /** The basic type. */
 260         sjme_basicTypeId basicType;
 261 } sjme_static_fieldType;
 262
 263 typedef struct sjme_static_classField
 264 {
 265         /** Field name. */
 266         sjme_lpstr name;
 267
 268         /** The field type. */
 269         const sjme_static_fieldType* type;
 270
 271         /** Flags. */
 272         sjme_jint flags;
 273
 274         /** The constant value type. */
 275         sjme_basicTypeId valueType;
 276
 277         /** The value. */
 278         sjme_static_constValue value;
 279 } sjme_static_classField;
 280
 281 typedef struct sjme_static_classFields
 282 {
 283         /** The number of fields. */
 284         sjme_jint count;
 285
 286         /** Fields. */
 287         sjme_static_classField fields[sjme_flexibleArrayCount];
 288 } sjme_static_classFields;
 289
 290 /**
 291  * Type used for method code functions.
 292  *
 293  * @param currentState The current virtual machine state.
 294  * @param currentThread The current virtual machine thread.
 295  * @return Will return @c SJME_JNI_TRUE if execution completed without throwing
 296  * a @c Throwable object.
 297  * @since 2023/07/25
 298  */
 299 typedef sjme_jboolean (*sjme_methodCodeFunction)(
 300         sjme_nvm currentState,
 301         sjme_nvm_thread currentThread);
 302
 303 /**
 304  * The variable mapping and setup for any given method.
 305  *
 306  * @since 2023/08/09
 307  */
 308 typedef struct sjme_static_classCodeLimits
 309 {
 310         /** The maximum number of @c sjme_basicTypeId local/stack variables. */
 311         const sjme_jubyte maxVariables[SJME_NUM_JAVA_TYPE_IDS];
 312 } sjme_static_classCodeLimits;
 313
 314 /**
 315  * Contains information about method code and how variables should be placed
 316  * on execution and stack handling.
 317  *
 318  * @since 2023/08/09
 319  */
 320 typedef struct sjme_static_classCode
 321 {
 322         /** The variable count and thrown index count used. */
 323         const sjme_static_classCodeLimits* limits;
 324
 325         /** The index where thrown objects are placed. */
 326         sjme_jshort thrownVarIndex;
 327
 328         /** The method code. */
 329         sjme_methodCodeFunction code;
 330 } sjme_static_classCode;
 331
 332 /**
 333  * Represents a standard Java method type, using field descriptors.
 334  *
 335  * @since 2023/08/10
 336  */
 337 typedef struct sjme_static_methodType
 338 {
 339         /** The hash code for the method type. */
 340         sjme_jint hashCode;
 341
 342         /** The descriptor for the method type. */
 343         sjme_lpcstr descriptor;
 344
 345         /** The return type. */
 346         const sjme_static_fieldType* returnType;
 347
 348         /** The number of arguments. */
 349         sjme_jint argCount;
 350
 351         /** The arguments to the method. */
 352         const sjme_static_fieldType* argTypes[sjme_flexibleArrayCount];
 353 } sjme_static_methodType;
 354
 355 typedef struct sjme_static_classMethod
 356 {
 357         /** Method name. */
 358         sjme_lpcstr name;
 359
 360         /** Flags. */
 361         sjme_jint flags;
 362
 363         /** Name typed. */
 364         const sjme_static_methodType* type;
 365
 366         /** Method code and any pertaining information. */
 367         const sjme_static_classCode* code;
 368 } sjme_static_classMethod;
 369
 370 typedef struct sjme_static_classMethods
 371 {
 372         /** The number of methods. */
 373         sjme_jint count;
 374
 375         /** Methods. */
 376         sjme_static_classMethod methods[sjme_flexibleArrayCount];
 377 } sjme_static_classMethods;
 378
 379 typedef struct sjme_static_classInterface
 380 {
 381         sjme_lpcstr interfaceName;
 382 } sjme_static_classInterface;
 383
 384 typedef struct sjme_static_classInterfaces
 385 {
 386         /** The number of interfaces. */
 387         sjme_jint count;
 388
 389         /** Interfaces. */
 390         sjme_static_classInterface interfaces[sjme_flexibleArrayCount];
 391 } sjme_static_classInterfaces;
 392
 393 typedef struct sjme_static_resource
 394 {
 395         /** The resource path. */
 396         sjme_lpcstr path;
 397
 398         /** The hash for the path. */
 399         sjme_jint pathHash;
 400
 401         /** The size of the resource. */
 402         sjme_jint size;
 403
 404         /** The resource data. */
 405         const sjme_jbyte data[sjme_flexibleArrayCount];
 406 } sjme_static_resource;
 407
 408 typedef struct sjme_static_linkage_data_classObject
 409 {
 410         /** The class name. */
 411         sjme_lpcstr className;
 412 } sjme_static_linkage_data_classObject;
 413
 414 typedef struct sjme_static_linkage_data_fieldAccess
 415 {
 416         /** Is this static? */
 417         sjme_jboolean isStatic;
 418
 419         /** Is this a store? */
 420         sjme_jboolean isStore;
 421
 422         /** The source method name. */
 423         sjme_lpcstr sourceMethodName;
 424
 425         /** The source method type. */
 426         sjme_lpcstr sourceMethodType;
 427
 428         /** The target class. */
 429         sjme_lpcstr targetClass;
 430
 431         /** The target field name. */
 432         sjme_lpcstr targetFieldName;
 433
 434         /** The target field type. */
 435         sjme_lpcstr targetFieldType;
 436 } sjme_static_linkage_data_fieldAccess;
 437
 438 typedef struct sjme_static_linkage_data_invokeSpecial
 439 {
 440         /** The source method name. */
 441         sjme_lpcstr sourceMethodName;
 442
 443         /** The source method type. */
 444         sjme_lpcstr sourceMethodType;
 445
 446         /** The target class. */
 447         sjme_lpcstr targetClass;
 448
 449         /** The target method name. */
 450         sjme_lpcstr targetMethodName;
 451
 452         /** The target method type. */
 453         sjme_lpcstr targetMethodType;
 454 } sjme_static_linkage_data_invokeSpecial;
 455
 456 typedef struct sjme_static_linkage_data_invokeNormal
 457 {
 458         /** Is this a static invocation? */
 459         sjme_jboolean isStatic;
 460
 461         /** The source method name. */
 462         sjme_lpcstr sourceMethodName;
 463
 464         /** The source method type. */
 465         sjme_lpcstr sourceMethodType;
 466
 467         /** The target class. */
 468         sjme_lpcstr targetClass;
 469
 470         /** The target method name. */
 471         sjme_lpcstr targetMethodName;
 472
 473         /** The target method type. */
 474         sjme_lpcstr targetMethodType;
 475 } sjme_static_linkage_data_invokeNormal;
 476
 477 typedef struct sjme_static_linkage_data_stringObject
 478 {
 479         /** The string value. */
 480         sjme_lpcstr string;
 481 } sjme_static_linkage_data_stringObject;
 482
 483 typedef union sjme_static_linkage_data
 484 {
 485         /** Reference to class object. */
 486         sjme_static_linkage_data_classObject classObject;
 487
 488         /** Field access. */
 489         sjme_static_linkage_data_fieldAccess fieldAccess;
 490
 491         /** Special invocation. */
 492         sjme_static_linkage_data_invokeSpecial invokeSpecial;
 493
 494         /** Normal invocation. */
 495         sjme_static_linkage_data_invokeNormal invokeNormal;
 496
 497         /** String object. */
 498         sjme_static_linkage_data_stringObject stringObject;
 499 } sjme_static_linkage_data;
 500
 501 /**
 502  * Static linkage.
 503  *
 504  * @since 2023/07/25
 505  */
 506 typedef struct sjme_static_linkage
 507 {
 508         /** The type of linkage this is. */
 509         sjme_staticLinkageType type;
 510
 511         /** Linkage data. */
 512         sjme_static_linkage_data data;
 513 } sjme_static_linkage;
 514
 515 typedef struct sjme_static_linkages
 516 {
 517         /** The number of linkages. */
 518         sjme_jint count;
 519
 520         /** The define linkages. */
 521         sjme_static_linkage linkages[sjme_flexibleArrayCount];
 522 } sjme_static_linkages;
 523
 524 typedef struct sjme_dynamic_linkage_data_classObject
 525 {
 526         int todo;
 527 } sjme_dynamic_linkage_data_classObject;
 528
 529 typedef struct sjme_dynamic_linkage_data_fieldAccess
 530 {
 531         int todo;
 532 } sjme_dynamic_linkage_data_fieldAccess;
 533
 534 typedef struct sjme_dynamic_linkage_data_invokeSpecial
 535 {
 536         int todo;
 537 } sjme_dynamic_linkage_data_invokeSpecial;
 538
 539 typedef struct sjme_dynamic_linkage_data_invokeNormal
 540 {
 541         int todo;
 542 } sjme_dynamic_linkage_data_invokeNormal;
 543
 544 typedef struct sjme_dynamic_linkage_data_stringObject
 545 {
 546         int todo;
 547 } sjme_dynamic_linkage_data_stringObject;
 548
 549 typedef union sjme_dynamic_linkage_data
 550 {
 551         /** Reference to class object. */
 552         sjme_dynamic_linkage_data_classObject classObject;
 553
 554         /** Field access. */
 555         sjme_dynamic_linkage_data_fieldAccess fieldAccess;
 556
 557         /** Special invocation. */
 558         sjme_dynamic_linkage_data_invokeSpecial invokeSpecial;
 559
 560         /** Normal invocation. */
 561         sjme_dynamic_linkage_data_invokeNormal invokeNormal;
 562
 563         /** String object. */
 564         sjme_dynamic_linkage_data_stringObject stringObject;
 565 } sjme_dynamic_linkage_data;
 566
 567 /**
 568  * Dynamic linkage.
 569  *
 570  * @since 2023/07/25
 571  */
 572 typedef struct sjme_dynamic_linkage
 573 {
 574         /** The type of linkage this is. */
 575         sjme_staticLinkageType type;
 576
 577         /** Linkage data. */
 578         sjme_dynamic_linkage_data data;
 579 } sjme_dynamic_linkage;
 580
 581 /**
 582  * Represents the frame of a stack tread.
 583  *
 584  * @since 2023/11/15
 585  */
 586 typedef struct sjme_nvm_frameTread
 587 {
 588         /** The number of items in this tread. */
 589         sjme_jint count;
 590
 591         /** The base index for the stack index. */
 592         sjme_jint stackBaseIndex;
 593
 594         /** The maximum size this tread can be. */
 595         sjme_jint max;
 596
 597         /** Values within the tread. */
 598         union
 599         {
 600                 /** Integer values. */
 601                 sjme_jint jints[sjme_flexibleArrayCountUnion];
 602
 603                 /** Long values. */
 604                 sjme_jlong jlongs[sjme_flexibleArrayCountUnion];
 605
 606                 /** Float values. */
 607                 sjme_jfloat jfloats[sjme_flexibleArrayCountUnion];
 608
 609                 /** Double values. */
 610                 sjme_jdouble jdoubles[sjme_flexibleArrayCountUnion];
 611
 612                 /** Object references. */
 613                 sjme_jobject jobjects[sjme_flexibleArrayCountUnion];
 614         } values;
 615 } sjme_nvm_frameTread;
 616
 617 /**
 618  * Calculates the size of a frame tread for a given type.
 619  *
 620  * @param type The type to get the size for.
 621  * @param count The number if items to store.
 622  * @return The size in bytes for the tread.
 623  * @since 2023/11/15
 624  */
 625 #define SJME_SIZEOF_FRAME_TREAD(type, count, baseType) \
 626         (sizeof(sjme_nvm_frameTread) + \
 627         /* Need to handle cases where values could be aligned up... */ \
 628         (offsetof(sjme_nvm_frameTread, values.SJME_TOKEN_PASTE(baseType,s)[0]) - \
 629                 offsetof(sjme_nvm_frameTread, values)) + \
 630         (sizeof(type) * (size_t)(count)))
 631
 632 /**
 633  * Calculates the size of a frame tread for a given type via variable.
 634  *
 635  * @param typeId The type to get the size for.
 636  * @param count The number if items to store.
 637  * @return The size in bytes for the tread.
 638  * @since 2023/11/15
 639  */
 640 static sjme_inline sjme_attrArtificial size_t SJME_SIZEOF_FRAME_TREAD_VAR(
 641         sjme_javaTypeId typeId, sjme_jint count)
 642 {
 643         switch (typeId)
 644         {
 645                 case SJME_JAVA_TYPE_ID_INTEGER:
 646                         return SJME_SIZEOF_FRAME_TREAD(sjme_jint, count, jint);
 647
 648                 case SJME_JAVA_TYPE_ID_LONG:
 649                         return SJME_SIZEOF_FRAME_TREAD(sjme_jlong, count, jlong);
 650
 651                 case SJME_JAVA_TYPE_ID_FLOAT:
 652                         return SJME_SIZEOF_FRAME_TREAD(sjme_jfloat, count, jfloat);
 653
 654                 case SJME_JAVA_TYPE_ID_DOUBLE:
 655                         return SJME_SIZEOF_FRAME_TREAD(sjme_jdouble, count, jdouble);
 656
 657                 case SJME_JAVA_TYPE_ID_OBJECT:
 658                         return SJME_SIZEOF_FRAME_TREAD(sjme_jobject, count, jobject);
 659         }
 660
 661         /* Invalid. */
 662         return 0;
 663 }
 664
 665 /**
 666  * Represents information on a frame's stack storage.
 667  *
 668  * @since 2023/11/16
 669  */
 670 typedef struct sjme_nvm_frameStack
 671 {
 672         /** The number of items in the stack. */
 673         sjme_jint count;
 674
 675         /** The current limit of this structure. */
 676         sjme_jint limit;
 677
 678         /** The stack order. */
 679         sjme_javaTypeId order[sjme_flexibleArrayCount];
 680 } sjme_nvm_frameStack;
 681
 682 /**
 683  * Calculates the size of a frame stack.
 684  *
 685  * @param count The number if items to store.
 686  * @return The size in bytes for the tread.
 687  * @since 2023/11/16
 688  */
 689 #define SJME_SIZEOF_FRAME_STACK(count) \
 690         (sizeof(sjme_nvm_frameStack) + \
 691         (sizeof(sjme_javaTypeId) * (size_t)(count)))
 692
 693 typedef struct sjme_nvm_frameLocalMap
 694 {
 695         /** The maximum number of locals. */
 696         sjme_jint max;
 697
 698         /** Mapping of a specific variable to a given type index. */
 699         union
 700         {
 701                 sjme_jbyte to[SJME_NUM_JAVA_TYPE_IDS];
 702         } maps[sjme_flexibleArrayCount];
 703 } sjme_nvm_frameLocalMap;
 704
 705 /**
 706  * Calculates the size of the frame local variable map.
 707  *
 708  * @param count The number of items in the mapping.
 709  * @return The size in bytes of the local mapping.
 710  * @since 2023/11/26
 711  */
 712 #define SJME_SIZEOF_FRAME_LOCAL_MAP(count) \
 713         (sizeof(sjme_nvm_frameLocalMap) + \
 714         (SJME_SIZEOF_STRUCT_MEMBER(sjme_nvm_frameLocalMap, maps[0]) * (count)))
 715
 716 struct sjme_nvm_frameBase
 717 {
 718         /** The thread this frame is in. */
 719         sjme_nvm_thread inThread;
 720
 721         /** The wrapper in the front end. */
 722         sjme_frontEnd frontEnd;
 723
 724         /** The parent frame. */
 725         sjme_nvm_frame parent;
 726
 727         /** The frame index in the thread. */
 728         sjme_jint frameIndex;
 729
 730         /** The current program counter. */
 731         sjme_pcAddr pc;
 732
 733         /** Object which is waiting to be thrown for exception handling. */
 734         sjme_jobject waitingThrown;
 735
 736         /** Frame linkage. */
 737         sjme_dynamic_linkage* linkage;
 738
 739         /** Temporary stack. */
 740         sjme_any* tempStack;
 741
 742         /** Reference to this. */
 743         sjme_jobject thisRef;
 744
 745         /** Class reference. */
 746         sjme_jclass classObjectRef;
 747
 748         /** The current stack information. */
 749         sjme_nvm_frameStack* stack;
 750
 751         /** Treads for the stack and locals. */
 752         sjme_nvm_frameTread* treads[SJME_NUM_BASIC_TYPE_IDS];
 753
 754         /** Mapping of local variables to the tread indexes per type. */
 755         const sjme_nvm_frameLocalMap* localMap;
 756 };
 757
 758 /**
 759  * Contains the payload information.
 760  *
 761  * @since 2023/07/27
 762  */
 763 typedef struct sjme_payload_config sjme_payload_config;
 764
 765 /**
 766  * Hook for garbage collection detection and/or cancel capability.
 767  *
 768  * @param frame The frame this is garbage collecting in.
 769  * @param gcWhat what is being garbage collected?
 770  * @return Returns @c SJME_JNI_TRUE if garbage collection should continue.
 771  * @since 2023/11/17
 772  */
 773 typedef sjme_jboolean (*sjme_nvm_stateHookGcFunc)(sjme_nvm_frame frame,
 774         sjme_jobject gcWhat);
 775
 776 /**
 777  * Hooks for alternative function.
 778  *
 779  * @since 2023/11/17
 780  */
 781 typedef struct sjme_nvm_stateHooks
 782 {
 783         /** Garbage collection. */
 784         sjme_nvm_stateHookGcFunc gc;
 785 } sjme_nvm_stateHooks;
 786
 787 /**
 788  * Boot parameters for NanoCoat.
 789  *
 790  * @since 2023/07/27
 791  */
 792 typedef struct sjme_nvm_bootParam sjme_nvm_bootParam;
 793
 794 /**
 795  * Standard Suite structure.
 796  *
 797  * @since 2023/12/12
 798  */
 799 typedef struct sjme_rom_suiteBase sjme_rom_suiteBase;
 800
 801 /**
 802  * Opaque suite structure type.
 803  *
 804  * @since 2023/12/22
 805  */
 806 typedef struct sjme_rom_suiteBase* sjme_rom_suite;
 807
 808 /**
 809  * Structure for a single task.
 810  *
 811  * @since 2023/12/17
 812  */
 813 typedef struct sjme_nvm_taskBase* sjme_nvm_task;
 814
 815 struct sjme_nvm_commonBase
 816 {
 817         /** Closeable for this NanoCoat object. */
 818         sjme_closeableBase closeable;
 819
 820         /** The type of item this is. */
 821         sjme_nvm_structType type;
 822
 823         /** The wrapper in the front end. */
 824         sjme_frontEnd frontEnd;
 825
 826         /** The lock to access this common item. */
 827         sjme_thread_spinLock lock;
 828 };
 829
 830 struct sjme_nvm_stateBase
 831 {
 832         /** Common data. */
 833         sjme_nvm_commonBase common;
 834
 835         /** The memory pool to use for allocations. */
 836         sjme_alloc_pool allocPool;
 837
 838         /** The reserved memory pool. */
 839         sjme_alloc_pool reservedPool;
 840
 841         /** The copy of the input boot parameters. */
 842         const sjme_nvm_bootParam* bootParamCopy;
 843
 844         /** Hooks for the state. */
 845         const sjme_nvm_stateHooks* hooks;
 846
 847         /* The suite containing all the libraries. */
 848         sjme_rom_suite suite;
 849 };
 850
 851 /**
 852  * Method initialization start.
 853  *
 854  * @since 2023/07/25
 855  */
 856 #define SJME_NANOCOAT_START_CALL ((sjme_pcAddr)-1)
 857
 858 /**
 859  * Method closing end.
 860  *
 861  * @since 2023/07/25
 862  */
 863 #define SJME_NANOCOAT_END_CALL ((sjme_pcAddr)-2)
 864
 865 /*--------------------------------------------------------------------------*/
 866
 867 /* Anti-C++. */
 868 #ifdef __cplusplus
 869         #ifdef SJME_CXX_SQUIRRELJME_NVM_H
 870 }
 871                 #undef SJME_CXX_SQUIRRELJME_NVM_H
 872                 #undef SJME_CXX_IS_EXTERNED
 873         #endif /* #ifdef SJME_CXX_SQUIRRELJME_NVM_H */
 874 #endif     /* #ifdef __cplusplus */
 875
 876 #endif /* SQUIRRELJME_NVM_H */