摘要:本文介紹了LiteOS-M核心Newlib C的實現,特別是檔案系統和記憶體分配釋放部分,最後介紹了Newlib鉤子函式。
本文分享自華為雲社群《鴻蒙輕核心M核原始碼分析系列二十 Newlib C》,作者: zhushy。
使用Musl C庫的時候,核心提供了基於LOS_XXX適配實現pthread、mqeue、fs、semaphore、time等模組的posix介面(//kernel/liteos_m/kal/posix)。核心提供的posix介面與musl中的標準C庫介面共同組成LiteOS-M的LibC。編譯時使用arm-none-eabi-gcc,但只使用其工具鏈的編譯功能,通過加上-nostdinc與-nostdlib強制使用我們自己改造後的musl-C。
社群及三方廠商開發多使用公版工具鏈arm-none-eabi-gcc加上私有定製優化進行編譯,LiteOS-M核心也支援公版arm-none-eabi-gcc C庫編譯核心執行。newlib是小型C庫,針對posix介面涉及系統呼叫的部分,newlib提供一些需要系統適配的鉤子函式,例如_exit(),_open(),_close(),_gettimeofday()等,作業系統適配這些鉤子,就可以使用公版newlib工具鏈編譯執行程式。
1、Newlib C檔案系統
在使用Newlib C並且使能支援POSIX FS API時(可以在kernel\liteos-m\目錄下,執行make meuconfig彈出配置介面,路徑為Compat-Choose libc implementation),如下圖所示。可以使用檔案kal\libc\newlib\porting\src\fs.c中定義的檔案系統操作介面。這些是標準的POSIX介面,如果想了解POSIX用法,可以在linux平臺輸入 man -a 函式名稱,比如man -a opendir來開啟函式的手冊。
1.1 函式mount、umount和umount2
這些函式的用法,函式實現和musl c部分一致。
int mount(const char *source, const char *target, const char *filesystemtype, unsigned long mountflags, const void *data) { return LOS_FsMount(source, target, filesystemtype, mountflags, data); } int umount(const char *target) { return LOS_FsUmount(target); } int umount2(const char *target, int flag) { return LOS_FsUmount2(target, flag); }
1.2 檔案操作介面
以下劃線開頭的函式實現是newlib c的鉤子函式實現。有關newlib的鉤子函式呼叫過程下文專門分析下。
int _open(const char *path, int oflag, ...) { va_list vaList; va_start(vaList, oflag); int ret; ret = LOS_Open(path, oflag); va_end(vaList); return ret; } int _close(int fd) { return LOS_Close(fd); } ssize_t _read(int fd, void *buf, size_t nbyte) { return LOS_Read(fd, buf, nbyte); } ssize_t _write(int fd, const void *buf, size_t nbyte) { return LOS_Write(fd, buf, nbyte); } off_t _lseek(int fd, off_t offset, int whence) { return LOS_Lseek(fd, offset, whence); } int _unlink(const char *path) { return LOS_Unlink(path); } int _fstat(int fd, struct stat *buf) { return LOS_Fstat(fd, buf); } int _stat(const char *path, struct stat *buf) { return LOS_Stat(path, buf); } int fsync(int fd) { return LOS_Fsync(fd); } int mkdir(const char *path, mode_t mode) { return LOS_Mkdir(path, mode); } DIR *opendir(const char *dirName) { return LOS_Opendir(dirName); } struct dirent *readdir(DIR *dir) { return LOS_Readdir(dir); } int closedir(DIR *dir) { return LOS_Closedir(dir); } int rmdir(const char *path) { return LOS_Unlink(path); } int rename(const char *oldName, const char *newName) { return LOS_Rename(oldName, newName); } int statfs(const char *path, struct statfs *buf) { return LOS_Statfs(path, buf); } int ftruncate(int fd, off_t length) { return LOS_Ftruncate(fd, length); }
在newlib沒有使能使能支援POSIX FS API時時,需要提供這些鉤子函式的空的實現,返回-1錯誤碼即可。
int _open(const char *path, int oflag, ...) { return -1; } int _close(int fd) { return -1; } ssize_t _read(int fd, void *buf, size_t nbyte) { return -1; } ssize_t _write(int fd, const void *buf, size_t nbyte) { return -1; } off_t _lseek(int fd, off_t offset, int whence) { return -1; } int _unlink(const char *path) { return -1; } int _fstat(int fd, struct stat *buf) { return -1; } int _stat(const char *path, struct stat *buf) { return -1; }
2、Newlib C記憶體分配釋放
newlibc 的malloc適配參考The Red Hat newlib C Library-malloc。實現malloc適配有以下兩種方法:
- 實現 _sbrk_r 函式。這種方法中,記憶體分配函式使用newlib中的。
- 實現 _malloc_r, _realloc_r, _free_r, _memalign_r, _malloc_usable_size_r等。這種方法中,記憶體分配函式可以使用核心的。
為了方便地根據業務進行記憶體分配演算法調優和問題定位,推薦選擇後者。核心的記憶體函式定義在檔案kal\libc\newlib\porting\src\malloc.c中。原始碼片段如下,程式碼實現比較簡單,不再分析原始碼。
...... void __wrap__free_r(struct _reent *reent, void *aptr) { if (aptr == NULL) { return; } LOS_MemFree(OS_SYS_MEM_ADDR, aptr); } size_t __wrap__malloc_usable_size_r(struct _reent *reent, void *aptr) { return 0; } void *__wrap__malloc_r(struct _reent *reent, size_t nbytes) { if (nbytes == 0) { return NULL; } return LOS_MemAlloc(OS_SYS_MEM_ADDR, nbytes); } void *__wrap__memalign_r(struct _reent *reent, size_t align, size_t nbytes) { if (nbytes == 0) { return NULL; } return LOS_MemAllocAlign(OS_SYS_MEM_ADDR, nbytes, align); } ......
可能已經注意到函式命名由__wrap_加上鉤子函式名稱兩部分組成。這是因為newlib中已經存在這些函式的符號,因此需要用到gcc的wrap的連結選項替換這些函式符號為核心的實現,在裝置開發板的配置檔案中,比如//device/board/fnlink/v200zr/liteos_m/config.gni,新增這些函式的wrap連結選項,示例如下:
board_ld_flags += [ "-Wl,--wrap=_malloc_r", "-Wl,--wrap=_realloc_r", "-Wl,--wrap=_free_r", "-Wl,--wrap=_memalign_r", "-Wl,--wrap=_malloc_usable_size_r", ]
3、Newlib鉤子函式介紹
以open函式的鉤子函式_open為例來介紹newlib的鉤子函式的呼叫過程。open()函式實現在newlib-cygwin\newlib\libc\syscalls\sysopen.c中,該函式會進一步呼叫函式_open_r,這是個可重入函式Reentrant Function,支援在多執行緒中執行。
int open (const char *file, int flags, ...) { va_list ap; int ret; va_start (ap, flags); ret = _open_r (_REENT, file, flags, va_arg (ap, int)); va_end (ap); return ret; }
所有的可重入函式定義在資料夾newlib-cygwin\newlib\libc\reent,函式_open_r定義在該資料夾的檔案newlib-cygwin\newlib\libc\reent\openr.c裡。函式程式碼如下:
int _open_r (struct _reent *ptr, const char *file, int flags, int mode) { int ret; errno = 0; if ((ret = _open (file, flags, mode)) == -1 && errno != 0) ptr->_errno = errno; return ret; }
函式_open_r如上述程式碼所示,會進一步呼叫函式_open,該函式,以arm硬體平臺為例,實現在newlib-cygwin\libgloss\arm\syscalls.c檔案裡。newlib目錄是和硬體平臺無關的痛毆他那個功能實現,libloss目錄是底層的驅動實現,以各個硬體平臺為資料夾進行組織。在特定硬體平臺的目錄下的syscalls.c檔案裡面實現了newlib需要的各個樁函式:
/* Forward prototypes. */ int _system (const char *); int _rename (const char *, const char *); int _isatty (int); clock_t _times (struct tms *); int _gettimeofday (struct timeval *, void *); int _unlink (const char *); int _link (const char *, const char *); int _stat (const char *, struct stat *); int _fstat (int, struct stat *); int _swistat (int fd, struct stat * st); void * _sbrk (ptrdiff_t); pid_t _getpid (void); int _close (int); clock_t _clock (void); int _swiclose (int); int _open (const char *, int, ...); int _swiopen (const char *, int); int _write (int, const void *, size_t); int _swiwrite (int, const void *, size_t); _off_t _lseek (int, _off_t, int); _off_t _swilseek (int, _off_t, int); int _read (int, void *, size_t); int _swiread (int, void *, size_t); void initialise_monitor_handles (void);
對於上文提到的函式_open,原始碼如下。後續不再繼續分析了,LiteOS-M核心會提供這些鉤子函式的實現。
int _open (const char * path, int flags, ...) { return _swiopen (path, flags); }