目录
常见的与shell互动场景
实现代码
全部代码
homepath()接口
const char *getUsername()接口
const char *getHostname()接口
const char *getCwd()接口
int getUserCommand(char *command, int num)接口
void commandSplit(char *in, char *out[])接口
int execute(char *argv[])接口
void cd(const char *path)接口
int doBuildin(char *argv[])接口
main函数
常见的与shell互动场景
-
用下图的时间轴来表示事件的发生次序。其中时间从左向右。shell由标识为sh的方块代表,它随着时的流逝从左向右移动。shell从用户读入字符串"ls"。shell建立一个新的进程,然后在那个进程中运行ls程序并等待那个进程结束。
-
然后shell读取新的一行输入,建立一个新的进程,在这个进程中运行程序 并等待这个进程结束。所以要写一个shell,需要循环以下过程
-
获取命令行
-
解析命令行
-
建立一个子进程(fork)
-
替换子进程(execvp)
-
父进程等待子进程退出(wait)
-
根据这些思路,和我们前面的学的技术,就可以自己来实现一个shell了
实现代码
全部代码
-
这段代码是一个简单的命令行解释器,类似于Linux中的shell。它接受用户输入的命令,并通过执行系统调用来实现命令的执行。
-
主要的功能包括:
-
提示符:获取用户输入的命令字符串。
-
分割字符串:将用户输入的命令字符串分割成命令及其参数。
-
内建命令检测:检查用户输入的命令是否是内建命令(如cd、export、echo等)。
-
执行命令:执行用户输入的命令或者外部可执行程序。
-
代码中使用了一些C标准库函数和系统调用,其中比较重要的部分包括fork创建子进程,execvp执行外部命令,waitpid等待子进程退出,以及内建命令的处理。
-
整个程序的逻辑是不断循环,获取用户输入的命令,然后根据用户输入执行相应的操作。内建命令会被直接在主进程中执行,而外部命令则会创建子进程来执行。
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/wait.h>
#define NUM 1024
#define SIZE 64
#define SEP " "
//#define Debug 1
char cwd[1024];
char enval[1024]; // for test
int lastcode = 0;
char *homepath()
{
char *home = getenv("HOME");
if(home) return home;
else return (char*)".";
}
const char *getUsername()
{
const char *name = getenv("USER");
if(name) return name;
else return "none";
}
const char *getHostname()
{
const char *hostname = getenv("HOSTNAME");
if(hostname) return hostname;
else return "none";
}
const char *getCwd()
{
const char *cwd = getenv("PWD");
if(cwd) return cwd;
else return "none";
}
int getUserCommand(char *command, int num)
{
printf("[%s@%s %s]# ", getUsername(), getHostname(), getCwd());
char *r = fgets(command, num, stdin); // 最终你还是会输入\n
if(r == NULL) return -1;
// "abcd\n" "\n"
command[strlen(command) - 1] = '\0'; // 有没有可能越界?不会
return strlen(command);
}
void commandSplit(char *in, char *out[])
{
int argc = 0;
out[argc++] = strtok(in, SEP);
while( out[argc++] = strtok(NULL, SEP));
#ifdef Debug
for(int i = 0; out[i]; i++)
{
printf("%d:%s\n", i, out[i]);
}
#endif
}
int execute(char *argv[])
{
pid_t id = fork();
if(id < 0) return -1;
else if(id == 0) //child
{
// exec command
execvp(argv[0], argv); // cd ..
exit(1);
}
else // father
{
int status = 0;
pid_t rid = waitpid(id, &status, 0);
if(rid > 0){
lastcode = WEXITSTATUS(status);
}
}
return 0;
}
void cd(const char *path)
{
chdir(path);
char tmp[1024];
getcwd(tmp, sizeof(tmp));
sprintf(cwd, "PWD=%s", tmp); // bug
putenv(cwd);
}
// 什么叫做内键命令: 内建命令就是bash自己执行的,类似于自己内部的一个函数!
// 1->yes, 0->no, -1->err
int doBuildin(char *argv[])
{
if(strcmp(argv[0], "cd") == 0)
{
char *path = NULL;
if(argv[1] == NULL) path=homepath();
else path = argv[1];
cd(path);
return 1;
}
else if(strcmp(argv[0], "export") == 0)
{
if(argv[1] == NULL) return 1;
strcpy(enval, argv[1]);
putenv(enval); // ???
return 1;
}
else if(strcmp(argv[0], "echo") == 0)
{
if(argv[1] == NULL){
printf("\n");
return 1;
}
if(*(argv[1]) == '$' && strlen(argv[1]) > 1){
char *val = argv[1]+1; // $PATH $?
if(strcmp(val, "?") == 0)
{
printf("%d\n", lastcode);
lastcode = 0;
}
else{
const char *enval = getenv(val);
if(enval) printf("%s\n", enval);
else printf("\n");
}
return 1;
}
else {
printf("%s\n", argv[1]);
return 1;
}
}
else if(0){}
return 0;
}
int main()
{
while(1){
char usercommand[NUM];
char *argv[SIZE];
// 1. 打印提示符&&获取用户命令字符串获取成功
int n = getUserCommand(usercommand, sizeof(usercommand));
if(n <= 0) continue;
// 2. 分割字符串
// "ls -a -l" -> "ls" "-a" "-l"
commandSplit(usercommand, argv);
// 3. check build-in command
n = doBuildin(argv);
if(n) continue;
// 4. 执行对应的命令
execute(argv);
}
}
homepath()接口
-
char homepath():这是一个函数声明,指定了函数的返回类型为 char,表示返回一个字符指针。
-
char *home = getenv("HOME");:调用 getenv() 函数来获取环境变量 "HOME" 的值,并将其存储在 home 变量中。环境变量 "HOME" 通常包含用户的家目录路径。
-
if(home) return home;:检查 home 变量是否为非空(即环境变量 "HOME" 是否存在)。如果环境变量 "HOME" 存在,就直接返回该路径。
-
else return (char*)".";:如果环境变量 "HOME" 不存在(即 home 为 NULL),则返回一个点号 ".",表示当前目录。
char *homepath()
{
char *home = getenv("HOME");
if(home) return home;
else return (char*)".";
}
const char *getUsername()接口
const char *getUsername()
{
const char *name = getenv("USER");
if(name) return name;
else return "none";
}
-
这个函数用于获取当前用户的用户名。
-
首先调用 getenv("USER") 来获取环境变量 "USER" 的值,并将其存储在名为 name 的常量字符指针中。
-
然后使用条件语句检查 name 是否非空,如果非空则返回该用户名,否则返回字符串 "none"。
-
返回的类型是 const char*,表示返回一个指向常量字符的指针,即返回的用户名字符串不可被修改。
const char *getHostname()接口
const char *getHostname()
{
const char *hostname = getenv("HOSTNAME");
if(hostname) return hostname;
else return "none";
}
-
这个函数用于获取主机名。
-
类似于 getUsername() 函数,它首先调用 getenv("HOSTNAME") 来获取环境变量 "HOSTNAME" 的值,并将其存储在名为 hostname 的常量字符指针中。
-
使用条件语句检查 hostname 是否非空,如果非空则返回该主机名,否则返回字符串 "none"。 返回的类型也是 const char*,表示返回一个指向常量字符的指针。
const char *getCwd()接口
const char *getCwd()
{
const char *cwd = getenv("PWD");
if(cwd) return cwd;
else return "none";
}
-
这个函数用于获取当前工作目录的路径。
-
类似于前两个函数,它首先调用 getenv("PWD") 来获取环境变量 "PWD" 的值,并将其存储在名为 cwd 的常量字符指针中。
-
使用条件语句检查 cwd 是否非空,如果非空则返回当前工作目录的路径,否则返回字符串 "none"。
-
也是返回类型是 const char*,表示返回一个指向常量字符的指针。
int getUserCommand(char *command, int num)接口
int getUserCommand(char *command, int num)
{
printf("[%s@%s %s]# ", getUsername(), getHostname(), getCwd());
char *r = fgets(command, num, stdin); // 最终你还是会输入\n
if(r == NULL) return -1;
// "abcd\n" "\n"
command[strlen(command) - 1] = '\0'; // 有没有可能越界?不会
return strlen(command);
}
-
这个函数接受两个参数:command 是一个字符数组,用于存储用户输入的命令;num 是一个整数,表示 command 数组的长度。
-
首先通过调用 getUsername()、getHostname() 和 getCwd() 函数来获取当前用户的用户名、主机名和当前工作目录,并使用 printf 函数输出提示符 [用户名@主机名 当前目录]#。
-
调用 fgets(command, num, stdin) 来从标准输入中读取用户输入的命令,并将其存储在 command 中,最多读取 num-1 个字符(包括换行符)。
-
检查 fgets 的返回值 r 是否为 NULL,如果为 NULL 则说明读取失败,直接返回 -1。
-
将用户输入的命令中的换行符替换为字符串结束符 \0,确保命令字符串的结尾正确。
-
返回用户输入的命令的长度,不包括换行符。
command[strlen(command) - 1] = '\0';
-
这行代码将用户输入的命令中的换行符(\n)替换为字符串结束符(\0),从而消除换行符并确保命令字符串的正确结束。
-
通过 strlen(command) 获取用户输入的命令的长度,然后将倒数第二个字符(即换行符)改为字符串结束符,这样就能正确截断换行符。
void commandSplit(char *in, char *out[])接口
void commandSplit(char *in, char *out[])
{
int argc = 0;
out[argc++] = strtok(in, SEP);
while( out[argc++] = strtok(NULL, SEP));
#ifdef Debug
for(int i = 0; out[i]; i++)
{
printf("%d:%s\n", i, out[i]);
}
#endif
}
-
这个函数接受两个参数:in 是输入的命令字符串,out[] 是一个字符串数组,用于存储分割后的子串。
-
在函数内部定义了一个整型变量 argc 用于记录分割后子串的数量,并初始化为 0。
-
调用 strtok(in, SEP) 来以 SEP 作为分隔符对输入的命令字符串进行第一次分割,并将第一个分割后的子串存储在 out 数组中,同时 argc 自增。
-
使用循环结构 while 不断调用 strtok(NULL, SEP) 进行后续的分割,直到没有更多的子串可分割。
-
分割后的每个子串都会被存储在 out 数组中,并且 argc 会记录子串的数量。
#ifdef Debug ... #endif
-
这部分代码使用了条件编译,只有在定义了 Debug 宏的情况下才会编译执行其中的代码。
-
在这个条件编译块中,通过循环遍历输出存储子串的 out 数组,依次打印每个子串的内容和索引。
int execute(char *argv[])接口
int execute(char *argv[])
{
pid_t id = fork();
if(id < 0) return -1;
else if(id == 0) //child
{
// exec command
execvp(argv[0], argv); // cd ..
exit(1);
}
else // father
{
int status = 0;
pid_t rid = waitpid(id, &status, 0);
if(rid > 0){
lastcode = WEXITSTATUS(status);
}
}
return 0;
}
-
这个函数接受一个参数 argv[],是一个字符串数组,包含了要执行的命令及其参数。
-
在函数内部,首先调用 fork() 创建一个子进程。如果创建子进程失败,fork() 返回值小于 0,函数直接返回 -1。
-
如果 fork() 返回值等于 0,说明当前处于子进程中,接着调用 execvp(argv[0], argv) 来执行用户输入的命令。如果 execvp 执行成功,子进程将被替换为新的程序,否则子进程会退出,并返回值为 1。
-
如果 fork() 返回值大于 0,说明当前处于父进程中。父进程会调用 waitpid(id, &status, 0) 来等待子进程结束,并获取子进程的状态信息。如果成功等到子进程结束,就会将子进程的退出状态存储在 lastcode 中。
-
最后,函数返回值为 0。
void cd(const char *path)接口
void cd(const char *path)
{
chdir(path);
char tmp[1024];
getcwd(tmp, sizeof(tmp));
sprintf(cwd, "PWD=%s", tmp); // bug
putenv(cwd);
}
-
这个函数接受一个参数 path,是一个指向要切换到的目标路径的指针。
-
在函数内部,首先调用 chdir(path) 来改变当前工作目录到指定的路径。
-
接着声明一个名为 tmp 的字符数组,用于存储获取到的当前工作目录路径。
-
调用 getcwd(tmp, sizeof(tmp)) 来获取当前工作目录的绝对路径,然后将其存储在 tmp 中。
-
使用 sprintf 函数将当前工作目录路径格式化为 "PWD=当前路径" 的形式,并将格式化后的字符串存储在全局变量 cwd 中。这里提到了一个潜在的 bug,因为 cwd 变量可能没有足够的空间来存储格式化后的字符串。
-
最后,调用 putenv(cwd) 来更新环境变量 PWD 的数值为当前工作目录的路径。
int doBuildin(char *argv[])接口
int doBuildin(char *argv[])
{
if(strcmp(argv[0], "cd") == 0)
{
char *path = NULL;
if(argv[1] == NULL) path=homepath();
else path = argv[1];
cd(path);
return 1;
}
else if(strcmp(argv[0], "export") == 0)
{
if(argv[1] == NULL) return 1;
strcpy(enval, argv[1]);
putenv(enval); // ???
return 1;
}
else if(strcmp(argv[0], "echo") == 0)
{
if(argv[1] == NULL){
printf("\n");
return 1;
}
if(*(argv[1]) == '$' && strlen(argv[1]) > 1){
char *val = argv[1]+1; // $PATH $?
if(strcmp(val, "?") == 0)
{
printf("%d\n", lastcode);
lastcode = 0;
}
else{
const char *enval = getenv(val);
if(enval) printf("%s\n", enval);
else printf("\n");
}
return 1;
}
else {
printf("%s\n", argv[1]);
return 1;
}
}
else if(0){}
return 0;
}
-
这个函数接受一个参数 argv[],是一个字符串数组,包含了用户输入的命令及其参数。
-
首先通过比较 argv[0] 和内置命令的字符串来判断用户输入的命令是哪个内置命令。
-
如果用户输入的是 cd 命令,则调用 cd 函数来改变当前工作目录到指定路径。如果用户没有输入路径,则调用 homepath() 函数获取主目录路径作为默认路径。
-
如果用户输入的是 export 命令,则将传入的参数 argv[1] 复制到全局变量 enval 中,并调用 putenv(enval) 来更新环境变量。
-
如果用户输入的是 echo 命令,则根据参数进行相应的输出操作:
-
若参数以 $ 开头且长度大于1,则尝试获取环境变量的值并输出;如果参数是 ?,则输出最近一次命令的退出状态。
-
若参数不以 $ 开头,则直接输出参数。
-
最后,根据用户输入的命令执行相应的操作,并返回 1 表示成功处理了内置命令。
main函数
int main()
{
while(1){
char usercommand[NUM];
char *argv[SIZE];
// 1. 打印提示符&&获取用户命令字符串获取成功
int n = getUserCommand(usercommand, sizeof(usercommand));
if(n <= 0) continue;
// 2. 分割字符串
// "ls -a -l" -> "ls" "-a" "-l"
commandSplit(usercommand, argv);
// 3. check build-in command
n = doBuildin(argv);
if(n) continue;
// 4. 执行对应的命令
execute(argv);
}
}
-
主函数包含一个无限循环,表示该命令解释器会持续等待用户输入并执行对应的命令,直到手动停止程序运行。
-
在每一轮循环中:
-
定义了存储用户命令的字符数组 usercommand 和用于存储分割后命令的字符串数组 argv。
-
调用 getUserCommand 函数获取用户输入的命令字符串,并返回字符串长度。
-
如果用户未输入命令(n <= 0),则继续下一轮循环等待用户输入。
-
调用 commandSplit 函数将用户输入的命令字符串分割为命令及参数,并保存到 argv 数组中。
-
调用 doBuildin 函数来检查是否存在内置命令,如果存在内置命令则执行相应操作,返回值 n 不为 0 则表示已处理内置命令,继续下一轮循环。
-
如果不是内置命令,则调用 execute 函数执行对应的外部命令。