【转载】minix mkfs.c 可在RedFlag 4.0 上编译运行

/*
* mkfs.c - make a linux (minix) file-system.
*
* (C) 1991 Linus Torvalds. This file may be redistributed as per
* the Linux copyright.
*/

/*
* 24.11.91 -    time began. Used the fsck sources to get started.
*
* 25.11.91 -    corrected some bugs. Added support for ".badblocks"
*        The algorithm for ".badblocks" is a bit weird, but
*        it should work. Oh, well.
*
* Usuage: mkfs [-c] device size-in-blocks
*
*    -c for readablility checking (SLOW!)
*
* The device may be a block device or a image of one, but this isn't
* enforced (but it's not much fun on a character device :-).
*/
/*--hgl--该程序用于创建MINIX1.0文件系统(即通常所说的格式化)
//--hgl--相当于fdisk
//--hgl--主要功能:
//--hgl--                1,建立超级块,位图区域,inode区域和数据区
//--hgl--                2,检测磁盘的坏块
--hgl--*/

#include <unistd.h>
#include <fcntl.h>
#include <ctype.h>
#include <termios.h>
#include <sys/stat.h>

#include <linux/fs.h>

#ifndef __GNUC__
#error "needs gcc for the bitop-__asm__'s"
#endif

#ifndef __linux__
#define volatile
#endif

#define ROOT_INO 1                            //--hgl--根inode号
#define BAD_INO 2

#define TEST_BUFFER_BLOCKS 32                //--hgl--测试时的步进长度
#define MAX_GOOD_BLOCKS 512                //--hgl--

#define UPPER(size,n) ((size+((n)-1))/(n))                    //--hgl--向上取整
#define INODE_SIZE (sizeof(struct d_inode))                    //--hgl--
#define INODE_BLOCKS UPPER(INODES,INODES_PER_BLOCK)
#define INODE_BUFFER_SIZE (INODE_BLOCKS * BLOCK_SIZE)    //--hgl--inode区域的大小

#define BITS_PER_BLOCK (BLOCK_SIZE<<3)        //--hgl--每block的bit数目

static char * program_name = "mkfs";    //--hgl--默认的程序名称
static char * device_name = NULL;
static int DEV = -1;                    //--hgl--该块设备的文件句柄(其实就是current->filp[]中的下标)
static long BLOCKS = 0;                    //--hgl--逻辑块数目
static int check = 0;
static int badblocks = 0;                //--hgl--坏块的数目

#define ROOT_INO_STRING "\001\000"    //--hgl--第一数据块位根节点
#define BAD_INO_STRING "\002\000"    //--hgl--第二数据块位坏块的记录

//--hgl--根的目录项
static char root_block[BLOCK_SIZE] =
ROOT_INO_STRING ".\0\0\0\0\0\0\0\0\0\0\0\0\0"
ROOT_INO_STRING "..\0\0\0\0\0\0\0\0\0\0\0\0"
BAD_INO_STRING ".badblocks\0\0\0\0";

static char * inode_buffer = NULL;                    //--hgl--inode区域
   //--hgl--这里减1,可能是因为inode是1为起始的,所以预先减1了
#define Inode (((struct d_inode *) inode_buffer)-1)
static char super_block_buffer[BLOCK_SIZE];
#define Super (*(struct super_block *)super_block_buffer)
#define INODES ((unsigned long)Super.s_ninodes)        //--hgl--inode数目
#define ZONES ((unsigned long)Super.s_nzones)        //--hgl--逻辑块总数
#define IMAPS ((unsigned long)Super.s_imap_blocks)    //--hgl--inode位图的block数目
#define ZMAPS ((unsigned long)Super.s_zmap_blocks)    //--hgl--逻辑块位图的blk数目
#define FIRSTZONE ((unsigned long)Super.s_firstdatazone)    //--hgl--第一个数据块的逻辑块号
#define ZONESIZE ((unsigned long)Super.s_log_zone_size)
#define MAXSIZE ((unsigned long)Super.s_max_size)
#define MAGIC (Super.s_magic)
//--hgl--2=1+1,boot和sb
#define NORM_FIRSTZONE (2+IMAPS+ZMAPS+INODE_BLOCKS)    //--hgl--数据区的起始逻辑块号

static char inode_map[BLOCK_SIZE * I_MAP_SLOTS];    //--hgl--inode位图
static char zone_map[BLOCK_SIZE * Z_MAP_SLOTS];    //--hgl--逻辑块位图
//--hgl--因为在格式化的时候,先检测磁盘,如果发现坏块
//--hgl--则在blk位图中标记占用,所以正常的逻辑块的使用
//--hgl--情况不能在blk位图中标记了,所以就引入good_blocks_table[]
//--hgl--来保存正常逻辑块的占用情况
static unsigned short good_blocks_table[MAX_GOOD_BLOCKS];        //--hgl--已经使用的逻辑块数组,
static int used_good_blocks = 0;                    //--hgl--已经使用的好的逻辑块

#define bitop(name,op) \
static inline int name(char * addr,unsigned int nr) \
{ \
int __res; \
__asm__ __volatile__("bt" op " %1,%2; adcl $0,%0" \
:"=g" (__res) \
:"r" (nr),"m" (*(addr)),"0" (0)); \
return __res; \
}

bitop(bit,"")
bitop(setbit,"s")
bitop(clrbit,"r")

#define inode_in_use(x) (bit(inode_map,(x)))
#define zone_in_use(x) (bit(zone_map,(x)-FIRSTZONE+1))        //--hgl--询问该位的值
//--hgl--标记inode号为x的位图为1
#define mark_inode(x) (setbit(inode_map,(x)))
#define unmark_inode(x) (clrbit(inode_map,(x)))

#define mark_zone(x) (setbit(zone_map,(x)-FIRSTZONE+1))
#define unmark_zone(x) (clrbit(zone_map,(x)-FIRSTZONE+1))

/*
* Volatile to let gcc know that this doesn't return. When trying
* to compile this under minix, volatile gives a warning, as
* exit() isn't defined as volatile under minix.
*/
volatile void fatal_error(const char * fmt_string)
{
   printf(fmt_string);
   exit(1);
}

#define usage() fatal_error("Usage: %s [-c] /dev/name blocks\n")
#define die(str) fatal_error(": " str "\n")

void write_tables(void)
//--hgl--P--将前面的几个过程中建立的buffer 回写到块设备
{
//--hgl--跳过boot块
   if (BLOCK_SIZE != lseek(DEV, BLOCK_SIZE, SEEK_SET))
       die("seek failed in write_tables");
//--hgl--填写sb
   if (BLOCK_SIZE != write(DEV, super_block_buffer, BLOCK_SIZE))
       die("unable to write super-block");
//--hgl--填写inode位图域
   if (IMAPS*BLOCK_SIZE != write(DEV,inode_map,IMAPS*BLOCK_SIZE))
       die("Unable to write inode map");
//--hgl--填写blk位图域
   if (ZMAPS*BLOCK_SIZE != write(DEV,zone_map,ZMAPS*BLOCK_SIZE))
       die("Unable to write zone map");
//--hgl--填写inode缓冲区
   if (INODE_BUFFER_SIZE != write(DEV,inode_buffer,INODE_BUFFER_SIZE))
       die("Unable to write inodes");
}
//--hgl--blk            目标逻辑块
//--hgl--buffer        源缓冲区
void write_block(int blk, char * buffer)
//--hgl--P--填写逻辑块
//--hgl--???????????????????
{
//--hgl--因为它是一个应用程序,所以不能
   //--hgl--将该文件(其实是块设备)的文件指针指向blk
   if (blk*BLOCK_SIZE != lseek(DEV, blk*BLOCK_SIZE, SEEK_SET))
       die("seek failed in write_block");
   //--hgl--
   if (BLOCK_SIZE != write(DEV, buffer, BLOCK_SIZE))
       die("write failed in write_block");
}

int get_free_block(void)
//--hgl--P--获得空闲的逻辑块,并在good_block_table中标记该blk已经被使用
//--hgl--将正常的逻辑块(但被使用了,不直接标记在inode用,)而是保存在
//--hgl--used_good_blocks[]中,因为这时只有坏块才在inode位图中标记,
//--hgl--以免混淆
{
   int blk;
//--hgl--??????????????好像和坏块的数目没有关系呀
   if (used_good_blocks+1 >= MAX_GOOD_BLOCKS)
       die("too many bad blocks");
   //--hgl--获得查找的起始逻辑块号
   if (used_good_blocks)
       blk = good_blocks_table[used_good_blocks-1]+1;
   else
       blk = FIRSTZONE;
   //--hgl--找到没有被占用的blk
   while (blk < ZONES && zone_in_use(blk))
       blk++;

   if (blk >= ZONES)
       die("not enough good blocks");
//--hgl--将该逻辑块号添加到
   good_blocks_table[used_good_blocks] = blk;
   used_good_blocks++;
   return blk;
}

void mark_good_blocks(void)
//--hgl--P--标记已经使用的好的逻辑块(在blk位图中标记)
{
   int blk;

   for (blk=0 ; blk < used_good_blocks ; blk++)
       mark_zone(good_blocks_table[blk]);
}
//--hgl--zone    逻辑块号
inline int next(int zone)
//--hgl--P--
{
   //--hgl--zone==0表示为第一次搜索
   if (!zone)
       zone = FIRSTZONE-1;    //--hgl--减1,因为后面是先++zone
   //--hgl--搜索整个数据区,如果被占用了,则表示是坏块
   while (++zone < ZONES)
       if (zone_in_use(zone))
           return zone;
   return 0;
}

void make_bad_inode(void)
//--hgl--P--将坏的逻辑块都连接到第二ionde
{
   struct d_inode * inode = &Inode[BAD_INO];
   int i,j,zone;
   int ind=0,dind=0;
   unsigned short ind_block[BLOCK_SIZE>>1];
   unsigned short dind_block[BLOCK_SIZE>>1];

#define NEXT_BAD (zone = next(zone))
   //--hgl--看是否有坏块
   if (!badblocks)
       return;
   //--hgl--如果有,则占用坏块节点
   mark_inode(BAD_INO);
   inode->i_nlinks = 1;
   inode->i_time = time(NULL);
   inode->i_mode = S_IFREG + 0000;
   inode->i_size = badblocks*BLOCK_SIZE;    //--hgl--确定坏块文件的大小
//--hgl--填写直接块号
   zone = next(0);
   for (i=0 ; i<7 ; i++) {
       inode->i_zone[i] = zone;
       if (!NEXT_BAD)
           goto end_bad;
   }
//--hgl--填写一次间接块的缓冲区
   //--hgl--获得一次间接块
   inode->i_zone[7] = ind = get_free_block();
   //--hgl--清空该一次间接块
   memset(ind_block,0,BLOCK_SIZE);
   //--hgl--填写一次间接块缓冲区
   for (i=0 ; i<512 ; i++) {
       ind_block[i] = zone;
       if (!NEXT_BAD)
           goto end_bad;
   }
//--hgl--填写二次间接块
   inode->i_zone[8] = dind = get_free_block();
   memset(dind_block,0,BLOCK_SIZE);
   for (i=0 ; i<512 ; i++) {
       //--hgl--回写到快设备
       write_block(ind,(char *) ind_block);
       //--hgl--
       dind_block[i] = ind = get_free_block();
       memset(ind_block,0,BLOCK_SIZE);
       for (j=0 ; j<512 ; j++) {
           ind_block[j] = zone;
           if (!NEXT_BAD)
               goto end_bad;
       }
   }
   die("too many bad blocks");
end_bad:
   //--hgl--回写到块设备
   if (ind)
       write_block(ind, (char *) ind_block);
   if (dind)
       write_block(dind, (char *) dind_block);
}

void make_root_inode(void)
//--hgl--P--创建根inode
{
//--hgl--获得第一个inode,
   struct d_inode * inode = &Inode[ROOT_INO];
//--hgl--标记根inode已经被占用
   mark_inode(ROOT_INO);
//--hgl--填写该inode
   inode->i_zone[0] = get_free_block();
   inode->i_nlinks = 2;
   inode->i_time = time(NULL);
   //--hgl--确定文件大小
   if (badblocks)
       inode->i_size = 48;
   else
       inode->i_size = 32;
   inode->i_mode = S_IFDIR + 0755;
//--hgl--填写根inode的目录项
   write_block(inode->i_zone[0],root_block);
}

void setup_tables(void)
//--hgl--P--填写缓冲区
{
   int i;
//--hgl--???????????为何填写0xff(表示都被占用???)
//--hgl--它可能是将整个磁盘当成一个大文件,由根inode来控制
   memset(inode_map,0xff,sizeof(inode_map));
   memset(zone_map,0xff,sizeof(zone_map));
   memset(super_block_buffer,0,BLOCK_SIZE);
//--hgl--填写超级块
   MAGIC = SUPER_MAGIC;
   ZONESIZE = 0;
   MAXSIZE = (7+512+512*512)*1024;
   ZONES = BLOCKS;
                   /* some magic nrs: 1 inode / 3 blocks */
   //--hgl--***block和inode不是1:1的比例*********
   INODES = BLOCKS/3;                        //--hgl--inode的数目
                   /* I don't want some off-by-one errors, so this hack... */
//--hgl--????????干吗要减去5呢????
   if ((INODES & 8191) > 8188)
       INODES -= 5;
   //--hgl--如果是n块还多几个(<10)个比特,则放弃最后几个比特位
   if ((INODES & 8191) < 10)
       INODES -= 20;
   //--hgl--确定inode位图区域的大小
   IMAPS = UPPER(INODES,BITS_PER_BLOCK);    //--hgl--向上取整
   //--hgl--确定数据区位图区域的大小
   ZMAPS = 0;
   while (ZMAPS != UPPER(BLOCKS - NORM_FIRSTZONE,BITS_PER_BLOCK))
       ZMAPS = UPPER(BLOCKS - NORM_FIRSTZONE,BITS_PER_BLOCK);
   FIRSTZONE = NORM_FIRSTZONE;
//--hgl--清空位图
   //--hgl--清空所有数据区位图
   for (i = FIRSTZONE ; i<ZONES ; i++)
       unmark_zone(i);
   //--hgl--清空所有inode位图
   for (i = ROOT_INO ; i<INODES ; i++)
       unmark_inode(i);
//--hgl--清空inode区域
   inode_buffer = malloc(INODE_BUFFER_SIZE);
   if (!inode_buffer)
       die("Unable to allocate buffer for inodes");
   memset(inode_buffer,0,INODE_BUFFER_SIZE);
//--hgl--打印消息
   printf("%d inodes\n",INODES);
   printf("%d blocks\n",ZONES);
   printf("Firstdatazone=%d (%d)\n",FIRSTZONE,NORM_FIRSTZONE);
   printf("Zonesize=%d\n",BLOCK_SIZE<<ZONESIZE);
   printf("Maxsize=%d\n\n",MAXSIZE);
}

void check_blocks(void)
//--hgl--P--统计磁盘的坏块数目,并标记
{
   unsigned int current_block=0;    //--hgl--当前的逻辑块号
   int try,got;
   static char buffer[BLOCK_SIZE * TEST_BUFFER_BLOCKS];

   while (current_block < ZONES) {
       if (lseek(DEV,current_block*BLOCK_SIZE,SEEK_SET) !=
       current_block*BLOCK_SIZE)
           die("seek failed in check_blocks");
       //--hgl--连续读取TEST_BUFFER_BLOCKS长的数据
       try = TEST_BUFFER_BLOCKS;
       if (current_block + try > ZONES)
           try = ZONES-current_block;
       got = read(DEV, buffer, try * BLOCK_SIZE);
       //--hgl--看是否被正确的读取
       if (got<0)
           got = 0;
       if (got & (BLOCK_SIZE-1))
           printf("Weird values in check_blocks: probably bugs\n");

       got /= BLOCK_SIZE;
       current_block += got;
       //--hgl--
       if (got == try)                //--hgl--正确,则终止本次循环
           continue;
       if (current_block < FIRSTZONE)
           die("bad blocks before data-area: cannot make fs");
//--hgl--出错,则标志当前块被占用,(以防止该块被使用)
//--hgl--?????没有完全标记呀???因为每次测试的块数n(1<n<TEST_BUFFER_BLOCKS)

       mark_zone(current_block);
       badblocks++;
       current_block++;
   }
   //--hgl--打印坏块的数目
   if (badblocks)
       printf("%d bad block%s\n",badblocks,(badblocks>1)?"s":"");
}

//--hgl--Usage: mkfs [-c] device size-in-blocks
//--hgl--第一个参数为程序名称
//--hgl--第二个为设备名
//--hgl--第三个为块数目
int main(int argc, char ** argv)
{
   char * tmp;
   struct stat statbuf;        //--hgl--inode的状态
//--hgl--?????????????
   if (argc && *argv)
       program_name = *argv;
   //--hgl--验证
   if (INODE_SIZE * INODES_PER_BLOCK != BLOCK_SIZE)
       die("bad inode size");
//--hgl--<>解析参数
   while (argc-- > 1) {
       argv++;
//--hgl--?????????
       if (argv[0][0] != '-')
           if (device_name) {
               BLOCKS = strtol(argv[0],&tmp,0);
               if (*tmp)
                   usage();
           } else
               device_name = argv[0];
       //--hgl--如果有参数"-c"
       else
           while (*++argv[0])
           switch (argv[0][0]) {
               case 'c': check=1; break;
               default: usage();
           }
   }
   if (!device_name || BLOCKS<10 || BLOCKS > 65536)
       usage();
//--hgl--打开设备device_name ,
//--hgl--因为在unix中设备也是当作文件来访问的
   DEV = open(device_name,O_RDWR);
   if (DEV<0)
       die("unable to open %s");
   //--hgl--获的该文件的inode状态
   if (fstat(DEV,&statbuf)<0)
       die("unable to stat %s");
   //--hgl--检测该设备是否为块设备
   if (!S_ISBLK(statbuf.st_mode))
       check=0;
   else if (statbuf.st_rdev == 0x0300 || statbuf.st_rdev == 0x0305)
       die("Will not try to make filesystem on '%s'");
//--hgl--
   setup_tables();
//--hgl--统计快设备的坏块,并在blk位图中标记
   if (check)
       check_blocks();
//--hgl--创建根节点(即第一inode)
   make_root_inode();
//--hgl--创建第二inode,将坏块都归为第二inode的数据块,以免被使用
   make_bad_inode();
//--hgl--标记已经被占用的正常的逻辑块
   mark_good_blocks();
//--hgl--回写到快设备
   write_tables();
   return 0;
}