[리눅스] cscope 설치 및 사용 방법

목차 (OPEN)

• 🔎 cscope란
• 🛠️ 설치 및 간단한 실습
• 📚 결론

 

 

 

 

🔎 cscope란

[리눅스] ctags 설치 및 사용 방법

 

앞선 포스팅에서 봤던 ctags가 정의로 순간이동하는 인덱스(찾아보기)라면,

cscope는 전화망으로 비유해서 이해해볼 수 있다.

 

 

우리 반에 '소연, 수민, 지민, 채연, 민수'라는 친구가 있고,

반장이 아래의 두 가지를 미리 만들어 두었다고 해보자.

 

1) 연락처 카드함

     - 각 친구의 이름과 전화번호가 적힌 카드 (== 정의)

2) 통화 기록장 (전화망)

     - '누가 누구에게 전화했는지'를 화살표로 그려둔 전화망

     ex) 민수 👉🏻 지민, 민수 👉🏻 소연, 소연 👉🏻 수민

 

여기서 반장이 "민수가 누구한테 전화했었더라?" 하고 물어보는게, cscope d 와 동일한 의미이다.

코드처럼 말하자면 minsu( )라는 함수가 내부에서 호출하는 함수들(callee)의 목록을 찾아주는 것이다.

 

이번에는 반장이 "누가 수민이한테 전화했더라?" 하고 물어봤다면, 이는 cscope c 와 동일한 의미이다.

코드처럼 말하면, 누가 sumin( )이라는 함수를 호출했는지(caller)를 묻는 것이다.

 

 

이처럼 간단한 예시로 봐서 쉽겠지만, 만약 우리의 프로젝트가 커지면서 파일이 점점 많아지면,

"이 함수는 누가 부르지?", "이 심볼이 어디서 쓰이고 있지?", "정의는 어디 있지?" 같은 질문이 많아지게 되는데,

이를 빠르게 탐색해주는 것이 cscope라고 보면 된다.

 

 

---

🛠️ 설치 및 간단한 실습

1) 설치

우분투에서 터미널을 열어 아래의 명령어를 입력하면 간단하게 설치가 완료된다.

sudo apt update
sudo apt install -y cscope

 

 

 

2) 연습용 폴더 만들기

mkdir -p ~/cscope-test
cd ~/cscope-test

 

 

 

3) 예제 코드 파일 만들기

[ calc.c ]

int add(int a, int b) { return a + b; }
int mul(int a, int b) { return a * b; }

 

 

[ util.c ]

int square(int x) { return x * x; }
int twice(int x)  { return add(x, x); } // add를 부름

 

 

[ main.c ]

#include <stdio.h>

int add(int, int);
int mul(int, int);
int square(int);
int twice(int);

int main() {
    printf("%d\n", add(2, 3));
    printf("%d\n", mul(2, 3));
    printf("%d\n", square(4));
    printf("%d\n", twice(5));
    return 0;
}

 

 

 

4) 파일 목록 만들기

cscope는 어떤 파일을 인덱싱할건지 목록을 직접 입력해줘야 한다.

나는 현재 .c 파일들만 만들었으니까 아래의 명령어로 간단하게 목록을 넘겨줬다.

find . -name "*.[c]" > cscope.files

 

 

그러면 위의 사진과 같이 cscope.files가 생긴 것을 확인할 수 있다.

(사진에서는 오타 때문에 ccope.files라고 뜬다..)

 

 

어떤 파일들이 넘어갔는지 확인하고 싶으면 아래의 명령어를 입력하면 된다.

cat cscope.files

 

 

 

 

5) 데이터베이스 생성

아래의 명령어로 데이터베이스를 만들어주면 된다.

cscope -b -q -i cscope.files

 

그러면 아래의 사진과 같이 cscope.out, cscope.in.out, cscope.po.out 파일이 생성된 것을 확인할 수 있다.

 

 

이때 각각의 옵션에 대해서 간단히 설명해보면 다음과 같다.

• -b (build only)
  • DB만 마들고, 인터랙티브 모드로 들어가지 않는다는 의미
  • 이걸 안 붙이면 DB를 만든 다음에 곧바로 cscope 검색창에 들어가 버린다.
• -q (quick index)
  • cscope.in.out, cscope.po.out 같은 추가 인덱스 파일을 만들어서 검색 속도를 크게 올린다.
  • 사실상 거의 필수 옵션이라는데, 프로젝트 파일이 많아질수록 속도 차이가 체감된다고 한다.
• -i cscope.files
  • DB를 만들 때, 이 파일 목록에 적힌 소스만을 대상으로 하라는 의미
  • 이걸 안 붙이면 cscope가 현재 디렉토리 전체를 긁어가기 때문에
    .git이나 build/ 같은 불필요한 폴더까지 들어가서 이렇게 범위를 지정해놓고 한다고 한다.

 

 

 

6) 직접 검색해보기

이제 아래의 명령어를 쳐서 만들어진 cscope.out 파일을 읽기 전용으로 열어보자.

cscope -d

 

그러면 위 사진처럼 cscope 전용 화면이 뜨고, 하단에 여러 가지 검색 메뉴가 표시된다.

이중에서 원하는 항목을 선택해서 검색하면 되는데,

나는 Find this global definition을 이용해서 add함수를 검색해봤다.

 

 

그랬더니 이렇게 바로 add 함수가 정의된 파일과 해당 소스 코드 라인을 보여주었다.

 

 

 

 

 

다음으로는 Caller를 어떻게 찾을 수 있는지도 확인해보았다.

먼저 프로젝트 루트에서 아래의 명령어로 vim을 실행해준다.

vim main.c

 

 

다음으로 vim 아래서 아래의 명령어들을 입력해줘야 한다.

이거는 한 번만 연결해주면, 같은 세션 안에서는 계속 사용 가능하다고 한다.

:cs add cscope.out
:cs reset

 

 

이제 caller를 탐색하기 위해 아래의 명령어를 입력해주면 된다.

나는 누가 add 함수를 호출했는지 확인해보고 싶어서 아래처럼 해주었다.

:cs find c add

 

 

그랬더니 아래의 사진과 같은 결과가 나왔다.

 

 

 

callee를 탐색하고 싶으면 아래의 명령어를 입력해주면 된다.

:cs find d 원하는거

 

 

---

📚 결론

이번에 cscope를 직접 설치하고 사용해보면서

단순한 코드 검색 도구가 아니라, 함수와 함수 사이의 관계를 한눈에 보여주는 매우 편리한 도구임을 체감할 수 있었다.

 

특히 callers와 callees를 바로 확인할 수 있다는 게 인상깊었는데,

기존의 ctags는 단순히 정의만 찾아가는 거였기 때문에

조교님이 cscope까지 설치하라고 한 거 아닐까 싶었다.

 

앞으로는 ctags로 정의를 빠르게 오가고,

cscope로 호출 관계와 심볼 사용처를 탐색하는 습관을 들여야겠다.