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