10 #include <vfs_threads.h>
13 #define BIN_LOWEST MM_USER_MIN // 1MiB
14 #define BIN_GRANUALITY 0x10000 // 64KiB
15 #define BIN_HIGHEST (USER_LIB_MAX-BIN_GRANUALITY) // Just below the kernel
16 #define KLIB_LOWEST MM_MODULE_MIN
17 #define KLIB_GRANUALITY 0x10000 // 32KiB
18 #define KLIB_HIGHEST (MM_MODULE_MAX-KLIB_GRANUALITY)
21 typedef struct sKernelBin {
22 struct sKernelBin *Next;
28 extern char *Threads_GetName(int ID);
29 extern tKernelSymbol gKernelSymbols[];
30 extern tKernelSymbol gKernelSymbolsEnd[];
31 extern tBinaryType gELF_Info;
34 int Binary_int_CacheArgs(const char **Path, const char ***ArgV, const char ***EnvP, void *DestBuffer);
35 tVAddr Binary_Load(const char *Path, tVAddr *EntryPoint);
36 tBinary *Binary_GetInfo(tMount MountID, tInode InodeID);
37 tVAddr Binary_MapIn(tBinary *Binary, const char *Path, tVAddr LoadMin, tVAddr LoadMax);
38 tVAddr Binary_IsMapped(tBinary *Binary);
39 tBinary *Binary_DoLoad(tMount MountID, tInode Inode, const char *Path);
40 void Binary_Dereference(tBinary *Info);
42 Uint Binary_Relocate(void *Base);
44 Uint Binary_GetSymbolEx(const char *Name, Uint *Value);
46 Uint Binary_FindSymbol(void *Base, const char *Name, Uint *Val);
48 int Binary_int_CheckMemFree( tVAddr _start, size_t _len );
51 tShortSpinlock glBinListLock;
52 tBinary *glLoadedBinaries = NULL;
53 char **gsaRegInterps = NULL;
55 tShortSpinlock glKBinListLock;
56 tKernelBin *glLoadedKernelLibs;
57 tBinaryType *gRegBinTypes = &gELF_Info;
61 * \brief Registers a binary type
63 int Binary_RegisterType(tBinaryType *Type)
65 Type->Next = gRegBinTypes;
71 * \fn int Proc_Spawn(const char *Path)
73 int Proc_Spawn(const char *Path)
75 char stackPath[strlen(Path)+1];
78 strcpy(stackPath, Path);
80 LOG("stackPath = '%s'", stackPath);
82 if(Proc_Clone(CLONE_VM|CLONE_NOUSER) == 0)
85 const char *args[2] = {stackPath, NULL};
86 LOG("stackPath = '%s'", stackPath);
87 Proc_Execve(stackPath, args, &args[1], 0);
97 int Binary_int_CacheArgs(const char **Path, const char ***ArgV, const char ***EnvP, void *DestBuffer)
99 int size, argc=0, envc=0;
108 const char **argv = *ArgV;
109 for( argc = 0; argv[argc]; argc ++ )
110 size += strlen( argv[argc] ) + 1;
114 const char **envp = *EnvP;
115 for( envc = 0; envp[envc]; envc ++ )
116 size += strlen( envp[envc] ) + 1;
118 size = (size + sizeof(void*)-1) & ~(sizeof(void*)-1); // Word align
119 size += (argc+1+envc+1)*sizeof(void*); // Arrays
122 size += strlen( *Path ) + 1;
128 strbuf = (void*)&arrays[argc+1+envc+1];
133 const char **argv = *ArgV;
134 for( i = 0; argv[i]; i ++ )
137 strcpy(strbuf, argv[i]);
138 strbuf += strlen( argv[i] ) + 1;
147 const char **envp = *EnvP;
148 for( i = 0; envp[i]; i ++ )
151 strcpy(strbuf, envp[i]);
152 strbuf += strlen( envp[i] ) + 1;
161 strcpy(strbuf, *Path);
170 * \brief Create a new process with the specified set of file descriptors
172 int Proc_SysSpawn(const char *Binary, const char **ArgV, const char **EnvP, int nFD, int *FDs)
179 // --- Save File, ArgV and EnvP
180 size = Binary_int_CacheArgs( &Binary, &ArgV, &EnvP, NULL );
181 cachebuf = malloc( size );
182 Binary_int_CacheArgs( &Binary, &ArgV, &EnvP, cachebuf );
184 // Cache the VFS handles
185 handles = VFS_SaveHandles(nFD, FDs);
187 // Create new process
188 ret = Proc_Clone(CLONE_VM|CLONE_NOUSER);
191 VFS_RestoreHandles(nFD, handles);
192 VFS_FreeSavedHandles(nFD, handles);
194 Proc_Execve(Binary, ArgV, EnvP, size);
199 VFS_FreeSavedHandles(nFD, handles);
207 * \brief Replace the current user image with another
208 * \param File File to load as the next image
209 * \param ArgV Arguments to pass to user
210 * \param EnvP User's environment
211 * \note Called Proc_ for historical reasons
213 int Proc_Execve(const char *File, const char **ArgV, const char **EnvP, int DataSize)
217 Uint base; // Uint because Proc_StartUser wants it
220 ENTER("sFile pArgV pEnvP", File, ArgV, EnvP);
222 // --- Save File, ArgV and EnvP
225 DataSize = Binary_int_CacheArgs( &File, &ArgV, &EnvP, NULL );
226 cachebuf = malloc( DataSize );
227 Binary_int_CacheArgs( &File, &ArgV, &EnvP, cachebuf );
231 for( argc = 0; ArgV && ArgV[argc]; argc ++ );
233 // --- Set Process Name
234 Threads_SetName(File);
236 // --- Clear User Address space
237 // NOTE: This is a little roundabout, maybe telling ClearUser to not touch the
238 // PPD area would be a better idea.
240 int nfd = *Threads_GetMaxFD();
242 handles = VFS_SaveHandles(nfd, NULL);
243 VFS_CloseAllUserHandles();
245 VFS_RestoreHandles(nfd, handles);
246 VFS_FreeSavedHandles(nfd, handles);
249 // --- Load new binary
250 base = Binary_Load(File, &entry);
253 Log_Warning("Binary", "Proc_Execve - Unable to load '%s'", File);
255 Threads_Exit(0, -10);
259 LOG("entry = 0x%x, base = 0x%x", entry, base);
261 // --- And... Jump to it
262 Proc_StartUser(entry, base, argc, ArgV, DataSize);
263 for(;;); // Tell GCC that we never return
267 * \brief Load a binary into the current address space
268 * \param Path Path to binary to load
269 * \param EntryPoint Pointer for exectuable entry point
270 * \return Virtual address where the binary has been loaded
272 tVAddr Binary_Load(const char *Path, tVAddr *EntryPoint)
279 ENTER("sPath pEntryPoint", Path, EntryPoint);
281 // Sanity Check Argument
287 // Check if this path has been loaded before.
289 // TODO: Implement a list of string/tBinary pairs for loaded bins
296 fd = VFS_Open(Path, VFS_OPENFLAG_READ|VFS_OPENFLAG_EXEC);
298 LOG("%s does not exist", Path);
301 VFS_FInfo(fd, &info, 0);
303 mount_id = info.mount;
305 LOG("mount_id = %i, inode = %i", mount_id, inode);
308 // TODO: Also get modifcation time?
310 // Check if the binary has already been loaded
311 if( !(pBinary = Binary_GetInfo(mount_id, inode)) )
312 pBinary = Binary_DoLoad(mount_id, inode, Path); // Else load it
315 if(pBinary == NULL) {
320 // Map into process space
321 base = Binary_MapIn(pBinary, Path, BIN_LOWEST, BIN_HIGHEST);
330 if(pBinary->Interpreter) {
332 if( Binary_Load(pBinary->Interpreter, &start) == 0 ) {
339 *EntryPoint = pBinary->Entry - pBinary->Base + base;
342 LOG("*EntryPoint = 0x%x", *EntryPoint);
344 return base; // Pass the base as an argument to the user if there is an interpreter
348 * \brief Finds a matching binary entry
349 * \param MountID Mountpoint ID of binary file
350 * \param InodeID Inode ID of the file
351 * \return Pointer to the binary definition (if already loaded)
353 tBinary *Binary_GetInfo(tMount MountID, tInode InodeID)
356 for(pBinary = glLoadedBinaries; pBinary; pBinary = pBinary->Next)
358 if(pBinary->MountID == MountID && pBinary->Inode == InodeID)
365 * \brief Maps an already-loaded binary into an address space.
366 * \param Binary Pointer to globally stored binary definition
367 * \param Path Path to the binary's file (for debug)
368 * \param LoadMin Lowest location to map to
369 * \param LoadMax Highest location to map to
370 * \return Base load address
372 tVAddr Binary_MapIn(tBinary *Binary, const char *Path, tVAddr LoadMin, tVAddr LoadMax)
377 ENTER("pBinary sPath pLoadMin pLoadMax", Binary, Path, LoadMin, LoadMax);
379 // Reference Executable (Makes sure that it isn't unloaded)
380 Binary->ReferenceCount ++;
385 // Check if base is free
388 LOG("Checking base %p", base);
389 for( i = 0; i < Binary->NumSections; i ++ )
391 if( Binary_int_CheckMemFree( Binary->LoadSections[i].Virtual, Binary->LoadSections[i].MemSize ) )
394 LOG("Address 0x%x is taken\n", Binary->LoadSections[i].Virtual);
400 // Check if the executable has no base or it is not free
403 // If so, give it a base
405 while(base >= LoadMin)
407 for( i = 0; i < Binary->NumSections; i ++ )
409 tVAddr addr = Binary->LoadSections[i].Virtual - Binary->Base + base;
410 size_t size = Binary->LoadSections[i].MemSize;
411 if( addr + size > LoadMax )
413 if( Binary_int_CheckMemFree( addr, size ) )
416 // If space was found, break
417 if(i == Binary->NumSections) break;
418 // Else decrement pointer and try again
419 base -= BIN_GRANUALITY;
421 LOG("Allocated base %p", base);
426 Log_Warning("Binary", "Executable '%s' cannot be loaded, no space", Path);
432 if( Binary->MountID )
433 fd = VFS_OpenInode(Binary->MountID, Binary->Inode, VFS_OPENFLAG_READ);
435 fd = VFS_Open(Path, VFS_OPENFLAG_READ);
436 for( i = 0; i < Binary->NumSections; i ++ )
438 tBinarySection *sect = &Binary->LoadSections[i];
439 Uint protflags, mapflags;
440 tVAddr addr = sect->Virtual - Binary->Base + base;
441 LOG("%i - %p, 0x%x bytes from offset 0x%llx (%x)", i, addr, sect->FileSize, sect->Offset, sect->Flags);
443 protflags = MMAP_PROT_READ;
444 mapflags = MMAP_MAP_FIXED;
446 if( sect->Flags & BIN_SECTFLAG_EXEC )
447 protflags |= MMAP_PROT_EXEC;
448 // Read only pages are COW
449 if( sect->Flags & BIN_SECTFLAG_RO ) {
450 VFS_MMap( (void*)addr, sect->FileSize, protflags, MMAP_MAP_SHARED|mapflags, fd, sect->Offset );
453 protflags |= MMAP_PROT_WRITE;
454 VFS_MMap( (void*)addr, sect->FileSize, protflags, MMAP_MAP_PRIVATE|mapflags, fd, sect->Offset );
457 // Apply anonymous memory for BSS
458 if( sect->FileSize < sect->MemSize ) {
459 mapflags |= MMAP_MAP_ANONYMOUS;
461 (void*)(addr + sect->FileSize), sect->MemSize - sect->FileSize,
462 protflags, MMAP_MAP_PRIVATE|mapflags,
468 Log_Debug("Binary", "PID %i - Mapped '%s' to %p", Threads_GetPID(), Path, base);
477 * \fn Uint Binary_IsMapped(tBinary *binary)
478 * \brief Check if a binary is already mapped into the address space
479 * \param binary Binary information to check
480 * \return Current Base or 0
482 Uint Binary_IsMapped(tBinary *binary)
486 // Check prefered base
487 iBase = binary->Base;
488 if(MM_GetPage( iBase ) == (binary->Pages[0].Physical & ~0xFFF))
491 for(iBase = BIN_HIGHEST;
493 iBase -= BIN_GRANUALITY)
495 if(MM_GetPage( iBase ) == (binary->Pages[0].Physical & ~0xFFF))
504 * \fn tBinary *Binary_DoLoad(char *truePath)
505 * \brief Loads a binary file into memory
506 * \param truePath Absolute filename of binary
508 tBinary *Binary_DoLoad(tMount MountID, tInode Inode, const char *Path)
513 tBinaryType *bt = gRegBinTypes;
515 ENTER("iMountID XInode sPath", MountID, Inode, Path);
520 fp = VFS_OpenInode(MountID, Inode, VFS_OPENFLAG_READ);
524 fp = VFS_Open(Path, VFS_OPENFLAG_READ);
527 LOG("Unable to load file, access denied");
532 LOG("fp = 0x%x", fp);
535 VFS_Read(fp, 4, &ident);
536 VFS_Seek(fp, 0, SEEK_SET);
538 LOG("ident = 0x%x", ident);
540 // Determine the type
541 for(; bt; bt = bt->Next)
543 if( (ident & bt->Mask) != (Uint32)bt->Ident )
545 LOG("bt = %p (%s)", bt, bt->Name);
546 pBinary = bt->Load(fp);
555 Log_Warning("Binary", "'%s' is an unknown file type. (%02x %02x %02x %02x)",
556 Path, ident&0xFF, (ident>>8)&0xFF, (ident>>16)&0xFF, (ident>>24)&0xFF);
561 LOG("pBinary = %p", pBinary);
564 if(pBinary == NULL) {
569 // Initialise Structure
570 pBinary->ReferenceCount = 0;
571 pBinary->MountID = MountID;
572 pBinary->Inode = Inode;
575 LOG("Interpreter: '%s'", pBinary->Interpreter);
576 LOG("Base: 0x%x, Entry: 0x%x", pBinary->Base, pBinary->Entry);
577 LOG("NumSections: %i", pBinary->NumSections);
580 SHORTLOCK(&glBinListLock);
581 pBinary->Next = glLoadedBinaries;
582 glLoadedBinaries = pBinary;
583 SHORTREL(&glBinListLock);
585 // TODO: Register the path with the binary
593 * \fn void Binary_Unload(void *Base)
594 * \brief Unload / Unmap a binary
595 * \param Base Loaded Base
596 * \note Currently used only for kernel libaries
598 void Binary_Unload(void *Base)
601 tKernelBin *prev = NULL;
604 if((Uint)Base < 0xC0000000)
606 // TODO: User Binaries
607 Log_Warning("BIN", "Unloading user binaries is currently unimplemented");
612 for(pKBin = glLoadedKernelLibs;
614 prev = pKBin, pKBin = pKBin->Next)
617 if(pKBin->Base != Base) continue;
619 for(i = 0; i < pKBin->Info->NumSections; i++)
621 // TODO: VFS_MUnmap();
623 // Dereference Binary
624 Binary_Dereference( pKBin->Info );
626 if(prev) prev->Next = pKBin->Next;
627 else glLoadedKernelLibs = pKBin->Next;
635 * \fn void Binary_Dereference(tBinary *Info)
636 * \brief Dereferences and if nessasary, deletes a binary
637 * \param Info Binary information structure
639 void Binary_Dereference(tBinary *Info)
641 // Decrement reference count
642 Info->ReferenceCount --;
644 // Check if it is still in use
645 if(Info->ReferenceCount) return;
647 /// \todo Implement binary freeing
651 * \fn char *Binary_RegInterp(char *Path)
652 * \brief Registers an Interpreter
653 * \param Path Path to interpreter provided by executable
655 char *Binary_RegInterp(char *Path)
658 // NULL Check Argument
659 if(Path == NULL) return NULL;
660 // NULL Check the array
661 if(gsaRegInterps == NULL)
664 gsaRegInterps = malloc( sizeof(char*) );
665 gsaRegInterps[0] = malloc( strlen(Path) );
666 strcpy(gsaRegInterps[0], Path);
667 return gsaRegInterps[0];
671 for( i = 0; i < giRegInterps; i++ )
673 if(strcmp(gsaRegInterps[i], Path) == 0)
674 return gsaRegInterps[i];
677 // Interpreter is not in list
679 gsaRegInterps = malloc( sizeof(char*)*giRegInterps );
680 gsaRegInterps[i] = malloc( strlen(Path) );
681 strcpy(gsaRegInterps[i], Path);
682 return gsaRegInterps[i];
686 // Kernel Binary Handling
689 * \fn void *Binary_LoadKernel(const char *File)
690 * \brief Load a binary into kernel space
691 * \note This function shares much with #Binary_Load, but does it's own mapping
692 * \param File File to load into the kernel
694 void *Binary_LoadKernel(const char *File)
697 tKernelBin *pKBinary;
702 ENTER("sFile", File);
704 // Sanity Check Argument
711 int fd = VFS_Open(File, VFS_OPENFLAG_READ);
714 LOG("Opening failed");
718 VFS_FInfo(fd, &info, 0);
719 mount_id = info.mount;
722 LOG("Mount %i, Inode %lli", mount_id, inode);
725 // Check if the binary has already been loaded
726 if( (pBinary = Binary_GetInfo(mount_id, inode)) )
728 for(pKBinary = glLoadedKernelLibs;
730 pKBinary = pKBinary->Next )
732 if(pKBinary->Info == pBinary) {
733 LOG("Already loaded");
734 LEAVE('p', pKBinary->Base);
735 return pKBinary->Base;
740 pBinary = Binary_DoLoad(mount_id, inode, File); // Else load it
743 if(pBinary == NULL) {
748 LOG("Loaded as %p", pBinary);
750 // Now pBinary is valid (either freshly loaded or only user mapped)
751 // So, map it into kernel space
754 // Reference Executable (Makes sure that it isn't unloaded)
755 pBinary->ReferenceCount ++;
757 base = Binary_MapIn(pBinary, File, KLIB_LOWEST, KLIB_HIGHEST);
764 // TODO: Could this cause race conditions if a binary isn't fully loaded when used
765 pKBinary = malloc(sizeof(*pKBinary));
766 pKBinary->Base = (void*)base;
767 pKBinary->Info = pBinary;
768 SHORTLOCK( &glKBinListLock );
769 pKBinary->Next = glLoadedKernelLibs;
770 glLoadedKernelLibs = pKBinary;
771 SHORTREL( &glKBinListLock );
778 * \fn Uint Binary_Relocate(void *Base)
779 * \brief Relocates a loaded binary (used by kernel libraries)
780 * \param Base Loaded base address of binary
781 * \return Boolean Success
783 Uint Binary_Relocate(void *Base)
785 Uint32 ident = *(Uint32*) Base;
786 tBinaryType *bt = gRegBinTypes;
788 for( ; bt; bt = bt->Next)
790 if( (ident & bt->Mask) == (Uint)bt->Ident )
791 return bt->Relocate( (void*)Base);
794 Log_Warning("BIN", "%p is an unknown file type. (%02x %02x %02x %02x)",
795 Base, ident&0xFF, (ident>>8)&0xFF, (ident>>16)&0xFF, (ident>>24)&0xFF);
800 * \fn int Binary_GetSymbol(char *Name, Uint *Val)
801 * \brief Get a symbol value
802 * \return Value of symbol or -1 on error
804 * Gets the value of a symbol from either the currently loaded
805 * libraries or the kernel's exports.
807 int Binary_GetSymbol(const char *Name, Uint *Val)
809 if( Binary_GetSymbolEx(Name, Val) ) return 1;
814 * \fn Uint Binary_GetSymbolEx(char *Name, Uint *Value)
815 * \brief Get a symbol value
817 * Gets the value of a symbol from either the currently loaded
818 * libraries or the kernel's exports.
820 Uint Binary_GetSymbolEx(const char *Name, Uint *Value)
824 int numKSyms = ((Uint)&gKernelSymbolsEnd-(Uint)&gKernelSymbols)/sizeof(tKernelSymbol);
826 LOG("numKSyms = %i", numKSyms);
829 for( i = 0; i < numKSyms; i++ )
831 LOG("KSym %s = %p", gKernelSymbols[i].Name, gKernelSymbols[i].Value);
832 if(strcmp(Name, gKernelSymbols[i].Name) == 0) {
833 *Value = gKernelSymbols[i].Value;
838 // Scan Loaded Libraries
839 for(pKBin = glLoadedKernelLibs;
841 pKBin = pKBin->Next )
843 if( Binary_FindSymbol(pKBin->Base, Name, Value) ) {
848 Log_Warning("BIN", "Unable to find symbol '%s'", Name);
853 * \fn Uint Binary_FindSymbol(void *Base, char *Name, Uint *Val)
854 * \brief Get a symbol from the specified library
855 * \param Base Base address
856 * \param Name Name of symbol to find
857 * \param Val Pointer to place final value
859 Uint Binary_FindSymbol(void *Base, const char *Name, Uint *Val)
861 Uint32 ident = *(Uint32*) Base;
862 tBinaryType *bt = gRegBinTypes;
864 for(; bt; bt = bt->Next)
866 if( (ident & bt->Mask) == (Uint)bt->Ident )
867 return bt->GetSymbol(Base, Name, Val);
870 Log_Warning("BIN", "Binary_FindSymbol - %p is an unknown file type. (%02x %02x %02x %02x)",
871 Base, ident&0xFF, ident>>8, ident>>16, ident>>24);
876 * \brief Check if a range of memory is fully free
877 * \return Inverse boolean free (0 if all pages are unmapped)
879 int Binary_int_CheckMemFree( tVAddr _start, size_t _len )
881 ENTER("p_start x_len", _start, _len);
883 _len += _start & (PAGE_SIZE-1);
884 _len = (_len + PAGE_SIZE - 1) & ~(PAGE_SIZE-1);
885 _start &= ~(PAGE_SIZE-1);
886 LOG("_start = %p, _len = 0x%x", _start, _len);
887 for( ; _len > PAGE_SIZE; _len -= PAGE_SIZE, _start += PAGE_SIZE ) {
888 if( MM_GetPhysAddr( (void*)_start ) != 0 ) {
893 if( _len == PAGE_SIZE && MM_GetPhysAddr( (void*)_start ) != 0 ) {
903 EXPORT(Binary_FindSymbol);
904 EXPORT(Binary_Unload);