forked from MoonshotAI/checkpoint-engine
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathps.py
More file actions
1357 lines (1180 loc) · 54 KB
/
Copy pathps.py
File metadata and controls
1357 lines (1180 loc) · 54 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import argparse
import concurrent.futures
import ctypes
import os
import pickle
import random
import socket
import threading
import time
from collections import defaultdict
from collections.abc import Callable
from datetime import timedelta
from functools import lru_cache
from typing import TYPE_CHECKING, Annotated, Any, BinaryIO, NamedTuple
import httpx
import numpy as np
import torch
import torch.distributed as dist
import zmq
from loguru import logger
from pydantic import BaseModel, PlainSerializer, PlainValidator, WithJsonSchema
from safetensors.torch import safe_open
from torch.multiprocessing.reductions import reduce_tensor
if TYPE_CHECKING:
from typing_extensions import TypedDict
class FileMeta(TypedDict):
key: str # parameter name
dtype: torch.dtype
shape: torch.Size
type: type
tp_concat_dim: int
def _dt_validate(value: Any) -> torch.dtype:
if isinstance(value, str):
if not value.startswith("torch."):
raise ValueError(f"dtype {value} should start with torch.")
try:
value = getattr(torch, value.split(".")[1])
except AttributeError as e:
raise ValueError(f"unknown dtype: {value}") from e
if not isinstance(value, torch.dtype):
raise TypeError(f"dtype {value} should be torch.dtype, got {type(value)}")
return value
_TorchDtype = Annotated[
torch.dtype,
PlainValidator(_dt_validate),
PlainSerializer(lambda x: str(x), return_type=str),
WithJsonSchema({"type": "string"}, mode="serialization"),
]
def _size_validate(value: Any) -> torch.Size:
if isinstance(value, list | tuple):
return torch.Size(value)
if not isinstance(value, torch.Size):
raise TypeError(f"size {value} should be torch.Size, got {type(value)}")
return value
_TorchSize = Annotated[
torch.Size,
PlainValidator(_size_validate),
PlainSerializer(lambda x: tuple(x), return_type=tuple),
WithJsonSchema({"type": "array", "items": {"type": "integer"}}, mode="serialization"),
]
def _tensor_validate(value: Any) -> torch.Tensor:
if isinstance(value, torch.Tensor):
return value
raise TypeError(f"tensor {value} should be torch.Tensor, got {type(value)}")
_TorchTensor = Annotated[
torch.Tensor,
PlainValidator(_tensor_validate),
]
class ParameterMeta(BaseModel):
name: str
dtype: _TorchDtype
shape: _TorchSize
class BucketRange(NamedTuple):
idx: int # bucket_idx of MemoryBucket in memory_pool
offset: int
size: int
class H2DBucket(BaseModel):
size: int
ranges: list[BucketRange]
items: list[ParameterMeta]
class MemoryBufferMetas(BaseModel):
metas: list[ParameterMeta]
ptr: int
size: int
class MemoryBuffer(BaseModel):
buffer: _TorchTensor
size: int
metas: list[ParameterMeta]
class MemoryBufferMetaList(BaseModel):
p2p_store_addr: str | None
memory_buffer_metas_list: list[MemoryBufferMetas]
rdma_device: str
class DataToGather(MemoryBufferMetaList):
host_ip: str
device_uuid: str
# 256 bytes alignment when flatten torch tensors to uint8 buffer
_ALIGN_SIZE = 256
def _align_size(dtype: torch.dtype, shape: torch.Size) -> int:
return (dtype.itemsize * shape.numel() + _ALIGN_SIZE - 1) // _ALIGN_SIZE * _ALIGN_SIZE
def _to_named_tensor(metas: list[ParameterMeta], offset: int = 0) -> list[dict]:
ret = []
for meta in metas:
size = _align_size(meta.dtype, meta.shape)
ret.append(
{
"name": meta.name,
"dtype": meta.dtype,
"shape": meta.shape,
"offset": offset,
}
)
offset += size
return ret
def _load_checkpoint_file(file_path: str) -> tuple[int, dict[str, tuple["FileMeta", torch.Tensor]]]:
def _safetensors_load(fn: str) -> dict[str, tuple["FileMeta", torch.Tensor]]:
ret = {}
with safe_open(fn, framework="pt") as f:
for name in f.keys(): # noqa: SIM118
weight = f.get_tensor(name)
meta = {
"key": name,
"dtype": weight.dtype,
"shape": weight.shape,
"type": type(weight),
"tp_concat_dim": -1, # safetensors does not support tp_concat_dim
}
ret[name] = (meta, weight)
return ret
# deprecated, will be removed in the future
def _fast_np_load(fn: str) -> dict[str, tuple["FileMeta", torch.Tensor]]:
"""load *.np file and return memmap and related tensor meta"""
def parse_npy_header(fin: BinaryIO) -> dict[str, Any]:
start = fin.tell()
major, minor = np.lib.format.read_magic(fin)
if major == 1 and minor == 0:
read_header_fn = np.lib.format.read_array_header_1_0
elif major == 2 and minor == 0:
read_header_fn = np.lib.format.read_array_header_2_0
else:
raise ValueError(
f"unknown version {major}.{minor} when parsing npy header from {fn}"
)
shape, is_fortran, dtype = read_header_fn(fin)
return {
"shape": shape,
"is_fortran": is_fortran,
"dtype": dtype,
"header_length": fin.tell() - start,
}
meta_fn = fn + ".meta"
with open(meta_fn, "rb") as fin:
meta_lst = pickle.load(fin)
tensors = []
offset = 0
with open(fn, "rb") as fin:
fin.seek(0, os.SEEK_END)
filesize = fin.tell()
fin.seek(0)
while fin.tell() < filesize:
tensor_meta = parse_npy_header(fin)
tensor = np.memmap(
fn,
dtype=tensor_meta["dtype"],
mode="c",
offset=offset + tensor_meta["header_length"],
shape=tensor_meta["shape"],
)
offset += tensor_meta["header_length"] + tensor.nbytes
fin.seek(offset)
tensors.append(tensor)
assert len(meta_lst) == len(tensors)
ret = {}
for meta, tensor in zip(meta_lst, tensors):
if meta["type"] == torch.Tensor:
tensor = torch.from_numpy(tensor)
tensor = tensor.view(dtype=meta["dtype"]).view(*meta["shape"])
ret[meta["key"]] = (meta, tensor)
return ret
tp_rank = 0
if file_path.endswith(".npy"):
logger.warning("numpy model file is deprecated, will be removed in the future")
filename_split = os.path.basename(file_path).split(".")
# if using numpy and want to specify tp rank
# file should be in model.{layer}.{tp}[.{ep}].npy format
tp_rank = int(filename_split[2]) if len(filename_split) > 3 else 0
ret = _fast_np_load(file_path)
elif file_path.endswith(".safetensors"):
ret = _safetensors_load(file_path)
else:
raise ValueError(f"unsupported file format: {file_path}")
return tp_rank, ret
def _concat_tp_weights(
tp_weights: list[torch.Tensor], tp_concat_dim: int, tp_size: int
) -> torch.Tensor:
"""Concat tp weights with meta info.
If meta.concat_dim is -1, meas this is shared tp weights, just use the first weights.
Else we will cat weights in concat_dim.
"""
if tp_concat_dim == -1:
return tp_weights[0]
assert tp_size == len(tp_weights)
if len(tp_weights) == 1:
return tp_weights[0]
return torch.cat([w for w in tp_weights], dim=tp_concat_dim)
def _get_physical_gpu_id(device_index: int | None = None) -> str:
try:
return f"GPU-{torch.cuda.get_device_properties(device_index).uuid!s}"
except AssertionError as e:
raise ValueError(f"fail to get physical gpu id {device_index}") from e
@lru_cache(maxsize=1)
def _get_ip() -> str:
try:
# try to get ip from network interface
with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as s:
s.connect(("8.8.8.8", 80))
return s.getsockname()[0]
except Exception as e: # noqa: BLE001
# fallback to get ip from hostname
logger.warning(
f"fail to get ip from network interface, fallback to get ip from hostname: {e}"
)
return socket.gethostbyname(socket.gethostname())
def _ibv_get_device_list() -> list[str]:
lib = ctypes.CDLL("libibverbs.so.1")
lib.ibv_get_device_list.argtypes = [ctypes.POINTER(ctypes.c_int)] # int *num_devices
lib.ibv_get_device_list.restype = ctypes.POINTER(ctypes.c_void_p) # struct ibv_device **
lib.ibv_free_device_list.argtypes = [ctypes.POINTER(ctypes.c_void_p)]
lib.ibv_get_device_name.argtypes = [ctypes.c_void_p] # struct ibv_device *
lib.ibv_get_device_name.restype = ctypes.c_char_p # const char *
num = ctypes.c_int()
dev_array = lib.ibv_get_device_list(ctypes.byref(num))
if not dev_array or num.value <= 0:
return []
devices = []
for i in range(num.value):
dev_ptr = dev_array[i] # struct ibv_device *
name = lib.ibv_get_device_name(dev_ptr) # const char *
devices.append(name.decode())
lib.ibv_free_device_list(dev_array)
return devices
def _get_rdma_devices() -> list[str]:
"""
use _ibv_get_device_list to get RDMA devices, if NCCL_IB_HCA has multiple values, just return
"""
devices_str = os.getenv("PS_P2P_STORE_RDMA_DEVICES")
if devices_str:
return devices_str.split(",")
# if PS_P2P_STORE_RDMA_DEVICES is not set, try to use NCCL_IB_HCA to get RDMA devices
hca = os.getenv("NCCL_IB_HCA", None)
return _parse_NCCL_IB_HCA(hca or "", _ibv_get_device_list()) or _ibv_get_device_list()
def _get_my_rdma_device(local_rank: int, gpu_count: int, devices: list[str]) -> str:
"""
implement network card device allocation, if network card is "mlx5_0,mlx5_1", then 0-3 will share mlx5_0, 4-7 will share mlx5_1, etc.
"""
if not devices:
raise RuntimeError("no rdma devices found")
assert len(devices) <= gpu_count, (
f"rdma devices count {len(devices)} should be less than or equal to gpu count {gpu_count}"
)
assert gpu_count % len(devices) == 0, (
f"gpu count {gpu_count} should be divisible by rdma devices count {len(devices)}"
)
return devices[local_rank // (gpu_count // len(devices))]
def _parse_NCCL_IB_HCA(value: str, available_devices: list[str]) -> list[str]:
"""
The acceptable value by NCCL_IB_HCA is documented in https://docs.nvidia.com/deeplearning/nccl/user-guide/docs/env.html#id8.
The Python version parser is referred to the CPP parser in NCCL: https://github.com/NVIDIA/nccl/blob/v2.28.3-1/src/transport/net_ib.cc#L658-L662.
The list is comma-separated; port numbers are NOT supported yet.
An optional prefix '^' indicates the list is an exclude list.
A second optional prefix '=' indicates that the tokens are exact names, otherwise by default NCCL would treat each token as a prefix.
Please note that when '^' and '=' appear together, only '^=' is allowed, '=^' is not supported.
Examples:
- `NCCL_IB_HCA="mlx5"`: Use all cards starting with `mlx5`.
- `NCCL_IB_HCA="=mlx5_0,mlx5_1"`: Use specific cards `mlx5_0` and `mlx5_1`.
- `NCCL_IB_HCA="^mlx5"`: Use all cards except those starting with `mlx5`.
- `NCCL_IB_HCA="^=mlx5_0,mlx5_1"`: Use all cards except `mlx5_0` and `mlx5_1`.
"""
max_hcas = 32
if not value or value.strip() == "":
return available_devices[:max_hcas]
value = value.strip()
result = []
is_exclude = value.startswith("^")
if is_exclude:
value = value.removeprefix("^")
is_exact_match = value.startswith("=")
if is_exact_match:
value = value.removeprefix("=")
device_specs = [spec.strip() for spec in value.split(",") if spec.strip()]
result = _resolve_device_specs(device_specs, is_exact_match, available_devices)
if is_exclude:
result = [dev for dev in available_devices if dev not in result]
if len(result) > max_hcas:
result = result[:max_hcas]
logger.info(f"RDMA Devices from 'NCCL_IB_HCA': {result}")
return result
def _resolve_device_specs(
device_specs: list[str], is_exact_match: bool, available_devices: list[str]
) -> list[str]:
devices = set()
for spec in device_specs:
parts = spec.split(":", 1)
device_name = parts[0].strip()
# HACK: mooncake transfer engine does not support port specification yet, so we ignore it
# port = parts[1].strip() if len(parts) > 1 else None
base_devices = (
[device_name]
if device_name in available_devices
else []
if is_exact_match
else [dev for dev in available_devices if dev.startswith(device_name)]
)
if not base_devices:
logger.warning(f"No RDMA device match {device_name=} where {is_exact_match=}.")
continue
for base_dev in base_devices:
devices.add(base_dev)
return sorted(devices)
def _load_checkpoint(files: list[str]) -> dict[str, torch.Tensor]:
class TPMeta(BaseModel):
concat_dim: int
size: int
parameters: dict[str, torch.Tensor] = {}
parameter_metas: dict[str, ParameterMeta] = {}
tp_metas: dict[str, TPMeta] = {}
parameters_with_tp: dict[str, dict[int, torch.Tensor]] = {}
for file in files:
tp_rank, ret = _load_checkpoint_file(file)
for parameter_name, (meta, weight) in ret.items():
if parameter_name not in parameters_with_tp:
parameters_with_tp[parameter_name] = {}
parameters_with_tp[parameter_name][tp_rank] = weight
if parameter_name not in tp_metas:
tp_metas[parameter_name] = TPMeta(
concat_dim=meta["tp_concat_dim"],
size=1,
)
if parameter_name not in parameter_metas:
assert isinstance(meta["dtype"], torch.dtype), (
f"meta {meta} dtype should be torch.dtype"
)
assert isinstance(meta["shape"], torch.Size), (
f"meta {meta} shape should be torch.Size"
)
parameter_metas[parameter_name] = ParameterMeta(
name=parameter_name,
shape=meta["shape"],
dtype=meta["dtype"],
)
tp_meta = tp_metas[parameter_name]
if tp_meta.concat_dim != -1:
tp_meta.size = max(tp_meta.size, tp_rank + 1)
for name, tp_meta in tp_metas.items():
if tp_meta.concat_dim != -1:
shape = list(parameter_metas[name].shape)
shape[tp_meta.concat_dim] = shape[tp_meta.concat_dim] * tp_meta.size
parameter_metas[name] = ParameterMeta(
name=name, shape=torch.Size(shape), dtype=parameter_metas[name].dtype
)
weights_in_cpu = [parameters_with_tp[name][key] for key in sorted(parameters_with_tp[name])]
# TODO: here concat is serial, which may be slow
# but since tp storage is not used in the future
# we ignore this performance issue for now
parameters[name] = _concat_tp_weights(weights_in_cpu, tp_meta.concat_dim, tp_meta.size)
for name, parameter in parameters.items():
assert name in parameter_metas, f"parameter {name} not found in parameter_metas"
assert parameter_metas[name].shape == parameter.shape, (
f"parameter {name} shape mismatch, {parameter_metas[name].shape} != {parameter.shape}"
)
assert parameter_metas[name].dtype == parameter.dtype, (
f"parameter {name} dtype mismatch, {parameter_metas[name].dtype} != {parameter.dtype}"
)
return parameters
def _register_checkpoint(
*,
files: list[str],
named_tensors: dict[str, torch.Tensor],
rank: int | None = None,
) -> list[MemoryBuffer]:
logger.info(
f"[rank{rank}] start to register checkpoint with {len(files)} files and {len(named_tensors)} named_tensors"
)
if not files and not named_tensors:
return []
parameters = _load_checkpoint(files)
if named_tensors:
parameters.update(named_tensors)
bucket_size = max(4 << 30, max(_align_size(x.dtype, x.shape) for x in parameters.values()))
class MemoryBucket(BaseModel):
size: int
metas: list[ParameterMeta]
buckets: list[MemoryBucket] = [MemoryBucket(size=0, metas=[])]
for name, tensor in sorted(parameters.items()):
size = _align_size(tensor.dtype, tensor.shape)
if buckets[-1].size + size > bucket_size:
assert buckets[-1], f"buckets[{len(buckets) - 1}] should not be empty"
buckets.append(MemoryBucket(size=0, metas=[]))
buckets[-1].metas.append(ParameterMeta(name=name, shape=tensor.shape, dtype=tensor.dtype))
buckets[-1].size += size
memory_buffers = [
MemoryBuffer(buffer=torch.empty(0), size=bucket.size, metas=bucket.metas)
for bucket in buckets
]
def register_pin_memory(idx: int, size: int) -> tuple[int, torch.Tensor]:
buffer = torch.empty(size, dtype=torch.uint8, pin_memory=True)
return idx, buffer
def register_tensor(buffer: torch.Tensor, offset: int, tensor: torch.Tensor):
buffer[offset : offset + tensor.nbytes] = tensor.view(-1).view(dtype=torch.uint8)
with concurrent.futures.ThreadPoolExecutor(max_workers=32) as executor:
futures = [
executor.submit(register_pin_memory, idx, bucket.size)
for idx, bucket in enumerate(buckets)
]
new_futures = []
for future in concurrent.futures.as_completed(futures):
idx, buffer = future.result()
assert buffer.numel() == buckets[idx].size, (
f"buffer numel {buffer.numel()} should be equal to bucket size {buckets[idx].size}"
)
memory_buffers[idx].buffer = buffer
logger.info(
f"[rank{rank}] register pin_memory for bucket {idx + 1}/{len(buckets)} finished, "
f"size {buffer.numel() / 1024 / 1024:.2f}MiB, start to copy tensors to buffer"
)
offset = 0
for meta in buckets[idx].metas:
name = meta.name
tensor = parameters[name]
size = _align_size(tensor.dtype, tensor.shape)
assert size == _align_size(meta.dtype, meta.shape), (
f"tensor {name} size {size} should be equal to meta size {_align_size(meta.dtype, meta.shape)}"
)
new_futures.append(executor.submit(register_tensor, buffer, offset, tensor))
offset += size
for future in concurrent.futures.as_completed(new_futures):
future.result()
return memory_buffers
def request_inference_to_update(
url: str,
socket_paths: dict[str, str],
timeout: float = 300.0,
uds: str | None = None,
):
"""Send an inference update request to inference server via HTTP or Unix socket.
Args:
url (str): The HTTP URL or request path (e.g., "http://localhost:19730/inference") to send the request to.
socket_paths (dict[str, str]): A dictionary containing device uuid and IPC socket paths for updating weights.
timeout (float, optional): Request timeout in seconds. Defaults to 300.0.
uds (str, optional): Path to a Unix domain socket. If provided, the request
will be sent via the Unix socket instead of HTTP. Defaults to None.
Raises:
httpx.HTTPStatusError: If the response contains an HTTP error status.
httpx.RequestError: If there was an issue while making the request.
"""
resp = httpx.Client(transport=httpx.HTTPTransport(uds=uds)).post(
url,
json={
"method": "update_weights_from_ipc",
"args": [socket_paths],
"timeout": timeout,
},
timeout=timeout,
)
resp.raise_for_status()
def _gen_h2d_buckets(
global_metas: dict[int, MemoryBufferMetaList],
bucket_size: int,
local_topo: dict[str, set[int]],
remote_topo: dict[str, set[int]],
ranks: list[int] | None = None,
) -> list[tuple[int, int, H2DBucket]]:
buckets: list[tuple[int, H2DBucket]] = []
for owner_rank, items in global_metas.items():
buckets.append((owner_rank, H2DBucket(size=0, ranges=[], items=[])))
for idx, metas in enumerate(items.memory_buffer_metas_list):
start_offset, offset = 0, 0
for meta in metas.metas:
s = _align_size(meta.dtype, meta.shape)
if buckets[-1][1].size + s > bucket_size:
if offset - start_offset > 0:
buckets[-1][1].ranges.append(
BucketRange(idx, start_offset, offset - start_offset)
)
start_offset = offset
buckets.append((owner_rank, H2DBucket(size=0, ranges=[], items=[])))
offset += s
buckets[-1][1].size += s
buckets[-1][1].items.append(meta)
buckets[-1][1].ranges.append(BucketRange(idx, start_offset, offset - start_offset))
assert buckets[-1][1].size > 0, (
f"buckets[-1][1].size {buckets[-1][1].size} should be greater than 0"
)
actual_local_topo = (
{k: v & set(ranks) for k, v in local_topo.items() if v & set(ranks)}
if ranks
else local_topo
)
# if ranks is empty, assign the owner_rank as receiver_rank, this is used for colocate architecture
if not ranks:
return [(owner_rank, owner_rank, bucket) for owner_rank, bucket in buckets]
else:
return _assign_receiver_ranks(buckets, actual_local_topo, remote_topo)
if TYPE_CHECKING:
from typing import TypeVar
T = TypeVar("T")
def _assign_receiver_ranks(
buckets: list[tuple[int, "T"]],
local_topo: dict[str, set[int]],
remote_topo: dict[str, set[int]],
) -> list[tuple[int, int, "T"]]:
"""
(owner_rank, bucket) -> (receiver_rank, owner_rank, bucket)
Assign receiver ranks to buckets. If ranks is empty, assign the owner_rank as receiver_rank.
GPU-rdma_device topology will be considered to make full use of the bandwidth.
"""
if not buckets:
logger.warning("bucket list is empty, no need to assign receiver ranks")
return []
rank_to_rdma_device = {
rank: rdma_device for rdma_device, ranks in remote_topo.items() for rank in ranks
}
# group buckets by owner RDMA devices
buckets_by_rdma_device = defaultdict(list)
for owner_rank, bucket in buckets:
owner_rdma_device = rank_to_rdma_device[owner_rank]
buckets_by_rdma_device[owner_rdma_device].append((owner_rank, bucket))
buckets_matrix = list(buckets_by_rdma_device.values())
assert buckets_matrix, "buckets_matrix should not be empty"
# Select receiver ranks. We use the minimum rank in each local RDMA device group as receiver rank
num_receivers = min(len(local_topo), len(buckets_by_rdma_device))
receiver_list = [min(ranks) for ranks in list(local_topo.values())[:num_receivers]]
flattened_buckets = [
buckets_matrix[row][col]
for col in range(
max(len(matrix_row) for matrix_row in buckets_matrix) if buckets_matrix else 0
)
for row in range(len(buckets_matrix))
if col < len(buckets_matrix[row])
]
buckets_with_receiver = []
assigned_cnt = 0
while assigned_cnt < len(flattened_buckets):
occupied_devices = set()
for receiver_rank in receiver_list:
if assigned_cnt >= len(flattened_buckets):
break
owner_rank, bucket = flattened_buckets[assigned_cnt]
rdma_device = rank_to_rdma_device[owner_rank]
if rdma_device in occupied_devices:
break
buckets_with_receiver.append((receiver_rank, owner_rank, bucket))
occupied_devices.add(rdma_device)
assigned_cnt += 1
return buckets_with_receiver
def _get_master_port(master_port: int | None = None) -> int:
if master_port is None:
# HACK: use MASTER_PORT + 1 as master_port, avoid conflict with torchrun's rendezvous port
# TODO: check whether master_port is available or use a more elegant way
master_port = int(os.getenv("MASTER_PORT")) + 1
return master_port
def _get_bcast_rank_map(world_size: int, ranks: list[int] | None) -> dict[int, int]:
"""
map the real ranks (receiver_rank) to the bcast ranks (0 ~ len(ranks) - 1),
which are generated in self.init_process_group_for_ranks
"""
bcast_rank_map: dict[int, int] = {}
if not ranks:
bcast_rank_map = {r: r for r in range(world_size)}
else:
for i, r in enumerate(ranks):
bcast_rank_map[r] = i
return bcast_rank_map
class P2PStore:
def __init__(self):
from mooncake.engine import TransferEngine
self.rank = int(os.getenv("RANK"))
gpu_count = torch.cuda.device_count()
local_rank = self.rank % gpu_count
self.device = _get_my_rdma_device(local_rank, gpu_count, _get_rdma_devices())
self.ip = _get_ip()
# we will start at most 8 ps processes, so we use 8 retries to avoid port conflicts in extreme cases
retry_count = 8
for i in range(retry_count):
self.engine = TransferEngine()
ret = self.engine.initialize(self.ip, "P2PHANDSHAKE", "rdma", self.device)
if ret == 0:
break
# sleep 0.5 ~ 2.0s, to avoid port conflicts when two processes retry at the same time
sleep_ms = random.randint(500, 2000)
logger.warning(
f"[rank{self.rank}] fail to initialize transfer engine, ret {ret}, retry {i + 1}/{retry_count} in {sleep_ms}ms"
)
time.sleep(sleep_ms / 1000)
else:
raise RuntimeError(f"[rank{self.rank}] fail to initialize transfer engine")
self.port = self.engine.get_rpc_port()
self.named_tensors: dict[str, torch.Tensor] = {}
logger.info(
f"[rank{self.rank}] p2p store initialized, addr is {self.addr}, rdma device is {self.device}"
)
@property
def addr(self) -> str:
return f"{self.ip}:{self.port}"
def register_named_tensors(self, named_tensors: dict[str, torch.Tensor]):
buffer_addresses = [tensor.data_ptr() for tensor in named_tensors.values()]
capacities = [tensor.nbytes for tensor in named_tensors.values()]
self.named_tensors.update(named_tensors)
for i, name in enumerate(named_tensors.keys()):
logger.info(
f"[rank{self.rank}] p2p store register tensor {name} with addr {hex(buffer_addresses[i])} and capacity {capacities[i]}"
)
assert self.engine.batch_register_memory(buffer_addresses, capacities) == 0
def unregister_named_tensors(self, names: list[str]) -> int:
buffer_addresses = [self.named_tensors[name].data_ptr() for name in names]
assert self.engine.batch_unregister_memory(buffer_addresses) == 0
num_unregistered = 0
for i, name in enumerate(names):
del self.named_tensors[name]
logger.info(
f"[rank{self.rank}] p2p store unregister tensor {name} with addr {hex(buffer_addresses[i])}"
)
num_unregistered += 1
return num_unregistered
def batch_transfer_sync_read(
self, target_hostname: str, buf_ptrs: list[int], remote_ptrs: list[int], lens: list[int]
):
assert (
self.engine.batch_transfer_sync_read(target_hostname, buf_ptrs, remote_ptrs, lens) == 0
)
class ParameterServer:
def __init__(
self,
*,
rank: int | None = None,
world_size: int | None = None,
auto_pg: bool = False,
gpu_count: int | None = None,
mem_fraction: float | None = None,
):
"""
Initialize the parameter server. env RANK, WORLD_SIZE and MASTER_ADDR must be set.
Args:
auto_pg: Whether to automatically initialize the process group.
Notice that if auto_pg is True, will destroy the process group after update.
mem_fraction: The proportion (as a fraction) of the current free CUDA memory for allocation.
"""
self._rank = rank or int(os.environ.get("RANK", None))
self._world_size = world_size or int(os.environ.get("WORLD_SIZE", None))
self._gpu_count = gpu_count or torch.cuda.device_count()
self._local_rank = self._rank % self._gpu_count
self._auto_pg = auto_pg
self._all_hosts = []
self._global_device_uuids: list[str] = []
self._local_rdma_devices: dict[str, set[int]] = defaultdict(set)
self._remote_rdma_devices: dict[str, set[int]] = defaultdict(set)
self._mem_fraction = mem_fraction or 0.9
assert self._rank is not None and self._rank >= 0, self._rank
assert self._world_size and self._world_size > 0, self._world_size
assert (
self._gpu_count is not None
and self._gpu_count > 0
and self._gpu_count <= torch.cuda.device_count()
), self._gpu_count
assert (
self._mem_fraction is not None and self._mem_fraction > 0 and self._mem_fraction <= 1
), self._mem_fraction
self._zmq_ctx = zmq.Context()
self._zmq_addr_counter = 0
self._memory_pool: dict[str, list[MemoryBuffer]] = {}
# dict key is owner_rank, value is a bucket metas list in owner_rank
self._current_global_parameter_metas: dict[int, MemoryBufferMetaList] = {}
try:
self._p2p_store = P2PStore()
except ImportError as e:
logger.warning(f"[rank{self._rank}] fail to initialize p2p store due to {e}")
self._p2p_store = None
device_index = self._local_rank
torch.cuda.set_device(device_index)
self._device_uuid = _get_physical_gpu_id(device_index)
self._rdma_device = None if self._p2p_store is None else self._p2p_store.device
def _logger_rank0(self, msg: str):
if self._local_rank == 0:
logger.info(msg)
def get_metas(self) -> dict[int, MemoryBufferMetaList]:
return self._current_global_parameter_metas
def load_metas(self, metas: dict[int, MemoryBufferMetaList]):
self._current_global_parameter_metas = metas
self._remote_rdma_devices = defaultdict(set)
for i, meta in self._current_global_parameter_metas.items():
assert meta.rdma_device is not None, "meta.rdma_device should not be None"
assert meta.p2p_store_addr is not None, "meta.p2p_store_addr should not be None"
self._remote_rdma_devices[
meta.rdma_device + "@" + meta.p2p_store_addr.split(":")[0]
].add(i)
def register_checkpoint(
self,
checkpoint_name: str,
*,
files: list[str] | None = None,
named_tensors: dict[str, torch.Tensor] | None = None,
) -> None:
"""
Register a checkpoint to the parameter server. Both files and named_tensors will be registered together.
Args:
checkpoint_name: The name of the checkpoint.
files: The safetensors files to register.
named_tensors: The named tensors to register.
"""
try:
assert checkpoint_name not in self._memory_pool, (
f"checkpoint {checkpoint_name} already registered"
)
self._memory_pool[checkpoint_name] = _register_checkpoint(
files=files or [], named_tensors=named_tensors or {}, rank=self._rank
)
if self._p2p_store is not None:
self._register_parameters_to_p2p_store(checkpoint_name)
except Exception:
logger.exception(
f"[rank{self._rank}] fail to register checkpoint {checkpoint_name} with files {files}"
)
if self._p2p_store is not None:
self._unregister_parameters_from_p2p_store(checkpoint_name)
self.unregister_checkpoint(checkpoint_name)
raise
def unregister_checkpoint(self, checkpoint_name: str):
"""
Unregister a checkpoint from the parameter server. This function will also unregister the checkpoint
from p2p store if p2p store is initialized.
"""
if checkpoint_name not in self._memory_pool:
return
if self._p2p_store is not None:
num_unregistered = self._unregister_parameters_from_p2p_store(checkpoint_name)
logger.info(
f"[rank{self._rank}] unregister {num_unregistered} parameters from p2p store for checkpoint {checkpoint_name}"
)
del self._memory_pool[checkpoint_name]
# see https://github.com/pytorch/pytorch/blob/31d5c675394705f8a6bc767f80ae14bf4f01246b/torch/csrc/cuda/Module.cpp#L2018
# this works by using torch>=2.5.0
torch._C._host_emptyCache()
def gather_metas(self, checkpoint_name: str):
"""
Gather the parameter metas from all ranks. This will gather memory_buffer, and other metadatas.
This function should be called before update and init a new value to `self._current_global_parameter_metas`,
which can be exported by using `self.get_metas` function.
"""
if self._auto_pg and not dist.is_initialized():
self.init_process_group()
assert dist.is_initialized(), "process group is not initialized"
metas_lst: list[DataToGather | None] = [None for _ in range(self._world_size)] # type: ignore
metas = DataToGather(
memory_buffer_metas_list=[
MemoryBufferMetas(
metas=x.metas,
ptr=x.buffer.data_ptr(),
size=x.size,
)
for x in self._memory_pool.get(checkpoint_name, [])
],
p2p_store_addr=None if self._p2p_store is None else self._p2p_store.addr,
host_ip=_get_ip(),
device_uuid=self._device_uuid,
rdma_device=self._rdma_device or "",
)
dist.all_gather_object(metas_lst, metas)
num_parameters = 0
all_hosts: list[str] = []
global_device_uuids: list[str] = []
for i, metas_buckets in enumerate(metas_lst):
assert metas_buckets is not None, f"metas_buckets {i} should not be None"
if i % self._gpu_count == 0 and not self._all_hosts:
all_hosts.append(metas_buckets.host_ip)
if not self._global_device_uuids:
global_device_uuids.append(metas_buckets.device_uuid)
if metas_buckets.memory_buffer_metas_list:
self._current_global_parameter_metas[i] = MemoryBufferMetaList(
memory_buffer_metas_list=metas_buckets.memory_buffer_metas_list,
p2p_store_addr=metas_buckets.p2p_store_addr,
rdma_device=metas_buckets.rdma_device,
)
num_parameters += sum(len(x.metas) for x in metas_buckets.memory_buffer_metas_list)
self._local_rdma_devices[
metas_buckets.rdma_device + "@" + metas_buckets.p2p_store_addr.split(":")[0]
if metas_buckets.p2p_store_addr
else metas_buckets.host_ip
].add(i)
if not self._all_hosts:
self._all_hosts = all_hosts
if not self._global_device_uuids:
self._global_device_uuids = global_device_uuids
# Sender node and Receiver node have the same GPU-rdma_device topology is considered as default.
# Rewrite the sender's topology (_remote_rdma_devices) by calling load_metas.
self._remote_rdma_devices = self._local_rdma_devices.copy()
logger.info(
f"[rank{self._rank}] gather parameter metas finished, num_parameters: {num_parameters}"
)
def init_process_group(
self,
*,
master_addr: str | None = None,
master_port: int | None = None,
timeout: timedelta = timedelta(minutes=10),
):
"""
Initialize the process group for the ranks. This global group can be easily destroyed by calling dist.destroy_process_group.
Args:
master_port: The specified port of the master node. If not set, will use _get_master_port to get the port.
timeout: The timeout of the process group.
"""
master_addr = master_addr or os.getenv("MASTER_ADDR")
assert master_addr, "master_addr is required"
store = dist.TCPStore(
master_addr,
_get_master_port(master_port),
self._world_size,
timeout=timeout,
is_master=self._rank == 0,
)
dist.init_process_group(
backend="nccl",
world_size=self._world_size,
rank=self._rank,
timeout=timeout,
store=store,
)
logger.info(f"[rank{self._rank}] init process group successfully.")
def update(
self,
checkpoint_name: str,
req_func: Callable[[list[tuple[str, str]]], None],
*,
ranks: list[int] | None = None,
) -> None:
"""
Update the checkpoint to inference engine. This function should be called after gather_metas.
Args:
checkpoint_name: The name of the checkpoint.
req_func: The function to request the inference of inference engine.
ranks: The ranks to update. If not set, will use fully broadcast to update to all ranks,
which is the fastest way to update weights, especially in colocated architecture.
If set, will use p2p to update to the ranks, this is flexible to update to a group of ranks,
which is useful in disaggregated architecture.
"""
assert req_func is not None, "req_func is required"
try:
# if both ranks is None or [], it will use fully broadcast to update to all ranks
if not ranks:
if self._auto_pg and not dist.is_initialized():
self.init_process_group()
self._update_per_bucket(checkpoint_name, req_func)
else:
if self._auto_pg:
if dist.is_initialized():
dist.destroy_process_group()
# HACK: wait 2s to ensure destroy is finished
time.sleep(2)
self.init_process_group_for_ranks(ranks)
if self._rank not in ranks:
return
self._update_per_bucket(checkpoint_name, req_func, ranks)
if self._auto_pg:
dist.destroy_process_group()
torch.cuda.empty_cache()