summaryrefslogtreecommitdiffhomepage
path: root/dev/LibCompiler/src/DynamicLinkerPEF.cc
blob: 0def365ddb2c43238796b80fdf3aa57ab470ed3a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
/* -------------------------------------------

  Copyright (C) 2024-2025 Amlal El Mahrouss, all rights reserved

  @file DynamicLinker64PEF.cc
  @brief: C++ 64-Bit PEF Linker.

------------------------------------------- */

/// @author EL Mahrouss Amlal (amlal@nekernel.org)
/// @brief NeKernel 64-bit PEF Linker.
/// Last Rev: Sat Apr 19 CET 2025
/// @note Do not look up for anything with .code64/.data64/.zero64!
/// It will be loaded when the program loader will start the image.

//! Toolchain Kit.
#include <LibCompiler/Defines.h>

//! Error ID
#include <LibCompiler/ErrorID.h>

//! Assembler Kit
#include <LibCompiler/AssemblyInterface.h>

//! Preferred Executable Format
#include <LibCompiler/PEF.h>

//! UUID header.
#include <LibCompiler/UUID.h>

//! Release macros.
#include <LibCompiler/Version.h>

//! Advanced Executable Object Format.
#include <LibCompiler/AE.h>

//! Format header.
#include <format>

//! LibCompiler utils.
#include <LibCompiler/Detail/ClUtils.h>

//! I/O stream from std c++
#include <iostream>

#define kLinkerVersionStr                                                           \
  "NeKernel 64-Bit Linker (Preferred Executable Format) {}, (c) Amlal El Mahrouss " \
  "2024-2025 "                                                                      \
  "all rights reserved.\n"

#define MemoryCopy(DST, SRC, SZ) memcpy(DST, SRC, SZ)
#define StringCompare(DST, SRC) strcmp(DST, SRC)

#define kPefNoCpu (0U)
#define kPefNoSubCpu (0U)

#define kLinkerDefaultOrigin kPefBaseOrigin
#define kLinkerId (0x5046FF)
#define kLinkerAbiContainer "__PEFContainer:ABI:"

#define kPrintF printf
#define kLinkerSplash() kOutCon << std::format(kLinkerVersionStr, kDistVersion)

/// @brief PEF stack size symbol.
#define kLinkerStackSizeSymbol "__PEFSizeOfReserveStack"

#define kOutCon (std::cout << "\e[0;31m" << "ld64: " << "\e[0;97m")

namespace Detail {
struct DynamicLinkerBlob final {
  std::vector<CharType> mBlob{};       // PEF code/bss/data blob.
  UIntPtr               mOffset{0UL};  // the offset of the PEF container header...
};
}  // namespace Detail

enum {
  kABITypeNull    = 0,
  kABITypeStart   = 0x1010, /* Invalid ABI start of ABI list. */
  kABITypeNE      = 0x5046, /* PF (NeKernel's PEF ABI) */
  kABITypeInvalid = 0xFFFF,
};

static LibCompiler::String kOutput           = "a" kPefExt;
static Int32               kAbi              = kABITypeNE;
static Int32               kSubArch          = kPefNoSubCpu;
static Int32               kArch             = LibCompiler::kPefArchInvalid;
static Bool                kFatBinaryEnable  = false;
static Bool                kStartFound       = false;
static Bool                kDuplicateSymbols = false;

/* ld64 is to be found, mld is to be found at runtime. */
static const CharType* kLdDefineSymbol = ":UndefinedSymbol:";
static const CharType* kLdDynamicSym   = ":RuntimeSymbol:";

/* object code and list. */
static std::vector<LibCompiler::String>       kObjectList;
static std::vector<Detail::DynamicLinkerBlob> kObjectBytes;

///	@brief NE 64-bit Linker.
/// @note This linker is made for PEF executable, thus NE based OSes.
LIBCOMPILER_MODULE(DynamicLinker64PEF) {
  bool is_executable = true;

  ::signal(SIGSEGV, Detail::segfault_handler);

  /**
   * @brief parse flags and trigger options.
   */
  for (size_t linker_arg = 1; linker_arg < argc; ++linker_arg) {
    if (StringCompare(argv[linker_arg], "-help") == 0) {
      kLinkerSplash();

      kOutCon << "-version: Show linker version.\n";
      kOutCon << "-help: Show linker help.\n";
      kOutCon << "-ld-verbose: Enable linker trace.\n";
      kOutCon << "-dylib: Output as a Dynamic PEF.\n";
      kOutCon << "-fat: Output as a FAT PEF.\n";
      kOutCon << "-32k: Output as a 32x0 PEF.\n";
      kOutCon << "-64k: Output as a 64x0 PEF.\n";
      kOutCon << "-amd64: Output as a AMD64 PEF.\n";
      kOutCon << "-rv64: Output as a RISC-V PEF.\n";
      kOutCon << "-power64: Output as a POWER PEF.\n";
      kOutCon << "-arm64: Output as a ARM64 PEF.\n";
      kOutCon << "-output: Select the output file name.\n";

      return EXIT_SUCCESS;
    } else if (StringCompare(argv[linker_arg], "-version") == 0) {
      kLinkerSplash();
      return EXIT_SUCCESS;
    } else if (StringCompare(argv[linker_arg], "-fat-binary") == 0) {
      kFatBinaryEnable = true;

      continue;
    } else if (StringCompare(argv[linker_arg], "-64k") == 0) {
      kArch = LibCompiler::kPefArch64000;

      continue;
    } else if (StringCompare(argv[linker_arg], "-amd64") == 0) {
      kArch = LibCompiler::kPefArchAMD64;

      continue;
    } else if (StringCompare(argv[linker_arg], "-32k") == 0) {
      kArch = LibCompiler::kPefArch32000;

      continue;
    } else if (StringCompare(argv[linker_arg], "-power64") == 0) {
      kArch = LibCompiler::kPefArchPowerPC;

      continue;
    } else if (StringCompare(argv[linker_arg], "-riscv64") == 0) {
      kArch = LibCompiler::kPefArchRISCV;

      continue;
    } else if (StringCompare(argv[linker_arg], "-arm64") == 0) {
      kArch = LibCompiler::kPefArchARM64;

      continue;
    } else if (StringCompare(argv[linker_arg], "-ld-verbose") == 0) {
      kVerbose = true;

      continue;
    } else if (StringCompare(argv[linker_arg], "-dylib") == 0) {
      if (kOutput.empty()) {
        continue;
      }

      if (kOutput.find(kPefExt) != LibCompiler::String::npos)
        kOutput.erase(kOutput.find(kPefExt), strlen(kPefExt));

      kOutput += kPefDylibExt;

      is_executable = false;

      continue;
    } else if (StringCompare(argv[linker_arg], "-output") == 0) {
      if ((linker_arg + 1) > argc) continue;

      kOutput = argv[linker_arg + 1];
      ++linker_arg;

      continue;
    } else {
      if (argv[linker_arg][0] == '-') {
        kOutCon << "unknown flag: " << argv[linker_arg] << "\n";
        return EXIT_FAILURE;
      }

      kObjectList.emplace_back(argv[linker_arg]);

      continue;
    }
  }

  if (kOutput.empty()) {
    kOutCon << "no output filename set." << std::endl;
    return LIBCOMPILER_EXEC_ERROR;
  } else if (kObjectList.empty()) {
    kOutCon << "no input files." << std::endl;
    return LIBCOMPILER_EXEC_ERROR;
  } else {
    namespace FS = std::filesystem;

    // check for existing files, if they don't throw an error.
    for (auto& obj : kObjectList) {
      if (!FS::exists(obj)) {
        // if filesystem doesn't find file
        //          -> throw error.
        kOutCon << "no such file: " << obj << std::endl;
        return LIBCOMPILER_EXEC_ERROR;
      }
    }
  }

  // PEF expects a valid target architecture when outputing a binary.
  if (kArch == 0) {
    kOutCon << "no target architecture set, can't continue." << std::endl;
    return LIBCOMPILER_EXEC_ERROR;
  }

  LibCompiler::PEFContainer pef_container{};

  int32_t archs = kArch;

  pef_container.Count    = 0UL;
  pef_container.Kind     = is_executable ? LibCompiler::kPefKindExec : LibCompiler::kPefKindDylib;
  pef_container.SubCpu   = kSubArch;
  pef_container.Linker   = kLinkerId;  // Amlal El Mahrouss Linker
  pef_container.Abi      = kAbi;       // Multi-Processor UX ABI
  pef_container.Magic[0] = kPefMagic[kFatBinaryEnable ? 2 : 0];
  pef_container.Magic[1] = kPefMagic[1];
  pef_container.Magic[2] = kPefMagic[kFatBinaryEnable ? 0 : 2];
  pef_container.Magic[3] = kPefMagic[3];
  pef_container.Version  = kPefVersion;

  // specify the start address, can be 0x10000
  pef_container.Start = kLinkerDefaultOrigin;
  pef_container.HdrSz = sizeof(LibCompiler::PEFContainer);
  pef_container.Checksum = 0UL;

  std::ofstream output_fc(kOutput, std::ofstream::binary);

  if (output_fc.bad()) {
    if (kVerbose) {
      kOutCon << "error: " << strerror(errno) << "\n";
    }

    return LIBCOMPILER_FILE_NOT_FOUND;
  }

  //! Read AE to convert as PEF.

  std::vector<LibCompiler::PEFCommandHeader> command_headers;
  LibCompiler::Utils::AEReadableProtocol     reader_protocol{};

  for (const auto& objectFile : kObjectList) {
    if (!std::filesystem::exists(objectFile)) continue;

    LibCompiler::AEHeader hdr{};

    reader_protocol.FP = std::ifstream(objectFile, std::ifstream::binary);
    reader_protocol.FP >> hdr;

    auto ae_header = hdr;

    if (ae_header.fMagic[0] == kAEMag0 && ae_header.fMagic[1] == kAEMag1 &&
        ae_header.fSize == sizeof(LibCompiler::AEHeader)) {
      if (ae_header.fArch != kArch) {
        if (kVerbose) kOutCon << "Info: is this a FAT binary? : ";

        if (!kFatBinaryEnable) {
          if (kVerbose) kOutCon << "No.\n";

          kOutCon << "Error: object " << objectFile
                  << " is a different kind of architecture and output isn't "
                     "treated as a FAT binary."
                  << std::endl;

          return LIBCOMPILER_FAT_ERROR;
        } else {
          if (kVerbose) {
            kOutCon << "Architecture matches what we expect.\n";
          }
        }
      }

      // append arch type to archs varaible.
      archs |= ae_header.fArch;
      std::size_t cnt = ae_header.fCount;

      if (kVerbose) kOutCon << "Object header found, record count: " << cnt << "\n";

      pef_container.Count = cnt;

      char_type* raw_ae_records = new char_type[cnt * sizeof(LibCompiler::AERecordHeader)];

      if (!raw_ae_records) {
        if (kVerbose) kOutCon << "Allocation failure for records of count: " << cnt << "\n";
      }

      memset(raw_ae_records, 0, cnt * sizeof(LibCompiler::AERecordHeader));

      auto* ae_records = reader_protocol.Read(raw_ae_records, cnt);

      auto org = kLinkerDefaultOrigin;

      for (size_t ae_record_index = 0; ae_record_index < cnt; ++ae_record_index) {
        LibCompiler::PEFCommandHeader command_header{0};
        std::size_t                   offset_of_obj = ae_records[ae_record_index].fOffset;

        MemoryCopy(command_header.Name, ae_records[ae_record_index].fName, kPefNameLen);

        LibCompiler::String cmd_hdr_name(command_header.Name);

        // check this header if it's any valid.
        if (cmd_hdr_name.find(kPefCode64) == LibCompiler::String::npos &&
            cmd_hdr_name.find(kPefData64) == LibCompiler::String::npos &&
            cmd_hdr_name.find(kPefZero64) == LibCompiler::String::npos) {
          if (cmd_hdr_name.find(kPefStart) == LibCompiler::String::npos &&
              *command_header.Name == 0) {
            if (cmd_hdr_name.find(kLdDefineSymbol) != LibCompiler::String::npos) {
              goto ld_mark_header;
            } else {
              continue;
            }
          }
        }

        if (cmd_hdr_name.find(kPefStart) != LibCompiler::String::npos &&
            cmd_hdr_name.find(kPefCode64) != LibCompiler::String::npos) {
          kStartFound = true;
        }

      ld_mark_header:
        command_header.Offset = offset_of_obj;
        command_header.Kind   = ae_records[ae_record_index].fKind;
        command_header.Size   = ae_records[ae_record_index].fSize;
        command_header.Cpu    = ae_header.fArch;
        command_header.VMAddress = org; /// TODO:
        command_header.SubCpu = ae_header.fSubArch;

        org += command_header.Size;

        if (kVerbose) {
          kOutCon << "Record: " << ae_records[ae_record_index].fName << " is marked.\n";

          kOutCon << "Offset: " << command_header.Offset << "\n";
        }

        command_headers.emplace_back(command_header);
      }

      delete[] raw_ae_records;
      raw_ae_records = nullptr;

      std::vector<char> bytes;
      bytes.resize(ae_header.fCodeSize);

      reader_protocol.FP.seekg(std::streamsize(ae_header.fStartCode));
      reader_protocol.FP.read(bytes.data(), std::streamsize(ae_header.fCodeSize));

      kObjectBytes.push_back({.mBlob = bytes, .mOffset = ae_header.fStartCode});

      // Blob was written, close fp.

      reader_protocol.FP.close();

      continue;
    }

    kOutCon << "Not an container: " << objectFile << std::endl;
    // don't continue, it is a fatal error.
    return LIBCOMPILER_EXEC_ERROR;
  }

  pef_container.Cpu = archs;

  output_fc << pef_container;

  if (kVerbose) {
    kOutCon << "Wrote container to: " << output_fc.tellp() << ".\n";
  }

  output_fc.seekp(std::streamsize(pef_container.HdrSz));

  std::vector<LibCompiler::String> not_found;
  std::vector<LibCompiler::String> symbols;

  // step 2: check for errors (multiple symbols, undefined ones)

  for (auto& command_hdr : command_headers) {
    // check if this symbol needs to be resolved.
    if (LibCompiler::String(command_hdr.Name).find(kLdDefineSymbol) != LibCompiler::String::npos &&
        LibCompiler::String(command_hdr.Name).find(kLdDynamicSym) == LibCompiler::String::npos) {
      if (kVerbose) kOutCon << "Found undefined symbol: " << command_hdr.Name << "\n";

      if (auto it =
              std::find(not_found.begin(), not_found.end(), LibCompiler::String(command_hdr.Name));
          it == not_found.end()) {
        not_found.emplace_back(command_hdr.Name);
      }
    }

    symbols.emplace_back(command_hdr.Name);
  }

  // Now try to solve these symbols.

  for (size_t not_found_idx = 0; not_found_idx < command_headers.size(); ++not_found_idx) {
    if (const auto it = std::find(not_found.begin(), not_found.end(),
                                  LibCompiler::String(command_headers[not_found_idx].Name));
        it != not_found.end()) {
      LibCompiler::String symbol_imp = *it;

      if (symbol_imp.find(kLdDefineSymbol) == LibCompiler::String::npos) continue;

      // erase the lookup prefix.
      symbol_imp.erase(0, symbol_imp.find(kLdDefineSymbol) + strlen(kLdDefineSymbol));

      // demangle everything.
      while (symbol_imp.find('$') != LibCompiler::String::npos)
        symbol_imp.erase(symbol_imp.find('$'), 1);

      // the reason we do is because, this may not match the symbol, and we need
      // to look for other matching symbols.
      for (auto& command_hdr : command_headers) {
        if (LibCompiler::String(command_hdr.Name).find(symbol_imp) != LibCompiler::String::npos &&
            LibCompiler::String(command_hdr.Name).find(kLdDefineSymbol) ==
                LibCompiler::String::npos) {
          LibCompiler::String undefined_symbol = command_hdr.Name;
          auto result_of_sym = undefined_symbol.substr(undefined_symbol.find(symbol_imp));

          for (int i = 0; result_of_sym[i] != 0; ++i) {
            if (result_of_sym[i] != symbol_imp[i]) goto ld_continue_search;
          }

          not_found.erase(it);

          if (kVerbose) kOutCon << "Found symbol: " << command_hdr.Name << "\n";

          break;
        }
      }

    ld_continue_search:
      continue;
    }
  }

  // step 3: check for errors (recheck if we have those symbols.)

  if (!kStartFound && is_executable) {
    if (kVerbose)
      kOutCon << "Undefined entrypoint: " << kPefStart
              << ", you may have forget to link "
                 "against the C++ runtime library.\n";

    kOutCon << "Undefined entrypoint " << kPefStart << " for executable: " << kOutput << "\n";
  }

  // step 4: write all PEF commands.

  LibCompiler::PEFCommandHeader date_cmd_hdr{};

  time_t timestamp = time(nullptr);

  LibCompiler::String timeStampStr = "Container:BuildEpoch:";
  timeStampStr += std::to_string(timestamp);

  strncpy(date_cmd_hdr.Name, timeStampStr.c_str(), timeStampStr.size());

  date_cmd_hdr.Flags  = 0;
  date_cmd_hdr.Kind   = LibCompiler::kPefZero;
  date_cmd_hdr.Offset = output_fc.tellp();
  date_cmd_hdr.Size   = timeStampStr.size();

  command_headers.push_back(date_cmd_hdr);

  LibCompiler::PEFCommandHeader abi_cmd_hdr{};

  LibCompiler::String abi = kLinkerAbiContainer;

  switch (kArch) {
    case LibCompiler::kPefArchAMD64: {
      abi += "MSFT";
      break;
    }
    case LibCompiler::kPefArchPowerPC: {
      abi += "SYSV";
      break;
    }
    case LibCompiler::kPefArch32000:
    case LibCompiler::kPefArch64000: {
      abi += "_NEP";
      break;
    }
    default: {
      abi += "_IDK";
      break;
    }
  }

  MemoryCopy(abi_cmd_hdr.Name, abi.c_str(), abi.size());

  abi_cmd_hdr.Size   = abi.size();
  abi_cmd_hdr.Offset = output_fc.tellp();
  abi_cmd_hdr.Flags  = 0;
  abi_cmd_hdr.Kind   = LibCompiler::kPefLinkerID;

  command_headers.push_back(abi_cmd_hdr);

  LibCompiler::PEFCommandHeader stack_cmd_hdr{0};

  stack_cmd_hdr.Cpu    = kArch;
  stack_cmd_hdr.Flags  = 0;
  stack_cmd_hdr.Size   = sizeof(uintptr_t);
  stack_cmd_hdr.Offset = 0;

  MemoryCopy(stack_cmd_hdr.Name, kLinkerStackSizeSymbol, strlen(kLinkerStackSizeSymbol));

  command_headers.push_back(stack_cmd_hdr);

  LibCompiler::PEFCommandHeader uuid_cmd_hdr{};

  std::random_device rd;

  auto seedData = std::array<int, std::mt19937::state_size>{};
  std::generate(std::begin(seedData), std::end(seedData), std::ref(rd));
  std::seed_seq seq(std::begin(seedData), std::end(seedData));
  std::mt19937  generator(seq);

  auto        gen     = uuids::uuid_random_generator{generator};
  uuids::uuid id      = gen();
  auto        uuidStr = uuids::to_string(id);

  MemoryCopy(uuid_cmd_hdr.Name, "Container:GUID:4:", strlen("Container:GUID:4:"));
  MemoryCopy(uuid_cmd_hdr.Name + strlen("Container:GUID:4:"), uuidStr.c_str(), uuidStr.size());

  uuid_cmd_hdr.Size   = strlen(uuid_cmd_hdr.Name);
  uuid_cmd_hdr.Offset = output_fc.tellp();
  uuid_cmd_hdr.Flags  = LibCompiler::kPefLinkerID;
  uuid_cmd_hdr.Kind   = LibCompiler::kPefZero;

  command_headers.push_back(uuid_cmd_hdr);

  // prepare a symbol vector.
  std::vector<LibCompiler::String> undef_symbols;
  std::vector<LibCompiler::String> dupl_symbols;
  std::vector<LibCompiler::String> resolve_symbols;

  constexpr Int32 kPaddingOffset = 16;

  size_t previous_offset =
      (command_headers.size() * sizeof(LibCompiler::PEFCommandHeader)) + kPaddingOffset;

  LibCompiler::PEFCommandHeader end_exec_hdr;

  end_exec_hdr.Offset = output_fc.tellp();
  end_exec_hdr.Flags  = LibCompiler::kPefLinkerID;
  end_exec_hdr.Kind   = LibCompiler::kPefZero;

  MemoryCopy(end_exec_hdr.Name, "Container:Exec:END", strlen("Container:Exec:END"));

  end_exec_hdr.Size   = strlen(end_exec_hdr.Name);

  command_headers.push_back(end_exec_hdr);

  // Finally write down the command headers.
  // And check for any duplications
  for (size_t commandHeaderIndex = 0UL; commandHeaderIndex < command_headers.size();
       ++commandHeaderIndex) {
    if (LibCompiler::String(command_headers[commandHeaderIndex].Name).find(kLdDefineSymbol) !=
            LibCompiler::String::npos &&
        LibCompiler::String(command_headers[commandHeaderIndex].Name).find(kLdDynamicSym) ==
            LibCompiler::String::npos) {
      // ignore :UndefinedSymbol: headers, they do not contain code.
      continue;
    }

    LibCompiler::String symbol_name = command_headers[commandHeaderIndex].Name;

    if (!symbol_name.empty()) {
      undef_symbols.emplace_back(symbol_name);
    }

    command_headers[commandHeaderIndex].Offset += previous_offset;
    previous_offset += command_headers[commandHeaderIndex].Size;

    LibCompiler::String name = command_headers[commandHeaderIndex].Name;

    /// so this is valid when we get to the entrypoint.
    /// it is always a code64 container. And should equal to kPefStart as well.
    /// this chunk of code updates the pef_container.Start with the updated offset.
    if (name.find(kPefStart) != LibCompiler::String::npos &&
        name.find(kPefCode64) != LibCompiler::String::npos) {
      pef_container.Start = command_headers[commandHeaderIndex].Offset;
      auto tellCurPos     = output_fc.tellp();

      output_fc.seekp(0);
      output_fc << pef_container;

      output_fc.seekp(tellCurPos);
    }

    if (kVerbose) {
      kOutCon << "Command name: " << name << "\n";
      kOutCon << "VMAddress of command content: " << command_headers[commandHeaderIndex].Offset
              << "\n";
    }

    output_fc << command_headers[commandHeaderIndex];

    for (size_t sub_command_header_index = 0UL; sub_command_header_index < command_headers.size();
         ++sub_command_header_index) {
      if (sub_command_header_index == commandHeaderIndex) continue;

      if (LibCompiler::String(command_headers[sub_command_header_index].Name)
                  .find(kLdDefineSymbol) != LibCompiler::String::npos &&
          LibCompiler::String(command_headers[sub_command_header_index].Name).find(kLdDynamicSym) ==
              LibCompiler::String::npos) {
        if (kVerbose) {
          kOutCon << "Ignoring :UndefinedSymbol: headers...\n";
        }

        // ignore :UndefinedSymbol: headers, they do not contain code.
        continue;
      }

      auto& command_hdr = command_headers[sub_command_header_index];

      if (command_hdr.Name == LibCompiler::String(command_headers[commandHeaderIndex].Name)) {
        if (std::find(dupl_symbols.cbegin(), dupl_symbols.cend(), command_hdr.Name) ==
            dupl_symbols.cend()) {
          dupl_symbols.emplace_back(command_hdr.Name);
        }

        if (kVerbose) kOutCon << "Found duplicate symbols of: " << command_hdr.Name << "\n";

        kDuplicateSymbols = true;
      }
    }
  }

  if (!dupl_symbols.empty()) {
    for (auto& symbol : dupl_symbols) {
      kOutCon << "Multiple symbols of: " << symbol << " detected, cannot continue.\n";
    }

    return LIBCOMPILER_EXEC_ERROR;
  }

  // step 2.5: write program bytes.

  for (auto& struct_of_blob : kObjectBytes) {
    output_fc.write(struct_of_blob.mBlob.data(), struct_of_blob.mBlob.size());
  }

  if (kVerbose) {
    kOutCon << "Wrote contents of: " << kOutput << "\n";
  }

  // step 3: check if we have those symbols

  std::vector<LibCompiler::String> unreferenced_symbols;

  for (auto& command_hdr : command_headers) {
    if (auto it =
            std::find(not_found.begin(), not_found.end(), LibCompiler::String(command_hdr.Name));
        it != not_found.end()) {
      unreferenced_symbols.emplace_back(command_hdr.Name);
    }
  }

  if (!unreferenced_symbols.empty()) {
    for (auto& unreferenced_symbol : unreferenced_symbols) {
      kOutCon << "Undefined symbol " << unreferenced_symbol << "\n";
    }

    return LIBCOMPILER_EXEC_ERROR;
  }

  if ((!kStartFound || kDuplicateSymbols) &&
      (std::filesystem::exists(kOutput) || !unreferenced_symbols.empty())) {
    if (kVerbose) {
      kOutCon << "File: " << kOutput << ", is corrupt, removing file...\n";
    }

    return LIBCOMPILER_EXEC_ERROR;
  }

  return LIBCOMPILER_SUCCESS;
}

// Last rev 13-1-24