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 = alloca( 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);
193 Proc_Execve(Binary, ArgV, EnvP, size);
198 VFS_FreeSavedHandles(nFD, handles);
205 * \brief Replace the current user image with another
206 * \param File File to load as the next image
207 * \param ArgV Arguments to pass to user
208 * \param EnvP User's environment
209 * \note Called Proc_ for historical reasons
211 int Proc_Execve(const char *File, const char **ArgV, const char **EnvP, int DataSize)
215 Uint base; // Uint because Proc_StartUser wants it
218 ENTER("sFile pArgV pEnvP", File, ArgV, EnvP);
220 // --- Save File, ArgV and EnvP
223 DataSize = Binary_int_CacheArgs( &File, &ArgV, &EnvP, NULL );
224 cachebuf = malloc( DataSize );
225 Binary_int_CacheArgs( &File, &ArgV, &EnvP, cachebuf );
229 for( argc = 0; ArgV && ArgV[argc]; argc ++ );
231 // --- Set Process Name
232 Threads_SetName(File);
234 // --- Clear User Address space
235 // NOTE: This is a little roundabout, maybe telling ClearUser to not touch the
236 // PPD area would be a better idea.
238 int nfd = *Threads_GetMaxFD();
240 handles = VFS_SaveHandles(nfd, NULL);
241 VFS_CloseAllUserHandles();
243 VFS_RestoreHandles(nfd, handles);
244 VFS_FreeSavedHandles(nfd, handles);
247 // --- Load new binary
248 base = Binary_Load(File, &entry);
251 Log_Warning("Binary", "Proc_Execve - Unable to load '%s'", File);
253 Threads_Exit(0, -10);
257 LOG("entry = 0x%x, base = 0x%x", entry, base);
259 // --- And... Jump to it
260 Proc_StartUser(entry, base, argc, ArgV, DataSize);
261 for(;;); // Tell GCC that we never return
265 * \brief Load a binary into the current address space
266 * \param Path Path to binary to load
267 * \param EntryPoint Pointer for exectuable entry point
268 * \return Virtual address where the binary has been loaded
270 tVAddr Binary_Load(const char *Path, tVAddr *EntryPoint)
277 ENTER("sPath pEntryPoint", Path, EntryPoint);
279 // Sanity Check Argument
285 // Check if this path has been loaded before.
287 // TODO: Implement a list of string/tBinary pairs for loaded bins
294 fd = VFS_Open(Path, VFS_OPENFLAG_READ|VFS_OPENFLAG_EXEC);
296 LOG("%s does not exist", Path);
299 VFS_FInfo(fd, &info, 0);
301 mount_id = info.mount;
303 LOG("mount_id = %i, inode = %i", mount_id, inode);
306 // TODO: Also get modifcation time?
308 // Check if the binary has already been loaded
309 if( !(pBinary = Binary_GetInfo(mount_id, inode)) )
310 pBinary = Binary_DoLoad(mount_id, inode, Path); // Else load it
313 if(pBinary == NULL) {
318 // Map into process space
319 base = Binary_MapIn(pBinary, Path, BIN_LOWEST, BIN_HIGHEST);
328 if(pBinary->Interpreter) {
330 if( Binary_Load(pBinary->Interpreter, &start) == 0 ) {
337 *EntryPoint = pBinary->Entry - pBinary->Base + base;
340 LOG("*EntryPoint = 0x%x", *EntryPoint);
342 return base; // Pass the base as an argument to the user if there is an interpreter
346 * \brief Finds a matching binary entry
347 * \param MountID Mountpoint ID of binary file
348 * \param InodeID Inode ID of the file
349 * \return Pointer to the binary definition (if already loaded)
351 tBinary *Binary_GetInfo(tMount MountID, tInode InodeID)
354 for(pBinary = glLoadedBinaries; pBinary; pBinary = pBinary->Next)
356 if(pBinary->MountID == MountID && pBinary->Inode == InodeID)
363 * \brief Maps an already-loaded binary into an address space.
364 * \param Binary Pointer to globally stored binary definition
365 * \param Path Path to the binary's file (for debug)
366 * \param LoadMin Lowest location to map to
367 * \param LoadMax Highest location to map to
368 * \return Base load address
370 tVAddr Binary_MapIn(tBinary *Binary, const char *Path, tVAddr LoadMin, tVAddr LoadMax)
375 ENTER("pBinary sPath pLoadMin pLoadMax", Binary, Path, LoadMin, LoadMax);
377 // Reference Executable (Makes sure that it isn't unloaded)
378 Binary->ReferenceCount ++;
383 // Check if base is free
386 LOG("Checking base %p", base);
387 for( i = 0; i < Binary->NumSections; i ++ )
389 if( Binary_int_CheckMemFree( Binary->LoadSections[i].Virtual, Binary->LoadSections[i].MemSize ) )
392 LOG("Address 0x%x is taken\n", Binary->LoadSections[i].Virtual);
398 // Check if the executable has no base or it is not free
401 // If so, give it a base
403 while(base >= LoadMin)
405 for( i = 0; i < Binary->NumSections; i ++ )
407 tVAddr addr = Binary->LoadSections[i].Virtual - Binary->Base + base;
408 if( Binary_int_CheckMemFree( addr, Binary->LoadSections[i].MemSize ) )
411 // If space was found, break
412 if(i == Binary->NumSections) break;
413 // Else decrement pointer and try again
414 base -= BIN_GRANUALITY;
416 LOG("Allocated base %p", base);
421 Log_Warning("Binary", "Executable '%s' cannot be loaded, no space", Path);
427 fd = VFS_OpenInode(Binary->MountID, Binary->Inode, VFS_OPENFLAG_READ);
428 for( i = 0; i < Binary->NumSections; i ++ )
430 tBinarySection *sect = &Binary->LoadSections[i];
431 Uint protflags, mapflags;
432 tVAddr addr = sect->Virtual - Binary->Base + base;
433 LOG("%i - %p to offset 0x%llx (%x)", i, addr, sect->Offset, sect->Flags);
435 protflags = MMAP_PROT_READ;
436 mapflags = MMAP_MAP_FIXED;
438 if( sect->Flags & BIN_SECTFLAG_EXEC )
439 protflags |= MMAP_PROT_EXEC;
440 // Read only pages are COW
441 if( sect->Flags & BIN_SECTFLAG_RO ) {
442 VFS_MMap( (void*)addr, sect->FileSize, protflags, MMAP_MAP_SHARED|mapflags, fd, sect->Offset );
445 protflags |= MMAP_PROT_WRITE;
446 VFS_MMap( (void*)addr, sect->FileSize, protflags, MMAP_MAP_PRIVATE|mapflags, fd, sect->Offset );
449 // Apply anonymous memory for BSS
450 if( sect->FileSize < sect->MemSize ) {
451 mapflags |= MMAP_MAP_ANONYMOUS;
453 (void*)(addr + sect->FileSize), sect->MemSize - sect->FileSize,
454 protflags, MMAP_MAP_PRIVATE|mapflags,
460 Log_Debug("Binary", "PID %i - Mapped '%s' to %p", Threads_GetPID(), Path, base);
469 * \fn Uint Binary_IsMapped(tBinary *binary)
470 * \brief Check if a binary is already mapped into the address space
471 * \param binary Binary information to check
472 * \return Current Base or 0
474 Uint Binary_IsMapped(tBinary *binary)
478 // Check prefered base
479 iBase = binary->Base;
480 if(MM_GetPage( iBase ) == (binary->Pages[0].Physical & ~0xFFF))
483 for(iBase = BIN_HIGHEST;
485 iBase -= BIN_GRANUALITY)
487 if(MM_GetPage( iBase ) == (binary->Pages[0].Physical & ~0xFFF))
496 * \fn tBinary *Binary_DoLoad(char *truePath)
497 * \brief Loads a binary file into memory
498 * \param truePath Absolute filename of binary
500 tBinary *Binary_DoLoad(tMount MountID, tInode Inode, const char *Path)
505 tBinaryType *bt = gRegBinTypes;
507 ENTER("iMountID XInode sPath", MountID, Inode, Path);
510 fp = VFS_OpenInode(MountID, Inode, VFS_OPENFLAG_READ);
512 LOG("Unable to load file, access denied");
517 LOG("fp = 0x%x", fp);
520 VFS_Read(fp, 4, &ident);
521 VFS_Seek(fp, 0, SEEK_SET);
523 LOG("ident = 0x%x", ident);
525 // Determine the type
526 for(; bt; bt = bt->Next)
528 if( (ident & bt->Mask) != (Uint32)bt->Ident )
530 LOG("bt = %p (%s)", bt, bt->Name);
531 pBinary = bt->Load(fp);
540 Log_Warning("Binary", "'%s' is an unknown file type. (%02x %02x %02x %02x)",
541 Path, ident&0xFF, (ident>>8)&0xFF, (ident>>16)&0xFF, (ident>>24)&0xFF);
546 LOG("pBinary = %p", pBinary);
549 if(pBinary == NULL) {
554 // Initialise Structure
555 pBinary->ReferenceCount = 0;
556 pBinary->MountID = MountID;
557 pBinary->Inode = Inode;
560 LOG("Interpreter: '%s'", pBinary->Interpreter);
561 LOG("Base: 0x%x, Entry: 0x%x", pBinary->Base, pBinary->Entry);
562 LOG("NumSections: %i", pBinary->NumSections);
565 SHORTLOCK(&glBinListLock);
566 pBinary->Next = glLoadedBinaries;
567 glLoadedBinaries = pBinary;
568 SHORTREL(&glBinListLock);
570 // TODO: Register the path with the binary
578 * \fn void Binary_Unload(void *Base)
579 * \brief Unload / Unmap a binary
580 * \param Base Loaded Base
581 * \note Currently used only for kernel libaries
583 void Binary_Unload(void *Base)
586 tKernelBin *prev = NULL;
589 if((Uint)Base < 0xC0000000)
591 // TODO: User Binaries
592 Log_Warning("BIN", "Unloading user binaries is currently unimplemented");
597 for(pKBin = glLoadedKernelLibs;
599 prev = pKBin, pKBin = pKBin->Next)
602 if(pKBin->Base != Base) continue;
604 for(i = 0; i < pKBin->Info->NumSections; i++)
606 // TODO: VFS_MUnmap();
608 // Dereference Binary
609 Binary_Dereference( pKBin->Info );
611 if(prev) prev->Next = pKBin->Next;
612 else glLoadedKernelLibs = pKBin->Next;
620 * \fn void Binary_Dereference(tBinary *Info)
621 * \brief Dereferences and if nessasary, deletes a binary
622 * \param Info Binary information structure
624 void Binary_Dereference(tBinary *Info)
626 // Decrement reference count
627 Info->ReferenceCount --;
629 // Check if it is still in use
630 if(Info->ReferenceCount) return;
632 /// \todo Implement binary freeing
636 * \fn char *Binary_RegInterp(char *Path)
637 * \brief Registers an Interpreter
638 * \param Path Path to interpreter provided by executable
640 char *Binary_RegInterp(char *Path)
643 // NULL Check Argument
644 if(Path == NULL) return NULL;
645 // NULL Check the array
646 if(gsaRegInterps == NULL)
649 gsaRegInterps = malloc( sizeof(char*) );
650 gsaRegInterps[0] = malloc( strlen(Path) );
651 strcpy(gsaRegInterps[0], Path);
652 return gsaRegInterps[0];
656 for( i = 0; i < giRegInterps; i++ )
658 if(strcmp(gsaRegInterps[i], Path) == 0)
659 return gsaRegInterps[i];
662 // Interpreter is not in list
664 gsaRegInterps = malloc( sizeof(char*)*giRegInterps );
665 gsaRegInterps[i] = malloc( strlen(Path) );
666 strcpy(gsaRegInterps[i], Path);
667 return gsaRegInterps[i];
671 // Kernel Binary Handling
674 * \fn void *Binary_LoadKernel(const char *File)
675 * \brief Load a binary into kernel space
676 * \note This function shares much with #Binary_Load, but does it's own mapping
677 * \param File File to load into the kernel
679 void *Binary_LoadKernel(const char *File)
682 tKernelBin *pKBinary;
687 ENTER("sFile", File);
689 // Sanity Check Argument
696 int fd = VFS_Open(File, VFS_OPENFLAG_READ);
702 VFS_FInfo(fd, &info, 0);
703 mount_id = info.mount;
708 // Check if the binary has already been loaded
709 if( (pBinary = Binary_GetInfo(mount_id, inode)) )
711 for(pKBinary = glLoadedKernelLibs;
713 pKBinary = pKBinary->Next )
715 if(pKBinary->Info == pBinary) {
716 LEAVE('p', pKBinary->Base);
717 return pKBinary->Base;
722 pBinary = Binary_DoLoad(mount_id, inode, File); // Else load it
725 if(pBinary == NULL) {
731 // Now pBinary is valid (either freshly loaded or only user mapped)
732 // So, map it into kernel space
735 // Reference Executable (Makes sure that it isn't unloaded)
736 pBinary->ReferenceCount ++;
738 Binary_MapIn(pBinary, File, KLIB_LOWEST, KLIB_HIGHEST);
741 if( !Binary_Relocate( (void*)base ) )
743 Log_Warning("Binary", "Relocation of '%s' failed, unloading", File);
744 Binary_Unload( (void*)base );
745 Binary_Dereference( pBinary );
750 // Add to list (relocator must look at itself manually, not via Binary_GetSymbol)
751 pKBinary = malloc(sizeof(*pKBinary));
752 pKBinary->Base = (void*)base;
753 pKBinary->Info = pBinary;
754 SHORTLOCK( &glKBinListLock );
755 pKBinary->Next = glLoadedKernelLibs;
756 glLoadedKernelLibs = pKBinary;
757 SHORTREL( &glKBinListLock );
764 * \fn Uint Binary_Relocate(void *Base)
765 * \brief Relocates a loaded binary (used by kernel libraries)
766 * \param Base Loaded base address of binary
767 * \return Boolean Success
769 Uint Binary_Relocate(void *Base)
771 Uint32 ident = *(Uint32*) Base;
772 tBinaryType *bt = gRegBinTypes;
774 for(; bt; bt = bt->Next)
776 if( (ident & bt->Mask) == (Uint)bt->Ident )
777 return bt->Relocate( (void*)Base);
780 Log_Warning("BIN", "%p is an unknown file type. (%02x %02x %02x %02x)",
781 Base, ident&0xFF, (ident>>8)&0xFF, (ident>>16)&0xFF, (ident>>24)&0xFF);
786 * \fn int Binary_GetSymbol(char *Name, Uint *Val)
787 * \brief Get a symbol value
788 * \return Value of symbol or -1 on error
790 * Gets the value of a symbol from either the currently loaded
791 * libraries or the kernel's exports.
793 int Binary_GetSymbol(const char *Name, Uint *Val)
795 if( Binary_GetSymbolEx(Name, Val) ) return 1;
800 * \fn Uint Binary_GetSymbolEx(char *Name, Uint *Value)
801 * \brief Get a symbol value
803 * Gets the value of a symbol from either the currently loaded
804 * libraries or the kernel's exports.
806 Uint Binary_GetSymbolEx(const char *Name, Uint *Value)
810 int numKSyms = ((Uint)&gKernelSymbolsEnd-(Uint)&gKernelSymbols)/sizeof(tKernelSymbol);
813 for( i = 0; i < numKSyms; i++ )
815 if(strcmp(Name, gKernelSymbols[i].Name) == 0) {
816 *Value = gKernelSymbols[i].Value;
821 // Scan Loaded Libraries
822 for(pKBin = glLoadedKernelLibs;
824 pKBin = pKBin->Next )
826 if( Binary_FindSymbol(pKBin->Base, Name, Value) ) {
831 Log_Warning("BIN", "Unable to find symbol '%s'", Name);
836 * \fn Uint Binary_FindSymbol(void *Base, char *Name, Uint *Val)
837 * \brief Get a symbol from the specified library
838 * \param Base Base address
839 * \param Name Name of symbol to find
840 * \param Val Pointer to place final value
842 Uint Binary_FindSymbol(void *Base, const char *Name, Uint *Val)
844 Uint32 ident = *(Uint32*) Base;
845 tBinaryType *bt = gRegBinTypes;
847 for(; bt; bt = bt->Next)
849 if( (ident & bt->Mask) == (Uint)bt->Ident )
850 return bt->GetSymbol(Base, Name, Val);
853 Log_Warning("BIN", "Binary_FindSymbol - %p is an unknown file type. (%02x %02x %02x %02x)",
854 Base, ident&0xFF, ident>>8, ident>>16, ident>>24);
859 * \brief Check if a range of memory is fully free
860 * \return Inverse boolean free (0 if all pages are unmapped)
862 int Binary_int_CheckMemFree( tVAddr _start, size_t _len )
864 _len += _start & (PAGE_SIZE-1);
865 _len = (_len + PAGE_SIZE - 1) & ~(PAGE_SIZE-1);
866 _start &= ~(PAGE_SIZE-1);
867 for( ; _len > PAGE_SIZE; _len -= PAGE_SIZE, _start += PAGE_SIZE ) {
868 if( MM_GetPhysAddr(_start) != 0 )
871 if( _len == PAGE_SIZE && MM_GetPhysAddr(_start) != 0 )
878 EXPORT(Binary_FindSymbol);
879 EXPORT(Binary_Unload);