Debug 的过成比较无聊,所以这里先上结论和示例,Debug 的笔记看不看并没有什么乱用。
结论
在shell 中使用返回值,唯一具有通用性的方法是使用全局变量,或者使用echo 并在父进程中接收。
return 语句不能用来传递计算结果——return 语句是用来传递函数退出状态的,在几乎所有情况下,你的计算结果都不会是退出状态!
任何违反上面规则的shell 脚本,都不具有通用性。
示例
#!/usr/bin/env bash
# ======================================
# 使用全局变量
# 优点:返回值可以在所有情况下正确传递
# 缺点:全局变量过多会让程序难以阅读
# ======================================
global_value=‘‘
function make_value {
# 在这里做一些计算
:
# 然后设定全局变量
global_value=‘value‘
# 返回出错码
return $?
}
make_value
# 判断函数是否执行成功
if [[ 0 != $? ]]; then
echo ‘make_value 执行失败‘
exit $?
fi
# 读取存放在全局变量的结果
echo "Now we get return value with $global_value"
#!/usr/bin/env bash
# ======================================
# 使用echo 语句传递返回值
# 优点:在具有高可阅读性的同时正确传递返回值
# 缺点:函数中不得有任何向stdout 流的输出
# ======================================
function make_value {
# 在这里做一些计算
local local_value=‘value‘
# 返回计算后的结果
echo $local_value
# 返回出错码
return $?
}
local_value=$(make_value)
# 判断函数是否执行成功
if [[ 0 != $? ]]; then
echo ‘make_value 执行失败‘
exit $?
fi
# 读取存放在全局变量的结果
echo "Now we get return value with $local_value"
Debug
最近把开发环境换到了Arch Linux,然而最近几天重新编译一下项目的时候遇到问题了:make
过程中一个原本毫无问题的工具make_ext4fs
必现除0 错误,导致生成的system.img为空!这种错误是非常致命而且低级的,一个原本运行良好的工具中不可能突然必现一个致命且低级的问题。
追踪调用make_ext4fs
的位置,发现是在脚本sprdisk/utils/build64.sh的第219 行:
make_ext4fs -T -1 -S $ANDROID_PRODUCT_OUT/root/file_contexts -l $syssize -a system $ANDROID_PRODUCT_OUT/obj/PACKAGING/systemimage_intermediates/system.img $ANDROID_PRODUCT_OUT/system
变量$ANDROID_PRODUCT_OUT是在source build/envsetup.sh
之后就确定的,只有$syssize的值是在运行时确定,打印了一下这个变量的值,是不确定的数值,初步判断范围在0-200 之间。使用$syssize的值手动构造指令运行,除0 错误必现。
追踪$syssize的来源,发现是通过函数get_system_img_size的返回值设置
get_system_img_size
syssize=$?
打印了几次这个返回值,范围符合初步判断的范围,用这些返回值构造指令,除0 错误必现。
追踪$syssize的计算过程,发现这个值来源于文件$ANDROID_PRODUCT_OUT/obj/PACKAGING/systemimage_intermediates/system_image_info.txt,通过system_size字段来设置
while read line
do
item=$(echo $line | (awk -F "=" ‘{print $1}‘) | tr -d ‘ ‘)
if [ $item = "system_size" ] ; then
syssize=$(echo $line | (awk -F "=" ‘{print $2}‘) | tr -d ‘ ‘)
ramdisksize=$(echo $(du -b $TOPDIR/ramdisk.img) | (awk ‘{print$1}‘) | tr -d ‘ ‘)
syssize=$(expr $syssize + $ramdisksize)
break
fi
done < $sysinfo
grep 了一下这个文件,发现system_size字段的值接近6 亿,也就是在550MB 以上
system_size=596555857
用这个值构造make_ext4fs
指令,成功执行。确定问题出在变量$syssize。
在函数内部打印该变量的值,发现函数返回时数值计算正确,锁定问题发生在函数返回值的接收上,也就是之前提到的这两行
get_system_img_size
syssize=$?
整理之前的情况,掌握的条件如下:
- 函数调用后,返回值发生了改变
- 返回值的改变导致了
make_ext4fs
发生除0 错误 - 该问题在Ubuntu Kylin 上不出现,在Arch Linux 上必现
确定是环境问题导致的函数返回值接收错误,首先怀疑是shell 的不同,于是确定一遍脚本的shebang line
#!/bin/sh
在Arch Linux 上确认一遍/bin/sh
,发现指向/usr/bin/bash
;
借用同事的Ubuntu Kylin 确认一遍/bin/sh
,发现指向/usr/bin/dash
!
整理得到的情报
- 问题在于函数返回值不能正确接收
- 是
bash
和dash
导致了这种不同
因为没有安装dash
,首先确认bash
上的情况,man 1 bash
发现如下的信息
The return value of a simple command is its exit status, or 128+n if the command is terminated by signal n.
这个值显然不过5 亿。
事实上测试证明,bash
的return
语句做多能够返回255 的整形,任何超过255 的返回值,都会被和255 取模并返回取模后的数值。
而dash
对返回值和bash 的处理不同,会原封不动的返回return 语句后的数值。
这就是为什么返回值发生了改变的原因:shell 的设计中,return
语句是用来传递出错码而不是返回值的,所以不同的shell 对于return
语句有不同的处理。
这也得出一个结论:在Shell 脚本中return
语句只能用来返回出错码,绝对不能返回任何计算结果,这不符合Shell 的设计原则,所以不具有通用性。
最后出于保留系统全局设置的考虑,修改脚本使用echo
语句传递返回值,编译通过。
版权声明:本文为博主原创文章,未经博主允许不得转载。