makefile - KimTaebin-ai/study_posts GitHub Wiki

makefile 이란 빌드를 도와주는 스크립트 파일이다.

linux 환경에 있는 소스코드 프로그램들을 실행할 때 make 라는 명령어를 사용하면 Makefile에 작성된 스크립트 순서대로 빌드를 수행한다.

(makefile에 들어가기 전 gcc 빌드에 대해서 이해하고 넘어가는 것이 좋다.) gcc 빌드

a.exe / a.out 은 소스파일을 각각 컴파일하여 .o 라는 목적 파일을 생성하고 만들어진 목적 파일들을 한 곳으로 묶는 링킹 과정을 통해 만들어진다.

gcc -c -o main.o main.c 위 명령어는 gcc에 -c플래그를 붙여서 컴파일만 실행할 수 있다. 즉, main.o 파일을 빌드하는 것-c 플래그를 통해 목적파일을 생성하면 main과 같은 이름으로 .o가 생기지만 이름을 꼭 지정해주자

gcc -o a.out main.o

명령은 gcc지만 gcc내부적으로 링커를 실행하여 실행파일을 생성한다 (-o 플래그는 이름 변경)

Incremental build

Incremental build은 makefile은 똑똑하게 의존성이 있는 대상들만을 추려서 다시 빌드가 가능하기 때문에 덩치가 큰 작업의 경우 매우 유용하다!!

Rule block 의 구조

<Target> : <Dependencies>

  <Recipe>

• target: 빌드 대상 이름을 의미한다. 통상적으로 최종적으로 생성해내는 파일명을 쓴다고 한다.
• dependencies: target이 의존하는 target이나 파일목록 target을 만들기전 먼저 만들고 빌드 대상(target)을 생성
• recipe: 빌드 대상을 생성하는 명령. 여러줄로 작성이 가능하고 반드시 tap으로 구분해야한다.
• 내장 규칙

Makefile에서는 자주 사용되는 빌드 규칙들은 굳이 기술하지 않아도 자동으로 처리해준다..! (소스파일을 컴파일하여 목적파일로 만드는 규칙)

하지만 target에 대한 헤더파일을 추적하지 않기 때문에 dependencies까지는 명시해줘야 한다.(헤더파일을)

위에서 다룬 main.c파일에 의존성을 가지는 fun.c에 헤더파일이 존재한다면 아래와 같이 룰블럭을 작성한다.

a.out: main.o fun.o
  gcc -o a.out main.o fun.o

main.o: fun.h main.c
  fun.o: fun.h fun.c

• 변수 사용법

사용가능한 변수명은 make -p를 통해 확인할 수 있다.

CC=gcc
CFLAG= -Wall -Werror -Wextra
OBJS= main.o fun.o
TARGET= a.out

$(TARGET): $(OBJS)
  $(CC) -o $@ $(OBJS)

main.o: fun.h main.c
fun.o: fun.h fun.c

• $@은 현재 target의 이름을 나타내는 자동변수
• $^은 현재 target이 의존(Dependencies)하는 대상들의 전체 목록
• $<은 첫 번째 depend의 파일 이름
• $?은 현재 target이 의존하는 대상들중 변경된 목록

위의 Makefile을 해석해보면 a.out을 만들기 위한 의존성 파일들은 main.o, fun.o가 존재하고 a.out에 대한 레시피는 밑에 나와 있지만 먼저 의존성파일들을 먼저 생성한다.의존성 생성파일에 대한 룰블럭또한 아래에 나와 있으며 해당 레시피가 존재하지 않는 이유는 makefile의 내부 규착애 의해 자동 빌드된다.다시 돌아가서 $(TARGET)(a.out)의 recipe는 $(CC) gcc컴파일을 사용하여 -o(이름 변경)으로 target이름으로 변경하고 필요한 오브젝트 목록은 OBJS로 참조한다.

여기서 변수명을 사용하여 만약 개발자가 a.out이 아닌 다른 이름을 사용하고 싶다면 맨 위 변수 선언부에서 이름만 변경하면 아래의 $(TARGET)의 이름들은 자동변경되게 된다.

• 외부 헤더파일 포함시키는 법

외부 헤더파일을 포함시킬려면 gcc 뒤에 -I플래그가 붙어야 한다.(표준 디렉토리가 아닌 헤더파일의 경우 디렉토리 위치 지정)

gcc main.c -I ./include

• 라이브러리 생성 방법

ar r libft.a *.o

현재 루트에 존재하는 .o 목적 파일들로 libft.a라는 라이브러리 파일을 만든다.

ar s libft.a

함수의 인덱스를 추가한다.

++ ar t를 통해 내부 오브젝트 파일을 표시할 수 있다.

라이브러리를 생성할 때 마다 주의 표시가 뜨기 때문에 c플래그를 통해 제거할 수 있다.

libft 프로젝트에서 만들어야 하는 것은 정적 라이브러리이다.정적 라이브러리는 컴파일된 오브젝트 파일들이 하나의 아카이브로 묶여 있는 형태로, 오브젝트 파일들을 묶어 주는 명령어가 바로 ar 명령어이다.기본적으로 아카이브를 생성할 때의 사용 예는 다음과 같다.

ar rscv libft.a file1.o file2.o ...

사실 ar 명령어는 정적 라이브러리에 국한되지 않고, 범용적인 비압축 아카이브로 사용할 수 있으나 일반적으로는 정적 라이브러리를 다루기 위해 사용된다고 한다!

ar rcus [라이브러리 이름] [오브젝트 파일들]

r : 새로운 오브젝트 파일이면 추가, 기존 파일이면 치환

c : 아카이브(라이브러리 파일) 생성, 존재하지 않는 아카이브를 작성(또는 갱신)하는 경우에도 경고 메시지를 출력하지 않음

u : 오브젝트 파일의 타임스탬프를 비교해 새로운 파일일 경우에만 치환

s : ranlib(1)과 마찬가지로 아카이브 인덱스 생성. 아카이브 인덱스를 생성하지 않으면 링크 속도가 느려지고, 시스템 환경에 따라 에러가 발생할 수도 있음

ar ds [라이브러리 이름] [오브젝트 파일들]

d : 아카이브 모듈을 삭제, 삭제할 파일이 없다면 동작하지 않음

ar tv [라이브러리 이름]

t : 아카이브에 있는 파일 리스트 출력v : 자세한 내용을 보여주는 verbose 모드로, 이 옵션을 이용하면 파일 크기나 갱신 시각 등의 상세 정보도 출력

ar xv [라이브러리 이름]

x : 아카이브에서 오브젝트 파일 추출v : 추출한 파일의 파일명 출력

• clean

자주 사용되는 룰 블럭의 모습이며 make뒤에 플래그처럼 붙여 매크로로 사용 가능하다.

target과 목적파일들을 전부 삭제하는 역할을 한다. Dependencies가 존재하지 않으며 recipe만 존재

clean: rm -rf $(OBJS) $(TARGET)

• all

all: libft.a

all은 실제로 생성하는 것이 아닌 무엇이 최종 target인지 명확하게 지정해주는 역할이다.

make all을 실행할 경우 libft.a를 만들기 시작..

• .PHONY

실제 타켓의 이름을 가리키는 것이 아닌 가짜 타켓을 가르킨다..!

사용하는 이유는 동일한 이름의 충돌을 피하고 성능향상을 위해 사용한다.

clean: rm main.o main.c

위 매크로를 실행하면 rm명령은 clean이라는 이름의 파일을 생성하지않기 때문에 clean이란 이름의 파일이 존재하지 않을 것이다. rm명령은 make clean 수행할때 마다 매번 실행되게 된다.

하지만 디렉토리에 clean이라는 이름의 파일을 생성하게 되면 clean은 제대로 동작하지 않게 되고 이러한 문제를 해결하기 위해선 .PHONY를 사용하여 전제조건을 만들어 준다.

실제 라이브러리 생성!

TARGET= libft.a
CC= gcc
CFLAG= -Wall -Werror -Wextra
SRCS= main.c fun.c
OBJS= $(SRCS:.c=.o)

.c.o: $(SRCS)
  $(CC) $(CFLAGS) -c $<

all: $(TARGET)

$(TARGET): $(OBJS)
  ar rcs $(TARGET) $(OBJS)

clean:
  rm -f $(OBJS)

fclean: clean
  rm -f $(TARGET)

re: fclean all

.PHONY all clean fclean re

• 목적파일(target): 명령어 수행 후 나온 결과를 저장할 파일
• 의존성(dependency): 목적 파일을 만들기 위한 재료 파일
• 명령어(command): 실행 되어야 할 명령어들
• 매크로(macro): 코드를 단순화 시킴

CC = gcc
target1 : dependency1 dependency2
  command1
  command2
  
target2 : dependency3 dependency4
  command3
  command4

Relink란 의존성이 변경되었을때만 타겟을 생성하는 것을 말한다.

bonus: $(OBJ_B)
    $(AR) $(TARGET) $^

해당 명령어는 OBJ_B가 존재한다면 TARGET을 생성한다. OBJ_B가 변경되었나를 체크하지 않기 때문에 make bonus 를 하면 무조건 리링크되게 된다.

ifdef WITH_BONUS
    OBJ = $(OBJ_O) $(OBJ_B)
else
    OBJ = $(OBJ_O)
endif
...
bonus:
    make WITH_BONUS=1 all

위 명령어는 make bonus를 하면 WITH_BONUS라는 상수를 1로 지정하여 코드를 실행한다. WITH_BONUS라는 상수가 1일때는 OBJ를 OBJ_O와 OBJ_B 모두의 변경사항을 체크하기 때문에 리링크가 방지된다.

참고자료

https://www.joinc.co.kr/w/Site/C/Documents/minzkn_make

https://kcoder.tistory.com/m/entry/Linux-Makefile%EC%97%90%EC%84%9C%EC%9D%98-%ED%95%A8%EC%88%98%EB%93%A4

https://modoocode.com/311