C言語 strlenに実装されるマクロでdo{...}while(0)が使われている理由を知りたい

Question

C言語を学んでいるものです。

freebsdのstrlenの実装を確認しています。
freebsd/strlen.c at master · lattera/freebsd

ここで実装されているtestbyte(x)というマクロについて、疑問があります。
なぜdo{...}while(0)で囲まれているのでしょうか。
試しにdo whileを取って、実行して見ましたが、問題なく動きました。

while(0)だと必ず終了するのでdo...whileを使う意味が無いように思います。
どういった理由で使用されているのでしょうか。

#include <sys/cdefs.h>
#include <stdlib.h>

static const unsigned long mask01 = 0x0101010101010101;
static const unsigned long mask80 = 0x8080808080808080;

#define	LONGPTR_MASK (sizeof(long) - 1)

#define testbyte(x)				\
	do {					\
		if (p[x] == '\0')		\
		    return (p - str + x);	\
	} while (0)

size_t ft_strlen(const char *str)
{
	const char *p;
	const unsigned long *lp;
	long va, vb;

	lp = (const unsigned long *)((uintptr_t)str & ~LONGPTR_MASK);
	va = (*lp - mask01);
	vb = ((~*lp) & mask80);
	lp++;
	if (va & vb)
		for (p = str; p < (const char *)lp; p++)
			if (*p == '\0')
				return (p - str);

	for (; ; lp++) {
		va = (*lp - mask01);
		vb = ((~*lp) & mask80);
		if (va & vb) {
			p = (const char *)(lp);
			testbyte(0);
			testbyte(1);
			testbyte(2);
			testbyte(3);
			testbyte(4);
			testbyte(5);
			testbyte(6);
			testbyte(7);
		}
	}
	return (0);
}

Answer 1

do while で囲まなかったとき、たとえば

if (ほにゃらら) testbyte(x);
else なんちゃらかんちゃら;

といった文があったら、これは

if (ほにゃらら)
  if (p[x] == '\0')
    return (p - str + x);
  else なんちゃらかんちゃら;

と展開されます。

else 節が外側の if と対応付けることを意図しているにもかからわず testbyte の中の if と対応付いてしまいます。

こういうことを防止するためにマクロ定義で do while を用いるのはよくあるテクニックです。

---

Free BSD のカーネルのコーディングスタイルの文章の中にマクロを do while で囲むことについて言及があるのを発見しました。 if 文の中で安全に使えると述べています。

》 STYLE(9) FreeBSD Kernel Developer's Manual

余談ですが現代では関数として記述できるならば関数として書くことが一般的には好まれます。 現代のコンパイラはこのような簡単な関数をインライン化することが期待できるのでマクロで書く優位性がないからです。 カーネルの場合はコンパイラの最適化機能を無効に (または弱く) する必要がある場合もありますので事情が異なるのかもしれませんが。

Comments

[pepperleaf]

昔のマニアックなテクニックではないかと。(初期のC世界)

Answer 2

単に、{ }で囲まずに、do { } while(0)で囲む理由ですが、例えば、

#define foo(x) { a=x; b=x*2; }

などと定義すると、

if(zz) foo(1);
else foo(2);

が、

if(zz) { a=1; b=1*2; };
else { a=2; b=2*2; };

となり、余分な;のためにelseがエラーとなります。
これを回避するためには、

if(zz) foo(1)
else foo(2)

と書けばいいのですが、そのためにはfooは関数じゃなくて（最後に;を書いてはいけない）マクロだということを知っていないといけませんし、見たときにもちょっと違和感があります。

まあ、「ifやelseの後は単文でも必ず{ }を付ける」という方針で、

if(zz) { foo(1); }
else { foo(2); } 

と書けばいずれにせよ問題ないのですが、「使う側では全く関数のごとく書けるマクロ」に近づけようとすると、do { } while(0)と、最後に;を付けられる形の定義をします。

とはいえ、実引数が評価されるタイミングなどが同じには出来ないので、「使う側では全く関数のごとく書けるマクロ」の実現は限度がありますが。