콘텐츠로 이동

C++ API

이 레퍼런스는 공개 헤더 lccl.h의 Doxygen 주석을 한국어로 옮긴 것입니다. 이름은 C 스타일이지만 헤더가 C++ 전용(디폴트 인자, nullptr)이고 함께 include하는 hart 헤더가 C++17 기능을 쓰므로, C++17 이상으로 컴파일해야 합니다.

1
#include "lccl.h"  // 타입, 커뮤니케이터, 집합 연산, 점대점, 그룹

빌드와 링크

lccl.h와 libha_lccl.so는 lccl을 설치한 site-packages의 lccl/ 디렉터리에 있습니다(lccl/include/lccl.h, lccl/libha_lccl.so). lccl.h는 hart의 공개 헤더를 include하고 프로그램은 HaSetDevice, HaMemAlloc 같은 hart API도 부르므로, hart 패키지 디렉터리를 함께 지정하고 libha_runtime.so도 링크합니다. 실행할 때 두 라이브러리를 찾도록 두 디렉터리를 -rpath로 넣습니다. CMake 패키지 파일은 제공하지 않습니다.

1
2
3
4
5
6
7
8
# lccl과 hart를 설치한 Python 환경에서 두 디렉터리를 찾습니다.
LCCL_DIR=$(python3 -c "import importlib.util, pathlib; print(pathlib.Path(importlib.util.find_spec('lccl').origin).parent / 'lccl')")
HART_DIR=$(python3 -c "import importlib.util, pathlib; print(pathlib.Path(importlib.util.find_spec('hart').origin).parent)")

c++ -std=c++17 app.cc -I"$LCCL_DIR/include" -I"$HART_DIR/include" \
    -L"$LCCL_DIR" -L"$HART_DIR" -lha_lccl -lha_runtime \
    -Wl,-rpath,"$LCCL_DIR:$HART_DIR" -o app
./app

libha_lccl.so는 자기가 쓰는 나머지 hart 라이브러리를 같은 site-packages의 hart/에서 찾습니다. hart를 PYTHONPATH 등으로 다른 디렉터리에 두었다면 실행할 때 LD_LIBRARY_PATH="$HART_DIR"를 지정하십시오.

LPU 커널은 libha_lccl.so 안에 들어 있어 따로 배포할 커널 파일이 없습니다.


섹션

페이지 내용
커뮤니케이터 고유 ID, 랭크 랑데부, 수명, 조회, 버퍼 등록
집합 연산 all-reduce, reduce, reduce-scatter, broadcast, all-gather, gather, scatter, all-to-all
점대점 방향성 있는 송수신
그룹 여러 연산을 하나의 실행으로 묶기
타입 열거형, 별칭, 구조체, 매크로, 문자열 헬퍼

읽는 법

모든 진입점에 공통으로 적용되며 개별 페이지에서 반복하지 않는 내용입니다.

  • 타입·문자열 헬퍼(LcclTypeSize, *ToString)를 제외한 모든 진입점은 LcclResult를 반환합니다. 출력은 포인터 파라미터로 전달되며, 호출이 실패해도 기록될 수 있으므로 실패한 호출의 출력 값은 사용하지 마십시오.
  • 버퍼는 디바이스 포인터입니다. hart에서 얻으며, 이 라이브러리가 할당하거나 검증하지 않습니다.
  • count는 바이트가 아니라 원소 수입니다.
  • 기본값이 있는 HaStream_t 파라미터는 호출 스레드의 기본 스트림을 뜻합니다. 다만 LcclAllGather, LcclAllToAll, LcclSend, LcclRecv는 스트림 인자 자체가 없고, 그룹 밖에서 호출한 집합 연산은 반환될 때 이미 끝나 있지만 호출 전에 큐잉한 스트림 작업을 기다린다는 보장은 없습니다. 집합 연산을 보십시오.

랭크 순서, 그룹 시맨틱, 에러 분류처럼 여러 진입점에 걸치는 내용은 여기서 반복하지 않고 프로그래밍 가이드에서 한 번만 설명합니다.


범위

지원 대상 API는 lccl.h에 선언되어 이 레퍼런스에 실린 것입니다. collectives.h, group.h를 비롯한 소스 트리의 다른 헤더는 내부용이며 호환성 보장 대상이 아니므로 직접 include하지 마십시오.