blob: 1e04d4147f54ab9e59faf34baa18c89b34ac84fe [file] [log] [blame]
Tomasz Wasilczyk87329672019-07-12 11:43:00 -07001/*
2 * Copyright (C) 2019 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#pragma once
18
Tomasz Wasilczyka9872732020-06-02 18:03:27 -070019#include "nlbuf.h"
20
Tomasz Wasilczyka5c83a52020-06-16 15:58:19 -070021#include <linux/can.h>
22#include <net/if.h>
23
Tomasz Wasilczyk87329672019-07-12 11:43:00 -070024#include <string>
25
Tomasz Wasilczyk55f21932019-12-20 09:20:24 -080026namespace android::netdevice {
Tomasz Wasilczyk87329672019-07-12 11:43:00 -070027
Tomasz Wasilczyka5c83a52020-06-16 15:58:19 -070028namespace socketparams {
29
30struct Params {
31 int domain;
32 int type;
33 int protocol;
34};
35
36constexpr Params general = {AF_INET, SOCK_DGRAM, 0};
37constexpr Params can = {PF_CAN, SOCK_RAW, CAN_RAW};
38
39extern Params current;
40
41} // namespace socketparams
42
Tomasz Wasilczyk87329672019-07-12 11:43:00 -070043/**
44 * Returns the index of a given network interface.
45 *
46 * If the syscall to check the index fails with other error than ENODEV, it gets logged and the
47 * return value indicates the interface doesn't exists.
48 *
49 * \param ifname Interface to check
50 * \return Interface index, or 0 if the interface doesn't exist
51 */
52unsigned int nametoindex(const std::string& ifname);
53
Tomasz Wasilczyka9872732020-06-02 18:03:27 -070054/**
55 * Sanitize a string of unknown contents.
56 *
57 * Trims the string to the first '\0' character and replaces all non-printable characters with '?'.
58 */
59std::string sanitize(std::string str);
60
61/**
62 * Calculates a (optionally running) CRC16 checksum.
63 *
64 * CRC16 isn't a strong checksum, but is good for quick comparison purposes.
65 * One benefit (and also a drawback too) is that all-zero payloads with any length will
66 * always have a checksum of 0x0000.
67 *
68 * \param data Buffer to calculate checksum for
69 * \param crc Previous CRC16 value to continue calculating running checksum
70 * \return CRC16 checksum
71 */
72uint16_t crc16(const nlbuf<uint8_t> data, uint16_t crc = 0);
73
Tomasz Wasilczyk55f21932019-12-20 09:20:24 -080074} // namespace android::netdevice