PSP 게임 콘솔 에뮬레이터의 예를 사용하여 Travis CI에서 PVS-Studio를 구성하는 방법

Travis CI는 GitHub를 소스 코드 호스팅으로 사용하는 소프트웨어를 구축하고 테스트하기 위한 분산 웹 서비스입니다. 위의 운영 시나리오 외에도 광범위한 구성 옵션 덕분에 자신만의 시나리오를 추가할 수 있습니다. 이 기사에서는 PPSSPP 코드 예제를 사용하여 PVS-Studio와 작동하도록 Travis CI를 구성합니다.

소개

트래비스 CI 소프트웨어를 구축하고 테스트하기 위한 웹 서비스입니다. 일반적으로 지속적인 통합 방식과 함께 사용됩니다.

PPSSPP - PSP 게임 콘솔 에뮬레이터. 이 프로그램은 Sony PSP용 디스크 이미지에서 모든 게임의 실행을 에뮬레이트할 수 있습니다. 이 프로그램은 1년 2012월 2일에 출시되었습니다. PPSSPP는 GPL vXNUMX에 따라 라이센스가 부여됩니다. 누구나 개선할 수 있다 프로젝트 소스 코드.

PVS-스튜디오 — 프로그램 코드의 오류 및 잠재적인 취약점을 검색하기 위한 정적 코드 분석기입니다. 이 글에서는 변화를 위해 개발자의 컴퓨터에서 로컬이 아닌 클라우드에서 PVS-Studio를 시작하고 PPSSPP에서 오류를 찾아보겠습니다.

트래비스 CI 설정

필요한 프로젝트가 있는 GitHub의 저장소와 PVS-Studio용 키가 필요합니다. 평가판 키 또는 오픈 소스 프로젝트의 경우 무료).

사이트로 들어가보자 트래비스 CI. GitHub 계정을 사용하여 승인하면 리포지토리 목록이 표시됩니다.

테스트를 위해 PPSSPP를 포크했습니다.

수집하려는 저장소를 활성화합니다.

현재 Travis CI에는 빌드 지침이 없기 때문에 우리 프로젝트를 빌드할 수 없습니다. 이제 구성할 차례입니다.

분석 중에 일부 변수(예: 구성 파일에 지정하는 것이 바람직하지 않은 PVS-Studio의 키)가 유용합니다. Travis CI의 빌드 설정을 사용하여 환경 변수를 추가해 보겠습니다.

우리가 필요합니다 :

• PVS_USERNAME - 사용자 이름
• PVS_KEY - 키
• MAIL_USER - 보고서를 보내는 데 사용되는 이메일
• MAIL_PASSWORD - 이메일 비밀번호

마지막 두 개는 선택사항입니다. 이는 결과를 우편으로 보내는 데 사용됩니다. 보고서를 다른 방법으로 배포하려는 경우 이를 표시할 필요가 없습니다.

따라서 필요한 환경 변수를 추가했습니다.

이제 파일을 만들어보자 .travis.yml 그리고 프로젝트의 루트에 넣으세요. PPSSPP에는 이미 Travis CI에 대한 구성 파일이 있었지만 너무 크고 예제에 전혀 적합하지 않았기 때문에 이를 대폭 단순화하고 기본 요소만 남겨야 했습니다.

먼저, 가상 머신에서 사용하려는 언어, Ubuntu Linux 버전, 빌드에 필요한 패키지를 지정해 보겠습니다.

language: cpp
dist: xenial

addons:
  apt:
    update: true
    packages:
      - ant
      - aria2
      - build-essential
      - cmake
      - libgl1-mesa-dev
      - libglu1-mesa-dev
      - libsdl2-dev
      - pv
      - sendemail
      - software-properties-common
    sources:
      - sourceline: 'ppa:ubuntu-toolchain-r/test'
      - sourceline: 'ppa:ubuntu-sdk-team/ppa'

나열된 모든 패키지는 PPSSPP에만 필요합니다.

이제 어셈블리 매트릭스를 나타냅니다.

matrix:
  include:
    - os: linux
      compiler: "gcc"
      env: PPSSPP_BUILD_TYPE=Linux PVS_ANALYZE=Yes
    - os: linux
      compiler: "clang"
      env: PPSSPP_BUILD_TYPE=Linux

섹션에 대해 조금 더 매트릭스. Travis CI에는 빌드 옵션을 생성하는 두 가지 방법이 있습니다. 첫 번째는 컴파일러, 운영 체제 유형, 환경 변수 등의 목록을 지정한 후 가능한 모든 조합의 매트릭스가 생성되는 것입니다. 두 번째는 매트릭스를 명시적으로 표시하는 것입니다. 물론 이 두 가지 접근 방식을 결합하여 고유한 사례를 추가하거나 반대로 섹션을 사용하여 제외할 수 있습니다. 제외. 이에 대한 자세한 내용은 다음에서 읽을 수 있습니다. 트래비스 CI 문서.

남은 것은 프로젝트별 조립 지침을 제공하는 것입니다.

before_install:
  - travis_retry bash .travis.sh travis_before_install

install:
  - travis_retry bash .travis.sh travis_install

script:
  - bash .travis.sh travis_script

after_success:
  - bash .travis.sh travis_after_success

Travis CI를 사용하면 가상 머신 수명의 다양한 단계에 대한 고유한 명령을 추가할 수 있습니다. 부분 설치 전 패키지를 설치하기 전에 실행됩니다. 그 다음에 설치, 목록에서 패키지 설치를 따릅니다. addons.apt위에서 언급한 것입니다. 조립 자체는 다음에서 진행됩니다. 스크립트. 모든 것이 잘 되었다면 우리는 성공 후 (이 섹션에서는 정적 분석을 실행합니다). 이것이 수정될 수 있는 모든 단계는 아닙니다. 더 필요한 경우 다음을 살펴보아야 합니다. 트래비스 CI 문서.

읽기 쉽도록 명령을 별도의 스크립트에 배치했습니다. .travis.sh, 프로젝트 루트에 배치됩니다.

그래서 우리는 다음 파일을 가지고 있습니다 .travis.yml:

language: cpp
dist: xenial

addons:
  apt:
    update: true
    packages:
      - ant
      - aria2
      - build-essential
      - cmake
      - libgl1-mesa-dev
      - libglu1-mesa-dev
      - libsdl2-dev
      - pv
      - sendemail
      - software-properties-common
    sources:
      - sourceline: 'ppa:ubuntu-toolchain-r/test'
      - sourceline: 'ppa:ubuntu-sdk-team/ppa'

matrix:
  include:
    - os: linux
      compiler: "gcc"
      env: PVS_ANALYZE=Yes
    - os: linux
      compiler: "clang"

before_install:
  - travis_retry bash .travis.sh travis_before_install

install:
  - travis_retry bash .travis.sh travis_install

script:
  - bash .travis.sh travis_script

after_success:
  - bash .travis.sh travis_after_success

패키지를 설치하기 전에 서브모듈을 업데이트하겠습니다. 이는 PPSSPP를 구축하는 데 필요합니다. 첫 번째 함수를 추가해 보겠습니다. .travis.sh (확장자 참고):

travis_before_install() {
  git submodule update --init --recursive
}

이제 Travis CI에서 PVS-Studio 자동 실행을 직접 설정하겠습니다. 먼저 시스템에 PVS-Studio 패키지를 설치해야 합니다.

travis_install() {
  if [ "$CXX" = "g++" ]; then
    sudo apt-get install -qq g++-4.8
  fi
  
  if [ "$PVS_ANALYZE" = "Yes" ]; then
    wget -q -O - https://files.viva64.com/etc/pubkey.txt 
      | sudo apt-key add -
    sudo wget -O /etc/apt/sources.list.d/viva64.list 
      https://files.viva64.com/etc/viva64.list  
    
    sudo apt-get update -qq
    sudo apt-get install -qq pvs-studio 
                             libio-socket-ssl-perl 
                             libnet-ssleay-perl
  fi
    
  download_extract 
    "https://cmake.org/files/v3.6/cmake-3.6.2-Linux-x86_64.tar.gz" 
    cmake-3.6.2-Linux-x86_64.tar.gz
}

함수 시작 시 travis_install 환경 변수를 사용하여 필요한 컴파일러를 설치합니다. 그렇다면 변수는 $PVS_ANALYZE 가치를 저장한다 가능 (섹션에 표시했습니다. 환경 빌드 매트릭스 구성 중) 패키지를 설치합니다. pvs-스튜디오. 이 외에도 패키지도 표시되어 있습니다. libio-소켓-ssl-perl и libnet-ssleay-perl그러나 결과를 우편으로 보내는 데 필요하므로 보고서 전달을 위해 다른 방법을 선택한 경우에는 필요하지 않습니다.

기능 다운로드_추출 지정된 아카이브를 다운로드하고 압축을 푼다:

download_extract() {
  aria2c -x 16 $1 -o $2
  tar -xf $2
}

이제 프로젝트를 함께 구성할 시간입니다. 이 섹션에서 발생합니다. 스크립트:

travis_script() {
  if [ -d cmake-3.6.2-Linux-x86_64 ]; then
    export PATH=$(pwd)/cmake-3.6.2-Linux-x86_64/bin:$PATH
  fi
  
  CMAKE_ARGS="-DHEADLESS=ON ${CMAKE_ARGS}"
  if [ "$PVS_ANALYZE" = "Yes" ]; then
    CMAKE_ARGS="-DCMAKE_EXPORT_COMPILE_COMMANDS=On ${CMAKE_ARGS}"
  fi
  cmake $CMAKE_ARGS CMakeLists.txt
  make
}

실제로 이는 다음 줄을 제외하고는 단순화된 원래 구성입니다.

if [ "$PVS_ANALYZE" = "Yes" ]; then
  CMAKE_ARGS="-DCMAKE_EXPORT_COMPILE_COMMANDS=On ${CMAKE_ARGS}"
fi

이 코드 섹션에서는 다음과 같이 설정했습니다. cmake 컴파일 명령을 내보내기 위한 플래그입니다. 이는 정적 코드 분석기에 필요합니다. 이에 대한 자세한 내용은 "Linux 및 macOS에서 PVS-Studio를 실행하는 방법".

조립이 성공했다면 다음 단계로 넘어갑니다. 성공 후, 여기서 정적 분석을 수행합니다.

travis_after_success() {
  if [ "$PVS_ANALYZE" = "Yes" ]; then
    pvs-studio-analyzer credentials $PVS_USERNAME $PVS_KEY -o PVS-Studio.lic
    pvs-studio-analyzer analyze -j2 -l PVS-Studio.lic 
                                    -o PVS-Studio-${CC}.log 
                                    --disableLicenseExpirationCheck
    
    plog-converter -t html PVS-Studio-${CC}.log -o PVS-Studio-${CC}.html
    sendemail -t [email protected] 
              -u "PVS-Studio $CC report, commit:$TRAVIS_COMMIT" 
              -m "PVS-Studio $CC report, commit:$TRAVIS_COMMIT" 
              -s smtp.gmail.com:587 
              -xu $MAIL_USER 
              -xp $MAIL_PASSWORD 
              -o tls=yes 
              -f $MAIL_USER 
              -a PVS-Studio-${CC}.log PVS-Studio-${CC}.html
  fi
}

다음 줄을 자세히 살펴보겠습니다.

pvs-studio-analyzer credentials $PVS_USERNAME $PVS_KEY -o PVS-Studio.lic
pvs-studio-analyzer analyze -j2 -l PVS-Studio.lic 
                                -o PVS-Studio-${CC}.log 
                                --disableLicenseExpirationCheck
plog-converter -t html PVS-Studio-${CC}.log -o PVS-Studio-${CC}.html

첫 번째 줄은 Travis CI 환경 변수를 설정할 때 맨 처음에 지정한 사용자 이름과 키에서 라이센스 파일을 생성합니다.

두 번째 줄에서는 분석을 직접 시작합니다. 깃발 -제이 분석할 스레드 수를 설정하고 플래그를 지정합니다. -엘 라이센스, 플래그를 나타냅니다. -영형 로그 출력을 위한 파일과 플래그를 정의합니다. -disableLicenseExpirationCheck 평가판에는 필수입니다. 기본적으로 pvs-스튜디오-분석기 라이센스가 곧 만료될 것임을 사용자에게 경고합니다. 이런 일이 발생하지 않도록 하려면 이 플래그를 지정할 수 있습니다.

로그 파일에는 변환 없이는 읽을 수 없는 원시 출력이 포함되어 있으므로 먼저 파일을 읽을 수 있도록 설정해야 합니다. 로그를 전달해 보겠습니다. 플로그 변환기이며 출력은 html 파일입니다.

이 예에서는 다음 명령을 사용하여 보고서를 메일로 보내기로 결정했습니다. 이메일을 보내.

그 결과 아래와 같은 파일을 얻었습니다. .travis.sh:

#/bin/bash

travis_before_install() {
  git submodule update --init --recursive
}

download_extract() {
  aria2c -x 16 $1 -o $2
  tar -xf $2
}

travis_install() {
  if [ "$CXX" = "g++" ]; then
    sudo apt-get install -qq g++-4.8
  fi
  
  if [ "$PVS_ANALYZE" = "Yes" ]; then
    wget -q -O - https://files.viva64.com/etc/pubkey.txt 
      | sudo apt-key add -
    sudo wget -O /etc/apt/sources.list.d/viva64.list 
      https://files.viva64.com/etc/viva64.list  
    
    sudo apt-get update -qq
    sudo apt-get install -qq pvs-studio 
                             libio-socket-ssl-perl 
                             libnet-ssleay-perl
  fi
    
  download_extract 
    "https://cmake.org/files/v3.6/cmake-3.6.2-Linux-x86_64.tar.gz" 
    cmake-3.6.2-Linux-x86_64.tar.gz
}
travis_script() {
  if [ -d cmake-3.6.2-Linux-x86_64 ]; then
    export PATH=$(pwd)/cmake-3.6.2-Linux-x86_64/bin:$PATH
  fi
  
  CMAKE_ARGS="-DHEADLESS=ON ${CMAKE_ARGS}"
  if [ "$PVS_ANALYZE" = "Yes" ]; then
    CMAKE_ARGS="-DCMAKE_EXPORT_COMPILE_COMMANDS=On ${CMAKE_ARGS}"
  fi
  cmake $CMAKE_ARGS CMakeLists.txt
  make
}
travis_after_success() {
  if [ "$PVS_ANALYZE" = "Yes" ]; then
    pvs-studio-analyzer credentials $PVS_USERNAME $PVS_KEY -o PVS-Studio.lic
    pvs-studio-analyzer analyze -j2 -l PVS-Studio.lic 
                                    -o PVS-Studio-${CC}.log 
                                    --disableLicenseExpirationCheck
    
    plog-converter -t html PVS-Studio-${CC}.log -o PVS-Studio-${CC}.html
    sendemail -t [email protected] 
              -u "PVS-Studio $CC report, commit:$TRAVIS_COMMIT" 
              -m "PVS-Studio $CC report, commit:$TRAVIS_COMMIT" 
              -s smtp.gmail.com:587 
              -xu $MAIL_USER 
              -xp $MAIL_PASSWORD 
              -o tls=yes 
              -f $MAIL_USER 
              -a PVS-Studio-${CC}.log PVS-Studio-${CC}.html
  fi
}
set -e
set -x

$1;

이제 변경 사항을 git 저장소에 푸시할 차례입니다. 그러면 Travis CI가 자동으로 빌드를 실행합니다. 빌드 보고서로 이동하려면 "ppsspp"를 클릭하세요.

현재 빌드의 개요를 살펴보겠습니다.

빌드가 성공적으로 완료되면 정적 분석 결과가 포함된 이메일을 받게 됩니다. 물론 우편으로 보고서를 받는 유일한 방법은 아닙니다. 구현 방법을 선택할 수 있습니다. 그러나 빌드가 완료된 후에는 가상 머신 파일에 액세스할 수 없다는 점을 기억하는 것이 중요합니다.

오류 요약

우리는 가장 어려운 부분을 성공적으로 완료했습니다. 이제 우리의 모든 노력이 그만한 가치가 있는지 확인합시다. 메일로 받은 정적 분석 보고서에서 몇 가지 흥미로운 점을 살펴보겠습니다(괜히 표시한 것이 아닙니다).

위험한 최적화

void sha1( unsigned char *input, int ilen, unsigned char output[20] )
{
  sha1_context ctx;

  sha1_starts( &ctx );
  sha1_update( &ctx, input, ilen );
  sha1_finish( &ctx, output );

  memset( &ctx, 0, sizeof( sha1_context ) );
}

PVS-Studio 경고: V597 컴파일러는 'sum' 버퍼를 플러시하는 데 사용되는 'memset' 함수 호출을 삭제할 수 있습니다. 개인 데이터를 지우려면 RtlSecureZeroMemory() 함수를 사용해야 합니다. sha1.cpp 325

이 코드 조각은 보안 해싱 모듈에 있지만 심각한 보안 결함(CWE-14). 디버그 버전을 컴파일할 때 생성되는 어셈블리 목록을 살펴보겠습니다.

; Line 355
  mov r8d, 20
  xor edx, edx
  lea rcx, QWORD PTR sum$[rsp]
  call memset
; Line 356

모든 것이 정상이고 기능이 정상입니다. 멤셋 실행되어 RAM의 중요한 데이터를 덮어쓰지만 아직 기뻐하지 마십시오. 최적화된 릴리스 버전의 어셈블리 목록을 살펴보겠습니다.

; 354  :
; 355  :  memset( sum, 0, sizeof( sum ) );
; 356  :}

목록에서 볼 수 있듯이 컴파일러는 호출을 무시했습니다. 멤셋. 이는 함수에서 다음과 같은 사실 때문입니다. sha1 통화 후 멤셋 더 이상 구조에 대한 참조가 없습니다. ctx. 따라서 컴파일러는 나중에 사용되지 않는 메모리를 덮어쓰면서 프로세서 시간을 낭비하는 것을 의미하지 않습니다. 이 기능을 사용하면 이 문제를 해결할 수 있습니다. RtlSecureZero메모리 또는 비슷한 그녀.

올바르게 :

void sha1( unsigned char *input, int ilen, unsigned char output[20] )
{
  sha1_context ctx;

  sha1_starts( &ctx );
  sha1_update( &ctx, input, ilen );
  sha1_finish( &ctx, output );

  RtlSecureZeroMemory(&ctx, sizeof( sha1_context ) );
} 

불필요한 비교

static u32 sceAudioOutputPannedBlocking
             (u32 chan, int leftvol, int rightvol, u32 samplePtr) {
  int result = 0;
  // For some reason, this is the only one that checks for negative.
  if (leftvol > 0xFFFF || rightvol > 0xFFFF || leftvol < 0 || rightvol < 0) {
    ....
  } else {
    if (leftvol >= 0) {
      chans[chan].leftVolume = leftvol;
    }
    if (rightvol >= 0) {
      chans[chan].rightVolume = rightvol;
    }
    chans[chan].sampleAddress = samplePtr;
    result = __AudioEnqueue(chans[chan], chan, true);
  }
}

PVS-Studio 경고: V547 표현식 'leftvol >= 0'은 항상 참입니다. sceAudio.cpp 120

먼저 else 분기에 주목하세요. if. 모든 조건이 충족된 경우에만 코드가 실행됩니다. leftvol > 0xFFFF || 오른쪽볼 > 0xFFFF || leftvol < 0 || 오른쪽 볼륨 < 0 거짓으로 밝혀지게 됩니다. 따라서 우리는 else 분기에 적용되는 다음 명령문을 얻습니다. 왼쪽볼 <= 0xFFFF, 오른쪽볼 <= 0xFFFF, 왼쪽 볼륨 >= 0 и 오른쪽 볼륨 >= 0. 마지막 두 진술을 주목하십시오. 이 코드를 실행하기 위해 필요한 조건이 무엇인지 확인하는 것이 의미가 있습니까?

따라서 다음 조건문을 안전하게 제거할 수 있습니다.

static u32 sceAudioOutputPannedBlocking
(u32 chan, int leftvol, int rightvol, u32 samplePtr) {
  int result = 0;
  // For some reason, this is the only one that checks for negative.
  if (leftvol > 0xFFFF || rightvol > 0xFFFF || leftvol < 0 || rightvol < 0) {
    ....
  } else {
    chans[chan].leftVolume = leftvol;
    chans[chan].rightVolume = rightvol;

    chans[chan].sampleAddress = samplePtr;
    result = __AudioEnqueue(chans[chan], chan, true);
  }
}

또 다른 시나리오. 이러한 중복 조건 뒤에는 일종의 오류가 숨겨져 있습니다. 아마도 그들은 필요한 것이 무엇인지 확인하지 않았을 것입니다.

Ctrl+C Ctrl+V 반격

static u32 scePsmfSetPsmf(u32 psmfStruct, u32 psmfData) {
  if (!Memory::IsValidAddress(psmfData) ||
      !Memory::IsValidAddress(psmfData)) {
    return hleReportError(ME, SCE_KERNEL_ERROR_ILLEGAL_ADDRESS, "bad address");
  }
  ....
}

V501 '||' 왼쪽과 오른쪽에 동일한 하위 표현식 '!Memory::IsValidAddress(psmfData)'가 있습니다. 운영자. scePsmf.cpp 703

내부 수표에주의하십시오 if. 주소가 유효한지 확인하는 것이 이상하다고 생각하지 않나요? psmf데이터, 두 배? 그래서 제게는 이상하게 보입니다... 사실 이것은 물론 오타이며 두 입력 매개변수를 모두 확인하려는 아이디어였습니다.

올바른 옵션:

static u32 scePsmfSetPsmf(u32 psmfStruct, u32 psmfData) {
  if (!Memory::IsValidAddress(psmfStruct) ||
      !Memory::IsValidAddress(psmfData)) {
    return hleReportError(ME, SCE_KERNEL_ERROR_ILLEGAL_ADDRESS, "bad address");
  }
  ....
}

잊혀진 변수

extern void ud_translate_att(
  int size = 0;
  ....
  if (size == 8) {
    ud_asmprintf(u, "b");
  } else if (size == 16) {
    ud_asmprintf(u, "w");
  } else if (size == 64) {
    ud_asmprintf(u, "q");
  }
  ....
}

PVS-Studio 경고: V547 'size == 8' 표현식은 항상 false입니다. syn-att.c 195

이 오류는 폴더에 있습니다 내선, 그래서 프로젝트와 별로 관련이 없지만, 버그가 제가 깨닫기도 전에 발견되었기 때문에 떠나기로 결정했습니다. 결국 이 글은 오류 검토에 관한 것이 아니라 Travis CI와의 통합에 관한 것이며 분석기 구성은 수행되지 않았습니다.

변수 크기 상수로 초기화되지만 코드에서 연산자까지 전혀 사용되지 않습니다. if, 물론 이는 다음과 같습니다. 그릇된 조건을 확인하는 동안 우리가 기억하는 것처럼 크기 XNUMX과 같습니다. 후속 점검도 의미가 없습니다.

분명히 코드 조각 작성자가 변수를 덮어쓰는 것을 잊었습니다. 크기 그것 앞에.

중지

여기서 우리는 아마도 실수로 끝날 것입니다. 이 글의 목적은 Travis CI와 함께 PVS-Studio의 작업을 시연하는 것이지 프로젝트를 최대한 철저하게 분석하는 것이 아닙니다. 더 크고 아름다운 실수를 원한다면 언제든지 감탄할 수 있습니다. 여기에 :).

결론

웹 서비스를 사용하여 프로젝트를 빌드하고 증분 분석을 수행하면 코드 병합 후 즉시 많은 문제를 찾을 수 있습니다. 그러나 하나의 빌드만으로는 충분하지 않을 수 있으므로 정적 분석과 함께 테스트를 설정하면 코드 품질이 크게 향상됩니다.

유용한 링크

• Linux 및 macOS에서 PVS-Studio 실행
• Docker에서 PVS-Studio 시작
• 트래비스 CI 문서

이 기사를 영어권 청중과 공유하려면 번역 링크인 Maxim Zvyagintsev를 사용하십시오. PSP 게임 콘솔 에뮬레이터의 예를 사용하여 Travis CI에서 PVS-Studio를 설정하는 방법.

출처 : habr.com