如何閱讀源代碼(轉)

 寫在前面的話：
自從我在linuxaid.com.cn上發表一些文章開始，就不斷的有網友發來電子郵件，或是就其中某些問題進行探討，或是查詢其他文章的地址（往
往這些網友看的是其他網站轉載的我的文章），我很高興自己寫出的文章有這麼多人迴應，因爲這是對我最好的讚賞，也很高興有這麼多人對我的文章感興趣。但是
常常因爲工作關係。有很多郵件是詢問我的其他文章在哪裏能夠找到，我不一定能夠及時回覆，也覺得回覆同樣的問題比較麻煩，所以在這裏重複一下，我爲
linuxaid.com.cn寫的文章都能在www.linuxaid.com.cn的應用研發欄目中找到，我的一部分文章收集在
bambi.may10.ca/~ariesram/articles下面（這是個很簡陋的網頁，只有文本格式的文章，也歡迎有興趣的網友幫我設計一下
網頁），我的郵件地址：[email protected],
或[email protected]。請轉載文章的網站保留這一說明，歡迎網友寫email給我探討問題，雖然我不能確保能及時回覆。
正文：
由於工作的關係，我常常需要讀一些源代碼，並在上面做一些修改並且拿來使用，或是借鑑其中的某些部分。能夠說，open
source對於程式員來說，是很有意義的事情。根據我的經驗，讀源代碼，至少有3個好處。第一個好處是能夠學習到很多編程的方法，看好的源代碼，對於提
高自己的編程水平，比自己寫源代碼的幫助更大。當然不是說不用自己寫，而是說，自己寫代碼的同時，能夠從別人寫的好的源代碼中間學習到更多的編程方法和技
巧。第二個好處是，能夠提高自己把握大規模源代碼的能力。一個比較大型的程式，往往都是經過了很多個版本很長的時間，有很多人蔘和研發，修正錯誤，添加功
能而發展起來的。所以往往源代碼的規模都比較大，少則10-100多k, 多的有好幾十個MB.
在閱讀大量源代碼的時候，能夠提高自己對大的軟件的把握能力，快速瞭解脈絡，熟悉細節，不但僅是編程技巧，還能在程式的架構，設計方面提高自己的能力。
（這裏說一句題外話，>這本書相信很多人都看過，而且很多人對他推崇備至，奉爲經典。現在也出了不少書，都是冠以
"設計模式"這一名稱。在書中就提到，設計模式並不是一本教材，不是教您如何去編程式，而是把平時編程中一些固定的模式記錄下來，加以不斷的測試和改進，
分發給廣大程式員的一些經驗之談。我在看這本書的時候，有一些地方一些設計方法往往讓我有似曾相識的感覺，另外一些則是我以前就常常用到的。而這些經驗的
獲得，一部分得益於自己的編碼過程，另外一個很重要的來源就是閱讀別人寫的源代碼。)閱讀源代碼第三個好處，就是獲得一些好的思想。比如，有很多人在開始
一個軟件項目之前都喜歡到sourceforge.net上去找一下，是否有人以前做過相同或相似的軟件，假如有，則拿下來讀一讀，能夠使自己對這個軟
件項目有更多更深的認識。我以前曾想找一本關於如何閱讀源代碼的書來看看，卻沒有找到。相反，倒是找到了不少分析源代碼的書，比如Linux
kernel, Apache source,
等等。所以我想，爲什麼不自己來寫下一些經驗和大家交流呢？（當然不是寫書，沒有那個能力也沒有那個時間。）所以在這裏我準備用一個例子來寫一下如何閱讀
源代碼，分享一些經驗，算是拋磚引玉吧！
我找的例子是個統計日誌的工具，webalizer.
(這個工具我以前用過，似乎記得以前的版本是用perl寫的，不知道現在爲什麼作者把他完全修改成了C，可能是爲了效率，也可能根本就是我記錯了。）之所
以選擇這個軟件來作爲例子，一方面是因爲他是用C寫的，流程比較簡單，沒有C++的程式那麼多的枝節，而且軟件功能不算複雜，代碼規模不大，能夠在一篇文
章的篇幅裏面講完; 另外一個方面是因爲恰巧前段時間我因爲工作的關係把他拿來修改了一下，剛看過，還沒有忘記。
:-)我採用的例子是webalizer2.01-09, 也能夠到他的網站http://www.mrunix.net/webalizer/
下載最新的版本。這是個用C寫的，處理文本文檔（簡單的說是這樣，實際上他支持三種日誌文本格式：CLF, FTP, SQUID),
並且用html的方式輸出結果。讀者能夠自己去下載他的源代碼包，並一邊讀文章，一邊看程式。解壓縮他的tar包(我download的是他的源代碼
tar包），在文檔目錄中看到這樣的結果：
$ ls
aclocal.m4 dns_resolv.c lang output.h webalizer.1
CHANGES dns_resolv.h lang.h parser.c webalizer.c
configure graphs.c linklist.c parser.h webalizer.h
configure.in graphs.h linklist.h preserve.c webalizer_lang.h
COPYING hashtab.c Makefile.in preserve.h webalizer.LSM
Copyright hashtab.h Makefile.std README webalizer.png
country-codes.txt INSTALL msfree.png README.FIRST
DNS.README install-sh output.c sample.conf
首先，我閱讀了他的README(這是很重要的一個環節）,
大體瞭解了軟件的功能，歷史狀況，修改日誌，安裝方法等等。然後是安裝並且按照說明中的缺省方式來運行他，看看他的輸出結果。(安裝比較簡單，因爲他帶了
一個configure, 在沒有特別情況出現的時候，簡單的./configure, make, make
install就能夠安裝好。)然後就是閱讀源代碼了。我從makefile開始入手（我覺得這是瞭解一個軟件的最好的方法）在makefile開頭，有
這些內容：
prefix = /usr/local
exec_prefix = ${prefix}
BINDIR = ${exec_prefix}/bin
MANDIR = ${prefix}/man/man1
ETCDIR = /etc
CC = gcc
CFLAGS = -Wall -O2
LIBS = -lgd -lpng -lz -lm
DEFS = -DETCDIR="/etc" -DHAVE_GETOPT_H=1 -DHAVE_MATH_H=1
LDFLAGS=
INSTALL= /usr/bin/install -c
INSTALL_PROGRAM=${INSTALL}
INSTALL_DATA=${INSTALL} -m 644
# where are the GD header files?
GDLIB=/usr/include
這些定義了安裝的路徑，執行程式的安裝路徑，編譯器，配置文檔的安裝路徑，編譯的選項，安裝程式，安裝程式的選項等等。要注意的是，這些並不是軟件的作者寫的，而是./configure的輸出結果。呵呵. :-)下面纔是主題內容，也是我們關心的。
# Shouldn't have to touch below here!
all: webalizer
webalizer: webalizer.o webalizer.h hashtab.o hashtab.h
linklist.o linklist.h preserve.o preserve.h
dns_resolv.o dns_resolv.h parser.o parser.h
output.o output.h graphs.o graphs.h lang.h
webalizer_lang.h
$(CC) ${LDFLAGS} -o webalizer webalizer.o hashtab.o linklist.o preserv
e.o parser.o output.o dns_resolv.o graphs.o ${LIBS}
rm -f webazolver
ln -s webalizer webazolver
webalizer.o: webalizer.c webalizer.h parser.h output.h preserve.h
graphs.h dns_resolv.h webalizer_lang.h
$(CC) ${CFLAGS} ${DEFS} -c webalizer.c
parser.o: parser.c parser.h webalizer.h lang.h
$(CC) ${CFLAGS} ${DEFS} -c parser.c
hashtab.o: hashtab.c hashtab.h dns_resolv.h webalizer.h lang.h
$(CC) ${CFLAGS} ${DEFS} -c hashtab.c
linklist.o: linklist.c linklist.h webalizer.h lang.h
$(CC) ${CFLAGS} ${DEFS} -c linklist.c
output.o: output.c output.h webalizer.h preserve.h
hashtab.h graphs.h lang.h
$(CC) ${CFLAGS} ${DEFS} -c output.c
preserve.o: preserve.c preserve.h webalizer.h parser.h
hashtab.h graphs.h lang.h
$(CC) ${CFLAGS} ${DEFS} -c preserve.c
dns_resolv.o: dns_resolv.c dns_resolv.h lang.h webalizer.h
$(CC) ${CFLAGS} ${DEFS} -c dns_resolv.c
graphs.o: graphs.c graphs.h webalizer.h lang.h
$(CC) ${CFLAGS} ${DEFS} -I${GDLIB} -c graphs.c
好了，不用再往下看了，這些就已足夠了。從這裏我們能夠看到這個軟件的幾個源代碼文檔和他們的結構。webalizer.c是主程式所在的文檔，其他的是一些輔助程式模塊。對比一下目錄裏面的文檔，
$ ls *.c *.h
dns_resolv.c graphs.h lang.h output.c parser.h webalizer.c
dns_resolv.h hashtab.c linklist.c output.h preserve.c webalizer.h
graphs.c hashtab.h linklist.h parser.c preserve.h webalizer_lang.h
於是，讓我們從webalizer.c開始吧。
作爲一個C程式，在頭文檔裏面，和C文檔裏面定義的extern變量，結構等等肯定不會少，但是，單獨看這些東西我們不可能對這個程式有什麼認識。所以，
從main函數入手，逐步分析，在需要的時候再回頭來看這些數據結構定義纔是好的方法。（順便說一句，Visual C++,
等windows下的IDE工具提供了很方便的方法來獲取函數列表，C++的類列表連同資源文檔，對於閱讀源代碼很有幫助。Unix/Linux也有這些
工具，但是，我們在這裏暫時不說，而只是通過最簡單的文本編輯器vi來講)。跳過webalizer.c開頭的版權說明部分（GPL的），和數據結構定
義，全局變量聲明部分，直接進入main()函數。在函數開頭，我們看到：
/* initalize epoch */
epoch=jdate(1,1,1970); /* used for timestamp adj. */
/* add default index. alias */
add_nlist("index.",&index_alias);
這兩個函數暫時不用仔細看，後面會提到，略過。
sprintf(tmp_buf,"%s/webalizer.conf",ETCDIR);
/* check for default config file */
if (!access("webalizer.conf",F_OK))
get_config("webalizer.conf");
else if (!access(tmp_buf,F_OK))
get_config(tmp_buf);
從註釋和程式本身能夠看出，這是查找是否存在一個叫做webalizer.conf的配置文檔，假如當前目錄下有，則用get_config來讀入其中內
容，假如沒有，則查找ETCDIR/webalizer.conf是否存在。假如都沒有，則進入下一部分。(注意：ETCDIR =
@ETCDIR@在makefile中有定義）
/* get command line options */
opterr = 0; /* disable parser errors */
while ((i=getopt(argc,argv,"a:A:c:C:dD:e:E:fF:g:GhHiI:l:Lm:M:n:N:o:pP:qQr:R:s:S:t:Tu:U:vVx:XY"))!=EOF)
{
switch (i)
{
case 'a': add_nlist(optarg,&hidden_agents); break; /* Hide agents */
case 'A': ntop_agents=atoi(optarg); break; /* Top agents */
case 'c': get_config(optarg); break; /* Config file */
case 'C': ntop_ctrys=atoi(optarg); break; /* Top countries */
case 'd': debug_mode=1; break; /* Debug */
case 'D': dns_cache=optarg; break; /* DNS Cache filename */
case 'e': ntop_entry=atoi(optarg); break; /* Top entry pages */
case 'E': ntop_exit=atoi(optarg); break; /* Top exit pages */
case 'f': fold_seq_err=1; break; /* Fold sequence errs */
case 'F': log_type=(optarg[0]=='f')?
LOG_FTP:(optarg[0]=='s')?
LOG_SQUID:LOG_CLF; break; /* define log type */
case 'g': group_domains=atoi(optarg); break; /* GroupDomains (0=no) */
case 'G': hourly_graph=0; break; /* no hourly graph */
case 'h': print_opts(argv[0]); break; /* help */
case 'H': hourly_stats=0; break; /* no hourly stats */
case 'i': ignore_hist=1; break; /* Ignore history */
case 'I': add_nlist(optarg,&index_alias); break; /* Index alias */
case 'l': graph_lines=atoi(optarg); break; /* Graph Lines */
case 'L': graph_legend=0; break; /* Graph Legends */
case 'm': visit_timeout=atoi(optarg); break; /* Visit Timeout */
case 'M': mangle_agent=atoi(optarg); break; /* mangle user agents */
case 'n': hname=optarg; break; /* Hostname */
case 'N': dns_children=atoi(optarg); break; /* # of DNS children */
case 'o': out_dir=optarg; break; /* Output directory */
case 'p': incremental=1; break; /* Incremental run */
case 'P': add_nlist(optarg,&page_type); break; /* page view types */
case 'q': verbose=1; break; /* Quiet (verbose=1) */
case 'Q': verbose=0; break; /* Really Quiet */
case 'r': add_nlist(optarg,&hidden_refs); break; /* Hide referrer */
case 'R': ntop_refs=atoi(optarg); break; /* Top referrers */
case 's': add_nlist(optarg,&hidden_sites); break; /* Hide site */
case 'S': ntop_sites=atoi(optarg); break; /* Top sites */
case 't': msg_title=optarg; break; /* Report title */
case 'T': time_me=1; break; /* TimeMe */
case 'u': add_nlist(optarg,&hidden_urls); break; /* hide URL */
case 'U': ntop_urls=atoi(optarg); break; /* Top urls */
case 'v':
case 'V': print_version(); break; /* Version */
case 'x': html_ext=optarg; break; /* HTML file extension */
case 'X': hide_sites=1; break; /* Hide ind. sites */
case 'Y': ctry_graph=0; break; /* Supress ctry graph */
}
}
if (argc - optind != 0) log_fname = argv[optind];
if ( log_fname && (log_fname[0]=='-')) log_fname=NULL; /* force STDIN? */
/* check for gzipped file - .gz */
if (log_fname) if (!strcmp((log_fname+strlen(log_fname)-3),".gz")) gz_log=1;
這一段是分析命令行參數及開關。（getopt()的用法我在另外一篇文章中講過，這裏就不再重複了。）能夠看到，這個軟件雖然功能不太複雜，但是開關選
項還是不少。大多數的unix/linux程式的開頭部分都是這個套路，初始化配置文檔，並且讀入分析命令行。在這段程式中，我們需要注意一個函數：
add_nlist(). print_opts(),
get_config()等等一看就明白，就不用多講了。這裏我們已是第二次碰到add_nlist這個函數了，就仔細看看吧。
$ grep add_nlist *.h
linklist.h:extern int add_nlist(char *, NLISTPTR *); /* add list item */
能夠發現他定義在linklist.h中。
在這個h文檔中，當然會有一些數據結構的定義，比如：
struct nlist { char string[80]; /* list struct for HIDE items */
struct nlist *next; };
typedef struct nlist *NLISTPTR;
struct glist { char string[80]; /* list struct for GROUP items */
char name[80];
struct glist *next; };
typedef struct glist *GLISTPTR;
這是兩個鏈表結構。更有
extern GLISTPTR group_sites ; /* "group" lists */
extern GLISTPTR group_urls ;
extern GLISTPTR group_refs ;
這些都是鏈表， 太多了，不用一一看得很仔細，因爲現在也看不出來什麼東西。當然要注意他們是extern的， 也就是說，能夠在其他地方(文檔）看到他們的數值（類似於C++中的public變量）。這裏還定義了4個函數：
extern char *isinlist(NLISTPTR, char *); /* scan list for str */
extern char *isinglist(GLISTPTR, char *); /* scan glist for str */
extern int add_nlist(char *, NLISTPTR *); /* add list item */
extern int add_glist(char *, GLISTPTR *); /* add group list item */
注意，這些都是extern的，也就是說，能夠在其他地方見到他們的調用(有點相當於C++中的public函數）。再來看看linklist.c，
NLISTPTR new_nlist(char *); /* new list node */
void del_nlist(NLISTPTR *); /* del list */
GLISTPTR new_glist(char *, char *); /* new group list node */
void del_glist(GLISTPTR *); /* del group list */
int isinstr(char *, char *);
這5個函數是內部使用的（相當於C++中的private), 也就是說，這些函數只被isinlist(NLISTPTR, char *),
isinglist(GLISTPTR, char *), add_nlist(char *, NLISTPTR *),
add_glist(char *, GLISTPTR *)調用，而不會出現在其他地方。所以，我們先來看這幾個內部函數。舉例來說，
add_nlist(char *)
NLISTPTR new_nlist(char *str)
{
NLISTPTR newptr;
if (sizeof(newptr->string) string, str, sizeof(newptr->string));newptr->next=NULL;}
return newptr;
}
這個函數分配了一個struct nlist, 並且把其中的string賦值爲str,
next賦值爲NULL.這實際上是創建了鏈表中的一個節點。verbose是個全局變量，定義了輸出信息的類型，假如verbose爲1，則輸出很詳
細的信息，否則輸出簡略信息。這是爲了調試或使用者周詳瞭解程式情況來用的。不是重要內容，雖然我們常常能夠在這個源程式的其他地方看到他。另外一個函
數：
void del_nlist(NLISTPTR *list)
{
NLISTPTR cptr,nptr;
cptr=*list;
while (cptr!=NULL)
{
nptr=cptr->next;
free(cptr);
cptr=nptr;
}
}
這個函數刪除了一個nlist（也可能是list所指向的那一個部分開始知道鏈表結尾），比較簡單。看完了這兩個內部函數，能夠來看
/*********************************************/
/* ADD_NLIST - add item to FIFO linked list */
/*********************************************/
int add_nlist(char *str, NLISTPTR *list)
{
NLISTPTR newptr,cptr,pptr;
if ( (newptr = new_nlist(str)) != NULL)
{
if (*list==NULL) *list=newptr;
else
{
cptr=pptr=*list;
while(cptr!=NULL) { pptr=cptr; cptr=cptr->next; };
pptr->next = newptr;
}
}
return newptr==NULL;
}
這個函數是建立了一個新的節點，把參數str賦值給新節點的string,
並把他連接到list所指向鏈表的結尾。另外的三個函數：new_glist(), del_glist(),
add_glist()完成的功能和上述三個差不多，所不同的只是他們所處理的數據結構不同。看完了這幾個函數，我們回到main程式。接下來是，
/* setup our internal variables */
init_counters(); /* initalize main counters */
我們所閱讀的這個軟件是用來分析日誌並且做出統計的，那麼這個函數的名字已告訴了我們，這是個初始化計數器的函數。簡略的看看吧！
$ grep init_counters *.h
webalizer.h:extern void init_counters();
在webalizer.c中找到：
void init_counters()
{
int i;
for (i=0;i for (i=0;i>教材或>等書。
if (verbose>1)
{
uname(&system_info);
printf("Webalizer V%s-%s (%s %s) %s ",
version,editlvl,system_info.sysname,
system_info.release,language);
}
這一段，是打印有關係統的信息和webalizer程式的信息（能夠參考uname的函數說明）。
#ifndef USE_DNS
if (strstr(argv[0],"webazolver")!=0)
{
printf("DNS support not present, aborting... ");
exit(1);
}
#endif /* USE_DNS */
這一段，回憶我們在看README文檔的時候，曾提到過能夠在編譯的時候配置選項開關來設定DNS支持，在源代碼中能夠看到多次這樣的代碼段出現，假如不指定DNS支持，這些代碼段則會出現（ifdef)或不出現(ifndef).下面略過這些代碼段，不再重複。
/* open log file */
if (gz_log)
{
gzlog_fp = gzopen(log_fname,"rb");
if (gzlog_fp==Z_NULL)
{
/* Error: Can't open log file ... */
fprintf(stderr, "%s %s ",msg_log_err,log_fname);
exit(1);
}
}
else
{
if (log_fname)
{
log_fp = fopen(log_fname,"r");
if (log_fp==NULL)
{
/* Error: Can't open log file ... */
fprintf(stderr, "%s %s ",msg_log_err,log_fname);
exit(1);
}
}
}
這一段，回憶在README文檔中曾讀到過，假如log文檔是gzip壓縮格式，則用gzopen函數打開（能夠猜想gz***是一套針對gzip壓縮格式的實時解壓縮函數），假如不是，則用fopen打開。
/* switch directories if needed */
if (out_dir)
{
if (chdir(out_dir) != 0)
{
/* Error: Can't change directory to ... */
fprintf(stderr, "%s %s ",msg_dir_err,out_dir);
exit(1);
}
}
同樣，回憶在README文檔中讀到過，假如參數行有-o out_dir, 則將輸出結果到該目錄，否則，則輸出到當前目錄。在這一段中，假如輸出目錄不存在(chdir(out_dir) != 0)則出錯。
#ifdef USE_DNS
if (strstr(argv[0],"webazolver")!=0)
{
if (!dns_children) dns_children=5; /* default dns children if needed */
if (!dns_cache)
{
/* No cache file specified, aborting... */
fprintf(stderr,"%s ",msg_dns_nocf); /* Must have a cache file */
exit(1);
}
}
......
在上面曾提到過，這是DNS解析的代碼部分，能夠略過不看，不會影響對整個程式的理解。
/* prep hostname */
if (!hname)
{
if (uname(&system_info)) hname="localhost";
else hname=system_info.nodename;
}
這一段繼續處理參數做準備工作。假如在命令行中指定了hostname(機器名）則採用指定的名稱，否則調用uname查找機器名，假如沒有，則用localhost來作爲機器名。(同樣在README中說得很周詳）
/* get past history */
if (ignore_hist) {if (verbose>1) printf("%s ",msg_ign_hist); }
else get_history();
假如在命令行中指定了忽略歷史文檔，則不讀取歷史文檔，否則調用get_history()來讀取歷史數據。在這裏，我們能夠回想在README文檔中同
樣說過這一細節，在命令行或配置文檔中都能指定這一開關。需要說明的是，我們在這裏並不一定需要去看get_history這一函數，因爲從函數的名
稱，README文檔和程式註釋都能很清楚的得知這一函數的功能，不一定要去看代碼。而假如要猜想的話，也能夠想到，history是webalizer
在上次運行的時候記錄下來的一個文檔，而這個文檔則是去讀取他，並將他的數據包括到這次的分析中去。不信，我們能夠來看看。
void get_history()
{
int i,numfields;
FILE *hist_fp;
char buffer[BUFSIZE];
/* first initalize internal array */
for (i=0;i1) printf("%s %s ",msg_get_hist,hist_fname);
while ((fgets(buffer,BUFSIZE,hist_fp)) != NULL)
{
i = atoi(buffer) -1;
if (i>11)
{
if (verbose)
fprintf(stderr,"%s (mth=%d) ",msg_bad_hist,i+1);
continue;
}
/* month# year# requests files sites xfer firstday lastday */
numfields = sscanf(buffer,"%d %d %lu %lu %lu %lf %d %d %lu %lu",
&hist_month,
&hist_year,
&hist_hit,
&hist_files,
&hist_site,
&hist_xfer,
&hist_fday,
&hist_lday,
&hist_page,
&hist_visit);
if (numfields==8) /* kludge for reading 1.20.xx history files */
{
hist_page = 0;
hist_visit = 0;
}
}
fclose(hist_fp);
}
else if (verbose>1) printf("%s ",msg_no_hist);
}
/*********************************************/
/* PUT_HISTORY - write out history file */
/*********************************************/
void put_history()
{
int i;
FILE *hist_fp;
hist_fp = fopen(hist_fname,"w");
if (hist_fp)
{
if (verbose>1) printf("%s ",msg_put_hist);
for (i=0;i0) b--; break;
case '(': if (q) break; p++; break;
case ')': if (q) break; if (p>0) p--; break;
}
cp++;
}
}
從parser.h頭文檔中就能夠看到，這個函數是個內部函數，這個函數把一行字符串中間的空格字符用''字符（結束字符）來代替，同時考慮了不替換在
雙引號，方括號，圓括號中間的空格字符以免得將一行數據錯誤的分隔開了。（請參考WEB日誌的文檔格式，能夠更清楚的理解這一函數）
int parse_record_web(char *buffer)
{
int size;
char *cp1, *cp2, *cpx, *eob, *eos;
size = strlen(buffer); /* get length of buffer */
eob = buffer+size; /* calculate end of buffer */
fmt_logrec(buffer); /* seperate fields with 's */
/* HOSTNAME */
cp1 = cpx = buffer; cp2=log_rec.hostname;
eos = (cp1+MAXHOST)-1;
if (eos >= eob) eos=eob-1;
while ( (*cp1 != '') && (cp1 != eos) ) *cp2++ = *cp1++;
*cp2 = '';
if (*cp1 != '')
{
if (verbose)
{
fprintf(stderr,"%s",msg_big_host);
if (debug_mode) fprintf(stderr,": %s ",cpx);
else fprintf(stderr," ");
}
while (*cp1 != '') cp1++;
}
if (cp1 = eob) eos=eob-1;
while ( (*cp1 != '[') && (cp1 = eob) return 0;
/* check if oversized username */
if (*cp1 != '[')
{
if (verbose)
{
fprintf(stderr,"%s",msg_big_user);
if (debug_mode) fprintf(stderr,": %s ",cpx);
else fprintf(stderr," ");
}
while ( (*cp1 != '[') && (cp1 = eob) eos=eob-1;
while ( (*cp1 != '') && (cp1 != eos) ) *cp2++ = *cp1++;
*cp2 = '';
if (*cp1 != '')
{
if (verbose)
{
fprintf(stderr,"%s",msg_big_date);
if (debug_mode) fprintf(stderr,": %s ",cpx);
else fprintf(stderr," ");
}
while (*cp1 != '') cp1++;
}
if (cp1 = eob)) return 0;
/* HTTP request */
cpx = cp1;
cp2 = log_rec.url;
eos = (cp1+MAXURL-1);
if (eos >= eob) eos = eob-1;
while ( (*cp1 != '') && (cp1 != eos) ) *cp2++ = *cp1++;
*cp2 = '';
if (*cp1 != '')
{
if (verbose)
{
fprintf(stderr,"%s",msg_big_req);
if (debug_mode) fprintf(stderr,": %s ",cpx);
else fprintf(stderr," ");
}
while (*cp1 != '') cp1++;
}
if (cp1 = eob) ) return 0;
/* response code */
log_rec.resp_code = atoi(cp1);
/* xfer size */
while ( (*cp1 != '') && (cp1 '9') log_rec.xfer_size=0;
else log_rec.xfer_size = strtoul(cp1,NULL,10);
/* done with CLF record */
if (cp1>=eob) return 1;
while ( (*cp1 != '') && (*cp1 != ' ') && (cp1 = eob) eos = eob-1;
while ( (*cp1 != '') && (*cp1 != ' ') && (cp1 != eos) ) *cp2++ = *cp1++;
*cp2 = '';
if (*cp1 != '')
{
if (verbose)
{
fprintf(stderr,"%s",msg_big_ref);
if (debug_mode) fprintf(stderr,": %s ",cpx);
else fprintf(stderr," ");
}
while (*cp1 != '') cp1++;
}
if (cp1 = eob) eos = eob-1;
while ( (*cp1 != '') && (cp1 != eos) ) *cp2++ = *cp1++;
*cp2 = '';
return 1; /* maybe a valid record, return with TRUE */
}
該函數，一次讀入一行（其實是一段日誌數據中間的一個域，因爲該行數據已被fmt_logrec分開成多行數據了。根據CLF中的定義，檢查該數據並將其拷貝到log_rec結構中去，假如檢查該數據有效，則返回1。回到主程式,
/* convert month name to lowercase */
for (i=4;i=12)||(rec_min>59)||(rec_sec>59)||(rec_year='A') && (*cp1string))!=NULL)
{
if ((cp1==log_rec.url)||(*(cp1-1)=='/'))
{
*cp1='';
if (log_rec.url[0]=='')
{ log_rec.url[0]='/'; log_rec.url[1]=''; }
break;
}
}
lptr=lptr->next;
}
/* unescape referrer */
unescape(log_rec.refer);
......
這一段，做了一些URL字符串中的字符轉換工作，很長，我個人認爲爲了程式的模塊化，結構化和可複用性，應該將這一段代碼改爲函數，避免主程式體太長，造成可讀性不強和沒有移植性，和不夠結構化。跳過這一段乏味的代碼，進入到下面一個部分---後處理。
if (gz_log) gzclose(gzlog_fp);
else if (log_fname) fclose(log_fp);
if (good_rec) /* were any good records? */
{
tm_site[cur_day-1]=dt_site; /* If yes, clean up a bit */
tm_visit[cur_day-1]=tot_visit(sd_htab);
t_visit=tot_visit(sm_htab);
if (ht_hit > mh_hit) mh_hit = ht_hit;
if (total_rec > (total_ignore+total_bad)) /* did we process any? */
{
if (incremental)
{
if (save_state()) /* incremental stuff */
{
/* Error: Unable to save current run data */
if (verbose) fprintf(stderr,"%s ",msg_data_err);
unlink(state_fname);
}
}
month_update_exit(rec_tstamp); /* calculate exit pages */
write_month_html(); /* write monthly HTML file */
write_main_index(); /* write main HTML file */
put_history(); /* write history */
}
end_time = times(&mytms); /* display timing totals? */
if (time_me' '(verbose>1))
{
printf("%lu %s ",total_rec, msg_records);
if (total_ignore)
{
printf("(%lu %s",total_ignore,msg_ignored);
if (total_bad) printf(", %lu %s) ",total_bad,msg_bad);
else printf(") ");
}
else if (total_bad) printf("(%lu %s) ",total_bad,msg_bad);
/* get processing time (end-start) */
temp_time = (float)(end_time-start_time)/CLK_TCK;
printf("%s %.2f %s", msg_in, temp_time, msg_seconds);
/* calculate records per second */
if (temp_time)
i=( (int)( (float)total_rec/temp_time ) );
else i=0;
if ( (i>0) && (i
最後，對於在這篇文章中提到的分析源代碼程式的一些方法做一下小結，以作爲本文的結束。
分析一個源代碼，一個有效的方法是：
1、閱讀源代碼的說明文檔，比如本例中的README, 作者寫的很的周詳，仔細讀過之後，在閱讀程式的時候往往能夠從README文檔中找到相應的說明，從而簡化了源程式的閱讀工作。
2、假如源代碼有文檔目錄，一般爲doc或docs， 最好也在閱讀源程式之前仔細閱讀，因爲這些文檔同樣起了很好的說明註釋作用。
3、從makefile文檔入手，分析源代碼的層次結構，找出哪個是主程式，哪些是函數包。這對於快速把握程式結構有很大幫助。
4、從main函數入手，一步一步往下閱讀，碰到能夠猜測出意思來的簡單的函數，能夠跳過。但是一定要注意程式中使用的全局變量（假如是C程式），能夠把關鍵的數據結構說明拷貝到一個文本編輯器中以便隨時查找。
5、分析函數包（針對C程式），要注意哪些是全局函數，哪些是內部使用的函數，注意extern關鍵字。對於變量，也需要同樣注意。先分析清楚內部函數，再來分析外部函數，因爲內部函數肯定是在外部函數中被調用的。
6、需要說明的是數據結構的重要性：對於一個C程式來說，任何的函數都是在操作同一些數據，而由於沒有較好的封裝性，這些數據可能出現在程式的任何地方，被任何函數修改，所以一定要注意這些數據的定義和意義，也要注意是哪些函數在對他們進行操作，做了哪些改變。
7、在閱讀程式的同時，最好能夠把程式存入到cvs之類的版本控制器中去，在需要的時候能夠對源代碼做一些修改試驗，因爲動手修改是比僅僅是閱讀要好得多
的讀程式的方法。在您修改運行程式的時候，能夠從cvs中把原來的代碼調出來和您改變的部分進行比較(diff命令),
能夠看出一些源代碼的優缺點並且能夠實際的練習自己的編程技術。
8、閱讀程式的同時，要注意一些小工具的使用，能夠提高速度，比如vi中的查找功能，模式匹配查找，做標記，更有grep，find這兩個最強大最常用的文本搜索工具的使用。
對於一個Unix/Linux下面以命令行方式運行的程式，有這麼一些套路，大家能夠在閱讀程式的時候作爲參考。
1、在程式開頭，往往都是分析命令行，根據命令行參數對一些變量或數組，或結構賦值，後面的程式就是根據這些變量來進行不同的操作。
2、分析命令行之後，進行數據準備，往往是計數器清空，結構清零等等。
3、在程式中間有一些預編譯選項，能夠在makefile中找到相應部分。
4、注意程式中對於日誌的處理，和調試選項打開的時候做的動作，這些對於調試程式有很大的幫助。
5、注意多線程對數據的操作。（這在本例中沒有涉及）
結束語：
當然，在這篇文章中，並沒有闡述任何的閱讀源代碼的方法和技巧，也沒有涉及任何輔助工具（除了簡單的文本編輯器），也沒有涉及面向對象程式的閱讀方法。我想把這些留到以後再做討論。也請大家能夠就這些話題展開討論。