python-systemd/src/systemd/_reader.c at main · systemd/python-systemd · GitHub

History

1429 lines (1162 loc) · 49 KB

Raw

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

/* SPDX-License-Identifier: LGPL-2.1-or-later */

#include <stdbool.h>

#include <stdio.h>

#include <string.h>

#include <time.h>

#include <systemd/sd-journal.h>

#include "pyutil.h"

#include "macro.h"

#include "strv.h"

/* This needs to be below Python.h include for some reason */

#include <datetime.h>

#if defined(LIBSYSTEMD_VERSION) || LIBSYSTEMD_JOURNAL_VERSION > 204

# define HAVE_JOURNAL_OPEN_FILES 1

#else

# define SD_JOURNAL_SYSTEM (1 << 2)

# define SD_JOURNAL_CURRENT_USER (1 << 3)

# define HAVE_JOURNAL_OPEN_FILES 0

#endif

#define HAVE_ENUMERATE_FIELDS (LIBSYSTEMD_VERSION >= 229)

#define HAVE_HAS_RUNTIME_FILES (LIBSYSTEMD_VERSION >= 229)

#define HAVE_HAS_PERSISTENT_FILES (LIBSYSTEMD_VERSION >= 229)

#if LIBSYSTEMD_VERSION >= 245

# define HAVE_JOURNAL_OPEN_NAMESPACE 1

#else

# define HAVE_JOURNAL_OPEN_NAMESPACE 0

#endif

#if LIBSYSTEMD_VERSION >= 230

# define HAVE_JOURNAL_OPEN_DIRECTORY_FD 1

#else

# define SD_JOURNAL_OS_ROOT (1 << 4)

# define HAVE_JOURNAL_OPEN_DIRECTORY_FD 0

#endif

typedef struct {

PyObject_HEAD

sd_journal *journal;

} Reader;

static PyTypeObject ReaderType;

PyDoc_STRVAR(module__doc__,

"Class to reads the systemd journal similar to journalctl.");

static PyTypeObject MonotonicType;

PyDoc_STRVAR(MonotonicType__doc__,

"A tuple of (timestamp, bootid) for holding monotonic timestamps");

static PyStructSequence_Field MonotonicType_fields[] = {

{(char*) "timestamp", (char*) "Time"},

{(char*) "bootid", (char*) "Unique identifier of the boot"},

{} /* Sentinel */

};

static PyStructSequence_Desc Monotonic_desc = {

(char*) "journal.Monotonic",

MonotonicType__doc__,

MonotonicType_fields,

};

/**

* Convert a str or bytes object into a C-string path.

* Returns NULL on error.

static char* str_converter(PyObject *str, PyObject **bytes) {

int r;

r = PyUnicode_FSConverter(str, bytes);

if (r == 0)

return NULL;

return PyBytes_AsString(*bytes);

}

/**

* Return NULL is obj is None, and the object otherwise.

static int null_converter(PyObject* obj, void *_result) {

PyObject **result = _result;

assert(result);

if (!obj)

return 0;

if (obj == Py_None)

*result = NULL;

else

*result = obj;

return 1;

}

/**

* Convert a Python sequence object into a strv (char**).

static int strv_converter(PyObject* obj, void *_result) {

char ***result = _result;

assert(result);

if (!PySequence_Check(obj))

return 0;

Py_ssize_t len = PySequence_Length(obj);

*result = new0(char*, len + 1);

if (!*result) {

set_error(-ENOMEM, NULL, NULL);

return 0;

}

for (Py_ssize_t i = 0; i < len; i++) {

PyObject *item;

_cleanup_Py_DECREF_ PyObject *bytes = NULL;

char *s;

item = PySequence_ITEM(obj, i);

s = str_converter(item, &bytes);

if (!s)

goto cleanup;

s = strdup(s);

if (!s) {

set_error(-ENOMEM, NULL, NULL);

goto cleanup;

}

(*result)[i] = s;

}

return 1;

cleanup:

strv_free(*result);

*result = NULL;

return 0;

}

static int long_as_fd(PyObject *obj, int *fd) {

long num = PyLong_AsLong(obj);

if (PyErr_Occurred())

return -1;

if ((int) num != num) {

PyErr_SetString(PyExc_OverflowError, "Value too large");

return -1;

}

*fd = (int) num;

return 0;

}

/**

* Convert a Python sequence object into an int array.

static int intlist_converter(PyObject* obj, int **_result, size_t *_len) {

assert(_result);

assert(_len);

if (!PySequence_Check(obj))

return 0;

Py_ssize_t len = PySequence_Length(obj);

_cleanup_free_ int *result = new0(int, len);

if (!result) {

set_error(-ENOMEM, NULL, NULL);

return 0;

}

for (Py_ssize_t i = 0; i < len; i++) {

PyObject *item;

int fd;

item = PySequence_ITEM(obj, i);

if (long_as_fd(item, &fd) < 0)

return 0;

result[i] = fd;

}

*_result = result;

*_len = len;

result = NULL;

return 1;

}

static void Reader_dealloc(Reader* self) {

sd_journal_close(self->journal);

Py_TYPE(self)->tp_free((PyObject*)self);

}

PyDoc_STRVAR(Reader__doc__,

"_Reader([flags | path | files | namespace]) -> ...\n\n"

"_Reader allows filtering and retrieval of Journal entries.\n"

"Note: this is a low-level interface, and probably not what you\n"

"want, use systemd.journal.Reader instead.\n\n"

"Argument `flags` sets open flags of the journal, which can be one of, or an ORed\n"

"combination of constants: LOCAL_ONLY (default) opens journal on local machine only;\n"

"RUNTIME_ONLY opens only volatile journal files; and SYSTEM opens journal files of\n"

"system services and the kernel, CURRENT_USER opens files of the current user; and\n"

"OS_ROOT is used to open the journal from directories relative to the specified\n"

"directory path or file descriptor.\n"

"\n"

"If `namespace` argument is specified, the specific journal namespace will be open\n"

"(supported since systemd v245). Instead of opening the system journal, argument\n"

"`path` may specify a directory which contains the journal. It maybe be either\n"

"a file system path (a string), or a file descriptor (an integer). Alternatively,\n"

"argument `files` may specify a list of journal file names. Note that `flags`, `path`,\n"

"`files`, `directory_fd`, `namespace` are exclusive.\n\n"

"_Reader implements the context manager protocol: the journal will be closed when\n"

"exiting the block.");

static int Reader_init(Reader *self, PyObject *args, PyObject *keywds) {

unsigned flags = SD_JOURNAL_LOCAL_ONLY;

PyObject *_path = NULL, *_files = NULL, *_namespace = NULL;

int r;

static const char* const kwlist[] = {"flags", "path", "files", "namespace", NULL};

if (!PyArg_ParseTupleAndKeywords(args, keywds, "|iO&O&O&:__init__", (char**) kwlist,

&flags,

null_converter, &_path,

null_converter, &_files,

null_converter, &_namespace))

return -1;

if (!!_path + !!_files > 1) {

PyErr_SetString(PyExc_ValueError,

"path and files cannot be specified simultaneously");

return -1;

}

if (_path) {

if (PyLong_Check(_path)) {

int fd;

if (long_as_fd(_path, &fd) < 0)

return -1;

#if HAVE_JOURNAL_OPEN_DIRECTORY_FD

Py_BEGIN_ALLOW_THREADS

r = sd_journal_open_directory_fd(&self->journal, (int) fd, flags);

Py_END_ALLOW_THREADS

#else

r = -ENOSYS;

#endif

} else {

char *path = NULL;

_cleanup_Py_DECREF_ PyObject *path_bytes = NULL;

path = str_converter(_path, &path_bytes);

if (!path)

return -1;

Py_BEGIN_ALLOW_THREADS

r = sd_journal_open_directory(&self->journal, path, flags);

Py_END_ALLOW_THREADS

}

} else if (_files) {

_cleanup_Py_DECREF_ PyObject *item0 = NULL;

item0 = PySequence_GetItem(_files, 0);

if (!item0 || !PyLong_Check(item0)) {

_cleanup_strv_free_ char **files = NULL;

if (!strv_converter(_files, &files))

return -1;

#if HAVE_JOURNAL_OPEN_FILES

Py_BEGIN_ALLOW_THREADS

r = sd_journal_open_files(&self->journal, (const char**) files, flags);

Py_END_ALLOW_THREADS

#else

r = -ENOSYS;

#endif

} else {

_cleanup_free_ int *fds = NULL;

size_t n_fds;

if (!intlist_converter(_files, &fds, &n_fds))

return -1;

#if HAVE_JOURNAL_OPEN_DIRECTORY_FD

Py_BEGIN_ALLOW_THREADS

r = sd_journal_open_files_fd(&self->journal, fds, n_fds, flags);

Py_END_ALLOW_THREADS

#else

r = -ENOSYS;

#endif

}

} else if (_namespace) {

#if HAVE_JOURNAL_OPEN_NAMESPACE

char *namespace = NULL;

_cleanup_Py_DECREF_ PyObject *ns_bytes = NULL;

namespace = str_converter(_namespace, &ns_bytes);

if (!namespace)

return -1;

Py_BEGIN_ALLOW_THREADS

r = sd_journal_open_namespace(&self->journal, namespace, flags);

Py_END_ALLOW_THREADS

#else

r = -ENOSYS;

#endif

} else {

Py_BEGIN_ALLOW_THREADS

r = sd_journal_open(&self->journal, flags);

Py_END_ALLOW_THREADS

}

return set_error(r, NULL, "Opening the journal failed");

}

PyDoc_STRVAR(Reader_fileno__doc__,

"fileno() -> int\n\n"

"Get a file descriptor to poll for changes in the journal.\n"

"This method invokes sd_journal_get_fd().\n"

"See :manpage:`sd_journal_get_fd(3)`.\n\n"

"When the file descriptor returned by this function is used a poll\n"

"loop, .process() should be used to process events and reset the readability\n"

"state of the file descriptor.");

static PyObject* Reader_fileno(Reader *self, PyObject *args) {

int fd;

assert(self);

assert(!args);

fd = sd_journal_get_fd(self->journal);

set_error(fd, NULL, NULL);

if (fd < 0)

return NULL;

return PyLong_FromLong(fd);

}

PyDoc_STRVAR(Reader_reliable_fd__doc__,

"reliable_fd() -> bool\n\n"

"Returns True iff the journal can be polled reliably.\n"

"This method invokes sd_journal_reliable_fd().\n"

"See :manpage:`sd_journal_reliable_fd(3)`.");

static PyObject* Reader_reliable_fd(Reader *self, PyObject *args) {

int r;

assert(self);

assert(!args);

r = sd_journal_reliable_fd(self->journal);

if (set_error(r, NULL, NULL) < 0)

return NULL;

return PyBool_FromLong(r);

}

PyDoc_STRVAR(Reader_get_events__doc__,

"get_events() -> int\n\n"

"Returns a mask of poll() events to wait for on the file\n"

"descriptor returned by .fileno().\n\n"

"See :manpage:`sd_journal_get_events(3)` for further discussion.");

static PyObject* Reader_get_events(Reader *self, PyObject *args) {

int r;

assert(self);

assert(!args);

r = sd_journal_get_events(self->journal);

if (set_error(r, NULL, NULL) < 0)

return NULL;

return PyLong_FromLong(r);

}

PyDoc_STRVAR(Reader_get_timeout__doc__,

"get_timeout() -> int or None\n\n"

"Returns a timeout value for usage in poll(), the time since the\n"

"epoch of clock_gettime(2) in microseconds, or None if no timeout\n"

"is necessary.\n\n"

"The return value must be converted to a relative timeout in\n"

"milliseconds if it is to be used as an argument for poll().\n"

"See :manpage:`sd_journal_get_timeout(3)` for further discussion.");

static PyObject* Reader_get_timeout(Reader *self, PyObject *args) {

int r;

uint64_t t;

assert(self);

assert(!args);

r = sd_journal_get_timeout(self->journal, &t);

if (set_error(r, NULL, NULL) < 0)

return NULL;

if (t == (uint64_t) -1)

Py_RETURN_NONE;

assert_cc(sizeof(unsigned long long) == sizeof(t));

return PyLong_FromUnsignedLongLong(t);

}

PyDoc_STRVAR(Reader_get_timeout_ms__doc__,

"get_timeout_ms() -> int\n\n"

"Returns a timeout value suitable for usage in poll(), the value\n"

"returned by .get_timeout() converted to relative ms, or -1 if\n"

"no timeout is necessary.");

static PyObject* Reader_get_timeout_ms(Reader *self, PyObject *args) {

int r;

uint64_t t;

assert(self);

assert(!args);

r = sd_journal_get_timeout(self->journal, &t);

if (set_error(r, NULL, NULL) < 0)

return NULL;

return absolute_timeout(t);

}

PyDoc_STRVAR(Reader_close__doc__,

"close() -> None\n\n"

"Free resources allocated by this Reader object.\n"

"This method invokes sd_journal_close().\n"

"See :manpage:`sd_journal_close(3)`.");

static PyObject* Reader_close(Reader *self, PyObject *args) {

assert(self);

assert(!args);

sd_journal_close(self->journal);

self->journal = NULL;

Py_RETURN_NONE;

}

PyDoc_STRVAR(Reader_get_usage__doc__,

"get_usage() -> int\n\n"

"Returns the total disk space currently used by journal\n"

"files (in bytes). If `SD_JOURNAL_LOCAL_ONLY` was\n"

"passed when opening the journal this value will only reflect\n"

"the size of journal files of the local host, otherwise\n"

"of all hosts.\n\n"

"This method invokes sd_journal_get_usage().\n"

"See :manpage:`sd_journal_get_usage(3)`.");

static PyObject* Reader_get_usage(Reader *self, PyObject *args) {

int r;

uint64_t bytes;

assert(self);

assert(!args);

r = sd_journal_get_usage(self->journal, &bytes);

if (set_error(r, NULL, NULL) < 0)

return NULL;

assert_cc(sizeof(unsigned long long) == sizeof(bytes));

return PyLong_FromUnsignedLongLong(bytes);

}

PyDoc_STRVAR(Reader___enter____doc__,

"__enter__() -> self\n\n"

"Part of the context manager protocol.\n"

"Returns self.\n");

static PyObject* Reader___enter__(PyObject *self, PyObject *args) {

assert(self);

assert(!args);

Py_INCREF(self);

return self;

}

PyDoc_STRVAR(Reader___exit____doc__,

"__exit__(type, value, traceback) -> None\n\n"

"Part of the context manager protocol.\n"

"Closes the journal.\n");

static PyObject* Reader___exit__(Reader *self, PyObject *args _unused_) {

assert(self);

return Reader_close(self, NULL);

}

PyDoc_STRVAR(Reader_next__doc__,

"next([skip]) -> bool\n\n"

"Go to the next log entry. Optional skip value means to go to\n"

"the `skip`\\-th log entry.\n"

"Returns False if at end of file, True otherwise.");

static PyObject* Reader_next(Reader *self, PyObject *args) {

int64_t skip = 1;

int r = -EUCLEAN;

assert(self);

if (!PyArg_ParseTuple(args, "|L:next", &skip))

return NULL;

if (skip == 0) {

PyErr_SetString(PyExc_ValueError, "skip must be nonzero");

return NULL;

}

Py_BEGIN_ALLOW_THREADS

if (skip == 1)

r = sd_journal_next(self->journal);

else if (skip == -1)

r = sd_journal_previous(self->journal);

else if (skip > 1)

r = sd_journal_next_skip(self->journal, skip);

else if (skip < -1)

r = sd_journal_previous_skip(self->journal, -skip);

else

assert(!"should be here");

Py_END_ALLOW_THREADS

if (set_error(r, NULL, NULL) < 0)

return NULL;

return PyBool_FromLong(r);

}

PyDoc_STRVAR(Reader_previous__doc__,

"previous([skip]) -> bool\n\n"

"Go to the previous log entry. Optional skip value means to \n"

"go to the `skip`\\-th previous log entry.\n"

"Returns False if at start of file, True otherwise.");

static PyObject* Reader_previous(Reader *self, PyObject *args) {

int64_t skip = 1LL;

if (!PyArg_ParseTuple(args, "|L:previous", &skip))

return NULL;

return PyObject_CallMethod((PyObject *)self, (char*) "_next",

(char*) "L", -skip);

}

static int extract(const char* msg, size_t msg_len,

PyObject **key, PyObject **value) {

PyObject *k = NULL, *v;

const char *delim_ptr;

delim_ptr = memchr(msg, '=', msg_len);

if (!delim_ptr) {

PyErr_SetString(PyExc_OSError,

"journal gave us a field without '='");

return -1;

}

if (key) {

k = PyUnicode_FromStringAndSize(msg, delim_ptr - (const char*) msg);

if (!k)

return -1;

}

if (value) {

v = PyBytes_FromStringAndSize(delim_ptr + 1,

(const char*) msg + msg_len - (delim_ptr + 1));

if (!v) {

Py_XDECREF(k);

return -1;

}

*value = v;

}

if (key)

*key = k;

return 0;

}

PyDoc_STRVAR(Reader_get__doc__,

"get(str) -> str\n\n"

"Return data associated with this key in current log entry.\n"

"Throws KeyError is the data is not available.");

static PyObject* Reader_get(Reader *self, PyObject *args) {

const char* field;

const void* msg;

size_t msg_len;

PyObject *value;

int r;

assert(self);

assert(args);

if (!PyArg_ParseTuple(args, "s:get", &field))

return NULL;

r = sd_journal_get_data(self->journal, field, &msg, &msg_len);

if (r == -ENOENT) {

PyErr_SetString(PyExc_KeyError, field);

return NULL;

}

if (set_error(r, NULL, "field name is not valid") < 0)

return NULL;

r = extract(msg, msg_len, NULL, &value);

if (r < 0)

return NULL;

return value;

}

PyDoc_STRVAR(Reader_get_all__doc__,

"_get_all() -> dict\n\n"

"Return dictionary of the current log entry.");

static PyObject* Reader_get_all(Reader *self, PyObject *args) {

PyObject *dict;

const void *msg;

size_t msg_len;

int r;

assert(self);

assert(!args);

dict = PyDict_New();

if (!dict)

return NULL;

SD_JOURNAL_FOREACH_DATA(self->journal, msg, msg_len) {

_cleanup_Py_DECREF_ PyObject *key = NULL, *value = NULL;

r = extract(msg, msg_len, &key, &value);

if (r < 0)

goto error;

if (PyDict_Contains(dict, key)) {

PyObject *cur_value = PyDict_GetItem(dict, key);

if (PyList_CheckExact(cur_value)) {

r = PyList_Append(cur_value, value);

if (r < 0)

goto error;

} else {

_cleanup_Py_DECREF_ PyObject *tmp_list = PyList_New(0);

if (!tmp_list)

goto error;

r = PyList_Append(tmp_list, cur_value);

if (r < 0)

goto error;

r = PyList_Append(tmp_list, value);

if (r < 0)

goto error;

r = PyDict_SetItem(dict, key, tmp_list);

if (r < 0)

goto error;

}

} else {

r = PyDict_SetItem(dict, key, value);

if (r < 0)

goto error;

}

return dict;

error:

Py_DECREF(dict);

return NULL;

}

PyDoc_STRVAR(Reader_get_realtime__doc__,

"get_realtime() -> int\n\n"

"Return the realtime timestamp for the current journal entry\n"

"in microseconds.\n\n"

"Wraps sd_journal_get_realtime_usec().\n"

"See :manpage:`sd_journal_get_realtime_usec(3)`.");

static PyObject* Reader_get_realtime(Reader *self, PyObject *args) {

uint64_t timestamp;

int r;

assert(self);

assert(!args);

r = sd_journal_get_realtime_usec(self->journal, &timestamp);

if (set_error(r, NULL, NULL) < 0)

return NULL;

assert_cc(sizeof(unsigned long long) == sizeof(timestamp));

return PyLong_FromUnsignedLongLong(timestamp);

}

PyDoc_STRVAR(Reader_get_monotonic__doc__,

"get_monotonic() -> (timestamp, bootid)\n\n"

"Return the monotonic timestamp for the current journal entry\n"

"as a tuple of time in microseconds and bootid.\n\n"

"Wraps sd_journal_get_monotonic_usec().\n"

"See :manpage:`sd_journal_get_monotonic_usec(3)`.");

static PyObject* Reader_get_monotonic(Reader *self, PyObject *args) {

uint64_t timestamp;

sd_id128_t id;

PyObject *monotonic, *bootid, *tuple;

int r;

assert(self);

assert(!args);

r = sd_journal_get_monotonic_usec(self->journal, &timestamp, &id);

if (set_error(r, NULL, NULL) < 0)

return NULL;

assert_cc(sizeof(unsigned long long) == sizeof(timestamp));

monotonic = PyLong_FromUnsignedLongLong(timestamp);

bootid = PyBytes_FromStringAndSize((const char*) &id.bytes, sizeof(id.bytes));

tuple = PyStructSequence_New(&MonotonicType);

if (!monotonic || !bootid || !tuple) {

Py_XDECREF(monotonic);

Py_XDECREF(bootid);

Py_XDECREF(tuple);

return NULL;

}

PyStructSequence_SET_ITEM(tuple, 0, monotonic);

PyStructSequence_SET_ITEM(tuple, 1, bootid);

return tuple;

}

PyDoc_STRVAR(Reader_add_match__doc__,

"add_match(match) -> None\n\n"

"Add a match to filter journal log entries. All matches of different\n"

"fields are combined with logical AND, and matches of the same field\n"

"are automatically combined with logical OR.\n"

"Match is a string of the form \"FIELD=value\".");

static PyObject* Reader_add_match(Reader *self, PyObject *args) {

char *match;

Py_ssize_t match_len;

int r;

if (!PyArg_ParseTuple(args, "s#:add_match", &match, &match_len))

return NULL;

if (match_len > INT_MAX) {

set_error(-ENOBUFS, NULL, NULL);

return NULL;

}

r = sd_journal_add_match(self->journal, match, (int) match_len);

if (set_error(r, NULL, "Invalid match") < 0)

return NULL;

Py_RETURN_NONE;

}

PyDoc_STRVAR(Reader_add_disjunction__doc__,

"add_disjunction() -> None\n\n"

"Inserts a logical OR between matches added since previous\n"

"add_disjunction() or add_conjunction() and the next\n"

"add_disjunction() or add_conjunction().\n\n"

"See :manpage:`sd_journal_add_disjunction(3)` for explanation.");

static PyObject* Reader_add_disjunction(Reader *self, PyObject *args) {

int r;

assert(self);

assert(!args);

r = sd_journal_add_disjunction(self->journal);

if (set_error(r, NULL, NULL) < 0)

return NULL;

Py_RETURN_NONE;

}

PyDoc_STRVAR(Reader_add_conjunction__doc__,

"add_conjunction() -> None\n\n"

"Inserts a logical AND between matches added since previous\n"

"add_disjunction() or add_conjunction() and the next\n"

"add_disjunction() or add_conjunction().\n\n"

"See :manpage:`sd_journal_add_disjunction(3)` for explanation.");

static PyObject* Reader_add_conjunction(Reader *self, PyObject *args) {

int r;

assert(self);

assert(!args);

r = sd_journal_add_conjunction(self->journal);

if (set_error(r, NULL, NULL) < 0)

return NULL;

Py_RETURN_NONE;

}

PyDoc_STRVAR(Reader_flush_matches__doc__,

"flush_matches() -> None\n\n"

"Clear all current match filters.");

static PyObject* Reader_flush_matches(Reader *self, PyObject *args) {

assert(self);

assert(!args);

sd_journal_flush_matches(self->journal);

Py_RETURN_NONE;

}

PyDoc_STRVAR(Reader_seek_head__doc__,

"seek_head() -> None\n\n"

"Jump to the beginning of the journal.\n"

"This method invokes sd_journal_seek_head().\n"

"See :manpage:`sd_journal_seek_head(3)`.");

static PyObject* Reader_seek_head(Reader *self, PyObject *args) {

int r;

assert(self);

assert(!args);

Py_BEGIN_ALLOW_THREADS

r = sd_journal_seek_head(self->journal);

Py_END_ALLOW_THREADS

if (set_error(r, NULL, NULL) < 0)

return NULL;

Py_RETURN_NONE;

}

PyDoc_STRVAR(Reader_seek_tail__doc__,

"seek_tail() -> None\n\n"

"Jump to the end of the journal.\n"

"This method invokes sd_journal_seek_tail().\n"

"See :manpage:`sd_journal_seek_tail(3)`.");

static PyObject* Reader_seek_tail(Reader *self, PyObject *args) {

int r;

assert(self);

assert(!args);

Py_BEGIN_ALLOW_THREADS

r = sd_journal_seek_tail(self->journal);

Py_END_ALLOW_THREADS

if (set_error(r, NULL, NULL) < 0)

return NULL;

Py_RETURN_NONE;

}

PyDoc_STRVAR(Reader_seek_realtime__doc__,

"seek_realtime(realtime) -> None\n\n"

"Seek to nearest matching journal entry to `realtime`. Argument\n"

"`realtime` in specified in seconds.");

static PyObject* Reader_seek_realtime(Reader *self, PyObject *args) {

uint64_t timestamp;

int r;

assert(self);

if (!PyArg_ParseTuple(args, "K:seek_realtime", &timestamp))

return NULL;

Py_BEGIN_ALLOW_THREADS

r = sd_journal_seek_realtime_usec(self->journal, timestamp);

Py_END_ALLOW_THREADS

if (set_error(r, NULL, NULL) < 0)

return NULL;

Py_RETURN_NONE;

}

PyDoc_STRVAR(Reader_seek_monotonic__doc__,

"seek_monotonic(monotonic[, bootid]) -> None\n\n"

"Seek to nearest matching journal entry to `monotonic`. Argument\n"

"`monotonic` is an timestamp from boot in microseconds.\n"

"Argument `bootid` is a string representing which boot the\n"

"monotonic time is reference to. Defaults to current bootid.");

static PyObject* Reader_seek_monotonic(Reader *self, PyObject *args) {

char *bootid = NULL;

uint64_t timestamp;

sd_id128_t id;

int r;

assert(self);

if (!PyArg_ParseTuple(args, "K|z:seek_monotonic", &timestamp, &bootid))

return NULL;

if (bootid) {

r = sd_id128_from_string(bootid, &id);

if (set_error(r, NULL, "Invalid bootid") < 0)

return NULL;

} else {

Py_BEGIN_ALLOW_THREADS

r = sd_id128_get_boot(&id);

Py_END_ALLOW_THREADS

if (set_error(r, NULL, NULL) < 0)

return NULL;

}

Py_BEGIN_ALLOW_THREADS

r = sd_journal_seek_monotonic_usec(self->journal, id, timestamp);

Py_END_ALLOW_THREADS

if (set_error(r, NULL, NULL) < 0)

return NULL;

Py_RETURN_NONE;

}

PyDoc_STRVAR(Reader_get_start__doc__,

"get_start() -> int\n\n"

"Return the realtime timestamp of the first journal entry\n\n"

"in microseconds.\n\n"

"Wraps sd_journal_get_cutoff_realtime_usec().\n"

"See :manpage:`sd_journal_get_cutoff_realtime_usec(3)`.");

static PyObject* Reader_get_start(Reader *self, PyObject *args) {

uint64_t start;

int r;

assert(self);

assert(!args);

r = sd_journal_get_cutoff_realtime_usec(self->journal, &start, NULL);

if (set_error(r, NULL, NULL) < 0)

return NULL;

assert_cc(sizeof(unsigned long long) == sizeof(start));

return PyLong_FromUnsignedLongLong(start);

}

PyDoc_STRVAR(Reader_get_end__doc__,

"get_end() -> int\n\n"

"Return the realtime timestamp of the last journal entry\n\n"

"in microseconds.\n\n"

"Wraps sd_journal_get_cutoff_realtime_usec().\n"

"See :manpage:`sd_journal_get_cutoff_realtime_usec(3)`.");

static PyObject* Reader_get_end(Reader *self, PyObject *args) {

uint64_t end;

int r;

assert(self);

assert(!args);

r = sd_journal_get_cutoff_realtime_usec(self->journal, NULL, &end);

if (set_error(r, NULL, NULL) < 0)

return NULL;

assert_cc(sizeof(unsigned long long) == sizeof(end));

return PyLong_FromUnsignedLongLong(end);

}

PyDoc_STRVAR(Reader_process__doc__,

"process() -> state change (integer)\n\n"

"Process events and reset the readability state of the file\n"

"descriptor returned by .fileno().\n\n"

"Will return constants: NOP if no change; APPEND if new\n"

"entries have been added to the end of the journal; and\n"

"INVALIDATE if journal files have been added or removed.\n\n"

"See :manpage:`sd_journal_process(3)` for further discussion.");

static PyObject* Reader_process(Reader *self, PyObject *args) {

int r;

assert(!args);

Py_BEGIN_ALLOW_THREADS

r = sd_journal_process(self->journal);

Py_END_ALLOW_THREADS

if (set_error(r, NULL, NULL) < 0)

return NULL;

return PyLong_FromLong(r);

}

PyDoc_STRVAR(Reader_wait__doc__,

"wait([timeout]) -> state change (integer)\n\n"

"Wait for a change in the journal. Argument `timeout` specifies\n"

"the maximum number of microseconds to wait before returning\n"

"regardless of whether the journal has changed. If `timeout` is -1,\n"

"then block forever.\n\n"

"Will return constants: NOP if no change; APPEND if new\n"

"entries have been added to the end of the journal; and\n"

"INVALIDATE if journal files have been added or removed.\n\n"

"See :manpage:`sd_journal_wait(3)` for further discussion.");

static PyObject* Reader_wait(Reader *self, PyObject *args) {

int r;

int64_t timeout = -1;

if (!PyArg_ParseTuple(args, "|L:wait", &timeout))

return NULL;

Py_BEGIN_ALLOW_THREADS

r = sd_journal_wait(self->journal, timeout);

Py_END_ALLOW_THREADS

if (set_error(r, NULL, NULL) < 0)

return NULL;

return PyLong_FromLong(r);

}

PyDoc_STRVAR(Reader_seek_cursor__doc__,

"seek_cursor(cursor) -> None\n\n"

"Seek to journal entry by given unique reference `cursor`.");

static PyObject* Reader_seek_cursor(Reader *self, PyObject *args) {

const char *cursor;

int r;

if (!PyArg_ParseTuple(args, "s:seek_cursor", &cursor))

return NULL;

Py_BEGIN_ALLOW_THREADS

r = sd_journal_seek_cursor(self->journal, cursor);

Py_END_ALLOW_THREADS

if (set_error(r, NULL, "Invalid cursor") < 0)

return NULL;

View remainder of file in raw view

python-systemd/src/systemd/_reader.c at main · systemd/python-systemd · GitHub

Uh oh!

Expand file tree

Breadcrumbs

_reader.c

Latest commit

History

Breadcrumbs

_reader.c

File metadata and controls