顯示具有 程式 標籤的文章。 顯示所有文章
顯示具有 程式 標籤的文章。 顯示所有文章

星期三, 10月 15, 2014

寫程式就要像寫文章一樣

前幾天有位同事, 姑且叫他 Terence 吧, 問了我一個關於寫程式的問題,
我覺得很有意思, 把這個過程跟大家分享一下

"ccw, 請問一下, 你比較支持匈牙利命名法還是底線命名法呢 ?"
"泰倫斯, 你是說 ThisIsABook 或是 this_is_a_book 這兩種寫程式的命名法則嗎 ?"
"是的, 我感覺這兩種都有人支持, 也都各有好處, 不知道該選擇哪一種"
"如果單單只有比這兩種法則, 是很難選擇的, 但是如果把層次拉高一點, 我會選底線命名法"
"哦, 甚麼叫做把層次拉高一點呢?"
"所謂的層次拉高一點來看呢, 就是以程式的可讀性來考量"
"可讀性 ?"
"我覺得寫出來的程式, 要讓自己和別人最容易閱讀, 將來才容易維護或是改善"
"了解, 可是這跟命名法則有關係嗎 ?"
"有一點關係,

 例如下面這段程式

 if (authentication_is_success()) {
       load_welcome_page();
 }

 就會比下面這樣的程式風格, 更一目了然


 if (AuthenticationIsSuccess()) {
       LoadWelcomePage();
 }
"ccw, 我有點感覺了, 而且前面哪段程式念起來還蠻順的"
"泰倫斯, 真是孺子可教也, 沒錯, 基本上我認為寫程式跟寫文章沒有兩樣"
"我一直以為這是兩件事情呢..."
"如果你把這兩件事情當作一件事情, 那麼很多法則的選擇, 就很清楚了, 例如寫注解這件事情"
"寫注解 ?"
"如果你的程式可讀性很高, 哪麼基本上就不用寫注解, 換句話說, 與其花時間把注解寫得很好, 不如好好地改善程式結構, 花時間選一些適當的命名, 讓整段程式看起來, 就像一篇優美易讀的文章, 將來你的麻煩覺得只會少不會多"
"ccw, 感謝分享你的經驗"
ps. 上次看到有人分享一個 一家用漢字寫程式的公司, 大家可以參考看看

C# code     


遍历器<登录信息>.计数遍历(_详细信息集合).从(0).到(_详细信息集合.长度()).每隔(1).执行((当前行索引, 登陆信息) =>
           {
               判断.如果是(XXX).则(() =>
               {
                   判断.如果是(YYY).则(() =>
                   {
                       表格.行(当前行索引).背景色设为(Color.Gray);
                   });
               }).否则(() =>
               {
                   判断.如果是(ZZZ).则(() =>
                   {
                       判断.如果是(KKK).则(() =>
                       {
                           表格.行(当前行索引).背景色设为(Color.Gray);
                       });
                   });
               });
           });

星期二, 10月 14, 2014

如何決定何時從 Partition 何時從 Heap allocate memory


在嵌入式系統當中, 對memory 的使用有一些很有用的技巧,
有一本書寫得非常好, 推薦給大家
書名是 <> By Charles Weir and James Noble

英文版的網頁在這裡 (有on line 版本可以看哦)

中文版是侯捷翻譯的 (現在還有人認識他嗎 ?)


其中有一個技巧, 叫做 Partition Memory,
所謂的 Partition Memory 就是預先規劃好一堆固定大小的 memory 來給程式使用,
每次取用和歸還的單位是以一個 Partition為主.
舉一個常見的的設定如下
/* 定義在 const.h */

/* 定義了四種 Partition 的大小 */
#define PARTITION_A_SIZE                  60
#define PARTITION_B_SIZE                 250
#define PARTITION_C_SIZE                 600
#define PARTITION_D_SIZE               1600

/* 定義每一種 Partition 的個數 */
#define POOL_A_PARTITIONS             100
#define POOL_B_PARTITIONS             100
#define POOL_C_PARTITIONS              50
#define POOL_D_PARTITIONS              15

上面這樣的設定表示 Partition A 這個 group 的 memory block有100 個,
每一個 block的大小是 60 bytes. 以此類推.
所以就算程式只要 allocate 1 個 byte,
系統至少也會給一塊 partition, 也就是60 bytes. (標準的要五毛給一塊)

這樣的好處是 allocate 的速度比較快,(就是演算法比較簡單)
也不容易發生 fragmentation 的問題. (這個問題不懂, 請回去問學校老師)

通常使用 malloc() 這樣的 memory allocate interface 來 allocate 記憶體時,
只要需要的 size 沒有超過最大的 Partition size (以上面這個例子來說, 就是1600 bytes)
就會從 Partition Pool 裡面 allocate memory.

如果超過最大的 Partition size 就會從 Heap 裡面 allocate memory.

Partition memory 在使用上有一個通常的行為
就是小塊的 partition 如果都被用完了
會自動找次大塊的 partition.
所以 Partition A 用光了, 會去 Partition B 的Pool 中要 memory.

但是最大的那一塊 partition 被要光了之後,
並不會去heap 裡面要,
反而會回報 Software Exception – No More Partition. (懂了嗎 ! 這是故意的)

這是因為系統管理者會根據整個系統的需求,
在開發過程中, 持續調整 partition 的個數和大小,
不會無限制地加大 Partition.

最理想的狀況是可以把所有的 Partition 放在 Internal RAM, (跟CPU封裝在一起的RAM)
這可以加快 memory 存取速度.


一旦 Partition  會被使用光,
可能是系統的問題,
也可能是軟體設計和實做的問題, 需要盡快處理.

有兩個常發生的問題,
大家可以參考我們的解決方法


第一個是大量 allocate 很小的記憶體,
例如一下子 allocate 300個 20 bytes 的 memory,

第二個是剛好 allocate 的 memory 落在最大的 partition 當中 (個數很少記得嗎 ?)
而且需求的個數剛好超過最大的 partition 的個數,
例如 allocate 20 個1000 bytes 的memory.

如果某些軟體模組在使用 memory 時,
allocate 的大小和個數都不固定 (通常是該死的3rd party library).
建議使 malloc_heap()  這類的 interface,
強制直接跟 Heap 來 allocate memory,
以免 Partition Pool 被使用光所產生的 memory 問題,

如何避免 Alignment 問題


這次我們談談七大讓工程師黯然消魂的問題中排名第三的問題, 外號 -- “凌波微步"

現在一些高階語言的程式設計師 (例如 Java, PHP 等等)
應該比較少遇到可怕的 Alignment 的問題了
這也是好事情, 程式語言的設計本來就是應該要讓人類避免犯錯

1. 利用Compiler option 處理大部分的 alignment 的問題
首先要澄清一個觀念,
所謂的 Alignment 這種問題在 32 bits CPU上,
只會發生在讀寫 short (2 bytes) or int (4 bytes)這種資料型態上面,
char (1 byte) 的讀寫是不會有Alignment的問題. (有些曾經遇到過的人, 已經走火入魔了, 以為Alignment 無所不在)

如下面這個範例
typedef struct T_PERSON_TAG {
       char         name[9];
       short         age;
       int             id;
}T_PERSION;


T_PERSION person;

void foo(void) {
       strcpy( person.name, “John”);           //1
       person.age = 22;                     //2
       id = 0512001;                             //3
}

本帖隱藏的內容

//1是不會有問題,
因為讀寫都是以byte為單位,

但是//2 和//3 可能會有問題,
簡單的說現在寫進去的資料, 和將來讀出來的資料可能不一樣 (有沒有嚇到..)  
因為讀寫的位置可能不是 word align (4的倍數) 或是 half-word align (2的倍數) (有仔細看到那個 9 嗎?)

會發生問題的原因是 CPU 在設計的時候基於效能的考量, (設計CPU的人也是好意啊 !)  
會讓系統只能在 word align上讀寫 int 或是 half-word align上讀寫 short.

發生 Alignment 的問題時, 系統不一定會當掉, (怎麼可能這麼剛好..)
有時候會只會讀到不正確的資料,
或是寫資料到不正確的位置. 造成除錯的困難. (再一次重創工程師的心靈)   

通常可以加上 compiler option 強制word or half-word align 來解決.
但是不同compiler 的option 不一樣, 要參考 compiler 手冊才知道  (記得要檢查 Make file)   

上面這範例如果是以word align 編譯之後,
會產生如下的資料結構,

typedef struct T_PERSON_TAG {
           char          name[9];
           char          padding[1];        //4
           short         age;
           char          padding[2];        //5
           int            id;
}T_PERSION;

其中, //4 和 //5 就是 compiler 自動加上的.

雖然上面這樣的資料結構會經由 compiler 的(智慧型)補救把 Alignment的問題解決,
但是卻會浪費記憶體.
每宣告一個 T_PERSON 物件就會浪費 5 個bytes的空間. (在侏儸紀的時代, 這真的粉多耶)
如果宣告的量很大, 例如1000個T_PERSON 陣列,
就會浪費 5000 bytes 的空間. (這樣宣告的工程師保證會被技術長約談)
這樣的資料結構越多, 系統可用的記憶體資源就越少.


2. 手動處理Alignment , 可以節省記憶體
正確的寫法是在宣告 structure 時進行人工的 align. (果然還是要靠人類的智慧)

本帖隱藏的內容

例如上面的例子可以將排列的位置改成如下.
就可以解決浪費記憶體的問題.(傑克! 這真是太神奇了...)  

typedef struct T_PERSON_TAG {
   int           id;
   short       age;
   char        name[9];
}T_PERSION;


3. 使用 type cast 時要注意 alignment 的問題

上面談到 Alignment的問題時,
有提到 compiler 會幫我們處理掉 Alignment的問題.
但是有一種情形是 compiler也無能為力的. 要特別小心. (靠人家的總是要注意...)

本帖隱藏的內容

例如下面這個範例, 是想要從某個影像檔的檔頭 (header) 裡面拿到影像檔的大小.
假設使用的平台是使用 Little Endian 格式, (不知道甚麼是 Little Endian 嗎 ? 那你還能看到現在, 真服了你)  
這裡的假設是 image 資料也是 Little Endian 格式

U8 imgae[1024];

void foo(void) {
       U32 size;

       size = *((U32 *) &image[5]); //1
}

&image[5] 這個位置不一定是word align,
因為 image 這塊記憶體不一定會被放在 word align 的地方,
所以得到的資料不一定正確,
不一定這件事情很可怕,
因為有時候可能是正確的, 這會讓除錯非常的困難. (不然怎麼會讓工程師如此黯然銷魂呢...)   

在處理這類資訊的時候,
比較正確的處理方式是一個 byte 接著一個 byte 來處理資料.
不要使用 type cast 的方式.

例如上面這個範例, 應該要改成下面的用法.,


U32 GET_U32 (U8 *src);
{
        U32 ret_value;
       U8 *dest = (U8 *) &ret_value;

       *dest = *src;
       *(dest + 1) = *(src + 1);
       *(dest + 2) = *(src + 2);
       *(dest + 3) = *(src + 3);

       return ret_value ;
}

void foo(void) {
       U32 size;
       
       size = GET_U32((U8 *) &image[5]); //1
}


Alignment 問題的發生通常是在 raw data 轉換時,
所以遇到需要型態轉變(type cast) 的時候,

要特別注意這樣問題的發生.