https://github.com/florianl/go-tc

traffic control in pure go - it allows to read and alter queues, filters and classes
https://github.com/florianl/go-tc

bpf class ebpf filter go linux network qdisc qos rtnetlink traffic-control

Last synced: 3 days ago
JSON representation

traffic control in pure go - it allows to read and alter queues, filters and classes

• Host: GitHub
• URL: https://github.com/florianl/go-tc
• Owner: florianl
• License: mit
• Created: 2019-04-15T08:44:47.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-01-01T10:55:22.000Z (11 days ago)
• Last Synced: 2025-01-02T10:03:15.054Z (10 days ago)
• Topics: bpf, class, ebpf, filter, go, linux, network, qdisc, qos, rtnetlink, traffic-control
• Language: Go
• Homepage:
• Size: 616 KB
• Stars: 464
• Watchers: 6
• Forks: 49
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

• my-awesome - florianl/go-tc - control pushed_at:2025-01 star:0.5k fork:0.0k traffic control in pure go - it allows to read and alter queues, filters and classes (Go)

README

        
tc [![PkgGoDev](https://pkg.go.dev/badge/github.com/florianl/go-tc)](https://pkg.go.dev/github.com/florianl/go-tc) [![Go Report Card](https://goreportcard.com/badge/github.com/florianl/go-tc)](https://goreportcard.com/report/github.com/florianl/go-tc) [![GitHub Actions](https://github.com/florianl/go-tc/workflows/Go/badge.svg?branch=main)](https://github.com/florianl/go-tc/actions) [![Coverage Status](https://coveralls.io/repos/github/florianl/go-tc/badge.svg)](https://coveralls.io/github/florianl/go-tc)

==

This is a work in progress version of `tc`.  It provides a [C](https://en.wikipedia.org/wiki/C_(programming_language))-binding free API to the [netlink](http://man7.org/linux/man-pages/man7/netlink.7.html) based [traffic control system](http://man7.org/linux/man-pages/man8/tc.8.html) of [rtnetlink](http://man7.org/linux/man-pages/man7/rtnetlink.7.html).

## Example

```golang

package main

import (

	"fmt"

	"net"

	"os"

	"github.com/mdlayher/netlink"

	"github.com/florianl/go-tc"

)

func main() {

	// open a rtnetlink socket

	rtnl, err := tc.Open(&tc.Config{})

	if err != nil {

		fmt.Fprintf(os.Stderr, "could not open rtnetlink socket: %v\n", err)

		return

	}

	defer func() {

		if err := rtnl.Close(); err != nil {

			fmt.Fprintf(os.Stderr, "could not close rtnetlink socket: %v\n", err)

		}

	}()

	// For enhanced error messages from the kernel, it is recommended to set

	// option `NETLINK_EXT_ACK`, which is supported since 4.12 kernel.

	//

	// If not supported, `unix.ENOPROTOOPT` is returned.

	err = rtnl.SetOption(netlink.ExtendedAcknowledge, true)

	if err != nil {

		fmt.Fprintf(os.Stderr, "could not set option ExtendedAcknowledge: %v\n", err)

		return

	}

	// get all the qdiscs from all interfaces

	qdiscs, err := rtnl.Qdisc().Get()

	if err != nil {

		fmt.Fprintf(os.Stderr, "could not get qdiscs: %v\n", err)

		return

	}

	for _, qdisc := range qdiscs {

		iface, err := net.InterfaceByIndex(int(qdisc.Ifindex))

		if err != nil {

			fmt.Fprintf(os.Stderr, "could not get interface from id %d: %v", qdisc.Ifindex, err)

			return

		}

		fmt.Printf("%20s\t%s\n", iface.Name, qdisc.Kind)

	}

}

```

## Requirements

* A version of Go that is [supported by upstream](https://golang.org/doc/devel/release.html#policy)

## Privileges

This package processes information directly from the kernel and therefore it requires special privileges. You can provide this privileges by adjusting the `CAP_NET_ADMIN` capabilities.

```

	setcap 'cap_net_admin=+ep' /your/executable

```