taggedptr

KO | EN

gitlite — search

#python #llm #golang #go #android #linux #macos #java #awesome #cli #kubernetes #pytorch #ios #openai

(★ 10)

Golang implementation of tagged pointers.

taggedptr Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build Status](https://travis-ci.org/alexyer/taggedptr.svg)](https://travis-ci.org/alexyer/taggedptr)
[![Coverage Status](https://coveralls.io/repos/alexyer/taggedptr/badge.svg?branch=master&service=github)](https://coveralls.io/github/alexyer/taggedptr?branch=master)

# Description
This module contains methods to tag the pointer.
Tagged pointer is a pointer with additional data associate with it.
It's possible because data must be word aligned,
hence least significant bits could be used to store some data.
It's useful in lock-free programming,
to store some data in pointer atomically using CAS instructions.

## Examples
```go
type TestStruct struct {
	Field int
}

s := &TestStruct{42}

// Tag pointer and assign new value
newPtr, _ := Tag(unsafe.Pointer(s), 3)
s = (*TestStruct)(newPtr)

// Get clear pointer
initialPtr := GetPointer(unsafe.Pointer(s))

// Get tag
tag := GetTag(unsafe.Pointer(s))

// Tag, compare and swap pointer
casPtr := unsafe.Pointer(s)
CompareAndSwap(&casPtr, casPtr, casPtr, 0, 1)

// Atomically tag pointer
AttemptTag(&casPtr, casPtr, 1)

// Get both pointer and tag values
ptr, tag := Get(unsafe.Pointer(s))
```

taggedptr

taggedptr Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

taggedptr

taggedptr Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README