🛠 Make 겉 핥기

이 글에서는 make 명령어를 사용해서 C, C++ 코드를 컴파일하는 법을 알아보겠습니다.

⚠️ 글에 오류가 있거나 궁금한 점이 있다면 언제든 댓글로 알려주세요!

🤔 왜 Make가 필요하지?

처음 C언어를 배울 때를 떠올려볼까요. 대부분의 사람들은 윈도우를 사용하기 때문에 Visual Studio를 켜서 프로젝트를 만들고 파일 하나를 계속 수정하면서 컴파일 했을 것입니다. (필자도 그랬었죠) 하지만 이후 점차 다른 환경, 운영체제에서 개발하게 된다면 하나의 IDE에 의존해 코딩하기에는 어렵게 됩니다. 그러다 보면 최종적으로는 GCC 컴파일러를 활용해 컴파일을 진행하게 되는데, 매번 여러 명령어를 치다보면 귀찮아지기 마련입니다. 이런 귀찮은 상황을 해결하고자 리눅스에 존재하는 alias처럼 명령어 스크립트를 미리 저장해두고 컴파일을 진행하는데, 이를 자동화한 툴이 make입니다.

또한 make에는 유용한 기능을 제공하는데, 바로 Incremental Build(증분 빌드) 라는 기능입니다. 프로젝트를 진행하다 보면 모듈화를 위해 파일을 여러 개 만드는 경우가 많을 것입니다. 예를 들어 file_a.c, file_b.c, file_c.c 3개의 파일이 존재하는 프로젝트가 있다고 생각해봅시다. 프로젝트를 컴파일 하고 싶다면 gcc 기준으로 gcc file_a.c file_b.c file_c.c 와 같이 명령어를 실행해 실행 파일을 만들 것입니다. 이때 file_b.c에 변경해야 할 코드가 생긴다고 하면, 파일을 수정하고 새로 컴파일 할 때에도 file_a.c와 file_b.c를 컴파일 해야 합니다.

물론, 오브젝트 파일을 미리 만들어두고 새로 수정한 코드의 경우에만 오브젝트 파일로 변환시키는 작업을 해도 괜찮습니다. 다만 바뀌는 파일(들)을 골라 오브젝트 파일로 매번 바꿔야 하기 때문에 자동화하기 참 애매합니다. 이를 알아서 자동화하는 Make의 기능이 Incremental Build입니다. Make 명령어 과정 속에서 비교하는 대상이 있다면 비교 후 이전과 차이가 없다면 컴파일하지 않습니다. 이에 대한 자세한 작동과정은 Make를 알아보면서 서서히 알게 될 것입니다.

😉 Make의 단짝친구, Makefile

Make을 실행하기 위해선 프로젝트 폴더 루트 디렉토리에 Makefile이라는 파일을 만들어야 합니다. 이 파일은 Make가 어떻게 이 프로젝트를 빌드할 것인지 명시해놓은지 적은 파일로, 정해진 형식에 맞게 작성해야 합니다.

💡 Node를 해보신 분이시라면 package.json에 있는 scripts 파트와 비슷하다고 보시면 됩니다.

Rule

가장 작은 단위인 "Rule"은 다음과 같은 형식을 가지고 있습니다.

target ... : prerequisites ...
	command
	...
	...

• 타겟은 이 룰을 실행했을 때 나오는 파일 산출물을 주로 적습니다. 이 룰의 이름이라고 생각하시면 이해하기 쉽습니다. 항상 파일의 이름을 작성하는 것은 아닙니다. 이에 관련된 예시도 뒤에서 언급하겠습니다.
• 전제 조건(prerequisite)은 이 룰을 실행할 때 필요한 파일들을 적습니다. 이 룰을 실행할때 필요한 모든 파일을 넣지는 않습니다. 다른 룰을 통해 만들어지거나 Incremental Build를 사용하는 파일을 주로 작성합니다.
• 명령어(command)에 이 룰을 실행할 때 실행되는 명령어를 적어놓습니다. 명령어를 쓸 때엔 target & prerequisites와 구분하기 위해 탭을 넣어야 합니다.

위 프로젝트 예시에 사용한 명령어를 Makefile 형식으로 작성한다면 다음과 같이 작성할 수 있습니다.

a.out:
       gcc file_a.c file_b.c file_c.c

이렇게 작성한 이후, make를 통해 위 룰을 실행하려면, 커멘드라인에 make (타겟)을 실행하면 됩니다. 다만 이렇게 사용하게 된다면 문제가 발생합니다. 한번 컴파일한 이후 파일을 변경하고 다시 make a.out를 실행한다면 다음과 같이 나오면서 컴파일이 일어나지 않습니다.

make: `a.out' is up to date.

Make에서 룰이 실행되는 조건은 다음과 같습니다.

1. 타겟 파일이 프로젝트 폴더 안에 없을 때
2. Prerequisites에 변경점이 발생했을 때

위와 같은 룰은 한번 실행한 뒤에는 1번과 2번 모두 만족하지 않기 때문에 실행되지 않고 up to date라고 알려주는 것입니다. 그렇다면 다음과 같이 작성하게 된다면 문제를 해결할 수 있을것입니다.

a.out: file_a.c file_b.c file_c.c
       gcc file_a.c file_b.c file_c.c

변수

다만 위와 같이 작성한다면 중복되는 내용이 보이기 시작할것입니다. 이를 단순히하기 위해 Make에서는 쉘 스크립트와 같이 변수를 제공합니다. 쉘 스크립트에서는 변수를 선언할 때 공백(' ')을 넣으면 문제가 발생하지만, Make에서는 공백을 사용해 여러 값을 사용할 수 있습니다. 위 예시에 변수를 적용하면 다음과 같이 사용할 수 있습니다.

SRC = file_a.c file_b.c file_c.c
NAME = a.out

$(NAME): $(SRC)
         gcc $(SRC)

💡 $()를 사용하면 정의되어 있는 변수나 함수를 불러올 수 있습니다.

패턴 룰과 자동 변수

이제는, 최종적으로 우리가 원하던 수정된 파일만 컴파일되게 하기 위해서 한가지의 문법을 추가해봅시다. 바로 패턴 룰을 이용하는 것입니다. 위 예시를 패턴 룰을 사용해 바꿔보면 다음과 같이 사용할 수 있습니다.

OBJ = file_a.o file_b.o file_c.o
NAME = a.out

%.o : %.c
      gcc $< -o $@

$(NAME): $(OBJ)
         gcc $(OBJ)

몇가지 새로운 내용이 나와있는데 그렇게 어렵진 않습니다. 현제 오브젝트 파일은 없고 코드 파일만 있다고 가정했을때, Make가 어떻게 돌아가는지 설명해보겠습니다.

1. make a.out을 실행하면, 먼저 prerequisite를 확인합니다.
2. file_a.o를 확인하려 하는데, 현제 폴더에 file_a.o가 없습니다.
3. 만약 prerequisite에 참조되는 파일이 폴더에 없다면, Make는 file_a.o를 타겟으로 가진 룰이 있는지 확인하고 있다면 이를 실행합니다.
4. 타겟이 %.o인 룰은 파일이 .o로 끝난 모든 파일을 대사으로 하는 패턴 룰입니다. file_a.o는 이 패턴 룰에 포함되기 때문에 이 룰을 실행합니다. 이때 이 룰의 prerequisite에 %.c가 적혀있는데, 이는 실제 사용될 때 %.o 에서의 %부분을 가져와 채우게 됩니다. file_a.o에서 file_a가 %에서 대체되었기 때문에 prerequisite는 file_a.c가 됩니다.
5. 커멘드 중 $<와 $@는 Make에서 제공하는 자동 변수입니다. $@는 타겟을 저장하는 변수이고, $<는 첫 prerequisite를 저장하는 변수입니다. 그렇다면 패턴 룰에 있는 커멘드는 gcc file_a.c -o file_a.o로 대체되어 실행됩니다.
6. 이후 $(OBJ)의 나머지 값인 file_b.c와 file_c.c도 2~5번 과정을 거쳐가면서 오브젝트 파일을 만들고, a.out을 컴파일하게 됩니다.

💡 패턴 룰에서 사용되는 %을 보면 평소 와일드카드 문자인 *가 익숙할탠데, 이에 대해서 make에서도 지원하지만 이를 사용하게 된다면 문제가 생겨 잘 사용하지 않습니다.

🤔 더 알고 싶다면

여기까지만 안다면 간단한 프로젝트를 빌드하는 스크립트를 만들 수 있을 것입니다. 글 제목처럼 필수적인 내용들만 언급했는데 혹시나 추가적으로 Make를 잘 사용하고 싶다면 아래 팁을 참고하면 좋을 것입니다!

• Make를 실행할 때 타겟을 넣지 않고 make 명령어를 실행한다면, Makefile의 룰 중 '.'으로 시작하는 타겟을 가진 룰이나 패턴 룰을 제외한 최상단에 있는 룰을 실행합니다. 따라서 저희가 사용한 예시는 make a.out 뿐만 아니라 make로도 룰을 실행할 수 있습니다.
• Makefile에서도 함수를 만들 수 있습니다. 제가 자주 사용하는 함수로는 addprefix, addprefix, subst등이 있습니다. 자세한 사용법과 다양한 함수 목록은 여기를 참고해보면 좋을 것 같습니다.
• 타겟이 무조건 파일 이름일 필요는 없습니다. 예를 들어 대부분의 사람들이 오브젝트 파일을 지우는 명령을 사용하기 위해 clean이란 타겟을 사용합니다. 주로 하단과 같이 구현됩니다.

   clean:
          rm -f $(OBJ)

• 위와 같은 상황에서 반대로 clean이라는 파일이 존재한다면, 위 룰은 제 역활을 하지 않을겁니다. 초반에 언급했던 두가지 경우를 모두 만족하지 않기 때문에 up to date라고 뜨며 커멘드가 돌아가지 않을 것입니다. 따라서 위의 경우에는 .PHONY라는 타겟을 사용해야 합니다. Phony 타겟의 prerequisite로 지정되면 이를 타겟으로 가진 룰은 두가지 경우를 만족하지 않아도 무조건 실행하게 됩니다. 위 Makefile을 다음과 같이 수정하면 clean파일이 있어도 작동될 것입니다.

   clean:
          rm -f $(OBJ)
          
   .PHONY: clean

🤓 여담으로 썸네일의 Makefile은 제가 진행중인 ft_printf 프로젝트의 Makefile입니다 :)

📚 참고문서

• GNU make
• Makefile Tutorial by Example